gitlab-org--gitlab-foss/doc/install/kubernetes/index.md

62 lines
3.8 KiB
Markdown
Raw Normal View History

---
description: 'Read through the different methods to deploy GitLab on Kubernetes.'
---
# Installing GitLab on Kubernetes
2018-06-21 11:06:01 -04:00
> **Note**: These charts have been tested on Google Kubernetes Engine. Other Kubernetes installations may work as well, if not please [open an issue](https://gitlab.com/charts/issues).
2017-05-09 13:33:09 -04:00
2017-09-08 00:50:30 -04:00
The easiest method to deploy GitLab on [Kubernetes](https://kubernetes.io/) is
2017-08-28 14:18:25 -04:00
to take advantage of GitLab's Helm charts. [Helm] is a package
2017-05-09 13:33:09 -04:00
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.
2017-09-08 00:50:30 -04:00
## Chart Overview
2017-08-28 14:18:25 -04:00
2018-06-21 15:05:33 -04:00
* **[GitLab Chart](gitlab_chart.html)**: The recommended GitLab chart, currently in beta. Supports large deployments with horizontal scaling of individual GitLab components, and does not require NFS.
2018-06-21 11:06:01 -04:00
* **[GitLab Runner Chart](gitlab_runner_chart.md)**: For deploying just the GitLab Runner.
2017-09-08 00:50:30 -04:00
* Other Charts
2018-06-21 11:06:01 -04:00
* [GitLab-Omnibus](gitlab_omnibus.md): Chart based on the Omnibus GitLab linux package, only suitable for small deployments. The chart will be deprecated by the [GitLab chart](#gitlab-chart) when it is GA.
2017-10-01 22:04:18 -04:00
* [Community Contributed Charts](#community-contributed-charts): Community contributed charts, deprecated by the official GitLab chart.
2017-08-28 14:18:25 -04:00
2018-06-21 11:06:01 -04:00
## GitLab Chart
2018-06-21 11:06:01 -04:00
> **Note**: This chart is **beta**, while we work on the [remaining items for GA](https://gitlab.com/groups/charts/-/epics/15).
2017-08-29 14:39:06 -04:00
2018-06-21 11:06:01 -04:00
The best way to operate GitLab on Kubernetes. This chart contains all the required components to get started, and can scale to large deployments.
2017-08-29 14:39:06 -04:00
2018-06-21 15:05:33 -04:00
This chart offers a number of benefits:
2018-06-21 11:06:01 -04:00
* Horizontal scaling of individual components
* No requirement for shared storage to scale
* Containers do not need `root` permissions
* Automatic SSL with Let's Encrypt
2017-09-08 00:50:30 -04:00
* and plenty more.
2017-08-28 14:18:25 -04:00
2018-06-21 11:06:01 -04:00
Learn more about the [GitLab chart here](gitlab_chart.md) and [here [Video]](https://youtu.be/Z6jWR8Z8dv8).
2017-09-01 00:29:53 -04:00
2018-06-21 11:06:01 -04:00
## GitLab Runner Chart
2017-09-30 02:28:47 -04:00
2018-06-21 11:06:01 -04:00
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://docs.gitlab.com/runner/executors/kubernetes.html), it can be deployed with the GitLab Runner chart.
2017-08-28 14:18:25 -04:00
2018-06-21 11:06:01 -04:00
Learn more about [gitlab-runner chart](gitlab_runner_chart.md).
2017-05-09 13:33:09 -04:00
2018-06-21 11:06:01 -04:00
## Other Charts
2017-09-01 00:29:53 -04:00
2018-06-21 11:06:01 -04:00
### GitLab-Omnibus Chart
2017-05-09 13:33:09 -04:00
2018-06-21 11:06:01 -04:00
> **Note**: This chart is beta, and **will be deprecated** when the [`gitlab`](#gitlab-chart) chart is GA.
2017-08-28 16:03:42 -04:00
2018-06-21 11:06:01 -04:00
It deploys and configures nearly all features of GitLab, including: a [Runner](https://docs.gitlab.com/runner/), [Container Registry](../../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).
2017-09-08 00:50:30 -04:00
2018-06-21 11:06:01 -04:00
Once the [GitLab chart](#gitlab-chart) is GA, this chart will be deprecated. Migrating to the `gitlab` chart will require exporting data out of this instance and importing it into a new deployment.
2017-08-28 16:03:42 -04:00
2018-06-21 11:06:01 -04:00
Learn more about the [gitlab-omnibus chart](gitlab_omnibus.md).
2017-05-09 13:33:09 -04:00
2017-09-08 00:50:30 -04:00
### Community Contributed Charts
2017-09-30 13:32:39 -04:00
The community has also contributed GitLab [CE](https://github.com/kubernetes/charts/tree/master/stable/gitlab-ce) and [EE](https://github.com/kubernetes/charts/tree/master/stable/gitlab-ee) charts 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](gitlab_omnibus.md).
2017-08-28 16:03:42 -04:00
2017-05-09 13:33:09 -04:00
[chart]: https://github.com/kubernetes/charts
[helm]: https://github.com/kubernetes/helm/blob/master/README.md