Commit ddfc5e62 authored by Tristan Williams's avatar Tristan Williams Committed by Amy Qualls

Docs: review add_remove_clusters

parent c21d8b6d
...@@ -28,7 +28,7 @@ Google Kubernetes Engine Integration. All you have to do is [follow this link](h ...@@ -28,7 +28,7 @@ Google Kubernetes Engine Integration. All you have to do is [follow this link](h
Before [adding a Kubernetes cluster](#create-new-cluster) using GitLab, you need: Before [adding a Kubernetes cluster](#create-new-cluster) using GitLab, you need:
- GitLab itself. Either: - GitLab itself. Either:
- A GitLab.com [account](https://about.gitlab.com/pricing/#gitlab-com). - A [GitLab.com account](https://about.gitlab.com/pricing/#gitlab-com).
- A [self-managed installation](https://about.gitlab.com/pricing/#self-managed) with GitLab version - A [self-managed installation](https://about.gitlab.com/pricing/#self-managed) with GitLab version
12.5 or later. This will ensure the GitLab UI can be used for cluster creation. 12.5 or later. This will ensure the GitLab UI can be used for cluster creation.
- The following GitLab access: - The following GitLab access:
...@@ -131,7 +131,7 @@ arbitrary images as they effectively have root access. ...@@ -131,7 +131,7 @@ arbitrary images as they effectively have root access.
If you don't want to use GitLab Runner in privileged mode, either: If you don't want to use GitLab Runner in privileged mode, either:
- Use shared Runners on GitLab.com. They don't have this security issue. - Use shared Runners on GitLab.com. They don't have this security issue.
- Set up your own Runners using configuration described at - Set up your own Runners using the configuration described at
[Shared Runners](../../gitlab_com/index.md#shared-runners). This involves: [Shared Runners](../../gitlab_com/index.md#shared-runners). This involves:
1. Making sure that you don't have it installed via 1. Making sure that you don't have it installed via
[the applications](index.md#installing-applications). [the applications](index.md#installing-applications).
...@@ -140,10 +140,18 @@ If you don't want to use GitLab Runner in privileged mode, either: ...@@ -140,10 +140,18 @@ If you don't want to use GitLab Runner in privileged mode, either:
## Create new cluster ## Create new cluster
New clusters can be created using GitLab for: New clusters can be created using GitLab on Google Kubernetes Engine (GKE) or
Amazon Elastic Kubernetes Service (EKS) at the project, group, or instance level:
- [Google Kubernetes Engine (GKE)](add_gke_clusters.md). 1. Navigate to your:
- [Amazon Elastic Kubernetes Service (EKS)](add_eks_clusters.md). - Project's **{cloud-gear}** **Operations > Kubernetes** page, for a project-level cluster.
- Group's **{cloud-gear}** **Kubernetes** page, for a group-level cluster.
- **{admin}** **Admin Area >** **{cloud-gear}** **Kubernetes** page, for an instance-level cluster.
1. Click **Add Kubernetes cluster**.
1. Click the **Create new cluster** tab.
1. Click either **Amazon EKS** or **Google GKE**, and follow the instructions for your desired service:
- [Amazon EKS](add_eks_clusters.md#new-eks-cluster).
- [Google GKE](add_gke_clusters.md#creating-the-cluster-on-gke).
## Add existing cluster ## Add existing cluster
...@@ -156,7 +164,7 @@ For more information, see information for adding an: ...@@ -156,7 +164,7 @@ For more information, see information for adding an:
NOTE: **Note:** NOTE: **Note:**
Kubernetes integration is not supported for arm64 clusters. See the issue Kubernetes integration is not supported for arm64 clusters. See the issue
[Helm Tiller fails to install on arm64 cluster](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/64044) for details. [Helm Tiller fails to install on arm64 cluster](https://gitlab.com/gitlab-org/gitlab/-/issues/29838) for details.
### Existing Kubernetes cluster ### Existing Kubernetes cluster
...@@ -302,12 +310,12 @@ to install some [pre-defined applications](index.md#installing-applications). ...@@ -302,12 +310,12 @@ to install some [pre-defined applications](index.md#installing-applications).
When connecting a cluster via GitLab integration, you may specify whether the When connecting a cluster via GitLab integration, you may specify whether the
cluster is RBAC-enabled or not. This will affect how GitLab interacts with the cluster is RBAC-enabled or not. This will affect how GitLab interacts with the
cluster for certain operations. If you **did not** check the "RBAC-enabled cluster" cluster for certain operations. If you did *not* check the **RBAC-enabled cluster**
checkbox at creation time, GitLab will assume RBAC is disabled for your cluster checkbox at creation time, GitLab will assume RBAC is disabled for your cluster
when interacting with it. If so, you must disable RBAC on your cluster for the when interacting with it. If so, you must disable RBAC on your cluster for the
integration to work properly. integration to work properly.
![rbac](img/rbac.png) ![rbac](img/rbac_v13_1.png)
NOTE: **Note**: Disabling RBAC means that any application running in the cluster, NOTE: **Note**: Disabling RBAC means that any application running in the cluster,
or user who can authenticate to the cluster, has full API access. This is a or user who can authenticate to the cluster, has full API access. This is a
...@@ -325,17 +333,20 @@ kubectl create clusterrolebinding permissive-binding \ ...@@ -325,17 +333,20 @@ kubectl create clusterrolebinding permissive-binding \
## Enabling or disabling integration ## Enabling or disabling integration
After you have successfully added your cluster information, you can enable the The Kubernetes cluster integration enables after you have successfully either created
Kubernetes cluster integration: a new cluster or added an existing one. To disable Kubernetes cluster integration:
1. Click the **Enabled/Disabled** switch 1. Navigate to your:
1. Hit **Save** for the changes to take effect - Project's **{cloud-gear}** **Operations > Kubernetes** page, for a project-level cluster.
- Group's **{cloud-gear}** **Kubernetes** page, for a group-level cluster.
To disable the Kubernetes cluster integration, follow the same procedure. - **{admin}** **Admin Area >** **{cloud-gear}** **Kubernetes** page, for an instance-level cluster.
1. Click on the name of the cluster.
1. Click the **GitLab Integration** toggle.
1. Click **Save changes**.
## Removing integration ## Removing integration
To remove the Kubernetes cluster integration from your project, either: To remove the Kubernetes cluster integration from your project, first navigate to the **Advanced Settings** tab of the cluster details page and either:
- Select **Remove integration**, to remove only the Kubernetes integration. - Select **Remove integration**, to remove only the Kubernetes integration.
- [From GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/issues/26815), select - [From GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/issues/26815), select
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment