Commit 3a6100d0 authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-cicd-managed-apps' into 'master'

Update title of ci/cd managed apps section

See merge request gitlab-org/gitlab!27715
parents 1ec7dcda 600db154
...@@ -763,7 +763,7 @@ You must use a Kubernetes network plugin that implements support for ...@@ -763,7 +763,7 @@ You must use a Kubernetes network plugin that implements support for
`NetworkPolicy`. The default network plugin for Kubernetes (`kubenet`) `NetworkPolicy`. The default network plugin for Kubernetes (`kubenet`)
[does not implement](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/#kubenet) [does not implement](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/#kubenet)
support for it. The [Cilium](https://cilium.io/) network plugin can be support for it. The [Cilium](https://cilium.io/) network plugin can be
installed as a [cluster application](../../user/clusters/applications.md#install-cilium-using-gitlab-ci) installed as a [cluster application](../../user/clusters/applications.md#install-cilium-using-gitlab-cicd)
to enable support for network policies. to enable support for network policies.
You can enable deployment of a network policy by setting the following You can enable deployment of a network policy by setting the following
...@@ -799,7 +799,7 @@ networkPolicy: ...@@ -799,7 +799,7 @@ networkPolicy:
``` ```
For more information on how to install Network Policies, see For more information on how to install Network Policies, see
[Install Cilium using GitLab CI](../../user/clusters/applications.md#install-cilium-using-gitlab-ci). [Install Cilium using GitLab CI](../../user/clusters/applications.md#install-cilium-using-gitlab-cicd).
#### Web Application Firewall (ModSecurity) customization #### Web Application Firewall (ModSecurity) customization
......
...@@ -529,7 +529,7 @@ Interested in contributing a new GitLab managed app? Visit the ...@@ -529,7 +529,7 @@ Interested in contributing a new GitLab managed app? Visit the
[development guidelines page](../../development/kubernetes.md#gitlab-managed-apps) [development guidelines page](../../development/kubernetes.md#gitlab-managed-apps)
to get started. to get started.
## Install using GitLab CI (alpha) ## Install using GitLab CI/CD (alpha)
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20822) in GitLab 12.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20822) in GitLab 12.6.
...@@ -538,20 +538,20 @@ This is an _alpha_ feature, and it is subject to change at any time without ...@@ -538,20 +538,20 @@ This is an _alpha_ feature, and it is subject to change at any time without
prior notice. prior notice.
This alternative method allows users to install GitLab-managed This alternative method allows users to install GitLab-managed
applications using GitLab CI. It also allows customization of the applications using GitLab CI/CD. It also allows customization of the
install using Helm `values.yaml` files. install using Helm `values.yaml` files.
Supported applications: Supported applications:
- [Ingress](#install-ingress-using-gitlab-ci) - [Ingress](#install-ingress-using-gitlab-cicd)
- [cert-manager](#install-cert-manager-using-gitlab-ci) - [cert-manager](#install-cert-manager-using-gitlab-cicd)
- [Sentry](#install-sentry-using-gitlab-ci) - [Sentry](#install-sentry-using-gitlab-cicd)
- [GitLab Runner](#install-gitlab-runner-using-gitlab-ci) - [GitLab Runner](#install-gitlab-runner-using-gitlab-cicd)
- [Cilium](#install-cilium-using-gitlab-ci) - [Cilium](#install-cilium-using-gitlab-cicd)
- [Vault](#install-vault-using-gitlab-ci) - [Vault](#install-vault-using-gitlab-cicd)
- [JupyterHub](#install-jupyterhub-using-gitlab-ci) - [JupyterHub](#install-jupyterhub-using-gitlab-cicd)
- [Elastic Stack](#install-elastic-stack-using-gitlab-ci) - [Elastic Stack](#install-elastic-stack-using-gitlab-cicd)
- [Crossplane](#install-crossplane-using-gitlab-ci) - [Crossplane](#install-crossplane-using-gitlab-cicd)
### Usage ### Usage
...@@ -559,7 +559,7 @@ You can find and import all the files referenced below ...@@ -559,7 +559,7 @@ You can find and import all the files referenced below
in the [example cluster applications in the [example cluster applications
project](https://gitlab.com/gitlab-org/cluster-integration/example-cluster-applications/). project](https://gitlab.com/gitlab-org/cluster-integration/example-cluster-applications/).
To install applications using GitLab CI: To install applications using GitLab CI/CD:
1. Connect the cluster to a [cluster management project](management_project.md). 1. Connect the cluster to a [cluster management project](management_project.md).
1. In that project, add a `.gitlab-ci.yml` file with the following content: 1. In that project, add a `.gitlab-ci.yml` file with the following content:
...@@ -582,7 +582,7 @@ To install applications using GitLab CI: ...@@ -582,7 +582,7 @@ To install applications using GitLab CI:
1. Optionally, define `.gitlab/managed-apps/<application>/values.yaml` file to 1. Optionally, define `.gitlab/managed-apps/<application>/values.yaml` file to
customize values for the installed application. customize values for the installed application.
A GitLab CI pipeline will then run on the `master` branch to install the A GitLab CI/CD pipeline will then run on the `master` branch to install the
applications you have configured. In case of pipeline failure, the applications you have configured. In case of pipeline failure, the
output of the [Helm output of the [Helm
Tiller](https://v2.helm.sh/docs/install/#running-tiller-locally) binary Tiller](https://v2.helm.sh/docs/install/#running-tiller-locally) binary
...@@ -597,7 +597,7 @@ Note the following: ...@@ -597,7 +597,7 @@ Note the following:
- If you update `.gitlab/managed-apps/<application>/values.yaml` with new values, the - If you update `.gitlab/managed-apps/<application>/values.yaml` with new values, the
application will be redeployed. application will be redeployed.
### Install Ingress using GitLab CI ### Install Ingress using GitLab CI/CD
To install Ingress, define the `.gitlab/managed-apps/config.yaml` file To install Ingress, define the `.gitlab/managed-apps/config.yaml` file
with: with:
...@@ -616,9 +616,9 @@ management project. Refer to the ...@@ -616,9 +616,9 @@ management project. Refer to the
[chart](https://github.com/helm/charts/tree/master/stable/nginx-ingress) [chart](https://github.com/helm/charts/tree/master/stable/nginx-ingress)
for the available configuration options. for the available configuration options.
### Install cert-manager using GitLab CI ### Install cert-manager using GitLab CI/CD
cert-manager is installed using GitLab CI by defining configuration in cert-manager is installed using GitLab CI/CD by defining configuration in
`.gitlab/managed-apps/config.yaml`. `.gitlab/managed-apps/config.yaml`.
cert-manager: cert-manager:
...@@ -628,7 +628,7 @@ cert-manager: ...@@ -628,7 +628,7 @@ cert-manager:
email address to be specified. The email address is used by Let's Encrypt to email address to be specified. The email address is used by Let's Encrypt to
contact you about expiring certificates and issues related to your account. contact you about expiring certificates and issues related to your account.
The following configuration is required to install cert-manager using GitLab CI: The following configuration is required to install cert-manager using GitLab CI/CD:
```yaml ```yaml
certManager: certManager:
...@@ -638,7 +638,7 @@ certManager: ...@@ -638,7 +638,7 @@ certManager:
email: "user@example.com" email: "user@example.com"
``` ```
The following installs cert-manager using GitLab CI without the default `ClusterIssuer`: The following installs cert-manager using GitLab CI/CD without the default `ClusterIssuer`:
```yaml ```yaml
certManager: certManager:
...@@ -653,7 +653,7 @@ management project. Refer to the ...@@ -653,7 +653,7 @@ management project. Refer to the
[chart](https://hub.helm.sh/charts/jetstack/cert-manager) for the [chart](https://hub.helm.sh/charts/jetstack/cert-manager) for the
available configuration options. available configuration options.
### Install Sentry using GitLab CI ### Install Sentry using GitLab CI/CD
NOTE: **Note:** NOTE: **Note:**
The Sentry Helm chart [recommends](https://github.com/helm/charts/blob/f6e5784f265dd459c5a77430185d0302ed372665/stable/sentry/values.yaml#L284-L285) at least 3GB of available RAM for database migrations. The Sentry Helm chart [recommends](https://github.com/helm/charts/blob/f6e5784f265dd459c5a77430185d0302ed372665/stable/sentry/values.yaml#L284-L285) at least 3GB of available RAM for database migrations.
...@@ -714,12 +714,12 @@ postgresql: ...@@ -714,12 +714,12 @@ postgresql:
postgresqlPassword: example-postgresql-password postgresqlPassword: example-postgresql-password
``` ```
### Install GitLab Runner using GitLab CI ### Install GitLab Runner using GitLab CI/CD
GitLab Runner is installed using GitLab CI by defining configuration in GitLab Runner is installed using GitLab CI/CD by defining configuration in
`.gitlab/managed-apps/config.yaml`. `.gitlab/managed-apps/config.yaml`.
The following configuration is required to install GitLab Runner using GitLab CI: The following configuration is required to install GitLab Runner using GitLab CI/CD:
```yaml ```yaml
gitlabRunner: gitlabRunner:
...@@ -745,7 +745,7 @@ management project. Refer to the ...@@ -745,7 +745,7 @@ management project. Refer to the
[chart](https://gitlab.com/gitlab-org/charts/gitlab-runner) for the [chart](https://gitlab.com/gitlab-org/charts/gitlab-runner) for the
available configuration options. available configuration options.
### Install Cilium using GitLab CI ### Install Cilium using GitLab CI/CD
> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/22) in GitLab 12.8. > [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/22) in GitLab 12.8.
...@@ -823,14 +823,14 @@ agent: ...@@ -823,14 +823,14 @@ agent:
enabled: false enabled: false
``` ```
### Install Vault using GitLab CI ### Install Vault using GitLab CI/CD
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/9982) in GitLab 12.9. > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/9982) in GitLab 12.9.
[Hashicorp Vault](https://vaultproject.io/) is a secrets management solution which [Hashicorp Vault](https://vaultproject.io/) is a secrets management solution which
can be used to safely manage and store passwords, credentials, certificates and more. A Vault can be used to safely manage and store passwords, credentials, certificates and more. A Vault
installation could be leveraged to provide a single secure data store for credentials installation could be leveraged to provide a single secure data store for credentials
used in your applications, GitLab CI jobs, and more. It could also serve as a way of used in your applications, GitLab CI/CD jobs, and more. It could also serve as a way of
providing SSL/TLS certificates to systems and deployments in your infrastructure. Leveraging providing SSL/TLS certificates to systems and deployments in your infrastructure. Leveraging
Vault as a single source for all these credentials allows greater security by having Vault as a single source for all these credentials allows greater security by having
a single source of access, control, and auditability around all your sensitive a single source of access, control, and auditability around all your sensitive
...@@ -912,11 +912,11 @@ kubectl -n gitlab-managed-apps exec -it vault-0 sh ...@@ -912,11 +912,11 @@ kubectl -n gitlab-managed-apps exec -it vault-0 sh
This should give you your unseal keys and initial root token. Make sure to note these down This should give you your unseal keys and initial root token. Make sure to note these down
and keep these safe as you will need them to unseal the Vault throughout its lifecycle. and keep these safe as you will need them to unseal the Vault throughout its lifecycle.
### Install JupyterHub using GitLab CI ### Install JupyterHub using GitLab CI/CD
> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/40) in GitLab 12.8. > [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/40) in GitLab 12.8.
JupyterHub is installed using GitLab CI by defining configuration in JupyterHub is installed using GitLab CI/CD by defining configuration in
`.gitlab/managed-apps/config.yaml` as follows: `.gitlab/managed-apps/config.yaml` as follows:
```yaml ```yaml
...@@ -961,14 +961,14 @@ Refer to the ...@@ -961,14 +961,14 @@ Refer to the
[chart reference](https://zero-to-jupyterhub.readthedocs.io/en/stable/reference.html) for the [chart reference](https://zero-to-jupyterhub.readthedocs.io/en/stable/reference.html) for the
available configuration options. available configuration options.
### Install Elastic Stack using GitLab CI ### Install Elastic Stack using GitLab CI/CD
> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/45) in GitLab 12.8. > [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/45) in GitLab 12.8.
Elastic Stack is installed using GitLab CI by defining configuration in Elastic Stack is installed using GitLab CI/CD by defining configuration in
`.gitlab/managed-apps/config.yaml`. `.gitlab/managed-apps/config.yaml`.
The following configuration is required to install Elastic Stack using GitLab CI: The following configuration is required to install Elastic Stack using GitLab CI/CD:
```yaml ```yaml
elasticStack: elasticStack:
...@@ -988,14 +988,14 @@ available configuration options. ...@@ -988,14 +988,14 @@ available configuration options.
NOTE: **Note:** NOTE: **Note:**
In this alpha implementation of installing Elastic Stack through CI, reading the environment logs through Elasticsearch is unsupported. This is supported if [installed via the UI](#elastic-stack). In this alpha implementation of installing Elastic Stack through CI, reading the environment logs through Elasticsearch is unsupported. This is supported if [installed via the UI](#elastic-stack).
### Install Crossplane using GitLab CI ### Install Crossplane using GitLab CI/CD
> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/68) in GitLab 12.9. > [Introduced](https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/merge_requests/68) in GitLab 12.9.
Crossplane is installed using GitLab CI by defining configuration in Crossplane is installed using GitLab CI/CD by defining configuration in
`.gitlab/managed-apps/config.yaml`. `.gitlab/managed-apps/config.yaml`.
The following configuration is required to install Crossplane using GitLab CI: The following configuration is required to install Crossplane using GitLab CI/CD:
```yaml ```yaml
Crossplane: Crossplane:
......
...@@ -14,7 +14,7 @@ privileges. ...@@ -14,7 +14,7 @@ privileges.
This can be useful for: This can be useful for:
- Creating pipelines to install cluster-wide applications into your cluster, see [Install using GitLab CI (alpha)](applications.md#install-using-gitlab-ci-alpha) for details. - Creating pipelines to install cluster-wide applications into your cluster, see [Install using GitLab CI/CD (alpha)](applications.md#install-using-gitlab-cicd-alpha) for details.
- Any jobs that require `cluster-admin` privileges. - Any jobs that require `cluster-admin` privileges.
## Permissions ## Permissions
......
...@@ -10,7 +10,7 @@ Error tracking allows developers to easily discover and view the errors that the ...@@ -10,7 +10,7 @@ Error tracking allows developers to easily discover and view the errors that the
### Deploying Sentry ### Deploying Sentry
You may sign up to the cloud hosted <https://sentry.io>, deploy your own [on-premise instance](https://docs.sentry.io/server/installation/) or use GitLab to [install Sentry to a Kubernetes cluster](../../clusters/applications.md#install-sentry-using-gitlab-ci). You may sign up to the cloud hosted <https://sentry.io>, deploy your own [on-premise instance](https://docs.sentry.io/server/installation/) or use GitLab to [install Sentry to a Kubernetes cluster](../../clusters/applications.md#install-sentry-using-gitlab-cicd).
### Enabling Sentry ### Enabling Sentry
......
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