mw gitlab cluster agent bootstrap

mw gitlab cluster agent bootstrap agent-name [flags]

Bootstrap a GitLab Agent for Kubernetes (agentk) in a project.

The first argument must be the name of the agent.

It requires the kubectl and flux commands to be accessible via $PATH.

This command consists of multiple idempotent steps:

1. Register the agent with the project.
2. Configure the agent.
3. Configure an environment with dashboard for the agent.
4. Configure an environment with dashboard for FluxCD (if --create-flux-environment).
5. Create a token for the agent.
   • If the agent has reached the maximum amount of tokens, the one that has not been used the longest is revoked and a new one is created.
   • If the agent has not reached the maximum amount of tokens, a new one is created.
6. Push the Kubernetes Secret that contains the token to the cluster.
7. Create Flux HelmRepository and HelmRelease resources.
8. Commit and Push the created Flux Helm resources to the manifest path.
9. Trigger Flux reconciliation of GitLab Agent HelmRelease (unless --no-reconcile).

Options

--commit-author-email <string>

The Git commit author email to use. Conflicts with the --use-api-commit-author flag. Default: noreply@glab.gitlab.com.

--commit-author-name <string>

The Git commit author name to use. Conflicts with the --use-api-commit-author flag. Default: glab.

--create-environment

Create an environment for the GitLab Agent. Default: true.

--create-flux-environment

Create an environment for FluxCD. Affects only the environment creation, not the use of Flux itself. Flux is always required for the bootstrap process. Default: true.

--environment-flux-resource-path <string>

Flux resource path of the environment for the GitLab Agent. Default: helm.toolkit.fluxcd.io/v2beta1/namespaces/<helm-release-namespace>/helmreleases/<helm-release-name>.

--environment-name <string>

Name of the environment for the GitLab Agent. Default: <helm-release-namespace>/<helm-release-name>.

--environment-namespace <string>

Kubernetes namespace of the environment for the GitLab Agent. Default: <helm-release-namespace>.

--flux-environment-flux-resource-path <string>

Flux resource path of the environment for FluxCD. Default: kustomize.toolkit.fluxcd.io/v1/namespaces/flux-system/kustomizations/flux-system.

--flux-environment-name <string>

Name of the environment for FluxCD. Default: <flux-source-namespace>/<flux-source-name>.

--flux-environment-namespace <string>

Kubernetes namespace of the environment for FluxCD. Default: <flux-source-namespace>.

--flux-source-name <string>

Flux source name. Default: flux-system.

--flux-source-namespace <string>

Flux source namespace. Default: flux-system.

--flux-source-type <string>

Source type of the flux-system, like Git, OCI, or Helm. Default: git.

--gitlab-agent-token-secret-name <string>

Name of the Secret where the token for the GitLab Agent is stored. The helm-release-target-namespace is implied for the namespace of the Secret. Default: gitlab-agent-token.

--helm-release-filepath <string>

File path within the GitLab Agent project to commit the Flux HelmRelease to. Default: gitlab-agent-helm-release.yaml.

--helm-release-name <string>

Name of the Flux HelmRelease manifest. Default: gitlab-agent.

--helm-release-namespace <string>

Namespace of the Flux HelmRelease manifest. Default: flux-system.

--helm-release-target-namespace <string>

Namespace of the GitLab Agent deployment. Default: gitlab-agent.

--helm-release-values <strings>

Local path to values.yaml files. Multiple files can be comma-separated or specified by repeating the flag.

--helm-release-values-from <strings>

Kubernetes object reference that contains the values.yaml data key in the format '<kind>/<name>', where 'kind' must be one of: (Secret, ConfigMap). Multiple references can be comma-separated or specified by repeating the flag.

--helm-repository-address <string>

Address of the HelmRepository. Default: https://charts.gitlab.io.

--helm-repository-filepath <string>

File path within the GitLab Agent project to commit the Flux HelmRepository to. Default: gitlab-helm-repository.yaml.

--helm-repository-name <string>

Name of the Flux HelmRepository manifest. Default: gitlab.

--helm-repository-namespace <string>

Namespace of the Flux HelmRepository manifest. Default: flux-system.

-b, --manifest-branch <string>

Branch to commit the Flux Manifests to. (default to the project default branch)

-p, --manifest-path <string>

Location of directory in Git repository for storing the GitLab Agent for Kubernetes Helm resources.

--no-reconcile

Do not trigger Flux reconciliation for GitLab Agent for Kubernetes Flux resource.

--use-api-commit-author

When creating Git commits use the user from the authenticated API request. Conflicts with the --commit-author-name and --commit-author-email flags.

Global options

-h, --help

Show help for this command.

--no-interaction

Do not ask any interactive questions

--profile <string>

Saved account profile (login defaults to the verified username)

-R, --repo <OWNER/REPO>

Select another repository. Can use either OWNER/REPO or `GROUP/NAMESPACE/REPO` format. Also accepts full URL or Git URL.

-v, --verbose <count>

Increase output verbosity. Example: --verbose=2 or -vv

Examples

# Bootstrap "my-agent" to the root of the Git project in CWD, and trigger reconciliation
$ glab cluster agent bootstrap my-agent

# Bootstrap "my-agent" to "manifests/" of the Git project in CWD, and trigger reconciliation
# Especially useful when "flux bootstrap gitlab --path manifests/" is used.
# Make sure that the "--path" from the "flux bootstrap gitlab" command matches
# the "--manifest-path" of the "glab cluster agent bootstrap" command.
$ glab cluster agent bootstrap my-agent --manifest-path manifests/

# Bootstrap "my-agent" to "manifests/" of the Git project in CWD, and do not manually trigger a reconilication
$ glab cluster agent bootstrap my-agent --manifest-path manifests/ --no-reconcile

# Bootstrap "my-agent" without configuring an environment
$ glab cluster agent bootstrap my-agent --create-environment=false

# Bootstrap "my-agent" and configure an environment with custom name and Kubernetes namespace
$ glab cluster agent bootstrap my-agent --environment-name production --environment-namespace default

# Bootstrap "my-agent" without configuring a FluxCD environment
$ glab cluster agent bootstrap my-agent --create-flux-environment=false

# Bootstrap "my-agent" and configure a FluxCD environment with custom name and Kubernetes namespace
$ glab cluster agent bootstrap my-agent --flux-environment-name production-flux --flux-environment-namespace flux-system

# Bootstrap "my-agent" and pass additional GitLab Helm Chart values from a local file
$ glab cluster agent bootstrap my-agent --helm-release-values values.yaml

# Bootstrap "my-agent" and pass additional GitLab Helm Chart values from a Kubernetes ConfigMap
$ glab cluster agent bootstrap my-agent --helm-release-values-from ConfigMap/agent-config

# Bootstrap "my-agent" and commit with custom user
$ glab cluster agent bootstrap my-agent --commit-author-name="Tanuki" --commit-author-email="tanuki@example.com"

# Bootstrap "my-agent" with authenticated API user
$ glab cluster agent bootstrap my-agent --use-api-commit-author

See also

• mw gitlab cluster agent