summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThong Kuah <tkuah@gitlab.com>2018-09-09 11:08:13 +1200
committerThong Kuah <tkuah@gitlab.com>2018-09-14 16:26:51 +1200
commite4243bb15b966a85243e091c798e11cb26be45f8 (patch)
tree3f54c63d549eea2551062f82ec504182b8e2a8a3
parent292d2208e093658bbbd95a0d36c7e40b62cc271c (diff)
downloadgitlab-ce-e4243bb15b966a85243e091c798e11cb26be45f8.tar.gz
Document `gitlab` service account creation. Re-word to make documentation flow in both cluster addtion and creation scenarios
Add table of resources created for ease of scannning
-rw-r--r--doc/user/project/clusters/index.md34
1 files changed, 26 insertions, 8 deletions
diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md
index b5ff2e5b335..b651465f0aa 100644
--- a/doc/user/project/clusters/index.md
+++ b/doc/user/project/clusters/index.md
@@ -163,21 +163,39 @@ To enable the feature flag:
Feature.enable('rbac_clusters')
```
+If you are creating a [new GKE cluster via
+GitLab](#adding-and-creating-a-new-gke-cluster-via-gitlab), you will be
+asked if you would like to create a RBAC-enabled cluster. Enabling this
+setting will create a `gitlab` service account which will be used by
+GitLab to manage the newly created cluster. To enable this, this service
+account will have the `cluster-admin` privilege.
+
If you are [adding an existing Kubernetes
cluster](#adding-an-existing-kubernetes-cluster), you will be asked if
-the cluster you are adding is an RBAC-enabled cluster. Enabling this
-setting will create a `tiller` service account in the
-`gitlab-managed-apps` namespace when you install Helm Tiller into your cluster.
+the cluster you are adding is a RBAC-enabled cluster. Please ensure the
+token of the account has administrator privileges for the cluster.
+
+A RBAC-enabled cluster in both cases
+will create a `tiller` service account, with `cluster-admin`
+privilege, in the `gitlab-managed-apps` namespace when you install Helm Tiller into your cluster.
This service account will be added to the installed Helm Tiller
and will be used by Helm to install and run [GitLab managed
applications](#installing-applications).
-The `tiller` service account will have cluster-wide access (`cluster-admin` clusterrole).
+The table below summarizes which resources will be created in a
+RBAC-enabled cluster :
-If you are creating a [new GKE cluster via
-GitLab](#adding-and-creating-a-new-gke-cluster-via-gitlab), GitLab will
-automatically create an RBAC-enabled cluster. A `tiller` service account
-will be created as well and added to Helm Tiller.
+| Name | Kind | Details | Created when |
+| --- | --- | --- | --- |
+| `gitlab` | `ServiceAccount` | `default` namespace | Creating a new GKE Cluster |
+| `gitlab-admin` | `ClusterRoleBinding` | `cluster-admin` roleRef | Creating a new GKE Cluster |
+| `tiller` | `ServiceAccount` | `gitlab-managed-apps` namespace | Installing Helm Tiller |
+| `tiller-admin` | `ClusterRoleBinding` | `cluster-admin` roleRef | Installing Helm Tiller |
+
+
+Helm Tiller will also create additional service accounts and other RBAC
+resources for each installed application. Please consult the
+documentation for the Helm charts for each application for details.
NOTE: **Note:**
Auto DevOps will not successfully complete in a cluster that only has RBAC