summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThong Kuah <tkuah@gitlab.com>2019-09-05 14:17:18 +1200
committerThong Kuah <tkuah@gitlab.com>2019-09-12 16:36:53 +1200
commit7265f7396c5f02fc5c78fd43c5fd174149d03ca5 (patch)
treecf837018f7d3547fb0145ff225a251d923646065
parenta24143b3597259e1dfb3bb795b1daf0c65aafd4e (diff)
downloadgitlab-ce-ce-cluster-environments-integration.tar.gz
Add Cluster Environments documentationce-cluster-environments-integration
This documents the GitLab Premium feature of Cluster environments
-rw-r--r--doc/user/clusters/environments.md47
-rw-r--r--doc/user/clusters/img/cluster_environments_table_v12_3.pngbin0 -> 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
new file mode 100644
index 00000000000..52f232e2eb3
--- /dev/null
+++ b/doc/user/clusters/img/cluster_environments_table_v12_3.png
Binary files differ