Skip to content
Snippets Groups Projects
Commit ac88a749 authored by Suzanne Selhorn's avatar Suzanne Selhorn Committed by Diana Logan
Browse files

Docs: Changed charts to lowercase

Based on style guide decision

Related to: https://gitlab.com/gitlab-org/technical-writing/-/issues/642
parent 12babc62
No related branches found
No related tags found
Loading
Showing
with 31 additions and 31 deletions
......@@ -15,7 +15,7 @@ NOTE:
External Gitaly _services_ can be provided by Gitaly nodes, or
[Praefect](https://docs.gitlab.com/ee/administration/gitaly/praefect.html) clusters.
## Configure the Chart
## Configure the chart
Disable the `gitaly` chart and the Gitaly service it provides, and point the other services to the external service.
......
......@@ -44,7 +44,7 @@ Omnibus GitLab package.
1. Apply the changes by running `sudo gitlab-ctl reconfigure`.
## Configure the Chart
## Configure the chart
1. Create a bucket named `gitlab-pages` in the object storage for storing Pages
deployments.
......
......@@ -6,9 +6,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Configure the GitLab chart with Mattermost Team Edition
This document describes how to install Mattermost Team Edition Helm Chart in proximity with an existing GitLab Helm Chart deployment.
This document describes how to install Mattermost Team Edition Helm chart in proximity with an existing GitLab Helm chart deployment.
As the Mattermost Helm Chart is installed in a separate namespace, it is recommended that
As the Mattermost Helm chart is installed in a separate namespace, it is recommended that
`cert-manager` and `nginx-ingress` be configured to manage cluster-wide Ingress and certificate resources. For additional configuration information,
refer to the [Mattermost Helm configuration guide](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-team-edition#configuration).
......@@ -20,9 +20,9 @@ refer to the [Mattermost Helm configuration guide](https://github.com/mattermost
NOTE:
For the Team Edition you can have just one replica running.
## Deploy the Mattermost Team Edition Helm Chart
## Deploy the Mattermost Team Edition Helm chart
Once you have installed the Mattermost Team Edition Helm Chart, you can deploy it using the following command:
Once you have installed the Mattermost Team Edition Helm chart, you can deploy it using the following command:
```shell
helm repo add mattermost https://helm.mattermost.com
......@@ -33,12 +33,12 @@ helm upgrade --install mattermost -f values.yaml mattermost/mattermost-team-edit
Wait for the pods to run. Then, using the Ingress host you specified in the configuration, access your Mattermost server.
For additional configuration information, refer to the [Mattermost Helm configuration guide](https://github.com/mattermost/mattermost-helm/tree/master/charts/mattermost-team-edition#configuration).
you experience any issues with this, please view the [Mattermost Helm Chart issue repository](https://github.com/mattermost/mattermost-helm/issues) or
you experience any issues with this, please view the [Mattermost Helm chart issue repository](https://github.com/mattermost/mattermost-helm/issues) or
the [Mattermost Forum](https://forum.mattermost.com/search?q=helm).
## Deploy GitLab Helm Chart
## Deploy GitLab Helm chart
To deploy the GitLab Helm Chart, follow the instructions described [here](../../index.md).
To deploy the GitLab Helm chart, follow the instructions described [here](../../index.md).
Here's a light way to install it:
......
......@@ -4,7 +4,7 @@ group: Distribution
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/#designated-technical-writers
---
# Configure the GitLab Chart with an external object storage
# Configure the GitLab chart with an external object storage
GitLab relies on object storage for highly-available persistent data in Kubernetes.
By default, an S3-compatible storage solution named `minio` is deployed with the
......
......@@ -11,7 +11,7 @@ versions of its images, allowing you to run GitLab on FIPS-enabled clusters.
## Sample values
We provide an example for GitLab Chart values in
We provide an example for GitLab chart values in
[`examples/fips/values.yaml`](https://gitlab.com/gitlab-org/charts/gitlab/tree/master/examples/fips/values.yaml)
which can help you to build a FIPS-compatible GitLab deployment.
......
......@@ -10,7 +10,7 @@ GitLab offers [Red Hat UBI](https://www.redhat.com/en/blog/introducing-red-hat-u
versions of its images, allowing you to replace standard images with UBI-based
images. These images use the same tag as standard images with `-ubi8` extension.
The GitLab Chart uses third-party images that are not based on UBI. These images
The GitLab chart uses third-party images that are not based on UBI. These images
are mostly offer external services to GitLab, such as Redis, PostgreSQL, and so on.
If you wish to deploy a GitLab instance that purely based on UBI you must
disable the internal services, and use external deployments or services.
......@@ -30,7 +30,7 @@ The services must be disabled are:
## Sample values
We provide an example for GitLab Chart values in [`examples/ubi/values.yaml`](https://gitlab.com/gitlab-org/charts/gitlab/tree/master/examples/ubi/values.yaml)
We provide an example for GitLab chart values in [`examples/ubi/values.yaml`](https://gitlab.com/gitlab-org/charts/gitlab/tree/master/examples/ubi/values.yaml)
which can help you to build a pure UBI GitLab deployment.
## Known Limitations
......
......@@ -12,7 +12,7 @@ We plan to support three tiers of components:
1. Scheduler (Kubernetes)
1. Higher level configuration tool (Helm)
The main method customers would use to install would be the [Helm Chart](https://helm.sh/) in this repository.
The main method customers would use to install would be the [Helm chart](https://helm.sh/) in this repository.
At some point in the future, we may also offer other deployment methods like
Amazon CloudFormation or Docker Swarm.
......@@ -62,9 +62,9 @@ underlying services:
- PostgreSQL
- Grafana
## The GitLab Chart
## The GitLab chart
This is the top level `gitlab` chart, which configures all necessary resources
This is the top level GitLab chart (`gitlab`), which configures all necessary resources
for a complete configuration of GitLab. This includes GitLab, PostgreSQL, Redis,
Ingress, and certificate management charts.
......
......@@ -139,7 +139,7 @@ Our [NGINX Ingress chart](../charts/nginx/index.md) was altered from the upstrea
- Add feature to allow for the TCP ConfigMap to be external to the chart
- Add feature to allow Ingress class to be templated based on release name
## Kubernetes version used throughout Chart
## Kubernetes version used throughout chart
To maximize support for different Kubernetes versions, use a `kubectl` that's
one minor version lower than the current stable release of Kubernetes.
......
......@@ -36,7 +36,7 @@ We will try to leverage standard Kubernetes features:
Since we might be also using Consul, this may be utilized instead for consistency with other installation methods.
## Helm Charts
## Helm charts
A Helm chart will be created to manage the deployment of each GitLab specific container/service. We will then also include bundled charts to make the overall deployment easier. This is particularly
important for this effort, as there will be significantly more complexity in
......@@ -44,6 +44,6 @@ the Docker and Kubernetes layers than the all-in-one Omnibus based solutions.
Helm can help to manage this complexity, and provide an easy top level interface
to manage settings via the `values.yaml` file.
We plan to offer a three tiered set of Helm Charts
We plan to offer a three tiered set of Helm charts:
![Helm Chart Structure](../images/charts.png)
![Helm chart Structure](../images/charts.png)
......@@ -35,7 +35,7 @@ Follow these steps for backing up a GitLab Helm chart based installation
## Cron based backup
NOTE:
The Kubernetes CronJob created by the Helm Chart
The Kubernetes CronJob created by the Helm chart
sets the `cluster-autoscaler.kubernetes.io/safe-to-evict: "false"`
annotation on the jobTemplate. Some Kubernetes environments, such as
GKE Autopilot, don't allow this annotation to be set and will not create
......@@ -77,5 +77,5 @@ You also need to save a copy of the rails secrets as these are not included in t
## Additional Information
- [GitLab Chart Backup/Restore Introduction](index.md)
- [GitLab chart Backup/Restore Introduction](index.md)
- [Restoring a GitLab installation](restore.md)
......@@ -166,5 +166,5 @@ The restoration process does not update the `gitlab-initial-root-password` secre
## Additional Information
- [GitLab Chart Backup/Restore Introduction](index.md)
- [GitLab chart Backup/Restore Introduction](index.md)
- [Backing up a GitLab installation](backup.md)
......@@ -21,7 +21,7 @@ from the Kubernetes cluster on which this chart is deployed.
## Configuration
The `gitlab-exporter` chart is configured as follows:
[Global Settings](#global-settings) and [Chart Settings](#chart-settings).
[Global settings](#global-settings) and [Chart settings](#chart-settings).
## Installation command line options
......
......@@ -18,7 +18,7 @@ cluster this chart is deployed onto.
## Configuration
The `gitlab-pages` chart is configured as follows:
[Global Settings](#global-settings) and [Chart Settings](#chart-settings).
[Global settings](#global-settings) and [Chart settings](#chart-settings).
## Global Settings
......
......@@ -95,4 +95,4 @@ gitlab-runner:
nameservers = ["8.8.8.8"]
```
See the [Runner Chart additional configuration](https://docs.gitlab.com/runner/install/kubernetes.html#additional-configuration).
See the [Runner chart additional configuration](https://docs.gitlab.com/runner/install/kubernetes.html#additional-configuration).
......@@ -4,7 +4,7 @@ group: Distribution
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
---
# Configure Charts using Globals **(FREE SELF)**
# Configure charts using globals **(FREE SELF)**
To reduce configuration duplication when installing our wrapper Helm chart, several
configuration settings are available to be set in the `global` section of `values.yaml`.
......@@ -146,7 +146,7 @@ The GitLab global host settings for Ingress are located under the `global.ingres
| `apiVersion` | String | | API version to use in the Ingress object definitions.
| `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](#globalingressconfigurecertmanager). |
| `class` | String | `gitlab-nginx` | Global setting that controls `kubernetes.io/ingress.class` annotation or `spec.IngressClassName` in `Ingress` resources. Set to `none` to disable, or `""` for empty. Note: for `none` or `""`, set `nginx-ingress.enabled=false` to prevent the Charts from deploying unnecessary Ingress resources. |
| `class` | String | `gitlab-nginx` | Global setting that controls `kubernetes.io/ingress.class` annotation or `spec.IngressClassName` in `Ingress` resources. Set to `none` to disable, or `""` for empty. Note: for `none` or `""`, set `nginx-ingress.enabled=false` to prevent the charts from deploying unnecessary Ingress resources. |
| `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`](#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`. |
......@@ -1212,7 +1212,7 @@ kubectl create secret generic gitlab-rails-storage \
`externalDiffs` setting has an additional key `when` to
[conditionally store specific diffs on object storage](https://docs.gitlab.com/ee/administration/merge_request_diffs.html#alternative-in-database-storage).
This setting is left empty by default in the Charts, for a default value to be
This setting is left empty by default in the charts, for a default value to be
assigned by the Rails code.
### Incoming email settings
......
......@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Test the GitLab chart on GKE or EKS
This guide serves as a concise but complete documentation about how to install the
Cloud Native GitLab chart with default values on Google Kubernetes Engine (GKE)
GitLab chart with default values on Google Kubernetes Engine (GKE)
or Amazon Elastic Kubernetes Service (EKS).
By default, the GitLab chart includes an in-cluster PostgreSQL, Redis, and
......@@ -41,7 +41,7 @@ We'll instead refer to the cloud providers' own instructions:
- [Google GKE cluster creation guide](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-zonal-cluster).
- [Amazon AWS Getting started with Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html).
Use EC2 managed nodes for the EKS cluster, and not Fargate. Fargate [has a number of limitations](https://docs.aws.amazon.com/en_us/eks/latest/userguide/fargate.html) and is not supported for use with the GitLab Helm Chart.
Use EC2 managed nodes for the EKS cluster, and not Fargate. Fargate [has a number of limitations](https://docs.aws.amazon.com/en_us/eks/latest/userguide/fargate.html) and is not supported for use with the GitLab Helm chart.
### Install kubectl
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment