diff --git a/api/swagger.json b/api/swagger.json index 5233946..1a6333c 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -1,689 +1,828 @@ { - "swagger": "2.0", - "info": { - "title": "Shovel APIs", - "description": "", - "version": "1.0.0" - }, - "produces": [ "application/json" ], - "basePath": "/api/1.1", - "paths": { + "swagger": "2.0", + "info": { + "title": "Shovel APIs", + "description": "", + "version": "1.0.0" + }, + "produces": [ "application/json" ], + "basePath": "/api/1.1", + "paths": { - "/info": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "infoGet", - "summary": "Get nodes info", - "responses": { + "/info": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "infoGet", + "summary": "Get nodes info", + "responses": { - "200": { - "description": "Not Implemented" - }, + "200": { + "description": "Not Implemented" + }, - "default": { - "description": "unexpected error" - } - } - } - }, - "/shovel/config": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "configget", - "summary": "Get shovel config file", - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/shovel/set-config": { - "post": { - "x-swagger-router-controller": "Shovel", - "tags": [ "POST" ], - "operationId": "configset", - "summary": "set shovel config file", - "parameters": [ - { - "name": "Shovel Config Info", - "in": "body", - "description": "Shovel Config Info", - "required": true, - "schema": { - "$ref": "#/definitions/config" - } - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/shovel/monorail/set-config": { - "post": { - "x-swagger-router-controller": "Shovel", - "tags": [ "POST" ], - "operationId": "configsetmono", - "summary": "set shovel- monorail info", - "parameters": [ - { - "name": "Shovel Config Info", - "in": "body", - "description": "Shovel Config Info", - "required": true, - "schema": { - "$ref": "#/definitions/monorail" - } - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/shovel/ironic/set-config": { - "post": { - "x-swagger-router-controller": "Shovel", - "tags": [ "POST" ], - "operationId": "configsetironic", - "summary": "set shovel ironic info", - "parameters": [ - { - "name": "Shovel Config Info", - "in": "body", - "description": "Shovel Config Info", - "required": true, - "schema": { - "$ref": "#/definitions/ironic" - } - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/shovel/glance/set-config": { - "post": { - "x-swagger-router-controller": "Shovel", - "tags": [ "POST" ], - "operationId": "configsetglance", - "summary": "set shovel glance info", - "parameters": [ - { - "name": "Shovel Config Info", - "in": "body", - "description": "Shovel Config Info", - "required": true, - "schema": { - "$ref": "#/definitions/glance" - } - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/shovel/keystone/set-config": { - "post": { - "x-swagger-router-controller": "Shovel", - "tags": [ "POST" ], - "operationId": "configsetkeystone", - "summary": "set shovel Keystone info", - "parameters": [ - { - "name": "Shovel Config Info", - "in": "body", - "description": "Shovel Config Info", - "required": true, - "schema": { - "$ref": "#/definitions/keystone" - } - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/catalogs/{identifier}": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "catalogsGet", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Onrack node ID", - "required": true, - "type": "string" - } - ], - "summary": "Get catalog for a specified node", - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/catalogs/{identifier}/{source}": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "catalogsbysourceGet", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Onrack node ID", - "required": true, - "type": "string" - }, - { - "name": "source", - "in": "path", - "description": "source", - "required": true, - "type": "string" - } - ], - "summary": "Get source in the catalog for a specified node", - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/nodes/{identifier}": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "nodeGet", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Onrack node ID", - "required": true, - "type": "string" - } - ], - "summary": "get specific node by id", - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/nodes": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "nodesGet", - "summary": "get All OnRack Nodes", - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/nodes/{identifier}/sel": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "getSeldata", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Node SEL information", - "required": true, - "type": "string" - } - ], - "summary": "get current SEL data for specified node ID", - "responses": { - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/ironic/nodes": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "ironicnodesGet", - "summary": "get All ironic Nodes", - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/ironic/node/{identifier}": { - "patch": { - "x-swagger-router-controller": "Shovel", - "tags": [ "PATCH" ], - "operationId": "ironicnodePatch", - "summary": "patch specified ironic node", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Ironic node ID", - "required": true, - "type": "string" - }, - { - "name": "patchnode", - "in": "body", - "description": "Node patch form data", - "required": true, - "schema": { - "$ref": "#/definitions/patchnode" - } - } - ], - "responses": { - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/ironic/chassis/{identifier}": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "ironicchassisGet", - "summary": "get Ironic chassis by id", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Ironic node ID", - "required": true, - "type": "string" - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/ironic/nodes/{identifier}": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "ironicnodeGet", - "summary": "get Ironic node by name", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Ironic node name or ID", - "required": true, - "type": "string" - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/register": { - "post": { - "x-swagger-router-controller": "Shovel", - "tags": [ "POST" ], - "operationId": "registerpost", - "summary": "Register an OnRack node in Ironic", - "parameters": [ - { - "name": "Node Info", - "in": "body", - "description": "Node Registration info", - "required": true, - "schema": { - "$ref": "#/definitions/regnode" - } - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/unregister/{identifier}": { - "delete": { - "x-swagger-router-controller": "Shovel", - "tags": [ "DEL" ], - "operationId": "unregisterdel", - "summary": "UnRegister a node from Ironic", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "Ironic node ID", - "required": true, - "type": "string" - } - ], - "responses": { - - "200": { - "description": "Not Implemented" - }, - - "default": { - "description": "unexpected error" - } - } - } - }, - "/ironic/drivers": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "driversGet", - "summary": "Get all the drivers used in Ironic", - "responses": { - - "200": { - "description": "Not implemented", - - "headers": { - "x-expires": { - "type": "string" - } - } - }, - "default": { - "description": "unexpected error" - } - } - } - }, - "/glance/images": { - "get": { - "x-swagger-router-controller": "Shovel", - "tags": [ "GET" ], - "operationId": "imagesGet", - "summary": "Get all the images in Glance", - "responses": { - - "200": { - "description": "Not implemented", - - "headers": { - "x-expires": { - "type": "string" - } - } - }, - "default": { - "description": "unexpected error" - } - } - } + "default": { + "description": "unexpected error" + } } + } }, - "definitions": { - "monorail": { - "type": "object", - "properties": { - "httpHost": { - "type": "string" - }, - "httpPort": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "config": { - "type": "object", - "properties": { - "httpPort": { - "type": "integer", - "format": "int32" - } - } - }, - "ironic": { - "type": "object", - "properties": { - "httpHost": { - "type": "string" - }, - "httpPort": { - "type": "string" - }, - "version": { - "type": "string" - }, - "os_username": { - "type": "string" - }, - "os_password": { - "type": "string" - }, - "os_tenant_name": { - "type": "string" - }, - "os_auth_token": { - "type": "string" - }, - "insecure": { - "type": "string" - } - } - }, - "glance": { - "type": "object", - "properties": { - "httpHost": { - "type": "string" - }, - "httpPort": { - "type": "string" - }, - "version": { - "type": "string" - }, - "os_username": { - "type": "string" - }, - "os_password": { - "type": "string" - }, - "os_tenant_name": { - "type": "string" - }, - "os_auth_token": { - "type": "string" - }, - "insecure": { - "type": "string" - } - } - }, - "keystone": { - "type": "object", - "properties": { - "httpHost": { - "type": "string" - }, - "httpPort": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "regnode": { - "type": "object", - "required": [ - "uuid", - "kernel", - "ramdisk", - "port" - ], - "properties": { - "uuid": { - "type": "string" - }, - "driver": { - "type": "string" - }, - "ipmihost": { - "type": "string" - }, - "ipmiuser": { - "type": "string" - }, - "ipmipass": { - "type": "string" - }, - "sshhost": { - "type": "string" - }, - "sshuser": { - "type": "string" - }, - "sshpass": { - "type": "string" - }, - "sshport": { - "type": "string" - }, - "name": { - "type": "string" - }, - "kernel": { - "type": "string" - }, - "ramdisk": { - "type": "string" - }, - "port": { - - "type": "string" - } - } - }, - "patchnode": { - "type": "array", - "items": { - "type": "object" - } + "/shovel/config": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "configget", + "summary": "Get shovel config file", + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } } + } + }, + "/shovel/set-config": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "configset", + "summary": "set shovel config file", + "parameters": [ + { + "name": "Shovel Config Info", + "in": "body", + "description": "Shovel Config Info", + "required": true, + "schema": { + "$ref": "#/definitions/config" + } + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/shovel/monorail/set-config": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "configsetmono", + "summary": "set shovel- monorail info", + "parameters": [ + { + "name": "Shovel Config Info", + "in": "body", + "description": "Shovel Config Info", + "required": true, + "schema": { + "$ref": "#/definitions/monorail" + } + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/shovel/ironic/set-config": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "configsetironic", + "summary": "set shovel ironic info", + "parameters": [ + { + "name": "Shovel Config Info", + "in": "body", + "description": "Shovel Config Info", + "required": true, + "schema": { + "$ref": "#/definitions/ironic" + } + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/shovel/glance/set-config": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "configsetglance", + "summary": "set shovel glance info", + "parameters": [ + { + "name": "Shovel Config Info", + "in": "body", + "description": "Shovel Config Info", + "required": true, + "schema": { + "$ref": "#/definitions/glance" + } + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/shovel/keystone/set-config": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shovel Config" ], + "operationId": "configsetkeystone", + "summary": "set shovel Keystone info", + "parameters": [ + { + "name": "Shovel Config Info", + "in": "body", + "description": "Shovel Config Info", + "required": true, + "schema": { + "$ref": "#/definitions/keystone" + } + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/catalogs/{identifier}": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "RackHD API Wrappers" ], + "operationId": "catalogsGet", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "rackhd node ID", + "required": true, + "type": "string" + } + ], + "summary": "Get catalog for a specified node", + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/catalogs/{identifier}/{source}": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "RackHD API Wrappers" ], + "operationId": "catalogsbysourceGet", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "rackhd node ID", + "required": true, + "type": "string" + }, + { + "name": "source", + "in": "path", + "description": "source", + "required": true, + "type": "string" + } + ], + "summary": "Get source in the catalog for a specified node", + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/nodes/{identifier}": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "RackHD API Wrappers" ], + "operationId": "nodeGet", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "rackhd node ID", + "required": true, + "type": "string" + } + ], + "summary": "get specific node by id", + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/nodes": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "RackHD API Wrappers" ], + "operationId": "nodesGet", + "summary": "get All rackhd Nodes that been discovered with BMC,DMI information", + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/nodes/{identifier}/sel": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "RackHD API Wrappers" ], + "operationId": "getSeldata", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "Node SEL information", + "required": true, + "type": "string" + } + ], + "summary": "get current SEL data for specified node ID", + "responses": { + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/ironic/nodes": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Ironic API Wrappers" ], + "operationId": "ironicnodesGet", + "summary": "get All ironic Nodes", + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/ironic/node/{identifier}": { + "patch": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Ironic API Wrappers" ], + "operationId": "ironicnodePatch", + "summary": "patch specified ironic node", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "Ironic node ID", + "required": true, + "type": "string" + }, + { + "name": "patchnode", + "in": "body", + "description": "Node patch form data", + "required": true, + "schema": { + "$ref": "#/definitions/patchnode" + } + } + ], + "responses": { + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/ironic/chassis/{identifier}": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Ironic API Wrappers" ], + "operationId": "ironicchassisGet", + "summary": "get Ironic chassis by id", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "Ironic node ID", + "required": true, + "type": "string" + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/ironic/nodes/{identifier}": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Ironic API Wrappers" ], + "operationId": "ironicnodeGet", + "summary": "get Ironic node by name", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "Ironic node name or ID", + "required": true, + "type": "string" + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/register": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shoveling" ], + "operationId": "registerpost", + "summary": "Register an rackhd node in Ironic", + "parameters": [ + { + "name": "Node Info", + "in": "body", + "description": "Node Registration info", + "required": true, + "schema": { + "$ref": "#/definitions/regnode" + } + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/unregister/{identifier}": { + "delete": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Shoveling" ], + "operationId": "unregisterdel", + "summary": "UnRegister a node from Ironic", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "Ironic node ID", + "required": true, + "type": "string" + } + ], + "responses": { + + "200": { + "description": "Not Implemented" + }, + + "default": { + "description": "unexpected error" + } + } + } + }, + "/ironic/drivers": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Ironic API Wrappers" ], + "operationId": "driversGet", + "summary": "Get all the drivers used in Ironic", + "responses": { + + "200": { + "description": "Not implemented", + + "headers": { + "x-expires": { + "type": "string" + } + } + }, + "default": { + "description": "unexpected error" + } + } + } + }, + "/glance/images": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Glance API Wrappers" ], + "operationId": "imagesGet", + "summary": "Get all the images in Glance", + "responses": { + + "200": { + "description": "Not implemented", + + "headers": { + "x-expires": { + "type": "string" + } + } + }, + "default": { + "description": "unexpected error" + } + } + } + }, + "/deployos/{identifier}/": { + "post": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Nodes Provisionning" ], + "operationId": "deployOS", + "summary": "Deploy OS to a specific node", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "rackHD node ID", + "required": true, + "type": "string" + }, + { + "name": "Config", + "in": "body", + "description": "OS Configuration", + "required": true, + "schema": { + "$ref": "#/definitions/deployos" + } + } + ], + "responses": { + "200": { + "description": "Not Implemented" + }, + "default": { + "description": "unexpected error" + } + } + } + }, + "/worflow-status/{identifier}": { + "get": { + "x-swagger-router-controller": "Shovel", + "tags": [ "Nodes Provisionning" ], + "operationId": "workflowStatus", + "summary": "Get status of an active worflow running on a certain node in rackHD", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "rackHD node ID", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Not Implemented" + }, + "default": { + "description": "unexpected error" + } + } + } } + }, + "definitions": { + "monorail": { + "type": "object", + "properties": { + "httpHost": { + "type": "string" + }, + "httpPort": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "config": { + "type": "object", + "properties": { + "httpPort": { + "type": "integer", + "format": "int32" + } + } + }, + "ironic": { + "type": "object", + "properties": { + "httpHost": { + "type": "string" + }, + "httpPort": { + "type": "string" + }, + "version": { + "type": "string" + }, + "os_username": { + "type": "string" + }, + "os_password": { + "type": "string" + }, + "os_tenant_name": { + "type": "string" + }, + "os_auth_token": { + "type": "string" + }, + "insecure": { + "type": "string" + } + } + }, + "glance": { + "type": "object", + "properties": { + "httpHost": { + "type": "string" + }, + "httpPort": { + "type": "string" + }, + "version": { + "type": "string" + }, + "os_username": { + "type": "string" + }, + "os_password": { + "type": "string" + }, + "os_tenant_name": { + "type": "string" + }, + "os_auth_token": { + "type": "string" + }, + "insecure": { + "type": "string" + } + } + }, + "keystone": { + "type": "object", + "properties": { + "httpHost": { + "type": "string" + }, + "httpPort": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "regnode": { + "type": "object", + "required": [ + "uuid", + "kernel", + "ramdisk", + "port" + ], + "properties": { + "uuid": { + "type": "string" + }, + "driver": { + "type": "string" + }, + "ipmihost": { + "type": "string" + }, + "ipmiuser": { + "type": "string" + }, + "ipmipass": { + "type": "string" + }, + "sshhost": { + "type": "string" + }, + "sshuser": { + "type": "string" + }, + "sshpass": { + "type": "string" + }, + "sshport": { + "type": "string" + }, + "name": { + "type": "string" + }, + "kernel": { + "type": "string" + }, + "ramdisk": { + "type": "string" + }, + "port": { + + "type": "string" + } + } + }, + "patchnode": { + "type": "array", + "items": { + "type": "object" + } + }, + "deployos": { + "type": "object", + "required": [ + "name", + "options" + ], + "properties": { + "name": { + "type": "string", + "example":"Graph.InstallCentOS" + }, + "options": { + "type": "object", + "required": [ + "defaults" + ], + "properties": { + "defaults": { + "type": "object", + "properties": { + "obmServiceName": { + "type": "string", + "example": "ipmi-obm-service" + } + } + }, + "install-os": { + "type": "object", + "properties": { + "repo": { + "type": "string" + }, + "rootPassword": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "password" + ], + "properties": { + "name": { + "type": "string" + }, + "password": { + "type": "string" + }, + "uid": { + "type": "integer" + } + } + } + }, + "networkDevices": { + "type": "array", + "items": { + "type": "object", + "required": [ + "device", + "ipv4" + ], + "properties": { + "device": { + "type": "string" + }, + "ipv4": { + "type": "object" + } + } + } + } + } + } + } + } + } + } + } } diff --git a/controllers/Shovel.js b/controllers/Shovel.js index c244568..a0b2f7f 100644 --- a/controllers/Shovel.js +++ b/controllers/Shovel.js @@ -628,3 +628,38 @@ module.exports.imagesGet = function imagesGet(req, res) { res.end(JSON.stringify(err)); }); }; +/* +* @api {post} /api/1.1/deployOS/identifier / POST / +* @apiDescription deploy OS to specific node +*/ +module.exports.deployOS = function deployOS(req, res) { + 'use strict'; + res.setHeader('Content-Type', 'application/json'); + return monorail.runWorkFlow(req.swagger.params.identifier.value, + req.body.name,req.body) + .then(function(data) { + res.end(data); + }) + .catch(function(err) { + res.end(JSON.stringify(err)); + }); +}; +/* +* @api {get} /api/1.1/workflow-status/identifier / GET / +* @apiDescription Get status of an active worflow running on a node in rackHD +*/ +module.exports.workflowStatus = function workflowStatus(req,res) { + 'use strict'; + res.setHeader('Content-Type', 'application/json'); + return monorail.getWorkFlowActive(req.swagger.params.identifier.value) + .then(function(data) { + if (data) { + res.end(JSON.stringify({'jobStatus':'Running'})); + } else { + res.end(JSON.stringify({'jobStatus':'Currently there is no job running on this node'})); + } + }) + .catch(function(err) { + res.end(JSON.stringify(err)); + }); +}; diff --git a/lib/api/monorail/monorail.js b/lib/api/monorail/monorail.js index 8ded5bf..1eb11d0 100644 --- a/lib/api/monorail/monorail.js +++ b/lib/api/monorail/monorail.js @@ -145,7 +145,22 @@ var MonorailWrapper = { .catch(function (err) { throw err; }); + }, + runWorkFlow: function runWorkFlow(hwaddr,graphName,content) { + 'use strict'; + request.path = pfx + '/nodes/' + hwaddr + '/workflows/?name=' + graphName; + request.data = JSON.stringify(content); + return client.PostAsync(request); + }, + getWorkFlowActive: function getWorkFlowActive(hwaddr) { + 'use strict'; + request.path = pfx + '/nodes/' + hwaddr + '/workflows/active'; + return client.GetAsync(request); + }, + deleteWorkFlowActive: function deleteWorkFlowActive(hwaddr) { + 'use strict'; + request.path = pfx + '/nodes/' + hwaddr + '/workflows/active'; + return client.DeleteAsync(request); } - }; module.exports = Object.create(MonorailWrapper); diff --git a/test/api/monorail.js b/test/api/monorail.js index 1de371d..95e47b6 100644 --- a/test/api/monorail.js +++ b/test/api/monorail.js @@ -164,5 +164,26 @@ describe('****Monorail Lib****',function(){ done(); }); }); + it('monorail.runWorkFlow return data from monorail', function (done) { + return monorail.runWorkFlow('123','Graph.Name',{}) + .then(function (result) { + result.should.have.property('data'); + done(); + }); + }); + it('monorail.getWorkFlowActive return data from monorail', function (done) { + return monorail.getWorkFlowActive('123') + .then(function (result) { + result.should.have.property('data'); + done(); + }); + }); + it('monorail.deleteWorkFlowActive return data from monorail', function (done) { + return monorail.deleteWorkFlowActive('123') + .then(function (result) { + result.should.have.property('data'); + done(); + }); + }); }); }); \ No newline at end of file diff --git a/test/controllers/Shovel.js b/test/controllers/Shovel.js index 4fa28a0..04d1510 100644 --- a/test/controllers/Shovel.js +++ b/test/controllers/Shovel.js @@ -41,7 +41,7 @@ describe('****SHOVEL API Interface****', function () { }); describe('Shovel api unit testing', function () { var dmiData = { cpus: 1, memory: 1 }; - + var getWorkflow; beforeEach('set up mocks', function () { //monorail sinon.stub(monorail, 'request_node_get').returns(Promise.resolve(JSON.stringify(rackhdNode[0]))); @@ -54,6 +54,8 @@ describe('****SHOVEL API Interface****', function () { sinon.stub(monorail, 'nodeDiskSize').returns(Promise.resolve(0)); sinon.stub(monorail, 'getNodeMemoryCpu').returns(Promise.resolve(dmiData)); sinon.stub(monorail, 'get_catalog_data_by_source').returns(Promise.resolve(JSON.stringify(catalogSource[0]))); + sinon.stub(monorail, 'runWorkFlow').returns(Promise.resolve('{"definition":{}}')); + getWorkflow = sinon.stub(monorail,'getWorkFlowActive'); //glance sinon.stub(glance, 'get_images').returns(Promise.resolve(JSON.stringify(glanceImages))); //keystone @@ -79,6 +81,8 @@ describe('****SHOVEL API Interface****', function () { monorail['nodeDiskSize'].restore(); monorail['getNodeMemoryCpu'].restore(); monorail['get_catalog_data_by_source'].restore(); + monorail['runWorkFlow'].restore(); + monorail['getWorkFlowActive'].restore(); //ironic ironic['patch_node'].restore(); ironic['get_node_list'].restore(); @@ -324,6 +328,45 @@ describe('****SHOVEL API Interface****', function () { done(); }); }); + it('/api/1.1/deployos/ should return property definition', function (done) { + request(url) + .post('/api/1.1/deployos/123') + .send({"name": "Graph.InstallCentOS","options": { "defaults": {"obmServiceName": "ipmi-obm-service"}}}) + .end(function (err, res) { + if (err) { + console.log('hey yo'); + throw err; + } + console.log('hello' + res.text) + JSON.parse(res.text).should.have.property('definition'); + done(); + }); + }); + it('/api/1.1/worflow-status/{identifier} should return property jobStatus', function (done) { + getWorkflow.returns(Promise.resolve('{"node":"123", "_status": "valid"}')) + request(url) + .get('/api/1.1/worflow-status/123') + .end(function (err, res) { + if (err) { + throw err; + } + console.log(res.text); + JSON.parse(res.text).should.have.property('jobStatus'); + done(); + }); + }); + it('/api/1.1/worflow-status/{identifier} should return property jobStatus even if no job is running', function (done) { + getWorkflow.returns(Promise.resolve()); + request(url) + .get('/api/1.1/worflow-status/123') + .end(function (err, res) { + if (err) { + throw err; + } + JSON.parse(res.text).should.have.property('jobStatus'); + done(); + }); + }); }); @@ -490,6 +533,31 @@ describe('****SHOVEL API Interface****', function () { done(); }); }); + it('/deployos/{identifier} should return error message', function (done) { + request(url) + .post('/api/1.1/deployos/123') + .send([{}]) + .expect(200) + .end(function (err, res) { + if (err) { + throw err; + } + JSON.parse(res.text).should.have.property('error'); + done(); + }); + }); + it('/worflow-status/{identifier} should return error message', function (done) { + request(url) + .get('/api/1.1/worflow-status/123') + .expect(200) + .end(function (err, res) { + if (err) { + throw err; + } + JSON.parse(res.text).should.have.property('error'); + done(); + }); + }); }); describe('Shovel api unit test for register', function () {