Ocean GKE Doc Fixes

spotinst · Dec 13, 2023 · 3620d41 · 3620d41
1 parent 067d36a
commit 3620d41
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 45 deletions.
diff --git a/api/services/ocean/gke/paths/cluster-roll.yaml b/api/services/ocean/gke/paths/cluster-roll.yaml
@@ -18,9 +18,13 @@ put:
       application/json:
         schema:
           type: object
+          required:
+            - roll
           properties:
             roll:
               type: object
+              required:
+                - status
               description: >
                 Object that specifies the parameters of a roll (also called a deployment).
               properties:

diff --git a/api/services/ocean/gke/responses/oceanGkeUpdateResponse.yaml b/api/services/ocean/gke/responses/oceanGkeUpdateResponse.yaml
@@ -19,6 +19,6 @@ content:
                 items:
                   type: array
                   items:
-                    $ref: "../schemas/oceanCluster-create.yaml"
+                    $ref: "../schemas/oceanCluster-update.yaml"
                 kind:
                   example: "spotinst:ocean:gcp:k8s"
diff --git a/api/services/ocean/gke/schemas/manualHeadroomScheduledTaskCreate.yaml b/api/services/ocean/gke/schemas/manualHeadroomScheduledTaskCreate.yaml
@@ -1,14 +1,14 @@
 type: object
 title: manualHeadroomUpdate
-required:
-  - headrooms
 properties:
   headrooms:
     description: >
       Set custom headroom per VNG. Provide a list of launchSpec.autoscale.headroom objects.
     type: array
     items:
       type: object
+      required:
+        - numOfUnits
       properties:
         cpuPerUnit:
           description: >

diff --git a/api/services/ocean/gke/schemas/oceanClusterLaunchSpec.yaml b/api/services/ocean/gke/schemas/oceanClusterLaunchSpec.yaml
@@ -25,7 +25,7 @@ properties:
     example: [email protected]
     description: >
       The account used by applications running on the VM to call GCP APIs.
-  rootVolumeSize:
+  rootVolumeSizeInGb:
     type: integer
     description: Set root volume size (in GB).
     example: 8
@@ -36,13 +36,13 @@ properties:
     enum: [pd-standard, pd-ssd]
   metadata:
     type: array
-    required:
-      - key
-      - value
     description: >
       Add metadata to the cluster.
     items:
       type: object
+      required:
+        - key
+        - value
       properties:
         key:
           type: string
@@ -83,6 +83,10 @@ properties:
     description: Add taints to the virtual node group.
     items:
       type: object
+      required:
+        - key
+        - value
+        - effect
       properties:
         key:
           type: string
@@ -92,6 +96,7 @@ properties:
           description: Set taint value.
         effect:
           type: string
+          enum: [ NoSchedule, PreferNoSchedule, NoExecute ]
           description: Set taint effect.
     example:
       - key: taintKey
@@ -102,6 +107,9 @@ properties:
     description: 'An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.'
     items:
       type: object
+      required:
+        - key
+        - value
       properties:
         key:
           type: string
@@ -136,6 +144,8 @@ properties:
           Set custom headroom per virtual node group. Provide a list of launchSpec.autoScale.headroom objects.
         items:
           type: object
+          required:
+            - numOfUnits
           properties:
             cpuPerUnit:
               type: integer
@@ -205,13 +215,12 @@ properties:
     example: "2019-06-10T15:06:13.000Z"
   networkInterfaces:
       type: array
-      required:
-        - accessConfigs
-        - network
       description: >
         Settings for network interfaces
       items:
         type: object
+        required:
+          - network
         properties:
           network:
             type: string
@@ -228,10 +237,8 @@ properties:
             type: array
             description: >
                The network protocol of the VNG.
-            required:
-              - name
-              - type
             items:
+              type: object
               properties:
                   name:
                     type: string
@@ -246,12 +253,13 @@ properties:
                     example: "ONE_TO_ONE_NAT"
           aliasIpRanges:
             type: array
-            required:
-              - ipCidrRange
-              - subnetworkRangeName
             description:
               use the imported node pool’s associated aliasIpRange to assign secondary IP addresses to the nodes. Cannot be changed after VNG creation.
             items:
+              type: object
+              required:
+                - ipCidrRange
+                - subnetworkRangeName
               properties:
                 ipCidrRange:
                   type: string

diff --git a/api/services/ocean/gke/schemas/oceanClusterLaunchSpecUpdate.yaml b/api/services/ocean/gke/schemas/oceanClusterLaunchSpecUpdate.yaml
@@ -21,19 +21,19 @@ properties:
         example: "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517"
         description: >
           Set image URL. Can be null.
-      rootVolumeSize:
+      rootVolumeSizeInGb:
         type: integer
         description: Set root volume size (in GB).
         example: 8
       metadata:
         type: array
-        required:
-          - key
-          - value
         description: >
           Add metadata to the cluster.
         items:
           type: object
+          required:
+            - key
+            - value
           properties:
             key:
               type: string
@@ -74,6 +74,10 @@ properties:
         description: Add taints to virtual node group.
         items:
           type: object
+          required:
+            - key
+            - value
+            - effect
           properties:
             key:
               type: string
@@ -83,6 +87,7 @@ properties:
               description: Set taint value.
             effect:
               type: string
+              enum: [ NoSchedule, PreferNoSchedule, NoExecute ]
               description: Set taint effect.
         example:
           - key: taintKey
@@ -93,6 +98,9 @@ properties:
         description: 'An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.'
         items:
           type: object
+          required:
+            - key
+            - value
           properties:
             key:
               type: string
@@ -121,36 +129,40 @@ properties:
       autoScale:
         type: object
         properties:
-          headroom:
-            type: object
+          headrooms:
+            type: array
             description: >
               Set custom headroom per virtual node group. Provide a list of launchSpec.autoScale.headroom objects.
-            properties:
-              cpuPerUnit:
-                type: integer
-                description: >
-                  Configure the number of CPUs to allocate the headroom.
-                  CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
-                example: 1000
-              memoryPerUnit:
-                type: integer
-                description: >
-                  Configure the amount of memory (MiB) to allocate the headroom.
-                example: 2048
-              gpuPerUnit:
-                type: integer
-                description: >
-                  The amount of GPU allocate per headroom unit.
-                example: 0
-              numOfUnits:
-                type: integer
-                description: >
-                  The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
-                example: 3
+            items:
+              type: object
+              required:
+                - numOfUnits
+              properties:
+                cpuPerUnit:
+                  type: integer
+                  description: >
+                    Configure the number of CPUs to allocate the headroom.
+                    CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
+                  example: 1000
+                memoryPerUnit:
+                  type: integer
+                  description: >
+                    Configure the amount of memory (MiB) to allocate the headroom.
+                  example: 2048
+                gpuPerUnit:
+                  type: integer
+                  description: >
+                    The amount of GPU to allocate per headroom unit.
+                  example: 0
+                numOfUnits:
+                  type: integer
+                  description: >
+                    The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
+                  example: 3
           autoHeadroomPercentage:
             type: integer
             description: >
-              Number between 0-200 to control the headroom % of the specific Virtual Node Group. Effective when cluster.autoScaler.isAutoConfig=true is set on the Ocean cluster.
+              Number between 0-200 to control the headroom % of the specific Virtual Node Group. Effective when cluster.autoScaler.isAutoConfig=true is set on the Ocean cluster
             example: 20
       resourceLimits:
         type: object