Commit c4a03597 authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'selhorn-access-token' into 'master'

Standardized on access token

See merge request gitlab-org/gitlab!82949
parents 86e8fb0e 7bec2996
......@@ -53,7 +53,7 @@ To register an agent with GitLab:
- If you want to create a configuration with CI/CD defaults, type a name for the agent.
- If you already have an [agent configuration file](#create-an-agent-configuration-file), select it from the list.
1. Select **Register an agent**.
1. GitLab generates a registration token for this agent. Securely store this secret token. You need it to install the agent in your cluster and to [update the agent](#update-the-agent-version) to another version.
1. GitLab generates an access token for the agent. Securely store this token. You need it to install the agent in your cluster and to [update the agent](#update-the-agent-version) to another version.
1. Copy the command under **Recommended installation method**. You need it when you use the one-liner installation method to install the agent in your cluster.
### Create an agent configuration file
......@@ -79,7 +79,7 @@ To create an agent configuration file, go to the GitLab project. In the reposito
- For a GitOps workflow, view [the configuration reference](../gitops.md#gitops-configuration-reference) for details.
- For a GitLab CI/CD workflow, you can leave the file blank for now.
The agent bootstraps with the GitLab installation URL and an authentication token,
The agent bootstraps with the GitLab installation URL and an access token,
and you provide the rest of the configuration in your repository, following
Infrastructure as Code (IaaC) best practices.
......@@ -114,7 +114,7 @@ By default, the one-liner command generated by GitLab:
- Creates a namespace for the deployment (`gitlab-agent`).
- Sets up a service account with `cluster-admin` rights (see [how to restrict this service account](#customize-the-permissions-for-the-agentk-service-account)).
- Creates a `Secret` resource for the agent's registration token.
- Creates a `Secret` resource for the agent's access token.
- Creates a `Deployment` resource for the `agentk` pod.
You can edit these parameters to customize the one-liner installation command.
......@@ -173,7 +173,7 @@ To install multiple agents, follow the
a second time and:
1. Change the agent name and create a new configuration file.
1. Register the new agent. You receive a new token. Each token should be used only with one agent.
1. Register the new agent. You receive a new access token. Each token should be used only with one agent.
1. Change the namespace or prefix you use for the installation.
You should also change the RBAC for the installed `agentk`.
......@@ -214,7 +214,7 @@ To update the agent's version, re-run the [installation command](#install-the-ag
with a newer `--agent-version`. Make sure to specify the other required parameters: `--kas-address`, `--namespace`, and `--agent-token`.
The available `agentk` versions are in [the Container Registry](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/container_registry/1223205?sort=desc).
If you don't have access to your agent's token, you can retrieve it from your cluster:
If you don't have access to your agent's access token, you can retrieve it from your cluster:
1. Open a terminal and connect to your cluster.
1. To retrieve the namespace, run:
......@@ -229,7 +229,7 @@ If you don't have access to your agent's token, you can retrieve it from your cl
kubectl -n <namespace> get secrets
```
1. To retrieve the token, run:
1. To retrieve the access token, run:
```shell
kubectl -n <namespace> get secret <secret-name> --template={{.data.token}} | base64 --decode
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment