Merge branch 'jl-helm-polish-docs' into 'master'

Minor fixes for the Helm docs

See merge request gitlab-org/gitlab-ce!20078
This commit is contained in:
Mike Lewis 2018-06-22 18:48:49 +00:00
commit c1fa6f7c88
2 changed files with 10 additions and 9 deletions

View file

@ -32,7 +32,7 @@ Currently out of scope:
In order to deploy GitLab on Kubernetes, a few prerequisites are required. In order to deploy GitLab on Kubernetes, a few prerequisites are required.
1. `helm` and `kubectl` [installed on your computer](preparation/tools_installation.md). 1. `helm` and `kubectl` [installed on your computer](preparation/tools_installation.md).
1. A Kubernetes cluster, version 1.8 or higher. 4vCPU and 16GB of RAM is recommended. 1. A Kubernetes cluster, version 1.8 or higher. 6vCPU and 16GB of RAM is recommended.
* [Google GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-container-cluster) * [Google GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-container-cluster)
* [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) * [Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html)
* [Microsoft AKS](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal) * [Microsoft AKS](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal)
@ -64,7 +64,7 @@ run helm. In this example, we've named our helm release "gitlab".
``` ```
helm repo add gitlab https://charts.gitlab.io/ helm repo add gitlab https://charts.gitlab.io/
helm dependencies update helm update
helm upgrade --install gitlab gitlab/gitlab \ helm upgrade --install gitlab gitlab/gitlab \
--timeout 600 \ --timeout 600 \
--set global.hosts.domain=example.local \ --set global.hosts.domain=example.local \
@ -81,15 +81,16 @@ the deployment is taking place if you run the command in another terminal.
### Initial login ### Initial login
You can access the GitLab instance by visiting the domain specified during You can access the GitLab instance by visiting the domain name beginning with `gitlab.` followed by the domain specified during installation. From the example above, the URL would be `https://gitlab.example.local`.
installation. If you manually created the secret for initial root password, you
can use that to sign in as `root` user. If not, Gitlab would've automatically If you manually created the secret for initial root password, you
can use that to sign in as `root` user. If not, Gitlab automatically
created a random password for `root` user. This can be extracted by the created a random password for `root` user. This can be extracted by the
following command (replace `<name>` by name of the release - which is `gitlab` following command (replace `<name>` by name of the release - which is `gitlab`
if you used the command above) if you used the command above).
``` ```
kubectl get secret <name>-gitlab-initial-root-password -ojsonpath={.data.password} | base64 -d kubectl get secret <name>-gitlab-initial-root-password -ojsonpath={.data.password} | base64 --decode
``` ```
## Outgoing email ## Outgoing email

View file

@ -14,7 +14,7 @@ should be deployed, upgraded, and configured.
## Chart Overview ## Chart Overview
* **[GitLab Chart](https://gitlab.com/charts/gitlab/blob/master/README.md)**: The recommended GitLab chart, currently in beta. Support large deployments with horizontal scaling of individual GitLab components, and does not require NFS. * **[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.
* **[GitLab Runner Chart](gitlab_runner_chart.md)**: For deploying just the GitLab Runner. * **[GitLab Runner Chart](gitlab_runner_chart.md)**: For deploying just the GitLab Runner.
* Other Charts * Other Charts
* [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. * [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.
@ -26,7 +26,7 @@ should be deployed, upgraded, and configured.
The best way to operate GitLab on Kubernetes. This chart contains all the required components to get started, and can scale to large deployments. The best way to operate GitLab on Kubernetes. This chart contains all the required components to get started, and can scale to large deployments.
This chart includes a number of benefits: This chart offers a number of benefits:
* Horizontal scaling of individual components * Horizontal scaling of individual components
* No requirement for shared storage to scale * No requirement for shared storage to scale
* Containers do not need `root` permissions * Containers do not need `root` permissions