Merge branch '276931-gitlab-api-doesn-t-expose-cluster-managed-state' into 'master'

Resolve "GitLab API doesn't expose Cluster Managed state"

See merge request gitlab-org/gitlab!47310

doc/api/instance_clusters.md

@@ -35,6 +35,8 @@ Example response:
     "id": 9,
     "name": "cluster-1",
     "created_at": "2020-07-14T18:36:10.440Z",
+    "managed": true,
+    "enabled": true,
     "domain": null,
     "provider_type": "user",
     "platform_type": "kubernetes",
@@ -98,9 +100,9 @@ Returns a single instance cluster.
 
 Parameters:
 
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `cluster_id` | integer | yes | The ID of the cluster |
+| Attribute    | Type    | Required | Description           |
+| ------------ | ------- | -------- | --------------------- |
+| `cluster_id` | integer | yes      | The ID of the cluster |
 
 ```plaintext
 GET /admin/clusters/:cluster_id
@@ -119,6 +121,8 @@ Example response:
   "id": 9,
   "name": "cluster-1",
   "created_at": "2020-07-14T18:36:10.440Z",
+  "managed": true,
+  "enabled": true,
   "domain": null,
   "provider_type": "user",
   "platform_type": "kubernetes",
@@ -153,19 +157,19 @@ POST /admin/clusters/add
 
 Parameters:
 
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `name` | string | yes | The name of the cluster |
-| `domain` | string | no | The [base domain](../user/project/clusters/index.md#base-domain) of the cluster |
-| `environment_scope` | string | no | The associated environment to the cluster. Defaults to `*` |
-| `management_project_id` | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the cluster |
-| `enabled` | boolean | no | Determines if cluster is active or not, defaults to true |
-| `managed` | boolean | no | Determines if GitLab will manage namespaces and service accounts for this cluster, defaults to true |
-| `platform_kubernetes_attributes[api_url]` | string | yes | The URL to access the Kubernetes API |
-| `platform_kubernetes_attributes[token]` | string | yes | The token to authenticate against Kubernetes |
-| `platform_kubernetes_attributes[ca_cert]` | string | no | TLS certificate. Required if API is using a self-signed TLS certificate. |
-| `platform_kubernetes_attributes[namespace]` | string | no | The unique namespace related to the project |
-| `platform_kubernetes_attributes[authorization_type]` | string | no | The cluster authorization type: `rbac`, `abac` or `unknown_authorization`. Defaults to `rbac`. |
+| Attribute                                            | Type    | Required | Description                                                                                           |
+| ---------------------------------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------- |
+| `name`                                               | string  | yes      | The name of the cluster                                                                               |
+| `domain`                                             | string  | no       | The [base domain](../user/project/clusters/index.md#base-domain) of the cluster                       |
+| `environment_scope`                                  | string  | no       | The associated environment to the cluster. Defaults to `*`                                            |
+| `management_project_id`                              | integer | no       | The ID of the [management project](../user/clusters/management_project.md) for the cluster            |
+| `enabled`                                            | boolean | no       | Determines if cluster is active or not, defaults to `true`                                            |
+| `managed`                                            | boolean | no       | Determines if GitLab will manage namespaces and service accounts for this cluster, defaults to `true` |
+| `platform_kubernetes_attributes[api_url]`            | string  | yes      | The URL to access the Kubernetes API                                                                  |
+| `platform_kubernetes_attributes[token]`              | string  | yes      | The token to authenticate against Kubernetes                                                          |
+| `platform_kubernetes_attributes[ca_cert]`            | string  | no       | TLS certificate. Required if API is using a self-signed TLS certificate.                              |
+| `platform_kubernetes_attributes[namespace]`          | string  | no       | The unique namespace related to the project                                                           |
+| `platform_kubernetes_attributes[authorization_type]` | string  | no       | The cluster authorization type: `rbac`, `abac` or `unknown_authorization`. Defaults to `rbac`.        |
 
 Example request:
 
@@ -184,6 +188,8 @@ Example response:
   "id": 11,
   "name": "cluster-3",
   "created_at": "2020-07-14T18:42:50.805Z",
+  "managed": true,
+  "enabled": true,
   "domain": null,
   "provider_type": "user",
   "platform_type": "kubernetes",
@@ -218,18 +224,19 @@ PUT /admin/clusters/:cluster_id
 
 Parameters:
 
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `cluster_id` | integer | yes | The ID of the cluster |
-| `name` | string | no | The name of the cluster |
-| `domain` | string | no | The [base domain](../user/project/clusters/index.md#base-domain) of the cluster |
-| `environment_scope` | string | no | The associated environment to the cluster |
-| `management_project_id` | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the cluster |
-| `enabled` | boolean | no | Determines if cluster is active or not, defaults to true |
-| `platform_kubernetes_attributes[api_url]` | string | no | The URL to access the Kubernetes API |
-| `platform_kubernetes_attributes[token]` | string | no | The token to authenticate against Kubernetes |
-| `platform_kubernetes_attributes[ca_cert]` | string | no | TLS certificate. Required if API is using a self-signed TLS certificate. |
-| `platform_kubernetes_attributes[namespace]` | string | no | The unique namespace related to the project |
+| Attribute                                   | Type    | Required | Description                                                                                |
+| ------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------ |
+| `cluster_id`                                | integer | yes      | The ID of the cluster                                                                      |
+| `name`                                      | string  | no       | The name of the cluster                                                                    |
+| `domain`                                    | string  | no       | The [base domain](../user/project/clusters/index.md#base-domain) of the cluster            |
+| `environment_scope`                         | string  | no       | The associated environment to the cluster                                                  |
+| `management_project_id`                     | integer | no       | The ID of the [management project](../user/clusters/management_project.md) for the cluster |
+| `enabled`                                   | boolean | no       | Determines if cluster is active or not                                                     |
+| `managed`                                   | boolean | no       | Determines if GitLab will manage namespaces and service accounts for this cluster          |
+| `platform_kubernetes_attributes[api_url]`   | string  | no       | The URL to access the Kubernetes API                                                       |
+| `platform_kubernetes_attributes[token]`     | string  | no       | The token to authenticate against Kubernetes                                               |
+| `platform_kubernetes_attributes[ca_cert]`   | string  | no       | TLS certificate. Required if API is using a self-signed TLS certificate.                   |
+| `platform_kubernetes_attributes[namespace]` | string  | no       | The unique namespace related to the project                                                |
 
 NOTE: **Note:**
 `name`, `api_url`, `ca_cert` and `token` can only be updated if the cluster was added
@@ -252,6 +259,8 @@ Example response:
   "id": 9,
   "name": "update-cluster-name",
   "created_at": "2020-07-14T18:36:10.440Z",
+  "managed": true,
+  "enabled": true,
   "domain": null,
   "provider_type": "user",
   "platform_type": "kubernetes",
@@ -288,9 +297,9 @@ DELETE /admin/clusters/:cluster_id
 
 Parameters:
 
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `cluster_id` | integer | yes | The ID of the cluster |
+| Attribute    | Type    | Required | Description           |
+| ------------ | ------- | -------- | --------------------- |
+| `cluster_id` | integer | yes      | The ID of the cluster |
 
 Example request:
 

lib/api/admin/instance_clusters.rb

@@ -76,6 +76,7 @@ module API
           optional :namespace_per_environment, default: true, type: Boolean, desc: 'Deploy each environment to a separate Kubernetes namespace'
           optional :domain, type: String, desc: 'Cluster base domain'
           optional :management_project_id, type: Integer, desc: 'The ID of the management project'
+          optional :managed, type: Boolean, desc: 'Determines if GitLab will manage namespaces and service accounts for this cluster'
           optional :platform_kubernetes_attributes, type: Hash, desc: %q(Platform Kubernetes data) do
             optional :api_url, type: String, desc: 'URL to access the Kubernetes API'
             optional :token, type: String, desc: 'Token to authenticate against Kubernetes'

lib/api/entities/cluster.rb

@@ -3,7 +3,7 @@
 module API
   module Entities
     class Cluster < Grape::Entity
-      expose :id, :name, :created_at, :domain
+      expose :id, :name, :created_at, :domain, :enabled, :managed
       expose :provider_type, :platform_type, :environment_scope, :cluster_type, :namespace_per_environment
       expose :user, using: Entities::UserBasic
       expose :platform_kubernetes, using: Entities::Platform::Kubernetes

lib/api/group_clusters.rb

@@ -75,10 +75,12 @@ module API
       params do
         requires :cluster_id, type: Integer, desc: 'The cluster ID'
         optional :name, type: String, desc: 'Cluster name'
+        optional :enabled, type: Boolean, desc: 'Determines if cluster is active or not'
         optional :domain, type: String, desc: 'Cluster base domain'
         optional :environment_scope, type: String, desc: 'The associated environment to the cluster'
         optional :namespace_per_environment, default: true, type: Boolean, desc: 'Deploy each environment to a separate Kubernetes namespace'
         optional :management_project_id, type: Integer, desc: 'The ID of the management project'
+        optional :managed, type: Boolean, desc: 'Determines if GitLab will manage namespaces and service accounts for this cluster'
         optional :platform_kubernetes_attributes, type: Hash, desc: %q(Platform Kubernetes data) do
           optional :api_url, type: String, desc: 'URL to access the Kubernetes API'
           optional :token, type: String, desc: 'Token to authenticate against Kubernetes'

lib/api/project_clusters.rb

@@ -83,6 +83,8 @@ module API
         optional :environment_scope, type: String, desc: 'The associated environment to the cluster'
         optional :namespace_per_environment, default: true, type: Boolean, desc: 'Deploy each environment to a separate Kubernetes namespace'
         optional :management_project_id, type: Integer, desc: 'The ID of the management project'
+        optional :enabled, type: Boolean, desc: 'Determines if cluster is active or not'
+        optional :managed, type: Boolean, desc: 'Determines if GitLab will manage namespaces and service accounts for this cluster'
         optional :platform_kubernetes_attributes, type: Hash, desc: %q(Platform Kubernetes data) do
           optional :api_url, type: String, desc: 'URL to access the Kubernetes API'
           optional :token, type: String, desc: 'Token to authenticate against Kubernetes'

spec/requests/api/admin/instance_clusters_spec.rb

@@ -90,6 +90,8 @@ RSpec.describe ::API::Admin::InstanceClusters do
           expect(json_response['environment_scope']).to eq('*')
           expect(json_response['cluster_type']).to eq('instance_type')
           expect(json_response['domain']).to eq('example.com')
+          expect(json_response['enabled']).to be_truthy
+          expect(json_response['managed']).to be_truthy
         end
 
         it 'returns kubernetes platform information' do
@@ -163,6 +165,7 @@ RSpec.describe ::API::Admin::InstanceClusters do
         name: 'test-instance-cluster',
         domain: 'domain.example.com',
         managed: false,
+        enabled: false,
         namespace_per_environment: false,
         platform_kubernetes_attributes: platform_kubernetes_attributes,
         clusterable: clusterable
@@ -205,9 +208,9 @@ RSpec.describe ::API::Admin::InstanceClusters do
           expect(cluster_result.name).to eq('test-instance-cluster')
           expect(cluster_result.domain).to eq('domain.example.com')
           expect(cluster_result.environment_scope).to eq('*')
-          expect(cluster_result.enabled).to eq(true)
-          expect(platform_kubernetes.authorization_type).to eq('rbac')
           expect(cluster_result.managed).to be_falsy
+          expect(cluster_result.enabled).to be_falsy
+          expect(platform_kubernetes.authorization_type).to eq('rbac')
           expect(cluster_result.namespace_per_environment).to eq(false)
           expect(platform_kubernetes.api_url).to eq("https://example.com")
           expect(platform_kubernetes.token).to eq('sample-token')
@@ -301,6 +304,8 @@ RSpec.describe ::API::Admin::InstanceClusters do
     let(:update_params) do
       {
         domain: domain,
+        managed: false,
+        enabled: false,
         platform_kubernetes_attributes: platform_kubernetes_attributes
       }
     end
@@ -326,6 +331,8 @@ RSpec.describe ::API::Admin::InstanceClusters do
 
         it 'updates cluster attributes' do
           expect(cluster.domain).to eq('new-domain.com')
+          expect(cluster.managed).to be_falsy
+          expect(cluster.enabled).to be_falsy
         end
       end
 
@@ -338,6 +345,8 @@ RSpec.describe ::API::Admin::InstanceClusters do
 
         it 'does not update cluster attributes' do
           expect(cluster.domain).to eq('old-domain.com')
+          expect(cluster.managed).to be_truthy
+          expect(cluster.enabled).to be_truthy
         end
 
         it 'returns validation errors' do

spec/requests/api/group_clusters_spec.rb

@@ -89,6 +89,8 @@ RSpec.describe API::GroupClusters do
         expect(json_response['environment_scope']).to eq('*')
         expect(json_response['cluster_type']).to eq('group_type')
         expect(json_response['domain']).to eq('example.com')
+        expect(json_response['enabled']).to be_truthy
+        expect(json_response['managed']).to be_truthy
       end
 
       it 'returns group information' do
@@ -172,6 +174,7 @@ RSpec.describe API::GroupClusters do
         name: 'test-cluster',
         domain: 'domain.example.com',
         managed: false,
+        enabled: false,
         namespace_per_environment: false,
         platform_kubernetes_attributes: platform_kubernetes_attributes,
         management_project_id: management_project_id
@@ -206,6 +209,7 @@ RSpec.describe API::GroupClusters do
           expect(cluster_result.name).to eq('test-cluster')
           expect(cluster_result.domain).to eq('domain.example.com')
           expect(cluster_result.managed).to be_falsy
+          expect(cluster_result.enabled).to be_falsy
           expect(cluster_result.management_project_id).to eq management_project_id
           expect(cluster_result.namespace_per_environment).to eq(false)
           expect(platform_kubernetes.rbac?).to be_truthy
@@ -342,7 +346,9 @@ RSpec.describe API::GroupClusters do
       {
         domain: domain,
         platform_kubernetes_attributes: platform_kubernetes_attributes,
-        management_project_id: management_project_id
+        management_project_id: management_project_id,
+        managed: false,
+        enabled: false
       }
     end
 
@@ -381,6 +387,8 @@ RSpec.describe API::GroupClusters do
         it 'updates cluster attributes' do
           expect(cluster.domain).to eq('new-domain.com')
           expect(cluster.management_project).to eq(management_project)
+          expect(cluster.managed).to be_falsy
+          expect(cluster.enabled).to be_falsy
         end
       end
 
@@ -394,6 +402,8 @@ RSpec.describe API::GroupClusters do
         it 'does not update cluster attributes' do
           expect(cluster.domain).to eq('old-domain.com')
           expect(cluster.management_project).to be_nil
+          expect(cluster.managed).to be_truthy
+          expect(cluster.enabled).to be_truthy
         end
 
         it 'returns validation errors' do

spec/requests/api/project_clusters_spec.rb

@@ -88,6 +88,8 @@ RSpec.describe API::ProjectClusters do
         expect(json_response['environment_scope']).to eq('*')
         expect(json_response['cluster_type']).to eq('project_type')
         expect(json_response['domain']).to eq('example.com')
+        expect(json_response['enabled']).to be_truthy
+        expect(json_response['managed']).to be_truthy
       end
 
       it 'returns project information' do
@@ -171,6 +173,7 @@ RSpec.describe API::ProjectClusters do
         name: 'test-cluster',
         domain: 'domain.example.com',
         managed: false,
+        enabled: false,
         namespace_per_environment: false,
         platform_kubernetes_attributes: platform_kubernetes_attributes,
         management_project_id: management_project_id
@@ -202,6 +205,7 @@ RSpec.describe API::ProjectClusters do
           expect(cluster_result.name).to eq('test-cluster')
           expect(cluster_result.domain).to eq('domain.example.com')
           expect(cluster_result.managed).to be_falsy
+          expect(cluster_result.enabled).to be_falsy
           expect(cluster_result.management_project_id).to eq management_project_id
           expect(cluster_result.namespace_per_environment).to eq(false)
           expect(platform_kubernetes.rbac?).to be_truthy
@@ -337,7 +341,9 @@ RSpec.describe API::ProjectClusters do
       {
         domain: 'new-domain.com',
         platform_kubernetes_attributes: platform_kubernetes_attributes,
-        management_project_id: management_project_id
+        management_project_id: management_project_id,
+        managed: false,
+        enabled: false
       }
     end
 
@@ -373,6 +379,8 @@ RSpec.describe API::ProjectClusters do
         it 'updates cluster attributes' do
           expect(response).to have_gitlab_http_status(:ok)
           expect(cluster.domain).to eq('new-domain.com')
+          expect(cluster.managed).to be_falsy
+          expect(cluster.enabled).to be_falsy
           expect(cluster.platform_kubernetes.namespace).to eq('new-namespace')
           expect(cluster.management_project).to eq(management_project)
         end
@@ -384,6 +392,8 @@ RSpec.describe API::ProjectClusters do
         it 'does not update cluster attributes' do
           expect(response).to have_gitlab_http_status(:bad_request)
           expect(cluster.domain).not_to eq('new_domain.com')
+          expect(cluster.managed).to be_truthy
+          expect(cluster.enabled).to be_truthy
           expect(cluster.platform_kubernetes.namespace).not_to eq('invalid_namespace')
           expect(cluster.management_project).not_to eq(management_project)
         end