diff options
author | DJ Mountney <david@twkie.net> | 2017-05-05 16:46:17 -0700 |
---|---|---|
committer | DJ Mountney <david@twkie.net> | 2017-05-05 16:46:17 -0700 |
commit | e67ad5708f38d4439abcc1ff98ef59a1b127de0c (patch) | |
tree | 518df1203651fbc83b1267b13d6e5f669877c9f6 | |
parent | a4c90a41958b1b7cc2a350054d7cc39933cfe3b9 (diff) | |
download | gitlab-ce-helm-documentation.tar.gz |
Add some WIP fileshelm-documentation
Very basic Readme, and an intro to the gitlab chart
-rw-r--r-- | doc/install/kubernetes/README.md | 26 | ||||
-rw-r--r-- | doc/install/kubernetes/gitlab-chart.md | 48 | ||||
-rw-r--r-- | doc/install/kubernetes/gitlab-runner-chart.md | 0 |
3 files changed, 74 insertions, 0 deletions
diff --git a/doc/install/kubernetes/README.md b/doc/install/kubernetes/README.md new file mode 100644 index 00000000000..b960aef538d --- /dev/null +++ b/doc/install/kubernetes/README.md @@ -0,0 +1,26 @@ +# GitLab Helm charts + +The GitLab Helm repository can be found at https://charts.gitlab.io + +## Add the GitLab Helm repository + +Adding the GitLab Helm repository to Helm can be done by running the following: + +```bash +helm repo add gitlab https://charts.gitlab.io +``` + +## Installing GitLab Helm Charts + + - Install GitLab + - Install GitLab Runner + +## Troubleshooting + +## GitLab Chart 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 diff --git a/doc/install/kubernetes/gitlab-chart.md b/doc/install/kubernetes/gitlab-chart.md new file mode 100644 index 00000000000..bfba1bd6125 --- /dev/null +++ b/doc/install/kubernetes/gitlab-chart.md @@ -0,0 +1,48 @@ +# GitLab Helm Chart + +The `gitlab` Helm chart installs GitLab into your Kubernetes cluster. + +This chart includes the following: + +- Deployment using the [gitlab-ce](https://hub.docker.com/r/gitlab/gitlab-ce) or [gitlab-ee](https://hub.docker.com/r/gitlab/gitlab-ee) container image +- ConfigMap containing the `gitlab.rb` contents that configure [GitLab Omnibus](https://docs.gitlab.com/omnibus/settings/configuration.html#configuration-options) +- Persistent Volume Claims for Data, Config, Logs, and Registry Storage +- Service +- Optional Redis Deployment using the [Redis Chart](https://github.com/kubernetes/charts/tree/master/stable/redis) (defaults to enabled) +- Optional PostgreSQL Deployment using the [PostgreSQL Chart](https://github.com/kubernetes/charts/tree/master/stable/postgresql) (defaults to enabled) +- Optional Ingress (defaults to disabled) + +## Installing + +## Prerequisites + +- _At least_ 3 GB of RAM available on your cluster, in chunks of 1 GB +- Kubernetes 1.4+ with Beta APIs enabled +- PV provisioner support in the underlying infrastructure +- The ability to point a DNS entry or URL at your GitLab install +- The Helm Server (Tiller) already installed and running in the cluster +- The KubeCtl CLI installed locally and authenticated for the cluster +- The Helm Client installed locally +- The GitLab Helm Repo added to your Helm Client [link] + +## Installing + +```bash +helm install --namepace <NAMEPACE> --name gitlab -f <CONFIG_VALUES_FILE> gitlab/gitlab +``` + +- `<NAMESPACE>` is the kubernetes namespace where you want to install GitLab +- `<CONFIG_VALUES_FILE>` is the path to values file containing your custom configuration. See [link] to create it. + +## Configuration + +Create a `values.yaml` file for your GitLab configuration. See [Helm docs](https://github.com/kubernetes/helm/blob/master/docs/chart_template_guide/values_files.md) +for information on how your values file will override the defaults. + +The default configuration can always be found in the [values.yaml](https://gitlab.com/charts/charts.gitlab.io/blob/master/charts/gitlab/values.yaml) in the chart repository + +### Required Configuration + +In order for the install to work at all, your config file needs to specify the following: + + - An `externalUrl` that GitLab will be reachable at. diff --git a/doc/install/kubernetes/gitlab-runner-chart.md b/doc/install/kubernetes/gitlab-runner-chart.md new file mode 100644 index 00000000000..e69de29bb2d --- /dev/null +++ b/doc/install/kubernetes/gitlab-runner-chart.md |