CON-12531 Add DOKS multi-registries documentation

specification/DigitalOcean-public.v2.yaml

@@ -1344,6 +1344,13 @@ paths:
     delete:
       $ref: "resources/kubernetes/kubernetes_remove_registry.yml"
 
+  /v2/kubernetes/registries:
+    post:
+      $ref: "resources/kubernetes/kubernetes_add_registries.yml"
+
+    delete:
+      $ref: "resources/kubernetes/kubernetes_remove_registries.yml"
+
   /v2/kubernetes/clusters/{cluster_id}/status_messages:
     get:
       $ref: "resources/kubernetes/kubernetes_get_status_messages.yml"

specification/resources/kubernetes/examples/curl/kubernetes_add_registries.yml

@@ -0,0 +1,7 @@
+lang: cURL
+source: |-
+  curl -X POST \
+    -H "Content-Type: application/json" \
+    -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+    -d '{"cluster_uuids": ["bd5f5959-5e1e-4205-a714-a914373942af", "50c2f44c-011d-493e-aee5-361a4a0d1844"], "registries": ["registry-a", "registry-b"]}' \
+    "https://api.digitalocean.com/v2/kubernetes/registries"

specification/resources/kubernetes/examples/curl/kubernetes_remove_registries.yml

@@ -0,0 +1,7 @@
+lang: cURL
+source: |-
+  curl -X DELETE \
+    -H "Content-Type: application/json" \
+    -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+    -d '{"cluster_uuids": ["bd5f5959-5e1e-4205-a714-a914373942af", "50c2f44c-011d-493e-aee5-361a4a0d1844"], "registries": ["registry-a", "registry-b"]}' \
+    "https://api.digitalocean.com/v2/kubernetes/registries"

specification/resources/kubernetes/kubernetes_add_registries.yml

@@ -0,0 +1,39 @@
+operationId: kubernetes_add_registries
+
+summary: Add Container Registries to Kubernetes Clusters
+
+description: To integrate the container registries with Kubernetes clusters, send
+  a POST request to `/v2/kubernetes/registries`.
+
+tags:
+  - Kubernetes
+
+requestBody:
+  content:
+    application/json:
+      schema:
+        $ref: 'models/cluster_registries.yml'
+
+responses:
+  '204':
+    $ref: '../../shared/responses/no_content.yml'
+
+  '401':
+    $ref: '../../shared/responses/unauthorized.yml'
+
+  '429':
+    $ref: '../../shared/responses/too_many_requests.yml'
+
+  '500':
+    $ref: '../../shared/responses/server_error.yml'
+
+  default:
+    $ref: '../../shared/responses/unexpected_error.yml'
+
+x-codeSamples:
+  - $ref: 'examples/curl/kubernetes_add_registries.yml'
+
+security:
+  - bearer_auth:
+    - 'kubernetes:create'
+    - 'kubernetes:update'

specification/resources/kubernetes/kubernetes_add_registry.yml

@@ -12,7 +12,7 @@ requestBody:
   content:
     application/json:
       schema:
-        $ref: 'models/cluster_registries.yml'
+        $ref: 'models/cluster_registry.yml'
 
 responses:
   '204':

specification/resources/kubernetes/kubernetes_remove_registries.yml

@@ -0,0 +1,38 @@
+operationId: kubernetes_remove_registries
+
+summary: Remove Container Registries from Kubernetes Clusters
+
+description: To remove the container registries from Kubernetes clusters, send a
+  DELETE request to `/v2/kubernetes/registries`.
+
+tags:
+  - Kubernetes
+
+requestBody:
+  content:
+    application/json:
+      schema:
+        $ref: 'models/cluster_registries.yml'
+
+responses:
+  '204':
+    $ref: '../../shared/responses/no_content.yml'
+
+  '401':
+    $ref: '../../shared/responses/unauthorized.yml'
+
+  '429':
+    $ref: '../../shared/responses/too_many_requests.yml'
+
+  '500':
+    $ref: '../../shared/responses/server_error.yml'
+
+  default:
+    $ref: '../../shared/responses/unexpected_error.yml'
+
+x-codeSamples:
+  - $ref: 'examples/curl/kubernetes_remove_registries.yml'
+
+security:
+  - bearer_auth:
+    - 'kubernetes:update'

specification/resources/kubernetes/kubernetes_remove_registry.yml

@@ -12,7 +12,7 @@ requestBody:
   content:
     application/json:
       schema:
-        $ref: 'models/cluster_registries.yml'
+        $ref: 'models/cluster_registry.yml'
 
 responses:
   '204':

specification/resources/kubernetes/models/cluster_read.yml

@@ -156,6 +156,16 @@ properties:
     description: A read-only boolean value indicating if a container registry is
       integrated with the cluster.
 
+  registries:
+    type: array
+    nullable: true
+    items:
+      type: string
+    example:
+      - registry-a
+      - registry-b
+    description: An array of integrated DOCR registries.
+
   control_plane_firewall:
     $ref: "control_plane_firewall.yml"
 

specification/resources/kubernetes/models/cluster_registries.yml

@@ -9,3 +9,11 @@ properties:
     - bd5f5959-5e1e-4205-a714-a914373942af
     - 50c2f44c-011d-493e-aee5-361a4a0d1844
     description: An array containing the UUIDs of Kubernetes clusters.
+  registries:
+    type: array
+    items:
+      type: string
+    example:
+      - registry-a
+      - registry-b
+    description: An array containing the registry names.

specification/resources/kubernetes/models/cluster_registry.yml

@@ -0,0 +1,11 @@
+type: object
+
+properties:
+  cluster_uuids:
+    type: array
+    items:
+      type: string
+    example:
+    - bd5f5959-5e1e-4205-a714-a914373942af
+    - 50c2f44c-011d-493e-aee5-361a4a0d1844
+    description: An array containing the UUIDs of Kubernetes clusters.

specification/resources/kubernetes/responses/examples.yml

@@ -97,6 +97,9 @@ kubernetes_clusters_all:
       updated_at: '2018-11-15T16:00:11Z'
       surge_upgrade: false
       registry_enabled: false
+      registries:
+        - registry-a
+        - registry-b
       ha: false
       control_plane_firewall:
         enabled: true
@@ -218,6 +221,9 @@ kubernetes_single:
       updated_at: '2018-11-15T16:00:11Z'
       surge_upgrade: false
       registry_enabled: false
+      registries:
+        - registry-a
+        - registry-b
       ha: false
       control_plane_firewall:
         enabled: true
@@ -337,6 +343,9 @@ kubernetes_updated:
       updated_at: '2018-11-15T16:00:11Z'
       surge_upgrade: true
       registry_enabled: false
+      registries:
+        - registry-a
+        - registry-b
       ha: false
       control_plane_firewall:
         enabled: true
@@ -421,6 +430,9 @@ kubernetes_clusters_create_basic_response:
       updated_at: '2018-11-15T16:00:11Z'
       surge_upgrade: false
       registry_enabled: false
+      registries:
+        - registry-a
+        - registry-b
       ha: false
       control_plane_firewall:
         enabled: true
@@ -542,6 +554,9 @@ kubernetes_clusters_multi_pool_response:
       updated_at: '2018-11-15T16:00:11Z'
       surge_upgrade: false
       registry_enabled: false
+      registries:
+        - registry-a
+        - registry-b
       ha: false
       control_plane_firewall:
         enabled: true