summaryrefslogtreecommitdiff
path: root/doc/project_services/kubernetes.md
diff options
context:
space:
mode:
authorNick Thomas <nick@gitlab.com>2016-12-19 19:18:16 +0000
committerNick Thomas <nick@gitlab.com>2016-12-19 21:27:08 +0000
commitd2212a8b5f2ebc25ab8a007aa09a728779dd9212 (patch)
treef75ac2697463f0fd61a0074655a21651265e3232 /doc/project_services/kubernetes.md
parent7b7781654e9c01f5928850df0daaf50fd1d89e8a (diff)
downloadgitlab-ce-d2212a8b5f2ebc25ab8a007aa09a728779dd9212.tar.gz
Add online terminal documentation
Diffstat (limited to 'doc/project_services/kubernetes.md')
-rw-r--r--doc/project_services/kubernetes.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/project_services/kubernetes.md b/doc/project_services/kubernetes.md
index fda364b864e..0c5c88dd983 100644
--- a/doc/project_services/kubernetes.md
+++ b/doc/project_services/kubernetes.md
@@ -47,3 +47,17 @@ GitLab CI build environment:
- `KUBE_TOKEN`
- `KUBE_NAMESPACE`
- `KUBE_CA_PEM` - only if a custom CA bundle was specified
+
+## Terminal support
+
+>**NOTE:**
+Added in GitLab 8.15. You must be the project owner or have `master` permissions
+to use terminals. Support is currently limited to the first container in the
+first pod of your environment.
+
+When enabled, the Kubernetes service adds online [terminal support](../ci/environments.md#terminal-support)
+to your environments. This is based on the `exec` functionality found in
+Docker and Kubernetes, so you get a new shell session within your existing
+containers. To use this integration, you should deploy to Kubernetes using
+the deployment variables above, ensuring any pods you create are labelled with
+`app=$CI_ENVIRONMENT_SLUG`.