Merge branch '37550-improve-clarity-of-helm-chart-docs' into 'master'
Improve clarity of Helm Chart docs Closes #37550 See merge request !14100
This commit is contained in:
Achilleas Pipinellis
commit
dc46863cda
4 changed files with 59 additions and 44 deletions
|
|
@ -1,9 +1,9 @@
|
|||
# GitLab Helm Chart
|
||||
> **Note:**
|
||||
* > **Note**: This chart will be replaced by the [gitlab-omnibus](gitlab_omnibus.md) chart, once it supports [additional configuration options](https://gitlab.com/charts/charts.gitlab.io/issues/68).
|
||||
* Officially supported cloud providers are Google Container Service and Azure Container Service.
|
||||
> **Note**:
|
||||
* This chart will be replaced by the [gitlab-omnibus](gitlab_omnibus.md) chart, once it supports [additional configuration options](https://gitlab.com/charts/charts.gitlab.io/issues/68).
|
||||
* These charts have been tested on Google Container Engine and Azure Container Service. Other Kubernetes installations may work as well, if not please [open an issue](https://gitlab.com/charts/charts.gitlab.io/issues).
|
||||
|
||||
The `gitlab` Helm chart deploys just GitLab into your Kubernetes cluster, and offers extensive configuration options. For most deployments we recommended the [gitlab-omnibus](gitlab_omnibus.md) chart,
|
||||
The `gitlab` Helm chart deploys just GitLab into your Kubernetes cluster, and offers extensive configuration options. This chart requires advanced knowledge of Kubernetes to successfully use. For most deployments we **strongly recommended** the [gitlab-omnibus](gitlab_omnibus.md) chart, which will replace this chart once it supports [additional configuration options](https://gitlab.com/charts/charts.gitlab.io/issues/68). Due to the difficulty in supporting upgrades to the `omnibus-gitlab` chart, migrating will require exporting data out of this instance and importing it into the new deployment.
|
||||
|
||||
This chart includes the following:
|
||||
|
||||
|
|
@ -15,9 +15,11 @@ This chart includes the following:
|
|||
- Optional PostgreSQL deployment using the [PostgreSQL Chart](https://github.com/kubernetes/charts/tree/master/stable/postgresql) (defaults to enabled)
|
||||
- Optional Ingress (defaults to disabled)
|
||||
|
||||
For more information on available GitLab Helm Charts, please see our [overview](index.md#chart-overview).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- _At least_ 3 GB of RAM available on your cluster, in chunks of 1 GB. 41GB of storage and 2 CPU are also required.
|
||||
- _At least_ 3 GB of RAM available on your cluster. 41GB of storage and 2 CPU are also required.
|
||||
- Kubernetes 1.4+ with Beta APIs enabled
|
||||
- [Persistent Volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) provisioner support in the underlying infrastructure
|
||||
- The ability to point a DNS entry or URL at your GitLab install
|
||||
|
|
|
|||
|
|
@ -2,13 +2,15 @@
|
|||
> **Note:**
|
||||
* This Helm chart is in beta, while [additional features](https://gitlab.com/charts/charts.gitlab.io/issues/68) are being worked on.
|
||||
* GitLab is working on a [cloud native set of Charts](https://gitlab.com/charts/helm.gitlab.io/blob/master/README.md) which will eventually replace these.
|
||||
* Officially supported cloud providers are Google Container Service and Azure Container Service.
|
||||
* These charts have been tested on Google Container Engine and Azure Container Service. Other Kubernetes installations may work as well, if not please [open an issue](https://gitlab.com/charts/charts.gitlab.io/issues).
|
||||
|
||||
This work is based partially on: https://github.com/lwolf/kubernetes-gitlab/. GitLab would like to thank Sergey Nuzhdin for his work.
|
||||
|
||||
For more information on available GitLab Helm Charts, please see our [overview](index.md#chart-overview).
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart provides an easy way to get started with GitLab, provisioning an installation with nearly all functionality enabled. SSL is automatically provisioned as well via [Let's Encrypt](https://letsencrypt.org/).
|
||||
This chart provides an easy way to get started with GitLab, provisioning an installation with nearly all functionality enabled. SSL is automatically provisioned via [Let's Encrypt](https://letsencrypt.org/).
|
||||
|
||||
The deployment includes:
|
||||
|
||||
|
|
@ -19,7 +21,13 @@ The deployment includes:
|
|||
- [NGINX Ingress](https://github.com/kubernetes/charts/tree/master/stable/nginx-ingress)
|
||||
- Persistent Volume Claims for Data, Registry, Postgres, and Redis
|
||||
|
||||
A video demonstration of GitLab utilizing this chart [is available](https://about.gitlab.com/handbook/sales/demo/).
|
||||
### Limitations
|
||||
|
||||
* This chart is suited for small to medium size deployments, because [High Availability](https://docs.gitlab.com/ee/administration/high_availability/) and [Geo](https://docs.gitlab.com/ee/gitlab-geo/README.html) will not be supported.
|
||||
* It is in beta. Additional features to support production deployments, like backups, are [in development](https://gitlab.com/charts/charts.gitlab.io/issues/68). Once completed, this chart will be generally available.
|
||||
* A new generation of [cloud native charts](index.md#upcoming-cloud-native-helm-charts) is in development, and will eventually deprecate these. Due to the difficulty in supporting upgrades to the new architecture, migrating will require exporting data out of this instance and importing it into the new deployment. We do not expect these to be production ready before the second half of 2018.
|
||||
|
||||
For more information on available GitLab Helm Charts, please see our [overview](index.md#chart-overview).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
@ -46,7 +54,7 @@ Finally, set the `baseIP` setting to this IP address when [deploying GitLab](#co
|
|||
|
||||
#### Load Balancer IP
|
||||
|
||||
If you do not specify a `baseIP`, an ephemeral IP will be assigned to the Load Balancer or Ingress. You can retrieve this IP by running the following command *after* deploying GitLab:
|
||||
If you do not specify a `baseIP`, an IP will be assigned to the Load Balancer or Ingress. You can retrieve this IP by running the following command *after* deploying GitLab:
|
||||
|
||||
`kubectl get svc -w --namespace nginx-ingress nginx`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# GitLab Runner Helm Chart
|
||||
> **Note:**
|
||||
Officially supported cloud providers are Google Container Service and Azure Container Service.
|
||||
These charts have been tested on Google Container Engine and Azure Container Service. Other Kubernetes installations may work as well, if not please [open an issue](https://gitlab.com/charts/charts.gitlab.io/issues).
|
||||
|
||||
The `gitlab-runner` Helm chart deploys a GitLab Runner instance into your
|
||||
Kubernetes cluster.
|
||||
|
|
@ -11,6 +11,8 @@ This chart configures the Runner to:
|
|||
- For each new job it receives from [GitLab CI](https://about.gitlab.com/features/gitlab-ci-cd/), it will provision a
|
||||
new pod within the specified namespace to run it.
|
||||
|
||||
For more information on available GitLab Helm Charts, please see our [overview](index.md#chart-overview).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Your GitLab Server's API is reachable from the cluster
|
||||
|
|
|
|||
|
|
@ -1,56 +1,59 @@
|
|||
# Installing GitLab on Kubernetes
|
||||
> Officially supported cloud providers are Google Container Service and Azure Container Service.
|
||||
> **Note**: These charts have been tested on Google Container Engine and Azure Container Service. Other Kubernetes installations may work as well, if not please [open an issue](https://gitlab.com/charts/charts.gitlab.io/issues).
|
||||
|
||||
The easiest method to deploy GitLab in [Kubernetes](https://kubernetes.io/) is
|
||||
The easiest method to deploy GitLab on [Kubernetes](https://kubernetes.io/) is
|
||||
to take advantage of GitLab's Helm charts. [Helm] is a package
|
||||
management tool for Kubernetes, allowing apps to be easily managed via their
|
||||
Charts. A [Chart] is a detailed description of the application including how it
|
||||
should be deployed, upgraded, and configured.
|
||||
|
||||
GitLab provides [official Helm Charts](#official-gitlab-helm-charts-recommended) which are the recommended way to run GitLab within Kubernetes.
|
||||
## Chart Overview
|
||||
|
||||
There are also two other sets of charts:
|
||||
* Our [upcoming cloud native Charts](#upcoming-cloud-native-helm-charts), which are in development but will eventually replace the current official charts.
|
||||
* [Community contributed charts](#community-contributed-helm-charts). These charts should be considered deprecated, in favor of the official charts.
|
||||
* **[GitLab-Omnibus](#gitlab-omnibus-chart-recommended)**: The best way to run GitLab on Kubernetes today. It is suited for small to medium deployments, and is in beta while support for backups and other features are added.
|
||||
* **[Upcoming Cloud Native Charts](#upcoming-cloud-native-helm-charts)**: The next generation of charts, currently in development. Will support large deployments, with horizontal scaling of individual GitLab components.
|
||||
* Other Charts
|
||||
* [GitLab Runner Chart](#gitlab-runner-chart): For deploying just the GitLab Runner.
|
||||
* [Advanced GitLab Installation](#advanced-gitlab-installation): Provides additional deployment options, but provides less functionality out-of-the-box. It's beta, no longer actively developed, and will be deprecated by [gitlab-omnibus](#gitlab-omnibus-chart-recommended) once it supports these options.
|
||||
* [Community Contributed Charts](#community-contributed-charts): Community contributed charts, deprecated by the official GitLab charts.
|
||||
|
||||
## Official GitLab Helm Charts
|
||||
## GitLab-Omnibus Chart (Recommended)
|
||||
> **Note**: This chart is in beta while [additional features](https://gitlab.com/charts/charts.gitlab.io/issues/68) are being added.
|
||||
|
||||
These charts utilize our [GitLab Omnibus Docker images](https://docs.gitlab.com/omnibus/docker/README.html). You can report any issues and feedback related to these charts at
|
||||
https://gitlab.com/charts/charts.gitlab.io/issues.
|
||||
This chart is the best available way to operate GitLab on Kubernetes. It deploys and configures nearly all features of GitLab, including: a [Runner](https://docs.gitlab.com/runner/), [Container Registry](https://docs.gitlab.com/ee/user/project/container_registry.html#gitlab-container-registry), [Mattermost](https://docs.gitlab.com/omnibus/gitlab-mattermost/), [automatic SSL](https://github.com/kubernetes/charts/tree/master/stable/kube-lego), and a [load balancer](https://github.com/kubernetes/ingress/tree/master/controllers/nginx). It is based on our [GitLab Omnibus Docker Images](https://docs.gitlab.com/omnibus/docker/README.html).
|
||||
|
||||
### Deploying GitLab on Kubernetes
|
||||
> **Note**: This chart will eventually be replaced by the [cloud native charts](#upcoming-cloud-native-helm-charts), which are presently in development.
|
||||
Once the [cloud native charts](#upcoming-cloud-native-helm-charts) are ready for production use, this chart will be deprecated. Due to the difficulty in supporting upgrades to the new architecture, migrating will require exporting data out of this instance and importing it into the new deployment.
|
||||
|
||||
The best way to deploy GitLab on Kubernetes is to use the [gitlab-omnibus](gitlab_omnibus.md) chart.
|
||||
Learn more about the [gitlab-omnibus chart.](gitlab_omnibus.md)
|
||||
|
||||
It includes everything needed to run GitLab, including: a [Runner](https://docs.gitlab.com/runner/), [Container Registry](https://docs.gitlab.com/ee/user/project/container_registry.html#gitlab-container-registry), [automatic SSL](https://github.com/kubernetes/charts/tree/master/stable/kube-lego), and an [Ingress](https://github.com/kubernetes/ingress/tree/master/controllers/nginx). This chart is in beta while [additional features](https://gitlab.com/charts/charts.gitlab.io/issues/68) are being completed.
|
||||
## Upcoming Cloud Native Charts
|
||||
|
||||
### Deploying just the GitLab Runner
|
||||
|
||||
To deploy just the [GitLab Runner](https://docs.gitlab.com/runner/), utilize the [gitlab-runner](gitlab_runner_chart.md) chart.
|
||||
|
||||
It offers a quick way to configure and deploy the Runner on Kubernetes, regardless of where your GitLab server may be running.
|
||||
|
||||
### Advanced deployment of GitLab
|
||||
> **Note**: This chart will be replaced by the [gitlab-omnibus](gitlab_omnibus.md) chart, once it supports [additional configuration options](https://gitlab.com/charts/charts.gitlab.io/issues/68).
|
||||
|
||||
If advanced configuration of GitLab is required, the beta [gitlab](gitlab_chart.md) chart can be used which deploys the GitLab service along with optional Postgres and Redis. It offers extensive configuration, but requires deep knowledge of Kubernetes and Helm to use.
|
||||
|
||||
For most deployments we recommend using our [gitlab-omnibus](gitlab_omnibus.md) chart.
|
||||
|
||||
## Upcoming Cloud Native Helm Charts
|
||||
|
||||
GitLab is working towards a building a [cloud native deployment method](https://gitlab.com/charts/helm.gitlab.io/blob/master/README.md). A key part of this effort is to isolate each service into it's [own Docker container and Helm chart](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/2420), rather than utilizing the all-in-one container image of the [current charts](#official-gitlab-helm-charts-recommended).
|
||||
GitLab is working towards building a [cloud native deployment method](https://gitlab.com/charts/helm.gitlab.io/blob/master/README.md). A key part of this effort is to isolate each service into its [own Docker container and Helm chart](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/2420), rather than utilizing the all-in-one container image of the [current charts](#official-gitlab-helm-charts-recommended).
|
||||
|
||||
By offering individual containers and charts, we will be able to provide a number of benefits:
|
||||
* Easier horizontal scaling of each service
|
||||
* Smaller more efficient images
|
||||
* Potential for rolling updates and canaries within a service
|
||||
* Easier horizontal scaling of each service,
|
||||
* Smaller, more efficient images,
|
||||
* Potential for rolling updates and canaries within a service,
|
||||
* and plenty more.
|
||||
|
||||
This is a large project and will be worked on over the span of multiple releases. For the most up to date status and release information, please see our [tracking issue](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/2420).
|
||||
This is a large project and will be worked on over the span of multiple releases. For the most up-to-date status and release information, please see our [tracking issue](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/2420). We do not expect these to be production ready before the second half of 2018.
|
||||
|
||||
## Community Contributed Helm Charts
|
||||
## Other Charts
|
||||
|
||||
### GitLab Runner Chart
|
||||
|
||||
If you already have a GitLab instance running, inside or outside of Kubernetes, and you'd like to leverage the Runner's [Kubernetes capabilities](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/blob/master/docs/executors/kubernetes.md), it can be deployed with the GitLab Runner chart.
|
||||
|
||||
Learn more about [gitlab-runner chart.](gitlab_runner_chart.md)
|
||||
|
||||
### Advanced GitLab Installation
|
||||
|
||||
If advanced configuration of GitLab is required, the beta [gitlab](gitlab_chart.md) chart can be used which deploys the core GitLab service along with optional Postgres and Redis. It offers extensive configuration, but offers limited functionality out-of-the-box; it's lacking Pages support, the container registry, and Mattermost. It requires deep knowledge of Kubernetes and Helm to use.
|
||||
|
||||
This chart will be deprecated and replaced by the [gitlab-omnibus](gitlab_omnibus.md) chart, once it supports [additional configuration options](https://gitlab.com/charts/charts.gitlab.io/issues/68). It's beta quality, and since it is not actively under development, it will never be GA.
|
||||
|
||||
Learn more about the [gitlab chart.](gitlab_chart.md)
|
||||
|
||||
### Community Contributed Charts
|
||||
|
||||
The community has also [contributed GitLab charts](https://github.com/kubernetes/charts/tree/master/stable/gitlab-ce) to the [Helm Stable Repository](https://github.com/kubernetes/charts#repository-structure). These charts should be considered [deprecated](https://github.com/kubernetes/charts/issues/1138) in favor of the [official Charts](#official-gitlab-helm-charts-recommended).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue