diff options
Diffstat (limited to 'doc/install/kubernetes/gitlab_chart.md')
| -rw-r--r-- | doc/install/kubernetes/gitlab_chart.md | 109 |
1 files changed, 63 insertions, 46 deletions
diff --git a/doc/install/kubernetes/gitlab_chart.md b/doc/install/kubernetes/gitlab_chart.md index 692f81dd7cd..4e636ae3399 100644 --- a/doc/install/kubernetes/gitlab_chart.md +++ b/doc/install/kubernetes/gitlab_chart.md @@ -1,11 +1,12 @@ # GitLab Helm Chart -> **Note:** The chart is currently **beta**, if you encounter any problems please [open an issue](https://gitlab.com/charts/gitlab/issues/new). -For more information on available GitLab Helm Charts, please see our [overview](index.md#chart-overview). +This is the official and recommended way to install GitLab on a cloud native environment. +For more information on other available GitLab Helm Charts, see the [charts overview](index.md#chart-overview). ## Introduction -The `gitlab` chart is the best way to operate GitLab on Kubernetes. This chart contains all the required components to get started, and can scale to large deployments. +The `gitlab` chart is the best way to operate GitLab on Kubernetes. This chart +contains all the required components to get started, and can scale to large deployments. The default deployment includes: @@ -14,78 +15,94 @@ The default deployment includes: - An auto-scaling, unprivileged [GitLab Runner](https://docs.gitlab.com/runner/) using the Kubernetes executor - Automatically provisioned SSL via [Let's Encrypt](https://letsencrypt.org/). -### Limitations +## Limitations -Some features and functions are not currently available in the beta release. -For details, see [known issues and limitations](https://gitlab.com/charts/gitlab/blob/master/doc/architecture/beta.md#known-issues-and-limitations) in the charts repository. +Some features of GitLab are not currently available: -## Prerequisites +- [GitLab Pages](https://gitlab.com/charts/gitlab/issues/37) +- [GitLab Geo](https://gitlab.com/charts/gitlab/issues/8) +- [No in-cluster HA database](https://gitlab.com/charts/gitlab/issues/48) +- MySQL will not be supported, as support is [deprecated within GitLab](https://docs.gitlab.com/omnibus/settings/database.html#using-a-mysql-database-management-server-enterprise-edition-only) -In order to deploy GitLab on Kubernetes, a few prerequisites are required. +## Installing GitLab using the Helm Chart + +The `gitlab` chart includes all required dependencies, and takes a few minutes +to deploy. + +TIP: **Tip:** +For large scale deployments, we strongly recommend using the +[detailed installation instructions](https://gitlab.com/charts/gitlab/blob/master/doc/installation/README.md) +utilizing [external Postgres, Redis, and object storage](https://gitlab.com/charts/gitlab/tree/master/doc/advanced) services. + +### Requirements + +In order to deploy GitLab on Kubernetes, the following are required: 1. `helm` and `kubectl` [installed on your computer](preparation/tools_installation.md). 1. A Kubernetes cluster, version 1.8 or higher. 6vCPU and 16GB of RAM is recommended. - * [Google GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-container-cluster) - * [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) - * [Microsoft AKS](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal) + - [Google GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-container-cluster) + - [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) + - [Microsoft AKS](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal) 1. A [wildcard DNS entry and external IP address](preparation/networking.md) 1. [Authenticate and connect](preparation/connect.md) to the cluster 1. Configure and initialize [Helm Tiller](preparation/tiller.md). -## Configuring and Installing GitLab +### Deployment of GitLab to Kubernetes -> **Note**: For deployments to Amazon EKS, there are [additional configuration requirements](preparation/eks.md). +To deploy GitLab, the following three parameters are required: -For simple deployments, running all services within Kubernetes, only three parameters are required: -- `global.hosts.domain`: the [base domain](preparation/networking.md) of the wildcard host entry. For example, `mycompany.io` if the wild card entry is `*.mycompany.io`. -- `global.hosts.externalIP`: the [external IP](preparation/networking.md) which the wildcard DNS resolves to. -- `certmanager-issuer.email`: Email address to use when requesting new SSL certificates from Let's Encrypt. +- `global.hosts.domain`: the [base domain](preparation/networking.md) of the + wildcard host entry. For example, `exampe.com` if the wild card entry is + `*.example.com`. +- `global.hosts.externalIP`: the [external IP](preparation/networking.md) which + the wildcard DNS resolves to. +- `certmanager-issuer.email`: the email address to use when requesting new SSL + certificates from Let's Encrypt. -For enterprise deployments, or to utilize advanced settings, please use the instructions in the [`gitlab` chart project](https://gitlab.com/charts/gitlab) for the most up to date directions. -- [External Postgres, Redis, and other dependencies](https://gitlab.com/charts/gitlab/tree/master/doc/advanced) -- [Persistence settings](https://gitlab.com/charts/gitlab/blob/master/doc/installation/storage.md) -- [Manual TLS certificates](https://gitlab.com/charts/gitlab/blob/master/doc/installation/tls.md) -- [Manual secret creation](https://gitlab.com/charts/gitlab/blob/master/doc/installation/secrets.md) +NOTE: **Note:** +For deployments to Amazon EKS, there are +[additional configuration requirements](preparation/eks.md). A full list of +configuration options is [also available](https://gitlab.com/charts/gitlab/blob/master/doc/installation/command-line-options.md). -For additional configuration options, consult the [full list of settings](https://gitlab.com/charts/gitlab/blob/master/doc/installation/command-line-options.md). +Once you have all of your configuration options collected, you can get any +dependencies and run helm. In this example, the helm release is named "gitlab": -## Installing GitLab using the Helm Chart - -Once you have all of your configuration options collected, we can get any dependencies and -run helm. In this example, we've named our helm release "gitlab". - -``` +```sh helm repo add gitlab https://charts.gitlab.io/ -helm update +helm repo update helm upgrade --install gitlab gitlab/gitlab \ --timeout 600 \ - --set global.hosts.domain=example.local \ + --set global.hosts.domain=example.com \ --set global.hosts.externalIP=10.10.10.10 \ - --set certmanager-issuer.email=me@example.local + --set certmanager-issuer.email=email@example.com ``` ### Monitoring the Deployment -This will output the list of resources installed once the deployment finishes which may take 5-10 minutes. +This will output the list of resources installed once the deployment finishes, +which may take 5-10 minutes. -The status of the deployment can be checked by running `helm status gitlab` which can also be done while -the deployment is taking place if you run the command in another terminal. +The status of the deployment can be checked by running `helm status gitlab` +which can also be done while the deployment is taking place if you run the +command in another terminal. ### Initial login -You can access the GitLab instance by visiting the domain name beginning with `gitlab.` followed by the domain specified during installation. From the example above, the URL would be `https://gitlab.example.local`. +You can access the GitLab instance by visiting the domain name beginning with +`gitlab.` followed by the domain specified during installation. From the example +above, the URL would be `https://gitlab.example.com`. If you manually created the secret for initial root password, you can use that to sign in as `root` user. If not, Gitlab automatically created a random password for `root` user. This can be extracted by the following command (replace `<name>` by name of the release - which is `gitlab` -if you used the command above). +if you used the command above): -``` -kubectl get secret <name>-gitlab-initial-root-password -ojsonpath={.data.password} | base64 --decode +```sh +kubectl get secret <name>-gitlab-initial-root-password -ojsonpath={.data.password} | base64 --decode ; echo ``` -## Outgoing email +### Outgoing email By default outgoing email is disabled. To enable it, provide details for your SMTP server using the `global.smtp` and `global.email` settings. You can find details for these settings in the @@ -95,14 +112,14 @@ If your SMTP server requires authentication make sure to read the section on pro your password in the [secrets documentation](https://gitlab.com/charts/gitlab/blob/master/doc/installation/secrets.md#smtp-password). You can disable authentication settings with `--set global.smtp.authentication=""`. -If your Kubernetes cluster is on GKE, be aware that smtp [ports 25, 465, and 587 +If your Kubernetes cluster is on GKE, be aware that SMTP ports [25, 465, and 587 are blocked](https://cloud.google.com/compute/docs/tutorials/sending-mail/#using_standard_email_ports). -## Deploying the Community Edition +### Deploying the Community Edition To deploy the Community Edition, include these options in your `helm install` command: -```shell +```sh --set gitlab.migrations.image.repository=registry.gitlab.com/gitlab-org/build/cng/gitlab-rails-ce --set gitlab.sidekiq.image.repository=registry.gitlab.com/gitlab-org/build/cng/gitlab-sidekiq-ce --set gitlab.unicorn.image.repository=registry.gitlab.com/gitlab-org/build/cng/gitlab-unicorn-ce @@ -113,15 +130,15 @@ To deploy the Community Edition, include these options in your `helm install` co Once your GitLab Chart is installed, configuration changes and chart updates should be done using `helm upgrade`: -```bash -helm upgrade -f values.yaml gitlab gitlab/gitlab +```sh +helm upgrade --reuse-values gitlab gitlab/gitlab ``` ## Uninstalling GitLab using the Helm Chart To uninstall the GitLab Chart, run the following: -```bash +```sh helm delete gitlab ``` |