Commit f9db9e8c authored by Suzanne Selhorn's avatar Suzanne Selhorn Committed by Nick Gaskill

Edited for style and consistency

Related to: https://gitlab.com/gitlab-org/technical-writing/-/issues/528
I edited this page and tried to
clarify the purpose
parent e9442793
...@@ -4,93 +4,57 @@ group: Configure ...@@ -4,93 +4,57 @@ group: Configure
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Manage cluster applications **(FREE)** # Sample GitLab CI/CD project for Kubernetes **(FREE)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25318) in GitLab 12.10 with Helmfile support via Helm v2. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25318) in GitLab 12.10 with Helmfile support via Helm v2.
> - Helm v2 support was [dropped](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63577) in GitLab 14.0. Use Helm v3 instead. > - Helm v2 support was [dropped](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63577) in GitLab 14.0. Use Helm v3 instead.
> - [Migrated](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/24) to the GitLab agent in GitLab 14.5. > - [Migrated](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/24) to the GitLab agent in GitLab 14.5.
Use a repository to install, manage, and deploy clusters applications through code. GitLab provides a cluster management project template, which you use
to create a project. The project includes cluster applications that integrate with GitLab
and extend GitLab functionality. You can use the pattern shown in the project to extend
your custom cluster applications.
## Cluster Management Project Template ## Use one project for the agent and your manifests
The Cluster Management Project Template provides you a baseline to get If you **have not yet** used the agent to connect your cluster with GitLab:
started and flexibility to customize your project to your cluster's needs.
For instance, you can:
- Extend the CI/CD configuration. 1. [Create a project from the cluster management project template](#create-a-project-based-on-the-cluster-management-project-template).
- Configure the built-in cluster applications. 1. [Configure the project for the agent](agent/install/index.md).
- Remove the built-in cluster applications you don't need. 1. In your project's settings, create an
- Add other cluster applications using the same structure as the ones already available. [environment variable](../../ci/variables/index.md#add-a-cicd-variable-to-a-project) named `$KUBE_CONTEXT`
and set the value to `path/to/agent-configuration-project:your-agent-name`.
1. [Configure the files](#configure-the-project) as needed.
The template contains the following [components](#configure-the-available-components): ## Use separate projects for the agent and your manifests
- A pre-configured `.gitlab-ci.yml`file so that you can configure CI/CD pipelines using [the agent for Kubernetes](agent/ci_cd_tunnel.md). If you have already configured the agent and connected a cluster with GitLab:
- A pre-configured [Helmfile](https://github.com/roboll/helmfile) so that
you can manage cluster applications with [Helm v3](https://helm.sh/).
- An `applications` directory with a `helmfile.yaml` configured for each
application available in the template.
## Use the agent with the Cluster Management Project Template 1. [Create a project from the cluster management project template](#create-a-project-based-on-the-cluster-management-project-template).
1. In the project where you configured your agent,
[grant the agent access to the new project](agent/ci_cd_tunnel.md#authorize-the-agent).
1. In the new project, create an
[environment variable](../../ci/variables/index.md#add-a-cicd-variable-to-a-project) named `$KUBE_CONTEXT`
and set the value to `path/to/agent-configuration-project:your-agent-name`.
1. In the new project, [configure the files](#configure-the-project) as needed.
To use a new project created from the Cluster Management Project Template ## Create a project based on the cluster management project template
with a cluster connected to GitLab through the [GitLab agent](agent/index.md),
you have two options:
- [Use one single project](#single-project) to configure the agent and manage cluster applications. To create a project from the cluster management project template:
- [Use separate projects](#separate-projects) - one to configure the agent and another to manage cluster applications.
### Single project 1. On the top bar, select **Menu > Projects > Create new project**.
1. Select **Create from template**.
1. From the list of templates, next to **GitLab Cluster Management**, select **Use template**.
1. Enter the project details.
1. Select **Create project**.
This setup is particularly useful when you haven't connected your cluster If you use self-managed GitLab, your instance might not include the latest version of the template.
to GitLab through the agent yet and you want to use the Cluster Management In that case, select **Import project**, **Repo by URL** and for the **Git repository URL**, enter
Project Template to manage cluster applications. `https://gitlab.com/gitlab-org/project-templates/cluster-management.git`.
To use one single project to configure the agent and to manage cluster applications: ## Configure the project
1. [Create a new project from the Cluster Management Project Template](#create-a-new-project-based-on-the-cluster-management-template). After you use the cluster management template to create a project, you can configure:
1. Configure the new project as the [agent's configuration repository](agent/repository.md)
(where the agent is registered and its `config.yaml` is stored).
1. From your project's settings, add a [new environment variable](../../ci/variables/index.md#add-a-cicd-variable-to-a-project) `$KUBE_CONTEXT` and set it to `path/to/agent-configuration-project:your-agent-name`.
1. [Configure the components](#configure-the-available-components) inherited from the template.
### Separate projects
This setup is particularly useful **when you already have a cluster** connected
to GitLab through the agent and want to use the Cluster Management
Project Template to manage cluster applications.
To use one project to configure the agent ("project A") and another project to
manage cluster applications ("project B"), follow the steps below.
We assume that you already have a cluster connected through the agent and
[configured through the agent's configuration repository](agent/repository.md)
("project A").
1. [Create a new project from the Cluster Management Project Template](#create-a-new-project-based-on-the-cluster-management-template).
This new project is "project B".
1. In your "project A", [grant the agent access to the new project (B)](agent/ci_cd_tunnel.md#authorize-the-agent).
1. From the "project's B" settings, add a [new environment variable](../../ci/variables/index.md#add-a-cicd-variable-to-a-project) `$KUBE_CONTEXT` and set it to `path/to/agent-configuration-project:your-agent-name`.
1. In "project B", [configure the components](#configure-the-available-components) inherited from the template.
## Create a new project based on the Cluster Management Template
To get started, create a new project based on the Cluster Management
project template to use as a cluster management project.
You can either create the new project from the template or import the
project from the URL. Importing the project is useful if you are using
a GitLab self-managed instance that may not have the latest version of
the template.
To [create the new project](../project/working_with_projects.md#create-a-project):
- From the template: select the **GitLab Cluster Management** project template.
- Importing from the URL: use `https://gitlab.com/gitlab-org/project-templates/cluster-management.git`.
## Configure the available components
Use the available components to configure your cluster applications:
- [The `.gitlab-ci.yml` file](#the-gitlab-ciyml-file). - [The `.gitlab-ci.yml` file](#the-gitlab-ciyml-file).
- [The main `helmfile.yml` file](#the-main-helmfileyml-file). - [The main `helmfile.yml` file](#the-main-helmfileyml-file).
...@@ -98,22 +62,22 @@ Use the available components to configure your cluster applications: ...@@ -98,22 +62,22 @@ Use the available components to configure your cluster applications:
### The `.gitlab-ci.yml` file ### The `.gitlab-ci.yml` file
The base image used in your pipeline is built by the [cluster-applications](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications) The `.gitlab-ci.yml` file:
project. This image consists of a set of Bash utility scripts to support [Helm v3 releases](https://helm.sh/docs/intro/using_helm/#three-big-concepts):
- `gl-fail-if-helm2-releases-exist {namespace}`: It tries to detect whether you have apps deployed through Helm v2 - Ensures you are on Helm version 3.
releases for a given namespace. If so, it will fail the pipeline and ask you to manually - Deploys the enabled applications from the project.
[migrate your Helm v2 releases to Helm v3](https://helm.sh/docs/topics/v2_v3_migration/).
- `gl-ensure-namespace {namespace}`: It creates the given namespace if it does not exist and adds the necessary label You can edit and extend the pipeline definitions.
for the [Cilium](https://github.com/cilium/cilium/) app network policies to work.
- `gl-adopt-resource-with-helm-v3 {arguments}`: Used only internally in the [cert-manager's](https://cert-manager.io/) Helmfile to The base image used in the pipeline is built by the
facilitate the GitLab Managed Apps adoption. [cluster-applications](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications) project.
- `gl-adopt-crds-with-helm-v3 {arguments}`: Used only internally in the [cert-manager's](https://cert-manager.io/) Helmfile to This image contains a set of Bash utility scripts to support [Helm v3 releases](https://helm.sh/docs/intro/using_helm/#three-big-concepts).
facilitate the GitLab Managed Apps adoption.
- `gl-helmfile {arguments}`: A thin wrapper that triggers the [Helmfile](https://github.com/roboll/helmfile) command.
### The main `helmfile.yml` file ### The main `helmfile.yml` file
The template contains a [Helmfile](https://github.com/roboll/helmfile) you can use to manage
cluster applications with [Helm v3](https://helm.sh/).
This file has a list of paths to other Helmfiles for each app. They're all commented out by default, so you must uncomment This file has a list of paths to other Helmfiles for each app. They're all commented out by default, so you must uncomment
the paths for the apps that you would like to use in your cluster. the paths for the apps that you would like to use in your cluster.
...@@ -124,6 +88,9 @@ from your cluster. [Read more](https://github.com/roboll/helmfile) about how Hel ...@@ -124,6 +88,9 @@ from your cluster. [Read more](https://github.com/roboll/helmfile) about how Hel
### Built-in applications ### Built-in applications
The template contains an `applications` directory with a `helmfile.yaml` configured for each
application in the template.
The [built-in supported applications](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/tree/master/applications) are: The [built-in supported applications](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/tree/master/applications) are:
- [Apparmor](../infrastructure/clusters/manage/management_project_applications/apparmor.md) - [Apparmor](../infrastructure/clusters/manage/management_project_applications/apparmor.md)
...@@ -138,8 +105,8 @@ The [built-in supported applications](https://gitlab.com/gitlab-org/project-temp ...@@ -138,8 +105,8 @@ The [built-in supported applications](https://gitlab.com/gitlab-org/project-temp
- [Sentry](../infrastructure/clusters/manage/management_project_applications/sentry.md) - [Sentry](../infrastructure/clusters/manage/management_project_applications/sentry.md)
- [Vault](../infrastructure/clusters/manage/management_project_applications/vault.md) - [Vault](../infrastructure/clusters/manage/management_project_applications/vault.md)
#### Customize your applications Each application has an `applications/{app}/values.yaml` file.
For GitLab Runner, the file is `applications/{app}/values.yaml.gotmpl`.
Each app has an `applications/{app}/values.yaml` file (`applications/{app}/values.yaml.gotmpl` in case of GitLab Runner). This is the In this file, you can define default values for your app's Helm chart.
place where you can define default values for your app's Helm chart. Some apps already have defaults Some apps already have defaults defined.
pre-defined by GitLab.
...@@ -20,7 +20,7 @@ To migrate from GitLab Managed Apps to a Cluster Management Project, ...@@ -20,7 +20,7 @@ To migrate from GitLab Managed Apps to a Cluster Management Project,
follow the steps below. follow the steps below.
See also [video walk-throughs](#video-walk-throughs) with examples. See also [video walk-throughs](#video-walk-throughs) with examples.
1. Create a new project based on the [Cluster Management Project template](management_project_template.md#create-a-new-project-based-on-the-cluster-management-template). 1. Create a new project based on the [Cluster Management Project template](management_project_template.md#create-a-project-based-on-the-cluster-management-project-template).
1. [Associate your new Cluster Management Project with your cluster](management_project.md#associate-the-cluster-management-project-with-the-cluster). 1. [Associate your new Cluster Management Project with your cluster](management_project.md#associate-the-cluster-management-project-with-the-cluster).
1. Detect apps deployed through Helm v2 releases by using the pre-configured [`.gitlab-ci.yml`](management_project_template.md#the-gitlab-ciyml-file) file: 1. Detect apps deployed through Helm v2 releases by using the pre-configured [`.gitlab-ci.yml`](management_project_template.md#the-gitlab-ciyml-file) file:
- In case you had overwritten the default GitLab Managed Apps namespace, edit `.gitlab-ci.yml`, - In case you had overwritten the default GitLab Managed Apps namespace, edit `.gitlab-ci.yml`,
......
...@@ -74,7 +74,7 @@ Follow the process to [migrate from GitLab Managed Apps to the cluster managemen ...@@ -74,7 +74,7 @@ Follow the process to [migrate from GitLab Managed Apps to the cluster managemen
## Migrate a cluster management project ## Migrate a cluster management project
See [how to use a cluster management project with the GitLab agent](../../clusters/management_project_template.md#use-the-agent-with-the-cluster-management-project-template). See [how to use a cluster management project with the GitLab agent](../../clusters/management_project_template.md).
## Migrate cluster monitoring features ## Migrate cluster monitoring features
......
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