Deploy params (#14)

* Consolidate deploy OVA params

Makefile

@@ -15,7 +15,7 @@ GO_LDFLAGS +="
 
 TAG ?= $(COMMIT)
 
-GOLANGCI_LINTER_VERSION = v1.9.3
+GOLANGCI_LINTER_VERSION = v1.10
 
 all: lint test docker
 

README.md

@@ -15,7 +15,8 @@ See available environment variables examples in [.env.example](https://github.co
 ```bash
 export VMWARE_URL=username:[email protected]
 export VMWARE_INSECURE=1
-export VMWARE_DC=DC1
+export VMWARE_DATACENTER=DC1
+export VMWARE_FOLDER=DevVMs
 ```
 
 ## Development
@@ -30,5 +31,5 @@ or using Docker and Docker Compose
 make dc
 ```
 
-## API
+## API docs
 See [swagger file](https://github.com/vterdunov/janna-api/blob/master/api/swagger.yaml)

api/swagger.yaml

@@ -65,6 +65,11 @@ paths:
       tags:
       - Virtual Machines
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: datacenter
         in: query
         description: Datacenter name
@@ -90,12 +95,48 @@ paths:
               schema:
                 $ref: "#/components/schemas/vm_list_response"
 
+    post:
+      summary: Deploy OVA file
+      description: Deploy OVA file
+      tags:
+      - Virtual Machines
+      parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/deploy_ova_body'
+
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  task_id:
+                    type: string
+              example:
+                "task_id": "548f65e9-2f79-2af9-8641-be75088f43c5"
+
   /vm/{vm_uuid}:
     get:
       summary: "Get information about VM"
       tags:
       - Virtual Machines
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -123,6 +164,11 @@ paths:
       - Virtual Machines
       - Snapshots
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -148,6 +194,11 @@ paths:
       - Virtual Machines
       - Snapshots
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -181,6 +232,11 @@ paths:
       - Virtual Machines
       - Snapshots
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -207,6 +263,11 @@ paths:
       - Virtual Machines
       - Snapshots
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -233,6 +294,11 @@ paths:
       - Virtual Machines
       - Snapshots
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -259,6 +325,11 @@ paths:
       - Virtual Machines
       - Permissions
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: vm_uuid
         in: path
         required: true
@@ -289,8 +360,8 @@ paths:
       tags:
       - Permissions
       parameters:
-      - in: header
-        name: X-Request-ID
+      - name: X-Request-ID
+        in: header
         schema:
           type: string
           format: uuid
@@ -308,6 +379,11 @@ paths:
       tags:
       - Find
       parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
       - name: path
         in: query
         required: true
@@ -335,6 +411,33 @@ paths:
               schema:
                 $ref: "#/components/schemas/find_vm_error_response"
 
+  /status/{task_id}:
+    get:
+      summary: "Get information about backgroud task"
+      tags:
+      - Tasks
+      parameters:
+      - name: X-Request-ID
+        in: header
+        schema:
+          type: string
+          format: uuid
+      - name: task_id
+        in: path
+        required: true
+        description: Task ID
+        schema:
+          type: string
+          format: uuid
+          example: 6ef18379-6220-6f7e-30ca-1d1c20a3cc97
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json::
+              schema:
+                $ref: "#/components/schemas/task_id_response"
+
 components:
   schemas:
     build_info_response:
@@ -469,3 +572,67 @@ components:
           "description":
             "label": "Virtual machine user (sample)"
             "summary": "Provides virtual machine interaction permissions"
+
+    task_id_response:
+      type: object
+      properties:
+        task_id:
+          type: string
+      example:
+        "status": "Starting deploy"
+
+    deploy_ova_body:
+      type: object
+      properties:
+        name:
+          type: string
+          example: Janna VM
+        ova_url:
+          type: string
+          format: uri
+          example: https://stable.release.core-os.net/amd64-usr/current/coreos_production_vmware_ova.ova
+        datacenter:
+          type: string
+          example: DC1
+        folder:
+          type: string
+          example: Dev VMs
+        annotation:
+          type: string
+          example: This is an annotation of the deployed VM
+        datastores:
+          type: object
+          properties:
+            type:
+              type: string
+              description: "Storage type. Possible values: 'cluster', 'datastore'. If 'cluster' type was chosen then Janna try to get DRS recommendation to choose proper 'datastore'."
+              example: cluster
+            names:
+              type: array
+              items:
+                type: string
+                description: List of storages. One of them will be chosen randomly.
+                example: DatastoreCluster1
+          required:
+            - type
+        networks:
+          type: object
+          description: Network defines a mapping from each network inside the OVF to a ESXi network. The networks must be presented on the ESXi host.
+          example:
+            "VM Network": "esxi-net1"
+        computer_resources:
+          type: object
+          properties:
+            type:
+              type: string
+              description: "Computer resource type. Possible values: 'host', 'cluster', 'rp'."
+              example: cluster
+            path:
+              type: string
+              description: Name or path to a computer resource. The parameter Can be omitted, then Janna will try to get default computer resource.
+              example: my-esxi-cluster
+          required:
+            - type
+      required:
+        - name
+        - ova_url

config/.env.example

@@ -1,18 +1,20 @@
 # Example configuration file
 
-# Janna common settings
+### Janna common settings
 PORT=8080
+DEBUG=false
 
-# VMWare settings
+# Task info Time-To-Live
+TASKS_TTL=27
+
+### VMware setting
+# Connection settings
 VMWARE_URL=[email protected]:[email protected]
 VMWARE_INSECURE=1
 
-# VMWare default parameters. May be overriden in API request.
-VMWARE_DC=DC1
-VMWARE_DS=Cluster/host1
-VMWARE_FOLDER=vm-folder
-VMWARE_RP=janna
+### VMWare resources default parameters. May be overriden in API request.
+# Datacenter
+VMWARE_DATACENTER=DC1
 
-# VMWARE_HOST is optional. So if you use empty value, then vCenter will choose a host to deploy.
-# If you need a specify a cluster then specify a Resource Pool (VMWARE_RP env) param.
-# VMWARE_HOST=vi-devops-esx7.lab.vi.local
+# Folder VMs deploy to
+VMWARE_FOLDER=vm-folder

internal/config/config.go

@@ -19,10 +19,7 @@ type resources struct {
 	URL      string
 	Insecure bool
 	DC       string
-	DS       string
-	RP       string
 	Folder   string
-	Host     string
 }
 
 type protocols struct {
@@ -72,42 +69,18 @@ func Load() (*Config, error) {
 	config.VMWare.URL = vmwareURL
 
 	// VMWare Datacenter
-	vmwareDC, ok := os.LookupEnv("VMWARE_DC")
+	vmwareDC, ok := os.LookupEnv("VMWARE_DATACENTER")
 	if !ok {
-		return nil, errors.New("provide 'VMWARE_DC' environment variable")
+		return nil, errors.New("provide 'VMWARE_DATACENTER' environment variable")
 	}
 	config.VMWare.DC = vmwareDC
 
-	// VMWare Datastore
-	vmwareDS, exist := os.LookupEnv("VMWARE_DS")
-	if !exist {
-		return nil, errors.New("provide 'VMWARE_DS' environment variable")
-	}
-	config.VMWare.DS = vmwareDS
-
-	// VMWare Resource Pool
-	vmwareRP, exist := os.LookupEnv("VMWARE_RP")
-	if !exist {
-		return nil, errors.New("provide 'VMWARE_RP' environment variable")
-	}
-	config.VMWare.RP = vmwareRP
-
 	// VMWare VM Folder
 	vmwareFolder, exist := os.LookupEnv("VMWARE_FOLDER")
-	if !exist {
-		config.VMWare.Folder = ""
-	} else {
+	if exist {
 		config.VMWare.Folder = vmwareFolder
 	}
 
-	// VMWare ESXi Host
-	vmwareHost, exist := os.LookupEnv("VMWARE_HOST")
-	if !exist {
-		config.VMWare.Host = ""
-	} else {
-		config.VMWare.Host = vmwareHost
-	}
-
 	// Background jobs time to live
 	defaultTTL := time.Minute * 30
 	taskTTL, exist := os.LookupEnv("TASKS_TTL")