Commit d2e8002c authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'eread/refine-add-cluster-pages' into 'master'

Refine cluster topics

See merge request gitlab-org/gitlab!28393
parents ac577f01 87dcbeed
...@@ -36,7 +36,8 @@ Access the default page for admin area settings by navigating to ...@@ -36,7 +36,8 @@ Access the default page for admin area settings by navigating to
| [Slack application](../../../user/project/integrations/gitlab_slack_application.md#configuration) **(FREE ONLY)** | Slack integration allows you to interact with GitLab via slash commands in a chat window. This option is only available on GitLab.com, though it may be [available for self-managed instances in the future](https://gitlab.com/gitlab-org/gitlab/-/issues/28164). | | [Slack application](../../../user/project/integrations/gitlab_slack_application.md#configuration) **(FREE ONLY)** | Slack integration allows you to interact with GitLab via slash commands in a chat window. This option is only available on GitLab.com, though it may be [available for self-managed instances in the future](https://gitlab.com/gitlab-org/gitlab/-/issues/28164). |
| [Third party offers](third_party_offers.md) | Control the display of third party offers. | | [Third party offers](third_party_offers.md) | Control the display of third party offers. |
| [Snowplow](../../../telemetry/index.md#enabling-tracking) | Configure the Snowplow integration. | | [Snowplow](../../../telemetry/index.md#enabling-tracking) | Configure the Snowplow integration. |
| [Amazon EKS](../../project/clusters/add_new_eks_cluster.md#additional-requirements-for-self-managed-instances-core-only) | Amazon EKS integration allows you to provision EKS clusters from GitLab. | | [Google GKE](../../project/clusters/add_gke_clusters.md) | Google GKE integration allows you to provision GKE clusters from GitLab. |
| [Amazon EKS](../../project/clusters/add_eks_clusters.md) | Amazon EKS integration allows you to provision EKS clusters from GitLab. |
## Repository ## Repository
...@@ -45,7 +46,7 @@ Access the default page for admin area settings by navigating to ...@@ -45,7 +46,7 @@ Access the default page for admin area settings by navigating to
| [Repository mirror](visibility_and_access_controls.md#allow-mirrors-to-be-set-up-for-projects) | Configure repository mirroring. | | [Repository mirror](visibility_and_access_controls.md#allow-mirrors-to-be-set-up-for-projects) | Configure repository mirroring. |
| [Repository storage](../../../administration/repository_storage_types.md#how-to-migrate-to-hashed-storage) | Configure storage path settings. | | [Repository storage](../../../administration/repository_storage_types.md#how-to-migrate-to-hashed-storage) | Configure storage path settings. |
| Repository maintenance | ([Repository checks](../../../administration/repository_checks.md) and [Housekeeping](../../../administration/housekeeping.md)). Configure automatic Git checks and housekeeping on repositories. | | Repository maintenance | ([Repository checks](../../../administration/repository_checks.md) and [Housekeeping](../../../administration/housekeeping.md)). Configure automatic Git checks and housekeeping on repositories. |
| [Repository static objects](../../../administration/static_objects_external_storage.md) | Serve repository static objects (e.g. archives, blobs, ...) from an external storage (e.g. a CDN). | | [Repository static objects](../../../administration/static_objects_external_storage.md) | Serve repository static objects (for example, archives, blobs, ...) from an external storage (for example, a CDN). |
## Templates **(PREMIUM ONLY)** ## Templates **(PREMIUM ONLY)**
......
# Adding a new EKS Cluster # Adding EKS clusters
GitLab supports adding new and existing EKS clusters.
## EKS requirements ## EKS requirements
...@@ -7,7 +9,7 @@ requirements are met: ...@@ -7,7 +9,7 @@ requirements are met:
- An [Amazon Web Services](https://aws.amazon.com/) account is set up and you are able to log in. - An [Amazon Web Services](https://aws.amazon.com/) account is set up and you are able to log in.
- You have permissions to manage IAM resources. - You have permissions to manage IAM resources.
- If you want to use an [existing EKS cluster](add_new_eks_cluster.md#existing-eks-cluster): - If you want to use an [existing EKS cluster](#existing-eks-cluster):
- An Amazon EKS cluster with worker nodes properly configured. - An Amazon EKS cluster with worker nodes properly configured.
- `kubectl` [installed and configured](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html#get-started-kubectl) - `kubectl` [installed and configured](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html#get-started-kubectl)
for access to the EKS cluster. for access to the EKS cluster.
...@@ -48,9 +50,9 @@ Generate an access key for the IAM user, and configure GitLab with the credentia ...@@ -48,9 +50,9 @@ Generate an access key for the IAM user, and configure GitLab with the credentia
To create and add a new Kubernetes cluster to your project, group, or instance: To create and add a new Kubernetes cluster to your project, group, or instance:
1. Navigate to your: 1. Navigate to your:
- Project's **Operations > Kubernetes** page, for a project-level cluster. - Project's **{cloud-gear}** **Operations > Kubernetes** page, for a project-level cluster.
- Group's **Kubernetes** page, for a group-level cluster. - Group's **{cloud-gear}** **Kubernetes** page, for a group-level cluster.
- **Admin Area > Kubernetes** page, for an instance-level cluster. - **{admin}** **Admin Area >** **{cloud-gear}** **Kubernetes**, for an instance-level cluster.
1. Click **Add Kubernetes cluster**. 1. Click **Add Kubernetes cluster**.
1. Under the **Create new cluster** tab, click **Amazon EKS**. You will be provided with an 1. Under the **Create new cluster** tab, click **Amazon EKS**. You will be provided with an
`Account ID` and `External ID` to use in the next step. `Account ID` and `External ID` to use in the next step.
...@@ -246,9 +248,9 @@ To add an existing EKS cluster to your project, group, or instance: ...@@ -246,9 +248,9 @@ To add an existing EKS cluster to your project, group, or instance:
1. Locate the the API server endpoint so GitLab can connect to the cluster. This is displayed on 1. Locate the the API server endpoint so GitLab can connect to the cluster. This is displayed on
the AWS EKS console, when viewing the EKS cluster details. the AWS EKS console, when viewing the EKS cluster details.
1. Navigate to your: 1. Navigate to your:
- Project's **Operations > Kubernetes** page, for a project-level cluster. - Project's **{cloud-gear}** **Operations > Kubernetes** page, for a project-level cluster.
- Group's **Kubernetes** page, for a group-level cluster. - Group's **{cloud-gear}** **Kubernetes** page, for a group-level cluster.
- **Admin Area > Kubernetes** page, for an instance-level cluster. - **{admin}** **Admin Area >** **{cloud-gear}** **Kubernetes** page, for an instance-level cluster.
1. Click **Add Kubernetes cluster**. 1. Click **Add Kubernetes cluster**.
1. Click the **Add existing cluster** tab and fill in the details: 1. Click the **Add existing cluster** tab and fill in the details:
- **Kubernetes cluster name**: A name for the cluster to identify it within GitLab. - **Kubernetes cluster name**: A name for the cluster to identify it within GitLab.
......
# Adding a new GKE Cluster # Adding GKE clusters
GitLab supports adding new and existing GKE clusters.
## GKE requirements ## GKE requirements
...@@ -39,9 +41,9 @@ Note the following: ...@@ -39,9 +41,9 @@ Note the following:
To create and add a new Kubernetes cluster to your project, group, or instance: To create and add a new Kubernetes cluster to your project, group, or instance:
1. Navigate to your: 1. Navigate to your:
- Project's **Operations > Kubernetes** page, for a project-level cluster. - Project's **{cloud-gear}** **Operations > Kubernetes** page, for a project-level cluster.
- Group's **Kubernetes** page, for a group-level cluster. - Group's **{cloud-gear}** **Kubernetes** page, for a group-level cluster.
- **Admin Area > Kubernetes** page, for an instance-level cluster. - **{admin}** **Admin Area >** **{cloud-gear}** **Kubernetes** page, for an instance-level cluster.
1. Click **Add Kubernetes cluster**. 1. Click **Add Kubernetes cluster**.
1. Under the **Create new cluster** tab, click **Google GKE**. 1. Under the **Create new cluster** tab, click **Google GKE**.
1. Connect your Google account if you haven't done already by clicking the 1. Connect your Google account if you haven't done already by clicking the
...@@ -74,3 +76,8 @@ You can choose to use Cloud Run for Anthos in place of installing Knative and Is ...@@ -74,3 +76,8 @@ You can choose to use Cloud Run for Anthos in place of installing Knative and Is
separately after the cluster has been created. This means that Cloud Run separately after the cluster has been created. This means that Cloud Run
(Knative), Istio, and HTTP Load Balancing will be enabled on the cluster at (Knative), Istio, and HTTP Load Balancing will be enabled on the cluster at
create time and cannot be [installed or uninstalled](../../clusters/applications.md) separately. create time and cannot be [installed or uninstalled](../../clusters/applications.md) separately.
## Existing GKE cluster
For information on adding an existing GKE cluster, see
[Existing Kubernetes cluster](add_remove_clusters.md#existing-kubernetes-cluster).
...@@ -28,13 +28,6 @@ Before [adding a Kubernetes cluster](#add-new-cluster) using GitLab, you need: ...@@ -28,13 +28,6 @@ Before [adding a Kubernetes cluster](#add-new-cluster) using GitLab, you need:
- [Admin Area access](../../admin_area/index.md) for a self-managed instance-level - [Admin Area access](../../admin_area/index.md) for a self-managed instance-level
cluster. **(CORE ONLY)** cluster. **(CORE ONLY)**
## Add new cluster
New clusters can be added using GitLab for:
- [Google Kubernetes Engine (GKE)](add_new_gke_cluster.md).
- [Amazon Elastic Kubernetes Service (EKS)](add_new_eks_cluster.md).
## Access controls ## Access controls
When creating a cluster in GitLab, you will be asked if you would like to create either: When creating a cluster in GitLab, you will be asked if you would like to create either:
...@@ -134,14 +127,21 @@ If you don't want to use GitLab Runner in privileged mode, either: ...@@ -134,14 +127,21 @@ If you don't want to use GitLab Runner in privileged mode, either:
1. Installing a Runner 1. Installing a Runner
[using `docker+machine`](https://docs.gitlab.com/runner/executors/docker_machine.html). [using `docker+machine`](https://docs.gitlab.com/runner/executors/docker_machine.html).
## Add new cluster
New clusters can be added using GitLab for:
- [Google Kubernetes Engine (GKE)](add_gke_clusters.md).
- [Amazon Elastic Kubernetes Service (EKS)](add_eks_clusters.md).
## Add existing cluster ## Add existing cluster
If you have an existing Kubernetes cluster, you can add it to a project, group, or instance. If you have an existing Kubernetes cluster, you can add it to a project, group, or instance.
For more information, see information for adding an: For more information, see information for adding an:
- [Existing Kubernetes cluster](#existing-kubernetes-cluster). - [Existing Kubernetes cluster](#existing-kubernetes-cluster), including GKE clusters.
- [Existing Elastic Kubernetes Service cluster](add_new_eks_cluster.md#existing-eks-cluster). - [Existing EKS cluster](add_eks_clusters.md#existing-eks-cluster).
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
...@@ -152,9 +152,9 @@ Kubernetes integration is not supported for arm64 clusters. See the issue ...@@ -152,9 +152,9 @@ Kubernetes integration is not supported for arm64 clusters. See the issue
To add a Kubernetes cluster to your project, group, or instance: To add a Kubernetes cluster to your project, group, or instance:
1. Navigate to your: 1. Navigate to your:
- Project's **Operations > Kubernetes** page, for a project-level cluster. - Project's **{cloud-gear}** **Operations > Kubernetes** page, for a project-level cluster.
- Group's **Kubernetes** page, for a group-level cluster. - Group's **{cloud-gear}** **Kubernetes** page, for a group-level cluster.
- **Admin Area > Kubernetes** page, for an instance-level cluster. - **{admin}** **Admin Area >** **{cloud-gear}** **Kubernetes** page, for an instance-level cluster.
1. Click **Add Kubernetes cluster**. 1. Click **Add Kubernetes cluster**.
1. Click the **Add existing cluster** tab and fill in the details: 1. Click the **Add existing cluster** tab and fill in the details:
- **Kubernetes cluster name** (required) - The name you wish to give the cluster. - **Kubernetes cluster name** (required) - The name you wish to give the cluster.
...@@ -162,8 +162,8 @@ To add a Kubernetes cluster to your project, group, or instance: ...@@ -162,8 +162,8 @@ To add a Kubernetes cluster to your project, group, or instance:
[associated environment](index.md#setting-the-environment-scope-premium) to this cluster. [associated environment](index.md#setting-the-environment-scope-premium) to this cluster.
- **API URL** (required) - - **API URL** (required) -
It's the URL that GitLab uses to access the Kubernetes API. Kubernetes It's the URL that GitLab uses to access the Kubernetes API. Kubernetes
exposes several APIs, we want the "base" URL that is common to all of them, exposes several APIs, we want the "base" URL that is common to all of them.
e.g., `https://kubernetes.example.com` rather than `https://kubernetes.example.com/api/v1`. For example, `https://kubernetes.example.com` rather than `https://kubernetes.example.com/api/v1`.
Get the API URL by running this command: Get the API URL by running this command:
......
--- ---
redirect_to: '../add_new_eks_cluster.md#existing-eks-cluster' redirect_to: '../add_eks_clusters.md#existing-eks-cluster'
--- ---
This document was moved to [another location](../add_new_eks_cluster.md#existing-eks-cluster). This document was moved to [another location](../add_eks_clusters.md#existing-eks-cluster).
...@@ -238,7 +238,7 @@ The result will then be: ...@@ -238,7 +238,7 @@ The result will then be:
With GitLab Premium, you can associate more than one Kubernetes cluster to your With GitLab Premium, you can associate more than one Kubernetes cluster to your
project. That way you can have different clusters for different environments, project. That way you can have different clusters for different environments,
like dev, staging, production, etc. like dev, staging, production, and so on.
Simply add another cluster, like you did the first time, and make sure to Simply add another cluster, like you did the first time, and make sure to
[set an environment scope](#setting-the-environment-scope-premium) that will [set an environment scope](#setting-the-environment-scope-premium) that will
...@@ -247,7 +247,7 @@ differentiate the new cluster with the rest. ...@@ -247,7 +247,7 @@ differentiate the new cluster with the rest.
## Installing applications ## Installing applications
GitLab can install and manage some applications like Helm, GitLab Runner, Ingress, GitLab can install and manage some applications like Helm, GitLab Runner, Ingress,
Prometheus, etc., in your project-level cluster. For more information on Prometheus, and so on, in your project-level cluster. For more information on
installing, upgrading, uninstalling, and troubleshooting applications for installing, upgrading, uninstalling, and troubleshooting applications for
your project cluster, see your project cluster, see
[GitLab Managed Apps](../../clusters/applications.md). [GitLab Managed Apps](../../clusters/applications.md).
......
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