debian-mirror-gitlab/doc/user/clusters/agent/install/index.md

stage	group	info
Configure	Configure	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Install the GitLab Agent (FREE)

Moved from GitLab Premium to GitLab Free in 14.5.

To get started with the Agent, install it in your cluster.

Pre-requisites:

• An existing Kubernetes cluster.
• An account on GitLab.

Installation steps

To install the Agent in your cluster:

1. Set up the Agent Server for your GitLab instance.
2. Define a configuration repository.
3. Register an agent with GitLab.
4. Install the agent into the cluster.
5. Generate and copy a Secret token used to connect to the agent.
6. Create manifest files.

Watch a GitLab 14.2 walking-through video with this process.

Set up the Agent Server

Introduced in GitLab Premium 13.10, the GitLab Agent Server (KAS) became available on GitLab.com under wss://kas.gitlab.com.

To use the KAS:

• If you are a self-managed user, follow the instructions to install the Agent Server.
• If you are a GitLab.com user, when you set up the configuration repository for your agent, use wss://kas.gitlab.com as the --kas-address.

Define a configuration repository

• Introduced in GitLab 13.7, the Agent manifest configuration can be added to multiple directories (or subdirectories) of its repository.
• Group authorization was introduced in GitLab 14.3.

To create an agent, you need:

1. A GitLab repository to hold the configuration file.
2. Install the Agent in a cluster.

After installed, when you update the configuration file, GitLab transmits the information to the cluster automatically without downtime.

In your repository, add the Agent configuration file under:

.gitlab/agents/<agent-name>/config.yaml

Make sure that <agent-name> conforms to the Agent's naming format.

WARNING: The agent is only recognized if you use .yaml extension for the config.yaml file. The extension .yml is not recognized.

You don't have to add any content to this file when you create it. The fact that the file exists tells GitLab that this is an agent configuration file. It doesn't do anything so far, but, later on, you can use this file to configure the agent by setting up parameters such as:

• Groups and projects that can access the agent via the CI/CD Tunnel.
• Manifest projects to synchronize.
• The address of the hubble-relay for the Network Security policy integrations.

To see all the settings available, read the Agent configuration repository documentation.

Access your cluster from GitLab CI/CD

Use the CI/CD Tunnel to access your cluster from GitLab CI/CD.

Register an agent with GitLab

Introduced in GitLab 14.1, you can create a new Agent record directly from the GitLab UI.

Next, create a GitLab Rails Agent record to associate it with the configuration repository project. Creating this record also creates a Secret needed to configure the Agent in subsequent steps.

In GitLab:

1. Ensure that GitLab CI/CD is enabled in your project.
2. From your project's sidebar, select Infrastructure > Kubernetes clusters.
3. Select Actions.
4. From the Select an agent dropdown, select the agent you want to connect and select Register an agent to access the installation form.
5. The form reveals your registration token. Securely store this secret token as you cannot view it again.
6. Copy the command under Recommended installation method.

In your computer:

1. Open your local terminal and connect to your cluster.
2. Run the command you copied from the installation form.

Install the agent into the cluster

To install the in-cluster component of the Agent, first you need to define a namespace. To create a new namespace, for example, gitlab-kubernetes-agent, run:

kubectl create namespace gitlab-kubernetes-agent

To perform a one-liner installation, run the command below. Make sure to replace:

• your-agent-token with the token received from the previous step (identified as secret in the JSON output).
• gitlab-kubernetes-agent with the namespace you defined in the previous step.
• wss://kas.gitlab.example.com with the configured access of the Agent Server (KAS). For GitLab.com users, the KAS is available under wss://kas.gitlab.com.
• --agent-version=vX.Y.Z with the latest released patch version matching your GitLab installation's major and minor versions. For example, for GitLab v13.9.0, use --agent-version=v13.9.1. You can find your GitLab version under the "Help/Help" menu.

docker run --pull=always --rm registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/cli:stable generate --agent-token=your-agent-token --kas-address=wss://kas.gitlab.example.com --agent-version=vX.Y.Z --namespace gitlab-kubernetes-agent | kubectl apply -f -

WARNING: --agent-version stable can be used to refer to the latest stable release at the time when the command runs. It's fine for testing purposes but for production please make sure to specify a matching version explicitly.

To find out the various options the above Docker container supports, run:

docker run --pull=always --rm registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/cli:stable generate --help

Advanced installation

For more advanced configurations, we recommend to use the kpt based installation method.

Otherwise, follow the manual installation steps described below.

Create the Kubernetes secret

After generating the token, you must apply it to the Kubernetes cluster.

To create your Secret, run:

kubectl create secret generic -n gitlab-kubernetes-agent gitlab-kubernetes-agent-token --from-literal=token='YOUR_AGENT_TOKEN'

The following example file contains the Kubernetes resources required for the Agent to be installed. You can modify this example resources.yml file in the following ways:

• Replace namespace: gitlab-kubernetes-agent with namespace: <YOUR-DESIRED-NAMESPACE>.
• You can configure kas-address (Agent Server) in several ways. The agent can use the WebSockets or gRPC protocols to connect to the Agent Server. Select the option appropriate for your cluster configuration and GitLab architecture:
  • The wss scheme (an encrypted WebSockets connection) is specified by default after you install the gitlab-kas sub-chart, or enable gitlab-kas for Omnibus GitLab. When using the sub-chart, you must set wss://kas.host.tld:443 as kas-address, where host.tld is the domain you've setup for your GitLab installation. When using Omnibus GitLab, you must set wss://GitLab.host.tld:443/-/kubernetes-agent/ as kas-address, where GitLab.host.tld is your GitLab hostname.
  • When using the sub-chart, specify the ws scheme (such as ws://kas.host.tld:80) to use an unencrypted WebSockets connection. When using the Omnibus GitLab, specify the ws scheme (such as ws://GitLab.host.tld:80/-/kubernetes-agent/).
  • Specify the grpc scheme if both Agent and Server are installed in one cluster. In this case, you may specify kas-address value as grpc://gitlab-kas.<your-namespace>:8150) to use gRPC directly, where gitlab-kas is the name of the service created by gitlab-kas chart, and <your-namespace> is the namespace where the chart was installed.
  • Specify the grpcs scheme to use an encrypted gRPC connection.
  • When deploying KAS through the GitLab chart, it's possible to customize the kas-address for wss and ws schemes to whatever you need. Check the chart's KAS Ingress documentation to learn more about it.
  • In the near future, Omnibus GitLab intends to provision gitlab-kas under a sub-domain by default, instead of the /-/kubernetes-agent/ path. Please follow this issue for details.
• If you defined your own secret name, replace gitlab-kubernetes-agent-token with your secret name in the secretName: section.

To apply this file, run the following command:

kubectl apply -n gitlab-kubernetes-agent -f ./resources.yml

To review your configuration, run the following command:

$ kubectl get pods -n gitlab-kubernetes-agent

NAMESPACE                NAME                                          READY   STATUS    RESTARTS   AGE
gitlab-kubernetes-agent  gitlab-kubernetes-agent-77689f7dcb-5skqk      1/1     Running   0          51s

Example resources.yml file

---
apiVersion: v1
kind: Namespace
metadata:
  name: gitlab-kubernetes-agent
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: gitlab-kubernetes-agent
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: gitlab-kubernetes-agent
spec:
  replicas: 1
  selector:
    matchLabels:
      app: gitlab-kubernetes-agent
  template:
    metadata:
      labels:
        app: gitlab-kubernetes-agent
    spec:
      serviceAccountName: gitlab-kubernetes-agent
      containers:
      - name: agent
        # Make sure to specify a matching version for production
        image: "registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/agentk:vX.Y.Z"
        args:
        - --token-file=/config/token
        - --kas-address
        - wss://kas.host.tld:443 # replace this line with the line below if using Omnibus GitLab or GitLab.com.
        # - wss://gitlab.host.tld:443/-/kubernetes-agent/
        # - wss://kas.gitlab.com # for GitLab.com users, use this KAS.
        # - grpc://host.docker.internal:8150 # use this attribute when connecting from Docker.
        volumeMounts:
        - name: token-volume
          mountPath: /config
      volumes:
      - name: token-volume
        secret:
          secretName: gitlab-kubernetes-agent-token
  strategy:
    type: RollingUpdate
    rollingUpdate:
      maxSurge: 0
      maxUnavailable: 1
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: gitlab-kubernetes-agent-write
rules:
- resources:
  - '*'
  apiGroups:
  - '*'
  verbs:
  - create
  - update
  - delete
  - patch
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: gitlab-kubernetes-agent-write-binding
roleRef:
  name: gitlab-kubernetes-agent-write
  kind: ClusterRole
  apiGroup: rbac.authorization.k8s.io
subjects:
- name: gitlab-kubernetes-agent
  kind: ServiceAccount
  namespace: gitlab-kubernetes-agent
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: gitlab-kubernetes-agent-read
rules:
- resources:
  - '*'
  apiGroups:
  - '*'
  verbs:
  - get
  - list
  - watch
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: gitlab-kubernetes-agent-read-binding
roleRef:
  name: gitlab-kubernetes-agent-read
  kind: ClusterRole
  apiGroup: rbac.authorization.k8s.io
subjects:
- name: gitlab-kubernetes-agent
  kind: ServiceAccount
  namespace: gitlab-kubernetes-agent

Create manifest files

In a previous step, you configured a config.yaml to point to the GitLab projects the Agent should synchronize. Agent monitors each of those projects for changes to the manifest files it contains. You can auto-generate manifest files with a templating engine or other means.

The agent is authorized to download manifests for the configuration project, and public projects. Support for other private projects is planned in the issue Agent authorization for private manifest projects.

Each time you push a change to a monitored manifest repository, the Agent logs the change:

2020-09-15_14:09:04.87946 gitlab-k8s-agent      : time="2020-09-15T10:09:04-04:00" level=info msg="Config: new commit" agent_id=1 commit_id=e6a3651f1faa2e928fe6120e254c122451be4eea

Example manifest file

This file creates a minimal ConfigMap:

apiVersion: v1
kind: ConfigMap
metadata:
  name: demo-map
  namespace: gitlab-kubernetes-agent  # Can be any namespace managed by you that the agent has access to.
data:
  key: value

Example projects

The following example projects can help you get started with the Agent.

• Configuration repository
• This basic GitOps example deploys NGINX: Manifest repository

View installed Agents

Users with at least the Developer can access the user interface for the Agent at Infrastructure > Kubernetes clusters, under the Agent tab. This page lists all registered agents for the current project, and the configuration directory for each agent:

Additional management interfaces are planned for the GitLab Agent. Provide more feedback in the related epic.

View Agent activity information

Introduced in GitLab 14.6.

Users with at least the Developer can view the Agent's activity events. The activity logs help you to identify problems and get the information you need for troubleshooting. You can see events from a week before the current date. To access an agent's activity:

1. Go to your agent's configuration repository.
2. From the sidebar, select Infrastructure > Kubernetes clusters.
3. Select the Agent tab.
4. Select the agent you want to see the activity.

You can see the following events on the activity list:

• Agent registration:
  • When a new token is created.
• Connection events:
  • When an agent is successfully connected to a cluster.

Note that the connection status is logged when you connect an agent for the first time or after more than an hour of inactivity.

Upgrades and version compatibility

The Agent is comprised of two major components: agentk and kas. As we provide kas installers built into the various GitLab installation methods, the required kas version corresponds to the GitLab major.minor (X.Y) versions.

At the same time, agentk and kas can differ by 1 minor version in either direction. For example, agentk 14.4 supports kas 14.3, 14.4, and 14.5 (regardless of the patch).

A feature introduced in a given GitLab minor version might work with other agentk or kas versions. To make sure that it works, use at least the same agentk and kas minor version. For example, if your GitLab version is 14.2, use at least agentk 14.2 and kas 14.2.

We recommend upgrading your kas installations together with GitLab instances' upgrades, and to upgrade the agentk installations after upgrading GitLab.

The available agentk and kas versions can be found in the container registry.