Commit a7ee7bc7 authored by Marcel Amirault's avatar Marcel Amirault 🇯🇵

Fix all broken anchors in charts docs

parent 8931fc46
......@@ -9,10 +9,10 @@ If you do not have one, consider a cloud provided solution like [AWS Aurora](htt
To use an external database with the `gitlab` chart, there are a few prerequisites.
1. GitLab requires PostgreSQL 9.6.
1. The `pg_trgm` extension must be available
1. An empty database to use
1. A user with full access granted to the database above
1. A [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) with the password for the user above
1. The `pg_trgm` extension must be available.
1. An empty database to use.
1. A user with full access granted to the database above.
1. A [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) with the password for the user above.
1. Ensure that the database is reachable from the cluster. Be sure firewall policies are in place to allow traffic.
## Configuring `gitlab` to use an external database
......@@ -21,7 +21,7 @@ You need to set the following parameters:
* `postgresql.install`: Set to `false` to disable the embedded database.
* `global.psql.host`: Set to the hostname of the external database, can be a domain or an IP address.
* `global.psql.password.secret`: The name of the [secret which contains the database password for the `gitlab` user.](../../installation/secrets.md#postgres-password)
* `global.psql.password.secret`: The name of the [secret which contains the database password for the `gitlab` user.](../../installation/secrets.md#postgresql-password).
* `global.psql.password.key`: The key within the secret, which contains the password. The password should be *unencoded* value.
Items below can be further customized if you are not using the defaults:
......
......@@ -19,7 +19,7 @@ An IAM role can be specified via the annotations key:
--set registry.annotations."iam\.amazonaws\.com/role"=<role name>
```
When creating the [registry-storage.yaml](./index.md#registry-example) secret, omit the access and secret key:
When creating the [registry-storage.yaml](../../charts/registry/index.md#storage) secret, omit the access and secret key:
```yaml
s3:
......@@ -39,7 +39,7 @@ For LFS, artifacts, uploads, packages and pseudonymizer an IAM role can be speci
--set gitlab.unicorn.annotations."iam\.amazonaws\.com/role"=<role name>
```
For the [object-storage.yaml](./index.md#object-storage-example) secret, omit the access and secret key.
For the [object-storage.yaml](../../charts/globals.md#connection) secret, omit the access and secret key.
As unicorn uses Fog for S3 storage, the [use_iam_profile](https://docs.gitlab.com/ee/administration/job_artifacts.html#s3-compatible-connection-settings) key should be added for Fog to use the role:
```yaml
......
......@@ -13,7 +13,7 @@ You need to set the following parameters:
* `redis.enabled`: Set to `false` to disable the included Redis chart.
* `global.redis.host`: Set to the hostname of the external Redis, can be a domain or an IP address.
* `global.redis.password.enabled`: Set to `false` if the external Redis does not require a password.
* `global.redis.password.secret`: The name of the [secret which contains the token for authentication][redis-secret].
* `global.redis.password.secret`: The name of the [secret which contains the token for authentication](../../installation/secrets.md#redis-password).
* `global.redis.password.key`: The key within the secret, which contains the token content.
Items below can be further customized if you are not using the defaults:
......@@ -28,5 +28,3 @@ helm install . \
--set global.redis.password.secret=gitlab-redis \
--set global.redis.password.key=redis-password \
```
[redis-secret]: ../../installation/secrets.md#redis-secret
......@@ -12,7 +12,7 @@ from properties to secrets (in observance of our preference).
As a means of preventing a user from accidentally deploying an updated version of these
charts which includes a breaking change against a configuration that would not function, we
have chosen to implement [deprecation][] notifications. These are designed to detect
have chosen to implement [deprecation](../development/index.md#handling-configuration-deprecations) notifications. These are designed to detect
properties have have been relocated, altered, replaced, or removed entirely, then inform
the user of what changes need to be made to the configuration. This may include informing
the user to see documentation on how to replace a property with a secret. These notifications
......@@ -24,8 +24,6 @@ behavior complete failure that requires debugging.
Introduced in [!396 Deprecations: implement buffered list of deprecations](https://gitlab.com/charts/gitlab/merge_requests/396)
[deprecation]: ../development/index.md#handling-configuration-deprecation
## Preference of Secrets in initContainer over Environment
Much of the container ecosystem has, or expects, the capability to be configured
......
......@@ -15,7 +15,7 @@ for more information on how the global variables work.
- [Gitaly](#configure-gitaly-settings)
- [Minio](#configure-minio-settings)
- [appConfig](#configure-appconfig-settings)
- [GitLab Shell](#configure-gitlab-shell-settings)
- [GitLab Shell](#configure-gitlab-shell)
- [Custom Certificate Authorities](#custom-certificate-authorities)
- [Application Resource](#application-resource)
......@@ -44,8 +44,8 @@ global:
| Name | Type | Default | Description |
|:---------------------- |:-------:|:------------- |:----------- |
| `domain` | String | `example.com` | The base domain. GitLab and Registry will be exposed on the subdomain of this setting. This defaults to `example.com`, but is not used for hosts that have their `name` property configured. See the `gitlab.name`, `minio.name`, and `registry.name` sections below. |
| `externalIP` | | `nil` | Set the external IP address that will be claimed from the provider. This will be templated into the [nginx chart](nginx/index.md#configuring-the-service), in place of the more complex `nginx.service.loadBalancerIP`. |
| `https` | Boolean | `true` | If set to true, you will need to ensure the nginx chart has access to the certificates. In cases where you have TLS-termination in front of your ingresses, you probably want to look at [`global.ingress.tls.enabled`](#globalingresstlsenabled). Set to false for external urls to use `http://` instead of `https`. |
| `externalIP` | | `nil` | Set the external IP address that will be claimed from the provider. This will be templated into the [nginx chart](nginx/index.md#configuring-nginx), in place of the more complex `nginx.service.loadBalancerIP`. |
| `https` | Boolean | `true` | If set to true, you will need to ensure the nginx chart has access to the certificates. In cases where you have TLS-termination in front of your ingresses, you probably want to look at [`global.ingress.tls.enabled`](#configure-ingress-settings). Set to false for external urls to use `http://` instead of `https`. |
| `hostSuffix` | String | | [See Below](#hostsuffix). |
| `gitlab.https` | Boolean | `false` | If `hosts.https` or `gitlab.https` are `true`, the GitLab external url will use `https://` instead of `http://`. |
| `gitlab.name` | String | | The hostname for gitlab. If set, this hostname is used, regardless of the `global.hosts.domain` and `global.hosts.hostSuffix` settings. |
......@@ -83,9 +83,9 @@ The GitLab global host settings for Ingress are located under the `global.ingres
| Name | Type | Default | Description |
|:------------------------------ |:-------:|:------- |:----------- |
| `annotations.*annotation-key*` | String | | Where `annotation-key` is a string that will be used with the value as an annotation on every ingress. For Example: `global.ingress.annotations."nginx\.ingress\.kubernetes\.io/enable-access-log"=true`. No global annotations are provided by default. |
| `configureCertmanager` | Boolean | `true` | [See below](#global-ingress-configureCertmanager). |
| `configureCertmanager` | Boolean | `true` | [See below](#globalingressconfigurecertmanager). |
| `enabled` | Boolean | `true` | Global setting that controls whether to create ingress objects for services that support them. |
| `tls.enabled` | Boolean | `true` | When set to `false`, this disables TLS in Gitlab. This is useful for cases in which you cannot use TLS termination of ingresses, such as when you have a TLS-terminating proxy before the ingress controller. If you want to disable https completely, this should be set to `false` together with [`global.hosts.https`](#https). |
| `tls.enabled` | Boolean | `true` | When set to `false`, this disables TLS in Gitlab. This is useful for cases in which you cannot use TLS termination of ingresses, such as when you have a TLS-terminating proxy before the ingress controller. If you want to disable https completely, this should be set to `false` together with [`global.hosts.https`](#configure-host-settings). |
| `tls.secretName` | String | | The name of the [Kubernetes TLS Secret](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) that contains a **wildcard** certificate and key for the domain used in `global.hosts.domain`. |
### global.ingress.configureCertmanager
......@@ -706,7 +706,7 @@ global:
|:----------- |:-------:|:------- |:----------- |
| `port` | Integer | `22` | You can control the port used by the Ingress to pass SSH traffic, as well as the port used in SSH URLs provided from GitLab via `global.shell.port`. |
| `authToken` | | | See [authToken](gitlab/gitlab-shell/index.md#authtoken) in the GitLab Shell chart specific documentation. |
| `hostKeys` | | | See [hostKeys](gitlab/gitlab-shell/index.md#hostkeys-secret) in the GitLab Shell chart specific documentation. |
| `hostKeys` | | | See [hostKeys](gitlab/gitlab-shell/index.md#hostkeyssecret) in the GitLab Shell chart specific documentation. |
## Custom Certificate Authorities
......
......@@ -2,7 +2,7 @@
This guide contains instructions for when and how to generate a changelog entry
file, as well as information and history about our changelog process. These entries
are later integrated by [changelog_manager](#changelog-manager.md)
are later integrated by [changelog_manager](changelog-manager.md)
## Overview
......@@ -128,23 +128,15 @@ type:
### Arguments
| Argument | Shorthand | Purpose |
| ----------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| [`--amend`] | | Amend the previous commit |
| [`--force`] | `-f` | Overwrite an existing entry |
| [`--merge-request`] | `-m` | Set merge request ID |
| [`--dry-run`] | `-n` | Don't actually write anything, just print |
| [`--git-username`] | `-u` | Use Git user.name configuration as the author |
| [`--type`] | `-t` | The category of the change, valid options are: added, fixed, changed, deprecated, removed, security, other |
| [`--help`] | `-h` | Print help message |
[`--amend`]: #-amend
[`--force`]: #-force-or-f
[`--merge-request`]: #-merge-request-or-m
[`--dry-run`]: #-dry-run-or-n
[`--git-username`]: #-git-username-or-u
[`--type`]: #-type-or-t
[`--help`]: #-help
| Argument | Shorthand | Purpose |
| ------------------------------------------- | --------- | --------------------------------------------- |
| [`--amend`](#--amend) | | Amend the previous commit |
| [`--force`](#--force-or--f) | `-f` | Overwrite an existing entry |
| [`--merge-request`](#--merge-request-or--m) | `-m` | Set merge request ID |
| [`--dry-run`](#--dry-run-or--n) | `-n` | Don't actually write anything, just print |
| [`--git-username`](#--git-username-or--u) | `-u` | Use Git user.name configuration as the author |
| [`--type`](#--type-or--t) | `-t` | The category of the change, valid options are: added, fixed, changed, deprecated, removed, security, other |
| `--help` | `-h` | Print help message |
##### `--amend`
......
......@@ -115,7 +115,7 @@ Cursory instructions for [creating a set of OAuth credentials can be found
here](https://support.google.com/cloud/answer/6158849?hl=en).
The credentials from GCP can be added per the
[`unicorn` chart's `omniauth.providers` configuration documentation](../../charts/gitlab/unicorn/index.md#omniauthproviders).
[`globals` chart's `omniauth.providers` configuration documentation](../../charts/globals.md#omniauth).
## Run GitLab QA
......
......@@ -21,7 +21,7 @@ The script will:
1. Initialize Helm and install Tiller.
Google Cloud SDK is a dependency of this script, so make sure it's
[set up correctly](../tools.md#connect-to-the-cluster) in order for the script
[set up correctly](../tools.md#connecting-to-the-gke-cluster) in order for the script
to work.
The script reads various parameters from environment variables and an argument
......
......@@ -18,7 +18,7 @@ Any secret not provided manually will be automatically generated with a random v
To utilize autogenerated secrets continue to [next steps](#next-steps).
To specify your own secrets, proceed to [manual secret creation](#manual-secret-creation).
To specify your own secrets, proceed to [manual secret creation](#manual-secret-creation-optional).
## Manual secret creation (optional)
......@@ -28,7 +28,7 @@ documentation.
- [TLS certificates](tls.md)
- [Registry authentication certificates](#registry-authentication-certificates)
- [SSH Host Keys](#ssh-host-keys)
- [Passwords](#passwords)
- Passwords:
* [Initial root password](#initial-root-password)
* [Redis password](#redis-password)
* [GitLab Shell secret](#gitlab-shell-secret)
......@@ -36,7 +36,7 @@ documentation.
* [GitLab Rails secret](#gitlab-rails-secret)
* [GitLab workhorse secret](#gitlab-workhorse-secret)
* [GitLab runner secret](#gitlab-runner-secret)
* [Postgres password](#postgres-password)
* [Postgres password](#postgresql-password)
* [Minio secret](#minio-secret)
* [Registry HTTP secret](#registry-http-secret)
- [External Services](#external-services)
......@@ -205,7 +205,7 @@ Some charts have further secrets to enable functionality that can not be automat
### Unicorn Omniauth
In order to enable the use of [Omniauth Providers](https://docs.gitlab.com/ee/integration/omniauth.html) with the deployed GitLab, please follow the [instructions in the Unicorn chart](../charts/gitlab/unicorn/index.md#omniauth.providers)
In order to enable the use of [Omniauth Providers](https://docs.gitlab.com/ee/integration/omniauth.html) with the deployed GitLab, please follow the [instructions in the Globals chart](../charts/globals.md#omniauth)
### LDAP Password
......
......@@ -15,7 +15,7 @@ Several changes occurred during the beta cycle, which require being adddress pri
The list of breaking changes:
* [minio chart's enabled flag](../charts/globals.md#configure-minio-settings) has been [moved to global configuration](https://gitlab.com/charts/gitlab/merge_requests/389)
* [registry chart's storage configuration](../charts/registry/index.md#storage) has been [reimplemented as a secret](https://gitlab.com/charts/gitlab/issues/548)
* [Object storage configuration](../charts/globals.md#lfs-artifacts-uploads-packages-external-mr-diffs) has been [re-implemented as globally configured secrets](https://gitlab.com/charts/gitlab/issues/502)
* [Object storage configuration](../charts/globals.md#lfs--artifacts--uploads--packages--external-mr-diffs) has been [re-implemented as globally configured secrets](https://gitlab.com/charts/gitlab/issues/502)
* The [workhorse container has been split from unicorn](https://gitlab.com/charts/gitlab/merge_requests/397) and now has its [own docker image that needs to be set when swapping to the CE images](../installation/deployment.md#deploy-the-community-edition).
## Known issues and limitations
......
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