Commit b41251f4 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'k8s-naming-restriction' into 'master'

Clarify Kubernetes Agent naming restrictions

See merge request gitlab-org/gitlab!74475
parents 07d35443 12b0bdbe
...@@ -56,6 +56,8 @@ In your repository, add the Agent configuration file under: ...@@ -56,6 +56,8 @@ In your repository, add the Agent configuration file under:
.gitlab/agents/<agent-name>/config.yaml .gitlab/agents/<agent-name>/config.yaml
``` ```
Make sure that `<agent-name>` conforms to the [Agent's naming format](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/identity_and_auth.md#agent-identity-and-name).
Your `config.yaml` file specifies all configurations of the Agent, such as: Your `config.yaml` file specifies all configurations of the Agent, such as:
- The manifest projects to synchronize. - The manifest projects to synchronize.
......
...@@ -23,16 +23,18 @@ The Agent bootstraps with the GitLab installation URL and an authentication toke ...@@ -23,16 +23,18 @@ The Agent bootstraps with the GitLab installation URL and an authentication toke
and you provide the rest of the configuration in your repository, following and you provide the rest of the configuration in your repository, following
Infrastructure as Code (IaaC) best practices. Infrastructure as Code (IaaC) best practices.
A minimal repository layout looks like this, with `my_agent_1` as the name A minimal repository layout looks like this, with `my-agent-1` as the name
of your Agent: of your Agent:
```plaintext ```plaintext
|- .gitlab |- .gitlab
|- agents |- agents
|- my_agent_1 |- my-agent-1
|- config.yaml |- config.yaml
``` ```
Make sure that `<agent-name>` conforms to the [Agent's naming format](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc/identity_and_auth.md#agent-identity-and-name).
## Synchronize manifest projects **(PREMIUM)** ## Synchronize manifest projects **(PREMIUM)**
Your `config.yaml` file contains a `gitops` section, which contains a `manifest_projects` Your `config.yaml` file contains a `gitops` section, which contains a `manifest_projects`
......
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