diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-24 12:06:03 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-24 12:06:03 +0000 |
commit | 33813f993b49da58426d33a148ee70952e6835bb (patch) | |
tree | a8310742d6eb7e1dc83f72ceba1fefb3d5b8a030 /doc | |
parent | dc0622dbe3cd552abca4107557c6c09edb23625c (diff) | |
download | gitlab-ce-33813f993b49da58426d33a148ee70952e6835bb.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/group_clusters.md | 32 | ||||
-rw-r--r-- | doc/api/project_clusters.md | 32 | ||||
-rw-r--r-- | doc/user/clusters/management_project.md | 14 |
3 files changed, 75 insertions, 3 deletions
diff --git a/doc/api/group_clusters.md b/doc/api/group_clusters.md index e878bb5fa4d..6eb2cef4097 100644 --- a/doc/api/group_clusters.md +++ b/doc/api/group_clusters.md @@ -53,6 +53,16 @@ Example response: "api_url":"https://104.197.68.152", "authorization_type":"rbac", "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----" + }, + "management_project": + { + "id":2, + "description":null, + "name":"project2", + "name_with_namespace":"John Doe8 / project2", + "path":"project2", + "path_with_namespace":"namespace2/project2", + "created_at":"2019-10-11T02:55:54.138Z" } }, { @@ -111,6 +121,16 @@ Example response: "authorization_type":"rbac", "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----" }, + "management_project": + { + "id":2, + "description":null, + "name":"project2", + "name_with_namespace":"John Doe8 / project2", + "path":"project2", + "path_with_namespace":"namespace2/project2", + "created_at":"2019-10-11T02:55:54.138Z" + }, "group": { "id":26, @@ -135,6 +155,7 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) | | `name` | String | yes | The name of the cluster | | `domain` | String | no | The [base domain](../user/group/clusters/index.md#base-domain) of 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 | | `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 | @@ -178,6 +199,7 @@ Example response: "authorization_type":"rbac", "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----" }, + "management_project":null, "group": { "id":26, @@ -248,6 +270,16 @@ Example response: "authorization_type":"rbac", "ca_cert":null }, + "management_project": + { + "id":2, + "description":null, + "name":"project2", + "name_with_namespace":"John Doe8 / project2", + "path":"project2", + "path_with_namespace":"namespace2/project2", + "created_at":"2019-10-11T02:55:54.138Z" + }, "group": { "id":26, diff --git a/doc/api/project_clusters.md b/doc/api/project_clusters.md index 633ef20deb4..e733cd7ea7b 100644 --- a/doc/api/project_clusters.md +++ b/doc/api/project_clusters.md @@ -54,6 +54,16 @@ Example response: "namespace":"cluster-1-namespace", "authorization_type":"rbac", "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----" + }, + "management_project": + { + "id":2, + "description":null, + "name":"project2", + "name_with_namespace":"John Doe8 / project2", + "path":"project2", + "path_with_namespace":"namespace2/project2", + "created_at":"2019-10-11T02:55:54.138Z" } }, { @@ -113,6 +123,16 @@ Example response: "authorization_type":"rbac", "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----" }, + "management_project": + { + "id":2, + "description":null, + "name":"project2", + "name_with_namespace":"John Doe8 / project2", + "path":"project2", + "path_with_namespace":"namespace2/project2", + "created_at":"2019-10-11T02:55:54.138Z" + }, "project": { "id":26, @@ -205,6 +225,7 @@ Example response: "authorization_type":"rbac", "ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----" }, + "management_project":null, "project": { "id":26, @@ -253,6 +274,7 @@ Parameters: | `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 | +| `management_project_id` | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the 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 (needed if API is using a self-signed TLS certificate | @@ -300,6 +322,16 @@ Example response: "authorization_type":"rbac", "ca_cert":null }, + "management_project": + { + "id":2, + "description":null, + "name":"project2", + "name_with_namespace":"John Doe8 / project2", + "path":"project2", + "path_with_namespace":"namespace2/project2", + "created_at":"2019-10-11T02:55:54.138Z" + }, "project": { "id":26, diff --git a/doc/user/clusters/management_project.md b/doc/user/clusters/management_project.md index 37308ad7175..2c3c6850ea5 100644 --- a/doc/user/clusters/management_project.md +++ b/doc/user/clusters/management_project.md @@ -4,7 +4,7 @@ CAUTION: **Warning:** This is an _alpha_ feature, and it is subject to change at any time without prior notice. -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/17866) in GitLab 12.4 +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/32810) in GitLab 12.5 A project can be designated as the management project for a cluster. A management project can be used to run deployment jobs with @@ -22,6 +22,14 @@ This can be useful for: Only the management project will receive `cluster-admin` privileges. All other projects will continue to receive [namespace scoped `edit` level privileges](../project/clusters/index.md#rbac-cluster-resources). +Management projects are restricted to the following: + +- For project-level clusters, the management project must in the same + namespace (or descendants) as the cluster's project. +- For group-level clusters, the management project must in the same + group (or descendants) as as the cluster's group. +- For instance-level clusters, there are no such restrictions. + ## Usage ### Selecting a cluster management project @@ -87,9 +95,9 @@ configure production cluster: name: production ``` -## Disabling this feature +## Enabling this feature -This feature is enabled by default. To disable this feature, disable the +This feature is disabled by default. To enable this feature, enable the feature flag `:cluster_management_project`. To check if the feature flag is enabled on your GitLab instance, |