README.md 2.51 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
11
12
13
14
15
16
17
18
19
20
21
22
*Charts in this repository should be considered beta.*

This repository currently has the following charts:

| Chart name   | Status       | Remark
|--------------|--------------|----------|
| auto-deploy-app | Beta | Used for [Auto DevOps](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/topics/autodevops/index.md).|
| gitlab       | Deprecated | Should not be used, see [note](#cloud-native-charts) |
| gitlab-omnibus | Beta | Not suitable for production deploys. See [note](#cloud-native-charts). |
| kubernetes-gitlab-demo | Deprecated | Should not be used. |
| gitlab-runner | Beta | Not suitable for production deploys. See [note](#cloud-native-charts).|


### Cloud Native Charts

We are building a set of Cloud Native
23
charts at a separate repo at [helm.gitlab.io](https://gitlab.com/charts/helm.gitlab.io). The goal of that work
24
25
26
27
28
29
30
31
32
is to fully replace the charts in this repository as well as [the community supported charts](https://github.com/kubernetes/charts/tree/master/stable/gitlab-ce). Current plan
is to reuse the `gitlab` name once the Cloud Native charts are ready.

This means that Issues and Merge Requests for charts in this repository are handled
on a best-effort basis while the focus is on the Cloud Native charts effort.

> Note: One final item remains on the roadmap for gitlab-omnibus chart. Before
finally deprecating gitlab-omnibus chart in favor of Cloud Native chart, our goal
is to implement a [Backup solution](https://gitlab.com/charts/charts.gitlab.io/issues/27).
33

Mark Pundsack's avatar
Mark Pundsack committed
34
35
### Usage

36
37
38
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).

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

41
42
43
44
45
46
47
### 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>
48
49

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