Commit ac8d4f01 authored by João Cunha's avatar João Cunha

Move apps docs to new location

parent b0ac80cb
...@@ -68,17 +68,17 @@ The built-in applications are intended to provide an easy way to get started wit ...@@ -68,17 +68,17 @@ The built-in applications are intended to provide an easy way to get started wit
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](management_project_applications/apparmor.md) - [Apparmor](../infrastructure/clusters/manage/management_project_applications/apparmor.md)
- [Cert-manager](management_project_applications/certmanager.md) - [Cert-manager](../infrastructure/clusters/manage/management_project_applications/certmanager.md)
- [Cilium](management_project_applications/cilium.md) - [Cilium](../infrastructure/clusters/manage/management_project_applications/cilium.md)
- [Elastic Stack](management_project_applications/elasticstack.md) - [Elastic Stack](../infrastructure/clusters/manage/management_project_applications/elasticstack.md)
- [Falco](management_project_applications/falco.md) - [Falco](../infrastructure/clusters/manage/management_project_applications/falco.md)
- [Fluentd](management_project_applications/fluentd.md) - [Fluentd](../infrastructure/clusters/manage/management_project_applications/fluentd.md)
- [GitLab Runner](management_project_applications/runner.md) - [GitLab Runner](../infrastructure/clusters/manage/management_project_applications/runner.md)
- [Ingress](management_project_applications/ingress.md) - [Ingress](../infrastructure/clusters/manage/management_project_applications/ingress.md)
- [Prometheus](management_project_applications/prometheus.md) - [Prometheus](../infrastructure/clusters/manage/management_project_applications/prometheus.md)
- [Sentry](management_project_applications/sentry.md) - [Sentry](../infrastructure/clusters/manage/management_project_applications/sentry.md)
- [Vault](management_project_applications/vault.md) - [Vault](../infrastructure/clusters/manage/management_project_applications/vault.md)
### Migrating from GitLab Managed Apps ### Migrating from GitLab Managed Apps
......
...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install AppArmor you should [management project template](../../../../../user/clusters/management_project_template.md), to install AppArmor you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install cert-manager you should [management project template](../../../../../user/clusters/management_project_template.md), to install cert-manager you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -10,14 +10,14 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -10,14 +10,14 @@ info: To determine the technical writer assigned to the Stage/Group associated w
[Cilium](https://cilium.io/) is a networking plugin for Kubernetes that you can use to implement [Cilium](https://cilium.io/) is a networking plugin for Kubernetes that you can use to implement
support for [NetworkPolicy](https://kubernetes.io/docs/concepts/services-networking/network-policies/) support for [NetworkPolicy](https://kubernetes.io/docs/concepts/services-networking/network-policies/)
resources. For more information, see [Network Policies](../../../topics/autodevops/stages.md#network-policy). resources. For more information, see [Network Policies](../../../../../topics/autodevops/stages.md#network-policy).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see the For an overview, see the
[Container Network Security Demo for GitLab 12.8](https://www.youtube.com/watch?v=pgUEdhdhoUI). [Container Network Security Demo for GitLab 12.8](https://www.youtube.com/watch?v=pgUEdhdhoUI).
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install cilium you should [management project template](../../../../../user/clusters/management_project_template.md), to install cilium you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
...@@ -47,9 +47,9 @@ for the available configuration options. ...@@ -47,9 +47,9 @@ for the available configuration options.
You can check Cilium's installation status on the cluster management page: You can check Cilium's installation status on the cluster management page:
- [Project-level cluster](../../project/clusters/index.md): Navigate to your project's - [Project-level cluster](../../../../project/clusters/index.md): Navigate to your project's
**Infrastructure > Kubernetes clusters** page. **Infrastructure > Kubernetes clusters** page.
- [Group-level cluster](../../group/clusters/index.md): Navigate to your group's - [Group-level cluster](../../../../group/clusters/index.md): Navigate to your group's
**Kubernetes** page. **Kubernetes** page.
WARNING: WARNING:
...@@ -99,7 +99,7 @@ agent: ...@@ -99,7 +99,7 @@ agent:
The [Hubble](https://github.com/cilium/hubble) monitoring daemon is enabled by default The [Hubble](https://github.com/cilium/hubble) monitoring daemon is enabled by default
and it's set to collect per namespace flow metrics. This metrics are accessible on the and it's set to collect per namespace flow metrics. This metrics are accessible on the
[Threat Monitoring](../../application_security/threat_monitoring/index.md) [Threat Monitoring](../../../../application_security/threat_monitoring/index.md)
dashboard. You can disable Hubble by adding the following to dashboard. You can disable Hubble by adding the following to
`applications/cilium/values.yaml`: `applications/cilium/values.yaml`:
......
...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Elastic Stack you should [management project template](../../../../../user/clusters/management_project_template.md), to install Elastic Stack you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -13,8 +13,8 @@ as a runtime security tool that listens to the Linux kernel using eBPF. Falco pa ...@@ -13,8 +13,8 @@ as a runtime security tool that listens to the Linux kernel using eBPF. Falco pa
and asserts the stream against a configurable rules engine in real-time. For more information, see and asserts the stream against a configurable rules engine in real-time. For more information, see
[Falco's Documentation](https://falco.org/docs/). [Falco's Documentation](https://falco.org/docs/).
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Falco you should [management project template](../../../../../user/clusters/management_project_template.md), to install Falco you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Fluentd you should [management project template](../../../../../user/clusters/management_project_template.md), to install Fluentd you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Ingress you should [management project template](../../../../../user/clusters/management_project_template.md), to install Ingress you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -12,8 +12,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -12,8 +12,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
open-source monitoring and alerting system for supervising your open-source monitoring and alerting system for supervising your
deployed applications. deployed applications.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Prometheus you should [management project template](../../../../../user/clusters/management_project_template.md), to install Prometheus you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install GitLab Runner you should [management project template](../../../../../user/clusters/management_project_template.md), to install GitLab Runner you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
...@@ -24,16 +24,16 @@ For GitLab Runner to function, you _must_ specify the following in your ...@@ -24,16 +24,16 @@ For GitLab Runner to function, you _must_ specify the following in your
- `gitlabUrl`: The GitLab server full URL (for example, `https://gitlab.example.com`) - `gitlabUrl`: The GitLab server full URL (for example, `https://gitlab.example.com`)
to register the Runner against. to register the Runner against.
- `runnerRegistrationToken`: The registration token for adding new runners to GitLab. - `runnerRegistrationToken`: The registration token for adding new runners to GitLab.
This must be [retrieved from your GitLab instance](../../../ci/runners/index.md). This must be [retrieved from your GitLab instance](../../../../../ci/runners/index.md).
These values can be specified using [CI/CD variables](../../../ci/variables/index.md): These values can be specified using [CI/CD variables](../../../../../ci/variables/index.md):
- `GITLAB_RUNNER_GITLAB_URL` is used for `gitlabUrl`. - `GITLAB_RUNNER_GITLAB_URL` is used for `gitlabUrl`.
- `GITLAB_RUNNER_REGISTRATION_TOKEN` is used for `runnerRegistrationToken` - `GITLAB_RUNNER_REGISTRATION_TOKEN` is used for `runnerRegistrationToken`
The methods of specifying these values are mutually exclusive. Either specify variables `GITLAB_RUNNER_REGISTRATION_TOKEN` and `GITLAB_RUNNER_TOKEN` as CI variables (recommended) or provide values for `runnerRegistrationToken:` and `runnerToken:` in `applications/gitlab-runner/values.yaml.gotmpl`. The methods of specifying these values are mutually exclusive. Either specify variables `GITLAB_RUNNER_REGISTRATION_TOKEN` and `GITLAB_RUNNER_TOKEN` as CI variables (recommended) or provide values for `runnerRegistrationToken:` and `runnerToken:` in `applications/gitlab-runner/values.yaml.gotmpl`.
The runner registration token allows connection to a project by a runner and therefore should be treated as a secret to prevent malicious use and code exfiltration through a runner. For this reason, we recommend that you specify the runner registration token as a [protected variable](../../../ci/variables/index.md#protect-a-cicd-variable) and [masked variable](../../../ci/variables/index.md#mask-a-cicd-variable) and do not commit them to the Git repository in the `values.yaml.gotmpl` file. The runner registration token allows connection to a project by a runner and therefore should be treated as a secret to prevent malicious use and code exfiltration through a runner. For this reason, we recommend that you specify the runner registration token as a [protected variable](../../../../../ci/variables/index.md#protect-a-cicd-variable) and [masked variable](../../../../../ci/variables/index.md#mask-a-cicd-variable) and do not commit them to the Git repository in the `values.yaml.gotmpl` file.
You can customize the installation of GitLab Runner by defining You can customize the installation of GitLab Runner by defining
`applications/gitlab-runner/values.yaml.gotmpl` file in your cluster `applications/gitlab-runner/values.yaml.gotmpl` file in your cluster
......
...@@ -11,8 +11,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -11,8 +11,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
The Sentry Helm chart [recommends](https://github.com/helm/charts/blob/f6e5784f265dd459c5a77430185d0302ed372665/stable/sentry/values.yaml#L284-L285) The Sentry Helm chart [recommends](https://github.com/helm/charts/blob/f6e5784f265dd459c5a77430185d0302ed372665/stable/sentry/values.yaml#L284-L285)
at least 3 GB of available RAM for database migrations. at least 3 GB of available RAM for database migrations.
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Sentry you should [management project template](../../../../../user/clusters/management_project_template.md), to install Sentry you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
......
...@@ -18,10 +18,10 @@ a single source of access, control, and auditability around all your sensitive ...@@ -18,10 +18,10 @@ a single source of access, control, and auditability around all your sensitive
credentials and certificates. This feature requires giving GitLab the highest level of access and credentials and certificates. This feature requires giving GitLab the highest level of access and
control. Therefore, if GitLab is compromised, the security of this Vault instance is as well. To control. Therefore, if GitLab is compromised, the security of this Vault instance is as well. To
avoid this security risk, GitLab recommends using your own HashiCorp Vault to leverage avoid this security risk, GitLab recommends using your own HashiCorp Vault to leverage
[external secrets with CI](../../../ci/secrets/index.md). [external secrets with CI](../../../../../ci/secrets/index.md).
Assuming you already have a [Cluster management project](../management_project.md) created from a Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a
[management project template](../management_project_template.md), to install Vault you should [management project template](../../../../../user/clusters/management_project_template.md), to install Vault you should
uncomment this line from your `helmfile.yaml`: uncomment this line from your `helmfile.yaml`:
```yaml ```yaml
...@@ -35,7 +35,7 @@ Vault application causes downtime. ...@@ -35,7 +35,7 @@ Vault application causes downtime.
To optimally use Vault in a production environment, it's ideal to have a good understanding To optimally use Vault in a production environment, it's ideal to have a good understanding
of the internals of Vault and how to configure it. This can be done by reading of the internals of Vault and how to configure it. This can be done by reading
the [Vault Configuration guide](../../../ci/secrets/#configure-your-vault-server), the [Vault Configuration guide](../../../../../ci/secrets/#configure-your-vault-server),
the [Vault documentation](https://www.vaultproject.io/docs/internals) and the [Vault documentation](https://www.vaultproject.io/docs/internals) and
the Vault Helm chart [`values.yaml` file](https://github.com/hashicorp/vault-helm/blob/v0.3.3/values.yaml). the Vault Helm chart [`values.yaml` file](https://github.com/hashicorp/vault-helm/blob/v0.3.3/values.yaml).
......
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