diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-13 13:26:31 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-13 13:26:31 +0000 |
commit | b7dfe2ae4054aa40e15182fd3c6cb7dd39f131db (patch) | |
tree | 5ab080ca9cadeb6cd9578bf301e4e9e8810bed9e /doc/user/clusters | |
parent | 25cb337cf12438169f1b14bc5dace8a06a7356e3 (diff) | |
download | gitlab-ce-b7dfe2ae4054aa40e15182fd3c6cb7dd39f131db.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/clusters')
-rw-r--r-- | doc/user/clusters/environments.md | 47 | ||||
-rw-r--r-- | doc/user/clusters/img/cluster_environments_table_v12_3.png | bin | 0 -> 126230 bytes |
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/user/clusters/environments.md b/doc/user/clusters/environments.md new file mode 100644 index 00000000000..4aef871af55 --- /dev/null +++ b/doc/user/clusters/environments.md @@ -0,0 +1,47 @@ +# Cluster Environments **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/13392) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.3. + +Cluster environments provide a consolidated view of which CI [environments](../../ci/environments.md) are +deployed to the Kubernetes cluster and it: + +- Shows the project and the relevant environment related to the deployment. +- Displays the status of the pods for that environment. + +## Overview + +NOTE: **Note:** +Cluster environments are only available for +[group-level clusters](../group/clusters/index.md). +Support for [instance-level](../instance/clusters/index.md) clusters is +[planned](https://gitlab.com/gitlab-org/gitlab-ce/issues/63985). + +With cluster environments, you can gain insight into: + +- Which projects are deployed to the cluster. +- How many pods are in use for each project's environment. +- The CI job that was used to deploy to that environment. + +![Cluster environments page](img/cluster_environments_table_v12_3.png) + +Access to cluster environments is restricted to [group maintainers and +owners](../permissions.md#group-members-permissions) + +## Usage + +In order to: + +- Track environments for the cluster, you must + [deploy to a Kubernetes cluster](../project/clusters/index.md#deploying-to-a-kubernetes-cluster) + successfully. +- Show pod usage correctly, you must + [enable Deploy Boards](../project/deploy_boards.md#enabling-deploy-boards). + +Once you have successful deployments to your group-level cluster: + +1. Navigate to your group's **Kubernetes** page. +1. Click on the **Environments** tab. + +NOTE: **Note:** +Only successful deployments to the cluster is included in this page. +Non-cluster environments will not be included. diff --git a/doc/user/clusters/img/cluster_environments_table_v12_3.png b/doc/user/clusters/img/cluster_environments_table_v12_3.png Binary files differnew file mode 100644 index 00000000000..52f232e2eb3 --- /dev/null +++ b/doc/user/clusters/img/cluster_environments_table_v12_3.png |