diff options
Diffstat (limited to 'doc/user/clusters/agent/index.md')
| -rw-r--r-- | doc/user/clusters/agent/index.md | 214 |
1 files changed, 180 insertions, 34 deletions
diff --git a/doc/user/clusters/agent/index.md b/doc/user/clusters/agent/index.md index 6f3d1e197f5..9af339b20c6 100644 --- a/doc/user/clusters/agent/index.md +++ b/doc/user/clusters/agent/index.md @@ -21,6 +21,7 @@ tasks in a secure and cloud-native way. It enables: - Pull-based GitOps deployments by leveraging the [GitOps Engine](https://github.com/argoproj/gitops-engine). - Real-time access to API endpoints in a cluster. +- Alert generation based on [Container network policy](../../application_security/threat_monitoring/index.md#container-network-policy). Many more features are planned. Please review [our roadmap](https://gitlab.com/groups/gitlab-org/-/epics/3329) and [our development documentation](../../../development/agent/index.md). @@ -36,7 +37,7 @@ sequenceDiagram participant D as Developer participant A as Application code repository participant M as Manifest repository - participant K as Kubernetes agent + participant K as Kubernetes Agent participant C as Agent configuration repository K->C: Grab the configuration D->>+A: Pushing code changes @@ -49,19 +50,17 @@ sequenceDiagram There are several components that work in concert for the Agent to accomplish GitOps deployments: -- A properly-configured Kubernetes cluster. +- A properly-configured Kubernetes cluster where the Agent is running. - A configuration repository that contains a `config.yaml` file, which tells the - Agent which repositories to synchronize with. -- A manifest repository that contains a `manifest.yaml`, which is tracked by the - Agent and can be auto-generated. Any changes to `manifest.yaml` are applied to the cluster. + Agent which repositories to synchronize with the cluster. +- A manifest repository that contains manifest files. Any changes to manifest files are applied to the cluster. -These repositories might be the same GitLab project or separate projects. +You can use the same GitLab project or separate projects for configuration and manifest files, as follows: -NOTE: -GitLab recommends you use the same GitLab project for the agent configuration -and manifest repositories. Our backlog contains issues for adding support for +- Single GitLab project (recommended): when you use a single repository to hold both the manifest and the configuration files, these projects can be either private or public, as you prefer. +- Two GitLab projects: when you opt to use two different GitLab projects, one for manifest files, and another for configuration files, the manifests project must be private, while the configuration project can be either private or public. Our backlog contains issues for adding support for [private manifest repositories outside of the configuration project](https://gitlab.com/gitlab-org/gitlab/-/issues/220912) and -[group level agents](https://gitlab.com/gitlab-org/gitlab/-/issues/283885). +[group level agents](https://gitlab.com/gitlab-org/gitlab/-/issues/283885) in the future. For more details, please refer to our [full architecture documentation](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/architecture.md#high-level-architecture) in the Agent project. @@ -69,12 +68,12 @@ For more details, please refer to our [full architecture documentation](https:// The setup process involves a few steps to enable GitOps deployments: -1. [Install the Agent server](#install-the-kubernetes-agent-server). +1. [Install the Agent server](#install-the-kubernetes-agent-server) for your GitLab instance. 1. [Define a configuration repository](#define-a-configuration-repository). 1. [Create an Agent record in GitLab](#create-an-agent-record-in-gitlab). 1. [Generate and copy a Secret token used to connect to the Agent](#create-the-kubernetes-secret). 1. [Install the Agent into the cluster](#install-the-agent-into-the-cluster). -1. [Create a `manifest.yaml`](#create-a-manifestyaml). +1. [Create manifest files](#create-manifest-files). ### Upgrades and version compatibility @@ -92,7 +91,13 @@ Upgrade your agent installations together with GitLab upgrades. To decide which The available `agentk` and `kas` versions can be found in [the container registry](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/container_registry/). -### Install the Kubernetes Agent Server +### Install the Kubernetes Agent Server **(FREE SELF)** + +[Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3834) in GitLab 13.10, +the GitLab Kubernetes Agent Server (KAS) is available on GitLab.com under `wss://kas.gitlab.com`. +If you are a GitLab.com user, skip this step and directly +[set up the configuration repository](#define-a-configuration-repository) +for your agent. The GitLab Kubernetes Agent Server (KAS) can be deployed using [Omnibus GitLab](https://docs.gitlab.com/omnibus/) or the [GitLab @@ -100,9 +105,6 @@ chart](https://gitlab.com/gitlab-org/charts/gitlab). If you don't already have GitLab installed, please refer to our [installation documentation](https://docs.gitlab.com/ee/install/README.html). -NOTE: -GitLab plans to include the KAS on [GitLab.com](https://gitlab.com/groups/gitlab-org/-/epics/3834). - #### Install with Omnibus When using the [Omnibus GitLab](https://docs.gitlab.com/omnibus/) package: @@ -205,7 +207,13 @@ the Agent in subsequent steps. You can create an Agent record either: } mutation createToken { - clusterAgentTokenCreate(input: { clusterAgentId: <cluster-agent-id-taken-from-the-previous-mutation> }) { + clusterAgentTokenCreate( + input: { + clusterAgentId: "<cluster-agent-id-taken-from-the-previous-mutation>" + description: "<optional-description-of-token>" + name: "<required-name-given-to-token>" + } + ) { secret # This is the value you need to use on the next step token { createdAt @@ -223,7 +231,34 @@ the Agent in subsequent steps. You can create an Agent record either: [Getting started with the GraphQL API page](../../../api/graphql/getting_started.md), or the [GraphQL Explorer](https://gitlab.com/-/graphql-explorer). -### Create the Kubernetes secret +### Install the Agent into the cluster + +Next, install the in-cluster component of the Agent. + +NOTE: +For GitLab.com users, the KAS is available at `wss://kas.gitlab.com`. + +#### One-liner installation + +Replace the value of `agent-token` below with the token received from the previous step. Also, replace `kas-address` with the configured access of the Kubernetes Agent Server: + +```shell +docker run --rm registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/cli:latest generate --agent-token=your-agent-token --kas-address=wss://kas.gitlab.example.com --agent-version latest | kubectl apply -f - +``` + +To find out the various options the above Docker container supports, run: + +```shell +docker run --rm -it registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/cli:latest generate --help +``` + +#### Advanced installation + +For more advanced configurations, we recommend to use [the `kpt` based installation method](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/tree/master/build/deployment/gitlab-agent). + +Otherwise, you can follow below for fully manual, detailed installation steps. + +##### Create the Kubernetes secret After generating the token, you must apply it to the Kubernetes cluster. @@ -239,9 +274,7 @@ After generating the token, you must apply it to the Kubernetes cluster. kubectl create secret generic -n <YOUR-DESIRED-NAMESPACE> gitlab-agent-token --from-literal=token='YOUR_AGENT_TOKEN' ``` -### Install the Agent into the cluster - -Next, install the in-cluster component of the Agent. This example file contains the +The following example file contains the Kubernetes resources required for the Agent to be installed. You can modify this example [`resources.yml` file](#example-resourcesyml-file) in the following ways: @@ -253,7 +286,7 @@ example [`resources.yml` file](#example-resourcesyml-file) in the following ways 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 + 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. @@ -288,7 +321,7 @@ NAMESPACE NAME READY STATUS RESTARTS AG gitlab-agent gitlab-agent-77689f7dcb-5skqk 1/1 Running 0 51s ``` -#### Example `resources.yml` file +##### Example `resources.yml` file ```yaml apiVersion: v1 @@ -318,7 +351,7 @@ spec: - --token-file=/config/token - --kas-address - wss://kas.host.tld:443 # change this line for the one below if using Omnibus GitLab - # - wss://gitlab.host.tld:443/-/kubernetes-agent + # - wss://gitlab.host.tld:443/-/kubernetes-agent/ volumeMounts: - name: token-volume mountPath: /config @@ -388,11 +421,10 @@ subjects: namespace: gitlab-agent ``` -### Create a `manifest.yaml` +### Create manifest files In a previous step, you configured a `config.yaml` to point to the GitLab projects -the Agent should synchronize. In each of those projects, you must create a `manifest.yaml` -file for the Agent to monitor. You can auto-generate this `manifest.yaml` with a +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 @@ -400,13 +432,13 @@ project, and public projects. Support for other private projects is planned in the issue [Agent authorization for private manifest projects](https://gitlab.com/gitlab-org/gitlab/-/issues/220912). -Each time you commit and push a change to this file, the Agent logs the change: +Each time you push a change to a monitored manifest repository, the Agent logs the change: ```plaintext 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.yaml` file +#### Example manifest file This file creates an NGINX deployment. @@ -443,7 +475,52 @@ The following example projects can help you get started with the Kubernetes Agen ### Deploying GitLab Runner with the Agent You can use the Kubernetes Agent to -[deploy GitLab Runner in a Kubernetes cluster](http://docs.gitlab.com/runner/install/kubernetes-agent.html). +[deploy GitLab Runner in a Kubernetes cluster](https://docs.gitlab.com/runner/install/kubernetes-agent.html). + +## Kubernetes Network Security Alerts + +The GitLab Agent also provides an integration with Cilium. This integration provides a simple way to +generate network policy-related alerts and to surface those alerts in GitLab. + +There are several components that work in concert for the Agent to generate the alerts: + +- A working Kubernetes cluster. +- Cilium integration through either of these options: + - Installation through [GitLab Managed Apps](../applications.md#install-cilium-using-gitlab-cicd). + - Enablement of [hubble-relay](https://docs.cilium.io/en/v1.8/concepts/overview/#hubble) on an + existing installation. +- One or more network policies through any of these options: + - Use the [Container Network Policy editor](../../application_security/threat_monitoring/index.md#container-network-policy-editor) to create and manage policies. + - Use an [AutoDevOps](../../application_security/threat_monitoring/index.md#container-network-policy-management) configuration. + - Add the required labels and annotations to existing network policies. +- Use a configuration repository to inform the Agent through a `config.yaml` file, which + repositories can synchronize with. This repository might be the same, or a separate GitLab + project. + +The setup process follows the same steps as [GitOps](#get-started-with-gitops-and-the-gitlab-agent), +with the following differences: + +- When you define a configuration repository, you must do so with [Cilium settings](#define-a-configuration-repository-with-cilium-settings). +- You do not need to create a `manifest.yaml`. + +### Define a configuration repository with Cilium settings + +You need a GitLab repository to contain your Agent configuration. The minimal repository layout +looks like this: + +```plaintext +.gitlab/agents/<agent-name>/config.yaml +``` + +Your `config.yaml` file must specify the `host` and `port` of your Hubble Relay service. If your +Cilium integration was performed through [GitLab Managed Apps](../applications.md#install-cilium-using-gitlab-cicd), +you can use `hubble-relay.gitlab-managed-apps.svc.cluster.local:80`: + +```yaml +cilium: + hubble_relay_address: "<hubble-relay-host>:<hubble-relay-port>" + ... +``` ## Management interfaces @@ -497,15 +574,15 @@ This error is shown if there are some connectivity issues between the address specified as `kas-address`, and your Agent pod. To fix it, make sure that you specified the `kas-address` correctly. -### Agent logs - ValidationError(Deployment.metadata +### Agent logs - ValidationError(Deployment.metadata) ```plaintext {"level":"info","time":"2020-10-30T08:56:54.329Z","msg":"Synced","project_id":"root/kas-manifest001","resource_key":"apps/Deployment/kas-test001/nginx-deployment","sync_result":"error validating data: [ValidationError(Deployment.metadata): unknown field \"replicas\" in io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta, ValidationError(Deployment.metadata): unknown field \"selector\" in io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta, ValidationError(Deployment.metadata): unknown field \"template\" in io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta]"} ``` -This error is shown if your `manifest.yaml` file is malformed, and Kubernetes can't -create specified objects. Make sure that your `manifest.yaml` file is valid. You -may try using it to create objects in Kubernetes directly for more troubleshooting. +This error is shown if a manifest file is malformed, and Kubernetes can't +create specified objects. Make sure that your manifest files are valid. You +may try using them to create objects in Kubernetes directly for more troubleshooting. ### Agent logs - Error while dialing failed to WebSocket dial: failed to send handshake request @@ -531,3 +608,72 @@ issue is in progress, directly edit the deployment with the This error is shown if the version of the agent is newer that the version of KAS. To fix it, make sure that both `agentk` and KAS use the same versions. + +### Agent logs - Certificate signed by unknown authority + +```plaintext +{"level":"error","time":"2021-02-25T07:22:37.158Z","msg":"Reverse tunnel","mod_name":"reverse_tunnel","error":"Connect(): rpc error: code = Unavailable desc = connection error: desc = \"transport: Error while dialing failed to WebSocket dial: failed to send handshake request: Get \\\"https://GitLabhost.tld:443/-/kubernetes-agent/\\\": x509: certificate signed by unknown authority\""} +``` + +This error is shown if your GitLab instance is using a certificate signed by an internal CA that +is unknown to the agent. One approach to fixing it is to present the CA certificate file to the agent +via a Kubernetes `configmap` and mount the file in the agent `/etc/ssl/certs` directory from where it +will be picked up automatically. + +For example, if your internal CA certifciate is `myCA.pem`: + +```plaintext +kubectl -n gitlab-agent create configmap ca-pemstore --from-file=myCA.pem +``` + +Then in `resources.yml`: + +```plaintext + spec: + serviceAccountName: gitlab-agent + containers: + - name: agent + image: "registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/agentk:latest" + args: + - --token-file=/config/token + - --kas-address + - wss://kas.host.tld:443 # change this line for the one below if using Omnibus GitLab + # - wss://gitlab.host.tld:443/-/kubernetes-agent + volumeMounts: + - name: token-volume + mountPath: /config + - name: ca-pemstore-volume + mountPath: /etc/ssl/certs/myCA.pem + subPath: myCA.pem + volumes: + - name: token-volume + secret: + secretName: gitlab-agent-token + - name: ca-pemstore-volume + configMap: + name: ca-pemstore + items: + - key: myCA.pem + path: myCA.pem +``` + +Alternatively, you can mount the certificate file at a different location and include it using the +`--ca-cert-file` agent parameter: + +```plaintext + containers: + - name: agent + image: "registry.gitlab.com/gitlab-org/cluster-integration/gitlab-agent/agentk:latest" + args: + - --ca-cert-file=/tmp/myCA.pem + - --token-file=/config/token + - --kas-address + - wss://kas.host.tld:443 # change this line for the one below if using Omnibus GitLab + # - wss://gitlab.host.tld:443/-/kubernetes-agent + volumeMounts: + - name: token-volume + mountPath: /config + - name: ca-pemstore-volume + mountPath: /tmp/myCA.pem + subPath: myCA.pem +``` |