glab-cluster-agent-bootstrap - Man Page

glab 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. 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.
5. Push the Kubernetes Secret that contains the token to the cluster.
6. Create Flux HelmRepository and HelmRelease resource.
7. Commit and Push the created Flux Helm resources to the manifest path.
8. Trigger Flux reconciliation of GitLab Agent HelmRelease.

--create-environment[=true] Create an Environment for the GitLab Agent.

--environment-flux-resource-path="helm.toolkit.fluxcd.io/v2beta1/namespaces//helmreleases/" Flux Resource Path of the Environment for the GitLab Agent.

--environment-name="/" Name of the Environment for the GitLab Agent.

--environment-namespace="" Kubernetes namespace of the Environment for the GitLab Agent.

--flux-source-name="flux-system" Flux source name.

--flux-source-namespace="flux-system" Flux source namespace.

--flux-source-type="git" Source type of the flux-system, e.g. git, oci, helm, ...

--gitlab-agent-token-secret-name="gitlab-agent-token" 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.

--helm-release-filepath="gitlab-agent-helm-release.yaml" Filepath within the GitLab Agent project to commit the Flux HelmRelease to.

--helm-release-name="gitlab-agent" Name of the Flux HelmRelease manifest.

--helm-release-namespace="flux-system" Namespace of the Flux HelmRelease manifest.

--helm-release-target-namespace="gitlab-agent" Namespace of the GitLab Agent deployment.

--helm-release-values=[] Local path to values.yaml files

--helm-release-values-from=[] Kubernetes object reference that contains the values.yaml data key in the format '/', where kind must be one of: (Secret,ConfigMap)

--helm-repository-filepath="gitlab-helm-repository.yaml" Filepath within the GitLab Agent project to commit the Flux HelmRepository to.

--helm-repository-name="gitlab" Name of the Flux HelmRepository manifest.

--helm-repository-namespace="flux-system" Namespace of the Flux HelmRepository manifest.

-b, --manifest-branch="" Branch to commit the Flux Manifests to. (default to the project default branch)

-p, --manifest-path="" Location of directory in Git repository for storing the GitLab Agent for Kubernetes Helm resources.

--no-reconcile[=false] Do not trigger Flux reconciliation for GitLab Agent for Kubernetes Flux resource.

--help[=false] Show help for this command.

-R,  --repo="" Select another repository. Can use either OWNER/REPO or GROUP/NAMESPACE/REPO

format. Also accepts full URL or Git URL.

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

# Bootstrap "my-agent" to "manifests/" of Git project in CWD and trigger reconciliation
# This is especially useful when "flux bootstrap gitlab --path manifests/" was 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 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" 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

glab-cluster-agent(1)

glab-cluster-agent(1).