index.md 33,4 КБ
Newer Older
Evan Read's avatar
Evan Read включено в состав коммита
1
# Kubernetes clusters
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
2

Evan Read's avatar
Evan Read включено в состав коммита
3
4
5
6
7
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/35954) in GitLab 10.1 for projects.
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/34758) in
>   GitLab 11.6 for [groups](../../group/clusters/index.md).
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/39840) in
>   GitLab 11.11 for [instances](../../instance/clusters/index.md).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
8

Evan Read's avatar
Evan Read включено в состав коммита
9
10
11
12
13
GitLab provides many features with a Kubernetes integration. Kubernetes can be
integrated with projects, but also:

- [Groups](../../group/clusters/index.md).
- [Instances](../../instance/clusters/index.md).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
14

Sarah Daily's avatar
Sarah Daily включено в состав коммита
15
16
17
NOTE: **Scalable app deployment with GitLab and Google Cloud Platform**
[Watch the webcast](https://about.gitlab.com/webcast/scalable-app-deploy/) and learn how to spin up a Kubernetes cluster managed by Google Cloud Platform (GCP) in a few clicks.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
18
19
## Overview

Evan Read's avatar
Evan Read включено в состав коммита
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
Using the GitLab project Kubernetes integration, you can:

- Use [Review Apps](../../../ci/review_apps/index.md).
- Run [pipelines](../../../ci/pipelines.md).
- [Deploy](#deploying-to-a-kubernetes-cluster) your applications.
- Detect and [monitor Kubernetes](#kubernetes-monitoring).
- Use it with [Auto DevOps](#auto-devops).
- Use [Web terminals](#web-terminals).
- Use [Deploy Boards](#deploy-boards-premium). **(PREMIUM)**
- Use [Canary Deployments](#canary-deployments-premium). **(PREMIUM)**
- View [Pod logs](#pod-logs-ultimate). **(ULTIMATE)**

You can also:

- Connect and deploy to an [Amazon EKS cluster](eks_and_gitlab/index.html).
- Run serverless workloads on [Kubernetes with Knative](serverless/index.md).

### Deploy Boards **(PREMIUM)**

GitLab's Deploy Boards offer a consolidated view of the current health and
status of each CI [environment](../../../ci/environments.md) running on Kubernetes,
displaying the status of the pods in the deployment. Developers and other
teammates can view the progress and status of a rollout, pod by pod, in the
workflow they already use without any need to access Kubernetes.

[Read more about Deploy Boards](../deploy_boards.md)

### Canary Deployments **(PREMIUM)**

Leverage [Kubernetes' Canary deployments](https://kubernetes.io/docs/concepts/cluster-administration/manage-deployment/#canary-deployments)
and visualize your canary deployments right inside the Deploy Board, without
the need to leave GitLab.

[Read more about Canary Deployments](../canary_deployments.md)

### Pod logs **(ULTIMATE)**

GitLab makes it easy to view the logs of running pods in connected Kubernetes clusters. By displaying the logs directly in GitLab, developers can avoid having to manage console tools or jump to a different interface.

[Read more about Kubernetes pod logs](kubernetes_pod_logs.md)

### Kubernetes monitoring
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
62

Evan Read's avatar
Evan Read включено в состав коммита
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Automatically detect and monitor Kubernetes metrics. Automatic monitoring of
[NGINX ingress](../integrations/prometheus_library/nginx.md) is also supported.

[Read more about Kubernetes monitoring](../integrations/prometheus_library/kubernetes.md)

### Auto DevOps

Auto DevOps automatically detects, builds, tests, deploys, and monitors your
applications.

To make full use of Auto DevOps(Auto Deploy, Auto Review Apps, and Auto Monitoring)
you will need the Kubernetes project integration enabled.

[Read more about Auto DevOps](../../../topics/autodevops/index.md)

Evan Read's avatar
Evan Read включено в состав коммита
78
79
80
NOTE: **Note**
Kubernetes clusters can be used without Auto DevOps.

Evan Read's avatar
Evan Read включено в состав коммита
81
### Web terminals
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
82

Thong Kuah's avatar
Thong Kuah включено в состав коммита
83
NOTE: **Note:**
Evan Read's avatar
Evan Read включено в состав коммита
84
85
86
87
88
89
90
91
92
93
Introduced in GitLab 8.15. You must be the project owner or have `maintainer` permissions
to use terminals. Support is limited to the first container in the
first pod of your environment.

When enabled, the Kubernetes service adds [web terminal](../../../ci/environments.md#web-terminals)
support to your [environments](../../../ci/environments.md). 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 deployments, replica sets, and
pods are annotated with:
Thong Kuah's avatar
Thong Kuah включено в состав коммита
94

Evan Read's avatar
Evan Read включено в состав коммита
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
- `app.gitlab.com/env: $CI_ENVIRONMENT_SLUG`
- `app.gitlab.com/app: $CI_PROJECT_PATH_SLUG`

`$CI_ENVIRONMENT_SLUG` and `$CI_PROJECT_PATH_SLUG` are the values of
the CI variables.

## Adding and removing clusters

There are two options when adding a new cluster to your project:

- Associate your account with Google Kubernetes Engine (GKE) to
  [create new clusters](#add-new-gke-cluster) from within GitLab.
- Provide credentials to an
  [existing Kubernetes cluster](#add-existing-kubernetes-cluster).

### Add new GKE cluster
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
111

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
112
113
114
115
116
TIP: **Tip:**
Every new Google Cloud Platform (GCP) account receives [$300 in credit upon sign up](https://console.cloud.google.com/freetrial),
and in partnership with Google, GitLab is able to offer an additional $200 for new GCP accounts to get started with GitLab's
Google Kubernetes Engine Integration. All you have to do is [follow this link](https://goo.gl/AaJzRW) and apply for credit.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
117
NOTE: **Note:**
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
118
119
120
121
The [Google authentication integration](../../../integration/google.md) must
be enabled in GitLab at the instance level. If that's not the case, ask your
GitLab administrator to enable it. On GitLab.com, this is enabled.

Evan Read's avatar
Evan Read включено в состав коммита
122
#### Requirements
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
123
124
125
126
127
128

Before creating your first cluster on Google Kubernetes Engine with GitLab's
integration, make sure the following requirements are met:

- A [billing account](https://cloud.google.com/billing/docs/how-to/manage-billing-account)
  is set up and you have permissions to access it.
Daniel Gruesso's avatar
Daniel Gruesso включено в состав коммита
129
- The Kubernetes Engine API and related service are enabled. It should work immediately but may take up to 10 minutes after you create a project. For more information see the
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
130
131
  ["Before you begin" section of the Kubernetes Engine docs](https://cloud.google.com/kubernetes-engine/docs/quickstart#before-you-begin).

Evan Read's avatar
Evan Read включено в состав коммита
132
#### Creating the cluster
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
133

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
134
If all of the above requirements are met, you can proceed to create and add a
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
135
new Kubernetes cluster to your project:
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
136

Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
137
1. Navigate to your project's **Operations > Kubernetes** page.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
138

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
139
   NOTE: **Note:**
Evan Read's avatar
Evan Read включено в состав коммита
140
   You need Maintainer [permissions](../../permissions.md) and above to access the Kubernetes page.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
141

Mike Lewis's avatar
Mike Lewis включено в состав коммита
142
143
1. Click **Add Kubernetes cluster**.
1. Click **Create with Google Kubernetes Engine**.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
144
145
1. Connect your Google account if you haven't done already by clicking the
   **Sign in with Google** button.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
146
1. From there on, choose your cluster's settings:
Brett Walker's avatar
Brett Walker включено в состав коммита
147
   - **Kubernetes cluster name** - The name you wish to give the cluster.
Gareth Davies's avatar
Gareth Davies включено в состав коммита
148
   - **Environment scope** - The [associated environment](#setting-the-environment-scope-premium) to this cluster.
Brett Walker's avatar
Brett Walker включено в состав коммита
149
150
151
152
153
154
155
156
   - **Google Cloud Platform project** - Choose the project you created in your GCP
     console that will host the Kubernetes cluster. Learn more about
     [Google Cloud Platform projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects).
   - **Zone** - Choose the [region zone](https://cloud.google.com/compute/docs/regions-zones/)
     under which the cluster will be created.
   - **Number of nodes** - Enter the number of nodes you wish the cluster to have.
   - **Machine type** - The [machine type](https://cloud.google.com/compute/docs/machine-types)
     of the Virtual Machine instance that the cluster will be based on.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
157
   - **GitLab-managed cluster** - Leave this checked if you want GitLab to manage namespaces and service accounts for this cluster. See the [Managed clusters section](#gitlab-managed-clusters) for more information.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
158
1. Finally, click the **Create Kubernetes cluster** button.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
159

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
160
161
After a couple of minutes, your cluster will be ready to go. You can now proceed
to install some [pre-defined applications](#installing-applications).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
162

Thong Kuah's avatar
Thong Kuah включено в состав коммита
163
164
165
166
167
168
169
170
NOTE: **Note:**
GitLab requires basic authentication enabled and a client certificate issued for
the cluster in order to setup an [initial service
account](#access-controls). Starting from [GitLab
11.10](https://gitlab.com/gitlab-org/gitlab-ce/issues/58208), the cluster
creation process will explicitly request that basic authentication and
client certificate is enabled.

Hordur Freyr Yngvason's avatar
Hordur Freyr Yngvason включено в состав коммита
171
172
173
NOTE: **Note:**
Starting from [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-ce/issues/55902), all GKE clusters created by GitLab are RBAC enabled. Take a look at the [RBAC section](#rbac-cluster-resources) for more information.

Evan Read's avatar
Evan Read включено в состав коммита
174
### Add existing Kubernetes cluster
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
175

Alexander Tanayno's avatar
Alexander Tanayno включено в состав коммита
176
177
178
NOTE: **Note:**
Kubernetes integration is not supported for arm64 clusters. See the issue [Helm Tiller fails to install on arm64 cluster](https://gitlab.com/gitlab-org/gitlab-ce/issues/64044) for details.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
179
To add an existing Kubernetes cluster to your project:
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
180

Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
181
1. Navigate to your project's **Operations > Kubernetes** page.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
182

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
183
   NOTE: **Note:**
Evan Read's avatar
Evan Read включено в состав коммита
184
   You need Maintainer [permissions](../../permissions.md) and above to access the Kubernetes page.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
185

Mike Lewis's avatar
Mike Lewis включено в состав коммита
186
187
1. Click **Add Kubernetes cluster**.
1. Click **Add an existing Kubernetes cluster** and fill in the details:
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
188
189
190
191
192
193
194
195
196
197
198
199
200
201
   - **Kubernetes cluster name** (required) - The name you wish to give the cluster.
   - **Environment scope** (required) - The
     [associated environment](#setting-the-environment-scope-premium) to this cluster.
   - **API URL** (required) -
     It's the URL that GitLab uses to access the Kubernetes API. Kubernetes
     exposes several APIs, we want the "base" URL that is common to all of them,
     e.g., `https://kubernetes.example.com` rather than `https://kubernetes.example.com/api/v1`.

     Get the API URL by running this command:

     ```sh
     kubectl cluster-info | grep 'Kubernetes master' | awk '/http/ {print $NF}'
     ```

Daniel Gruesso's avatar
Daniel Gruesso включено в состав коммита
202
   - **CA certificate** (required) - A valid Kubernetes certificate is needed to authenticate to the cluster. We will use the certificate created by default.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
     - List the secrets with `kubectl get secrets`, and one should named similar to
      `default-token-xxxxx`. Copy that token name for use below.
     - Get the certificate by running this command:

     ```sh
     kubectl get secret <secret name> -o jsonpath="{['data']['ca\.crt']}" | base64 --decode
     ```

   - **Token** -
     GitLab authenticates against Kubernetes using service tokens, which are
     scoped to a particular `namespace`.
     **The token used should belong to a service account with
     [`cluster-admin`](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles)
     privileges.** To create this service account:

     1. Create a file called `gitlab-admin-service-account.yaml` with contents:

        ```yaml
        apiVersion: v1
        kind: ServiceAccount
        metadata:
          name: gitlab-admin
          namespace: kube-system
        ---
        apiVersion: rbac.authorization.k8s.io/v1beta1
        kind: ClusterRoleBinding
        metadata:
          name: gitlab-admin
        roleRef:
          apiGroup: rbac.authorization.k8s.io
          kind: ClusterRole
          name: cluster-admin
        subjects:
        - kind: ServiceAccount
          name: gitlab-admin
          namespace: kube-system
        ```

     1. Apply the service account and cluster role binding to your cluster:

        ```bash
        kubectl apply -f gitlab-admin-service-account.yaml
        ```

        Output:

        ```bash
        serviceaccount "gitlab-admin" created
        clusterrolebinding "gitlab-admin" created
        ```

     1. Retrieve the token for the `gitlab-admin` service account:

        ```bash
        kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep gitlab-admin | awk '{print $1}')
        ```

        Copy the `<authentication_token>` value from the output:

        ```yaml
        Name:         gitlab-admin-token-b5zv4
        Namespace:    kube-system
        Labels:       <none>
        Annotations:  kubernetes.io/service-account.name=gitlab-admin
                      kubernetes.io/service-account.uid=bcfe66ac-39be-11e8-97e8-026dce96b6e8

        Type:  kubernetes.io/service-account-token

        Data
        ====
        ca.crt:     1025 bytes
        namespace:  11 bytes
        token:      <authentication_token>
        ```

     NOTE: **Note:**
     For GKE clusters, you will need the
     `container.clusterRoleBindings.create` permission to create a cluster
     role binding. You can follow the [Google Cloud
     documentation](https://cloud.google.com/iam/docs/granting-changing-revoking-access)
     to grant access.

   - **GitLab-managed cluster** - Leave this checked if you want GitLab to manage namespaces and service accounts for this cluster. See the [Managed clusters section](#gitlab-managed-clusters) for more information.

   - **Project namespace** (optional) - You don't have to fill it in; by leaving
     it blank, GitLab will create one for you. Also:
     - Each project should have a unique namespace.
     - The project namespace is not necessarily the namespace of the secret, if
       you're using a secret with broader permissions, like the secret from `default`.
     - You should **not** use `default` as the project namespace.
     - If you or someone created a secret specifically for the project, usually
       with limited permissions, the secret's namespace and project namespace may
       be the same.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
296

Pascal Borreli's avatar
Pascal Borreli включено в состав коммита
297
1. Finally, click the **Create Kubernetes cluster** button.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
298

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
299
300
After a couple of minutes, your cluster will be ready to go. You can now proceed
to install some [pre-defined applications](#installing-applications).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
301

Evan Read's avatar
Evan Read включено в состав коммита
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
### Enabling or disabling integration

After you have successfully added your cluster information, you can enable the
Kubernetes cluster integration:

1. Click the **Enabled/Disabled** switch
1. Hit **Save** for the changes to take effect

To disable the Kubernetes cluster integration, follow the same procedure.

### Removing integration

NOTE: **Note:**
You need Maintainer [permissions](../../permissions.md) and above to remove a Kubernetes cluster integration.

NOTE: **Note:**
When you remove a cluster, you only remove its relation to GitLab, not the
cluster itself. To remove the cluster, you can do so by visiting the GKE
dashboard or using `kubectl`.

To remove the Kubernetes cluster integration from your project, simply click the
**Remove integration** button. You will then be able to follow the procedure
and add a Kubernetes cluster again.

## Cluster configuration

This section covers important considerations for configuring Kubernetes
clusters with GitLab.

### Security implications
332
333
334
335
336
337
338

CAUTION: **Important:**
The whole cluster security is based on a model where [developers](../../permissions.md)
are trusted, so **only trusted users should be allowed to control your clusters**.

The default cluster configuration grants access to a wide set of
functionalities needed to successfully build and deploy a containerized
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
339
application. Bear in mind that the same credentials are used for all the
340
341
applications running on the cluster.

Evan Read's avatar
Evan Read включено в состав коммита
342
### GitLab-managed clusters
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22011) in GitLab 11.5.
> Became [optional](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/26565) in GitLab 11.11.

You can choose to allow GitLab to manage your cluster for you. If your cluster is
managed by GitLab, resources for your projects will be automatically created. See the
[Access controls](#access-controls) section for details on which resources will
be created.

If you choose to manage your own cluster, project-specific resources will not be created
automatically. If you are using [Auto DevOps](../../../topics/autodevops/index.md), you will
need to explicitly provide the `KUBE_NAMESPACE` [deployment variable](#deployment-variables)
that will be used by your deployment jobs, otherwise a namespace will be created for you.

NOTE: **Note:**
If you [install applications](#installing-applications) on your cluster, GitLab will create
the resources required to run these even if you have chosen to manage your own cluster.

Evan Read's avatar
Evan Read включено в состав коммита
361
### Base domain
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
362

Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
363
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/24580) in GitLab 11.8.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
364

Daniel Gruesso's avatar
Daniel Gruesso включено в состав коммита
365
366
367
368
369
370
371
372
373
374
NOTE: **Note:**
You do not need to specify a base domain on cluster settings when using GitLab Serverless. The domain in that case
will be specified as part of the Knative installation. See [Installing Applications](#installing-applications).

Specifying a base domain will automatically set `KUBE_INGRESS_BASE_DOMAIN` as an environment variable.
If you are using [Auto DevOps](../../../topics/autodevops/index.md), this domain will be used for the different
stages. For example, Auto Review Apps and Auto Deploy.

The domain should have a wildcard DNS configured to the Ingress IP address. After ingress has been installed (see [Installing Applications](#installing-applications)),
you can either:
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
375

Daniel Gruesso's avatar
Daniel Gruesso включено в состав коммита
376
377
- Create an `A` record that points to the Ingress IP address with your domain provider.
- Enter a wildcard DNS address using a service such as nip.io or xip.io. For example, `192.168.1.1.xip.io`.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
378

Evan Read's avatar
Evan Read включено в состав коммита
379
### Access controls
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
380

Evan Read's avatar
Evan Read включено в состав коммита
381
When creating a cluster in GitLab, you will be asked if you would like to create either:
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
382

Evan Read's avatar
Evan Read включено в состав коммита
383
384
- An [Attribute-based access control (ABAC)](https://kubernetes.io/docs/admin/authorization/abac/) cluster.
- A [Role-based access control (RBAC)](https://kubernetes.io/docs/admin/authorization/rbac/) cluster.
Evan Read's avatar
Evan Read включено в состав коммита
385

Evan Read's avatar
Evan Read включено в состав коммита
386
387
NOTE: **Note:**
[RBAC](#rbac-cluster-resources) is recommended and the GitLab default.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
388

Evan Read's avatar
Evan Read включено в состав коммита
389
GitLab creates the necessary service accounts and privileges to install and run
Tiger Watson's avatar
Tiger Watson включено в состав коммита
390
391
392
[GitLab managed applications](#installing-applications). When GitLab creates the cluster,
a `gitlab` service account with `cluster-admin` privileges is created in the `default` namespace
to manage the newly created cluster.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
393
394
395
396

  NOTE: **Note:**
  Restricted service account for deployment was [introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/51716) in GitLab 11.5.

Evan Read's avatar
Evan Read включено в состав коммита
397
398
399
400
401
402
403
When you install Helm into your cluster, the `tiller` service account
is created with `cluster-admin` privileges in the `gitlab-managed-apps`
namespace. This service account will be added to the installed Helm Tiller and will
be used by Helm to install and run [GitLab managed applications](#installing-applications).
Helm will also create additional service accounts and other resources for each
installed application. Consult the documentation of the Helm charts for each application
for details.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
404

Evan Read's avatar
Evan Read включено в состав коммита
405
If you are [adding an existing Kubernetes cluster](#add-existing-kubernetes-cluster),
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
406
407
ensure the token of the account has administrator privileges for the cluster.

Evan Read's avatar
Evan Read включено в состав коммита
408
409
The resources created by GitLab differ depending on the type of cluster.

Evan Read's avatar
Evan Read включено в состав коммита
410
#### ABAC cluster resources
Evan Read's avatar
Evan Read включено в состав коммита
411
412

GitLab creates the following resources for ABAC clusters.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
413

Tiger Watson's avatar
Tiger Watson включено в состав коммита
414
415
416
417
418
419
420
421
422
| Name                  | Type                 | Details                              | Created when               |
|:----------------------|:---------------------|:-------------------------------------|:---------------------------|
| `gitlab`              | `ServiceAccount`     | `default` namespace                         | Creating a new GKE Cluster |
| `gitlab-token`        | `Secret`             | Token for `gitlab` ServiceAccount           | Creating a new GKE Cluster |
| `tiller`              | `ServiceAccount`     | `gitlab-managed-apps` namespace             | Installing Helm Tiller     |
| `tiller-admin`        | `ClusterRoleBinding` | `cluster-admin` roleRef                     | Installing Helm Tiller     |
| Environment namespace | `Namespace`          | Contains all environment-specific resources | Deploying to a cluster     |
| Environment namespace | `ServiceAccount`     | Uses namespace of environment               | Deploying to a cluster     |
| Environment namespace | `Secret`             | Token for environment ServiceAccount        | Deploying to a cluster     |
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
423

Evan Read's avatar
Evan Read включено в состав коммита
424
#### RBAC cluster resources
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
425

Evan Read's avatar
Evan Read включено в состав коммита
426
GitLab creates the following resources for RBAC clusters.
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
427

Tiger Watson's avatar
Tiger Watson включено в состав коммита
428
429
430
431
432
433
434
435
436
437
438
439
440
441
| Name                  | Type                 | Details                                                                                                    | Created when               |
|:----------------------|:---------------------|:-----------------------------------------------------------------------------------------------------------|:---------------------------|
| `gitlab`              | `ServiceAccount`     | `default` namespace                                                                                        | Creating a new GKE Cluster |
| `gitlab-admin`        | `ClusterRoleBinding` | [`cluster-admin`](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) roleRef | Creating a new GKE Cluster |
| `gitlab-token`        | `Secret`             | Token for `gitlab` ServiceAccount                                                                          | Creating a new GKE Cluster |
| `tiller`              | `ServiceAccount`     | `gitlab-managed-apps` namespace                                                                            | Installing Helm Tiller     |
| `tiller-admin`        | `ClusterRoleBinding` | `cluster-admin` roleRef                                                                                    | Installing Helm Tiller     |
| Environment namespace | `Namespace`          | Contains all environment-specific resources                                                                | Deploying to a cluster     |
| Environment namespace | `ServiceAccount`     | Uses namespace of environment                                                                              | Deploying to a cluster     |
| Environment namespace | `Secret`             | Token for environment ServiceAccount                                                                       | Deploying to a cluster     |
| Environment namespace | `RoleBinding`        | [`edit`](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) roleRef          | Deploying to a cluster     |

NOTE: **Note:**
Environment-specific resources are only created if your cluster is [managed by GitLab](#gitlab-managed-clusters).
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
442
443

NOTE: **Note:**
Tiger Watson's avatar
Tiger Watson включено в состав коммита
444
If your cluster was created before GitLab 12.2, it will use a single namespace for all project environments.
Thong Kuah's avatar
Thong Kuah включено в состав коммита
445

Evan Read's avatar
Evan Read включено в состав коммита
446
#### Security of GitLab Runners
447
448
449

GitLab Runners have the [privileged mode](https://docs.gitlab.com/runner/executors/docker.html#the-privileged-mode)
enabled by default, which allows them to execute special commands and running
Evan Read's avatar
Evan Read включено в состав коммита
450
451
Docker in Docker. This functionality is needed to run some of the
[Auto DevOps](../../../topics/autodevops/index.md)
452
453
454
455
456
457
458
459
jobs. This implies the containers are running in privileged mode and you should,
therefore, be aware of some important details.

The privileged flag gives all capabilities to the running container, which in
turn can do almost everything that the host can do. Be aware of the
inherent security risk associated with performing `docker run` operations on
arbitrary images as they effectively have root access.

Evan Read's avatar
Evan Read включено в состав коммита
460
461
462
463
464
465
466
467
468
If you don't want to use GitLab Runner in privileged mode, either:

- Use shared Runners on GitLab.com. They don't have this security issue.
- Set up your own Runners using configuration described at
  [Shared Runners](../../gitlab_com/index.md#shared-runners). This involves:
  1. Making sure that you don't have it installed via
     [the applications](#installing-applications).
  1. Installing a Runner
     [using `docker+machine`](https://docs.gitlab.com/runner/executors/docker_machine.html).
469

Evan Read's avatar
Evan Read включено в состав коммита
470
471
472
473
### Setting the environment scope **(PREMIUM)**

When adding more than one Kubernetes cluster to your project, you need to differentiate
them with an environment scope. The environment scope associates clusters with [environments](../../../ci/environments.md) similar to how the
Hordur Freyr Yngvason's avatar
Hordur Freyr Yngvason включено в состав коммита
474
[environment-specific variables](../../../ci/variables/README.md#limiting-environment-scopes-of-environment-variables) work.
Evan Read's avatar
Evan Read включено в состав коммита
475
476
477
478
479
480
481
482
483
484
485
486
487

The default environment scope is `*`, which means all jobs, regardless of their
environment, will use that cluster. Each scope can only be used by a single
cluster in a project, and a validation error will occur if otherwise.
Also, jobs that don't have an environment keyword set will not be able to access any cluster.

For example, let's say the following Kubernetes clusters exist in a project:

| Cluster     | Environment scope |
| ----------- | ----------------- |
| Development | `*`               |
| Production  | `production`      |

Evan Read's avatar
Evan Read включено в состав коммита
488
489
And the following environments are set in
[`.gitlab-ci.yml`](../../../ci/yaml/README.md):
Evan Read's avatar
Evan Read включено в состав коммита
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516

```yaml
stages:
- test
- deploy

test:
  stage: test
  script: sh test

deploy to staging:
  stage: deploy
  script: make deploy
  environment:
    name: staging
    url: https://staging.example.com/

deploy to production:
  stage: deploy
  script: make deploy
  environment:
    name: production
    url: https://example.com/
```

The result will then be:

Evan Read's avatar
Evan Read включено в состав коммита
517
518
519
520
521
522
- The Development cluster details will be available in the `deploy to staging`
  job.
- The production cluster details will be available in the `deploy to production`
  job.
- No cluster details will be available in the `test` job because it doesn't
  define any environment.
Evan Read's avatar
Evan Read включено в состав коммита
523
524
525
526
527
528
529
530
531
532
533
534
535

### Multiple Kubernetes clusters **(PREMIUM)**

> Introduced in [GitLab Premium](https://about.gitlab.com/pricing/) 10.3.

With GitLab Premium, you can associate more than one Kubernetes cluster to your
project. That way you can have different clusters for different environments,
like dev, staging, production, etc.

Simply add another cluster, like you did the first time, and make sure to
[set an environment scope](#setting-the-environment-scope-premium) that will
differentiate the new cluster with the rest.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
536
537
## Installing applications

Thong Kuah's avatar
Thong Kuah включено в состав коммита
538
539
540
541
GitLab can install and manage some applications in your project-level
cluster. For more information on installing, upgrading, uninstalling,
and troubleshooting applications for your project cluster, see
[Gitlab Managed Apps](../../clusters/applications.md).
Alexander Strachan's avatar
Alexander Strachan включено в состав коммита
542

Evan Read's avatar
Evan Read включено в состав коммита
543
### Getting the external endpoint
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
544
545

NOTE: **Note:**
Dylan Griffith's avatar
Dylan Griffith включено в состав коммита
546
With the following procedure, a load balancer must be installed in your cluster
walkafwalka's avatar
walkafwalka включено в состав коммита
547
to obtain the endpoint. You can use either
Dylan Griffith's avatar
Dylan Griffith включено в состав коммита
548
549
[Ingress](#installing-applications), or Knative's own load balancer
([Istio](https://istio.io)) if using [Knative](#installing-applications).
Chris Baumbauer's avatar
Chris Baumbauer включено в состав коммита
550

walkafwalka's avatar
walkafwalka включено в состав коммита
551
552
In order to publish your web application, you first need to find the endpoint which will be either an IP
address or a hostname associated with your load balancer.
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
553

Evan Read's avatar
Evan Read включено в состав коммита
554
#### Automatically determining the external endpoint
Dylan Griffith's avatar
Dylan Griffith включено в состав коммита
555
556
557

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17052) in GitLab 10.6.

Evan Read's avatar
Evan Read включено в состав коммита
558
559
560
561
562
563
564
565
566
567
After you install [Ingress or Knative](#installing-applications), Gitlab attempts to determine the external endpoint
and it should be available within a few minutes. If the endpoint doesn't appear
and your cluster runs on Google Kubernetes Engine:

1. Check your [Kubernetes cluster on Google Kubernetes Engine](https://console.cloud.google.com/kubernetes) to ensure there are no errors on its nodes.
1. Ensure you have enough [Quotas](https://console.cloud.google.com/iam-admin/quotas) on Google Kubernetes Engine. For more information, see [Resource Quotas](https://cloud.google.com/compute/quotas).
1. Check [Google Cloud's Status](https://status.cloud.google.com/) to ensure they are not having any disruptions.

If GitLab is still unable to determine the endpoint of your Ingress or Knative application, you can
manually determine it by following the steps below.
Dylan Griffith's avatar
Dylan Griffith включено в состав коммита
568

Evan Read's avatar
Evan Read включено в состав коммита
569
#### Manually determining the external endpoint
Dylan Griffith's avatar
Dylan Griffith включено в состав коммита
570

Mike Lewis's avatar
Mike Lewis включено в состав коммита
571
If the cluster is on GKE, click the **Google Kubernetes Engine** link in the
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
572
573
**Advanced settings**, or go directly to the
[Google Kubernetes Engine dashboard](https://console.cloud.google.com/kubernetes/)
Mike Lewis's avatar
Mike Lewis включено в состав коммита
574
and select the proper project and cluster. Then click **Connect** and execute
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
575
576
577
578
the `gcloud` command in a local terminal or using the **Cloud Shell**.

If the cluster is not on GKE, follow the specific instructions for your
Kubernetes provider to configure `kubectl` with the right credentials.
walkafwalka's avatar
walkafwalka включено в состав коммита
579
The output of the following examples will show the external endpoint of your
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
580
581
cluster. This information can then be used to set up DNS entries and forwarding
rules that allow external access to your deployed applications.
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
582

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
583
584
If you installed the Ingress [via the **Applications**](#installing-applications),
run the following command:
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
585
586

```bash
walkafwalka's avatar
walkafwalka включено в состав коммита
587
kubectl get service --namespace=gitlab-managed-apps ingress-nginx-ingress-controller -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
588
589
```

walkafwalka's avatar
walkafwalka включено в состав коммита
590
Some Kubernetes clusters return a hostname instead, like [Amazon EKS](https://aws.amazon.com/eks/). For these platforms, run:
danielgruesso's avatar
danielgruesso включено в состав коммита
591

Chris Baumbauer's avatar
Chris Baumbauer включено в состав коммита
592
```bash
walkafwalka's avatar
walkafwalka включено в состав коммита
593
kubectl get service --namespace=gitlab-managed-apps ingress-nginx-ingress-controller -o jsonpath='{.status.loadBalancer.ingress[0].hostname}'
Chris Baumbauer's avatar
Chris Baumbauer включено в состав коммита
594
595
```

walkafwalka's avatar
walkafwalka включено в состав коммита
596
For Istio/Knative, the command will be different:
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
597
598

```bash
walkafwalka's avatar
walkafwalka включено в состав коммита
599
kubectl get svc --namespace=istio-system knative-ingressgateway -o jsonpath='{.status.loadBalancer.ingress[0].ip} '
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
600
601
```

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
602
Otherwise, you can list the IP addresses of all load balancers:
Joshua Lambert's avatar
Joshua Lambert включено в состав коммита
603

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
604
605
606
```bash
kubectl get svc --all-namespaces -o jsonpath='{range.items[?(@.status.loadBalancer.ingress)]}{.status.loadBalancer.ingress[*].ip} '
```
Fabio Busatto's avatar
Fabio Busatto включено в состав коммита
607

Evan Read's avatar
Evan Read включено в состав коммита
608
#### Using a static IP
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
609
610
611
612
613
614
615

By default, an ephemeral external IP address is associated to the cluster's load
balancer. If you associate the ephemeral IP with your DNS and the IP changes,
your apps will not be able to be reached, and you'd have to change the DNS
record again. In order to avoid that, you should change it into a static
reserved IP.

Mike Lewis's avatar
Mike Lewis включено в состав коммита
616
Read how to [promote an ephemeral external IP address in GKE](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address#promote_ephemeral_ip).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
617

Evan Read's avatar
Evan Read включено в состав коммита
618
#### Pointing your DNS at the external endpoint
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
619

walkafwalka's avatar
walkafwalka включено в состав коммита
620
621
622
623
Once you've set up the external endpoint, you should associate it with a [wildcard DNS
record](https://en.wikipedia.org/wiki/Wildcard_DNS_record) such as `*.example.com.`
in order to be able to reach your apps. If your external endpoint is an IP address,
use an A record. If your external endpoint is a hostname, use a CNAME record.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
624

Evan Read's avatar
Evan Read включено в состав коммита
625
## Deploying to a Kubernetes cluster
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
626

Evan Read's avatar
Evan Read включено в состав коммита
627
628
629
630
631
632
633
634
635
636
A Kubernetes cluster can be the destination for a deployment job. If

- The cluster is integrated with GitLab, special
  [deployment variables](#deployment-variables) are made available to your job
  and configuration is not required. You can immediately begin interacting with
  the cluster from your jobs using tools such as `kubectl` or `helm`.
- You don't use GitLab's cluster integration you can still deploy to your
  cluster. However, you will need configure Kubernetes tools yourself
  using [environment variables](../../../ci/variables/README.md#creating-a-custom-environment-variable)
  before you can interact with the cluster from your jobs.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
637

Evan Read's avatar
Evan Read включено в состав коммита
638
### Deployment variables
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
639
640

The Kubernetes cluster integration exposes the following
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
641
[deployment variables](../../../ci/variables/README.md#deployment-environment-variables) in the
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
642
643
644
645
646
GitLab CI/CD build environment.

| Variable | Description |
| -------- | ----------- |
| `KUBE_URL` | Equal to the API URL. |
Tiger Watson's avatar
Tiger Watson включено в состав коммита
647
648
| `KUBE_TOKEN` | The Kubernetes token of the [environment service account](#access-controls). |
| `KUBE_NAMESPACE` | The Kubernetes namespace is auto-generated if not specified. The default value is `<project_name>-<project_id>-<environment>`. You can overwrite it to use different one if needed, otherwise the `KUBE_NAMESPACE` variable will receive the default value. |
Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
649
650
| `KUBE_CA_PEM_FILE` | Path to a file containing PEM data. Only present if a custom CA bundle was specified. |
| `KUBE_CA_PEM` | (**deprecated**) Raw PEM data. Only if a custom CA bundle was specified. |
🤖 GitLab Bot 🤖's avatar
🤖 GitLab Bot 🤖 включено в состав коммита
651
| `KUBECONFIG` | Path to a file containing `kubeconfig` for this deployment. CA bundle would be embedded if specified. This config also embeds the same token defined in `KUBE_TOKEN` so you likely will only need this variable. This variable name is also automatically picked up by `kubectl` so you won't actually need to reference it explicitly if using `kubectl`. |
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
652
| `KUBE_INGRESS_BASE_DOMAIN` | From GitLab 11.8, this variable can be used to set a domain per cluster. See [cluster domains](#base-domain) for more information. |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
653

Mayra Cabrera's avatar
Mayra Cabrera включено в состав коммита
654
655
656
657
NOTE: **NOTE:**
Prior to GitLab 11.5, `KUBE_TOKEN` was the Kubernetes token of the main
service account of the cluster integration.

Tiger Watson's avatar
Tiger Watson включено в состав коммита
658
659
660
NOTE: **Note:**
If your cluster was created before GitLab 12.2, default `KUBE_NAMESPACE` will be set to `<project_name>-<project_id>`.

Evan Read's avatar
Evan Read включено в состав коммита
661
### Troubleshooting
🤖 GitLab Bot 🤖's avatar
🤖 GitLab Bot 🤖 включено в состав коммита
662

Evan Read's avatar
Evan Read включено в состав коммита
663
664
665
666
667
Before the deployment jobs starts, GitLab creates the following specifically for
the deployment job:

- A namespace.
- A service account.
🤖 GitLab Bot 🤖's avatar
🤖 GitLab Bot 🤖 включено в состав коммита
668

Evan Read's avatar
Evan Read включено в состав коммита
669
However, sometimes GitLab can not create them. In such instances, your job will fail with the message:
Tiger's avatar
Tiger включено в состав коммита
670

Evan Read's avatar
Evan Read включено в состав коммита
671
```text
jerasmus's avatar
jerasmus включено в состав коммита
672
This job failed because the necessary resources were not successfully created.
Evan Read's avatar
Evan Read включено в состав коммита
673
```
Tiger's avatar
Tiger включено в состав коммита
674

Dylan Griffith's avatar
Dylan Griffith включено в состав коммита
675
To find the cause of this error when creating a namespace and service account, check the [logs](../../../administration/logs.md#kuberneteslog).
🤖 GitLab Bot 🤖's avatar
🤖 GitLab Bot 🤖 включено в состав коммита
676

Evan Read's avatar
Evan Read включено в состав коммита
677
Reasons for failure include:
🤖 GitLab Bot 🤖's avatar
🤖 GitLab Bot 🤖 включено в состав коммита
678

Evan Read's avatar
Evan Read включено в состав коммита
679
- The token you gave GitLab does not have [`cluster-admin`](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles)
Evan Read's avatar
Evan Read включено в состав коммита
680
681
682
683
  privileges required by GitLab.
- Missing `KUBECONFIG` or `KUBE_TOKEN` variables. To be passed to your job, they must have a matching
  [`environment:name`](../../../ci/environments.md#defining-environments). If your job has no
  `environment:name` set, it will not be passed the Kubernetes credentials.
🤖 GitLab Bot 🤖's avatar
🤖 GitLab Bot 🤖 включено в состав коммита
684

Evan Read's avatar
Evan Read включено в состав коммита
685
686
687
688
689
690
NOTE: **NOTE:**
Project-level clusters upgraded from GitLab 12.0 or older may be configured
in a way that causes this error. Ensure you deselect the
[GitLab-managed cluster](#gitlab-managed-clusters) option if you want to manage
namespaces and service accounts yourself.

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
691
## Monitoring your Kubernetes cluster **(ULTIMATE)**
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
692

Evan Read's avatar
Evan Read включено в состав коммита
693
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/4701) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.6.
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
694
695
696

When [Prometheus is deployed](#installing-applications), GitLab will automatically monitor the cluster's health. At the top of the cluster settings page, CPU and Memory utilization is displayed, along with the total amount available. Keeping an eye on cluster resources can be important, if the cluster runs out of memory pods may be shutdown or fail to start.

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
697
![Cluster Monitoring](img/k8s_cluster_monitoring.png)