README.md 2.45 KB
Newer Older
Mark Pundsack's avatar
Mark Pundsack committed
1
2
## GitLab Helm Charts

Joshua Lambert's avatar
Joshua Lambert committed
3
4
5
This repository contains GitLab's official Helm charts. [Helm](https://helm.sh/) is a package manager for
Kubernetes, making it easier to deploy, upgrade, and maintain software like GitLab.
The charts are automatically published to our Helm repo, located at [charts.gitlab.io](https://charts.gitlab.io).
Mark Pundsack's avatar
Mark Pundsack committed
6

7
8
9
10
This repository currently has the following charts:

| Chart name   | Status       | Remark
|--------------|--------------|----------|
Joshua Lambert's avatar
Joshua Lambert committed
11
12
13
| gitlab-omnibus | Beta | Suitable for small to medium deployments, will be replaced by the [cloud native GitLab chart](#cloud-native-gitlab-chart). |
| gitlab-runner | GA | Deploys the GitLab CI/CD Runner. |
| gitlab       | Deprecated | Should not be used. |
14
| kubernetes-gitlab-demo | Deprecated | Should not be used. |
Joshua Lambert's avatar
Joshua Lambert committed
15
| auto-deploy-app | Beta | Used by [Auto DevOps](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/topics/autodevops/index.md). |
16

Joshua Lambert's avatar
Joshua Lambert committed
17
More information is available in our [chart documentation](https://docs.gitlab.com/ce/install/kubernetes/).
18

Joshua Lambert's avatar
Joshua Lambert committed
19
### Cloud Native GitLab Chart
20

Joshua Lambert's avatar
Joshua Lambert committed
21
22
We are building a cloud native GitLab chart in a separate repo at [helm.gitlab.io](https://gitlab.com/charts/helm.gitlab.io). The goal of that work
is to replace the `gitlab` and `gitlab-omnibus` charts in this repository as well as [the community supported charts](https://github.com/kubernetes/charts/tree/master/stable/gitlab-ce). We plan
Joshua Lambert's avatar
grammar    
Joshua Lambert committed
23
to launch the cloud native chart in this repository with the `gitlab` name once it is ready.
24

Joshua Lambert's avatar
Joshua Lambert committed
25
A migration will be required to move from the `gitlab-omnibus` chart to the cloud native GitLab chart. We plan for this to be accomplished by an upcoming [backup option](https://gitlab.com/charts/charts.gitlab.io/issues/27) for the current instance and restoring on the new one.
26

Mark Pundsack's avatar
Mark Pundsack committed
27
28
### Usage

29
30
31
To use the charts, the Helm tool must be installed and initialized. The best
place to start is by reviewing the [Helm Quick Start Guide](https://github.com/kubernetes/helm/blob/master/docs/quickstart.md).

32
Installation instructions, including configuration options, can be found in our [documentation](http://docs.gitlab.com/ce/install/kubernetes/).
33

34
35
36
37
38
39
40
### GitLab Helm Charts Issue Tracker

Issues related to the Charts can be logged at: <https://gitlab.com/charts/charts.gitlab.io/issues>

### Contributing to the Charts

We welcome contributions and improvements. The source repo for our Helm Charts can be found here: <https://gitlab.com/charts/charts.gitlab.io>
41
42

Please see the [contribution guidelines](CONTRIBUTING.md)