Man page - glab-cluster-agent-bootstrap(1)
Packages contas this manual
- glab-mr-close(1)
- glab-label(1)
- glab-variable-set(1)
- glab-ci-run(1)
- glab-repo-fork(1)
- glab-mr-approve(1)
- glab-mr-issues(1)
- glab-ssh-key(1)
- glab-job-artifact(1)
- glab-repo-mirror(1)
- glab-config-set(1)
- glab-ssh-key-delete(1)
- glab-repo-transfer(1)
- glab-release-create(1)
- glab-user(1)
- glab-schedule-list(1)
- glab-release(1)
- glab-mr-diff(1)
- glab-stack-sync(1)
- glab-ci(1)
- glab-mr-delete(1)
- glab-issue-create(1)
- glab-repo-contributors(1)
- glab-schedule-create(1)
- glab-auth(1)
- glab-repo-clone(1)
- glab-config(1)
- glab-cluster-agent-update-kubeconfig(1)
- glab-mr(1)
- glab-mr-note(1)
- glab-stack-switch(1)
- glab-ci-lint(1)
- glab-repo-list(1)
- glab-ci-config-compile(1)
- glab-issue-board-view(1)
- glab-incident-close(1)
- glab-cluster-agent-bootstrap(1)
- glab-mr-unsubscribe(1)
- glab-schedule(1)
- glab-variable-delete(1)
- glab-stack-prev(1)
- glab-incident-view(1)
- glab-ci-get(1)
- glab-ci-run-trig(1)
- glab-release-download(1)
- glab-stack-create(1)
- glab-mr-revoke(1)
- glab-completion(1)
- glab-ci-trigger(1)
- glab-token-list(1)
- glab-repo-archive(1)
- glab-stack-first(1)
- glab-issue(1)
- glab-config-get(1)
- glab-ci-list(1)
- glab-release-upload(1)
- glab-cluster-agent-list(1)
- glab-mr-list(1)
- glab-incident-reopen(1)
- glab-cluster-agent(1)
- glab-issue-update(1)
- glab-token-rotate(1)
- glab-mr-create(1)
- glab-stack-list(1)
- glab-snippet(1)
- glab-incident-list(1)
- glab-ci-delete(1)
- glab-variable(1)
- glab-mr-rebase(1)
- glab-duo-ask(1)
- glab-incident-subscribe(1)
- glab-api(1)
- glab-ssh-key-add(1)
- glab-issue-list(1)
- glab-ci-retry(1)
- glab-issue-close(1)
- glab-token-create(1)
- glab-cluster-agent-check_manifest_usage(1)
- glab-repo-delete(1)
- glab-mr-todo(1)
- glab-label-list(1)
- glab-stack-move(1)
- glab-repo-create(1)
- glab-ci-trace(1)
- glab-cluster(1)
- glab-release-delete(1)
- glab-token-revoke(1)
- glab-repo(1)
- glab-user-events(1)
- glab-schedule-update(1)
- glab-variable-list(1)
- glab-stack-save(1)
- glab-issue-view(1)
- glab-incident(1)
- glab-snippet-create(1)
- glab-ci-status(1)
- glab-issue-note(1)
- glab-auth-login(1)
- glab-ci-config(1)
- glab-incident-note(1)
- glab-issue-board(1)
- glab-changelog-generate(1)
- glab-issue-unsubscribe(1)
- glab-token(1)
- glab-alias-list(1)
- glab-issue-delete(1)
- glab-changelog(1)
- glab-alias-set(1)
- glab-mr-update(1)
- glab-schedule-delete(1)
- glab-mr-checkout(1)
- glab-job(1)
- glab-alias-delete(1)
- glab-stack-next(1)
- glab-ci-cancel(1)
- glab-release-list(1)
- glab(1)
- glab-repo-search(1)
- glab-ssh-key-get(1)
- glab-stack-last(1)
- glab-label-create(1)
- glab-ci-cancel-job(1)
- glab-check-update(1)
- glab-duo(1)
- glab-variable-export(1)
- glab-issue-subscribe(1)
- glab-label-delete(1)
- glab-repo-view(1)
- glab-mr-merge(1)
- glab-alias(1)
- glab-mr-subscribe(1)
- glab-variable-get(1)
- glab-version(1)
- glab-auth-status(1)
- glab-variable-update(1)
- glab-mr-view(1)
- glab-schedule-run(1)
- glab-release-view(1)
- glab-mr-reopen(1)
- glab-ssh-key-list(1)
- glab-ci-view(1)
- glab-incident-unsubscribe(1)
- glab-ci-cancel-pipeline(1)
- glab-stack(1)
- glab-issue-reopen(1)
- glab-stack-amend(1)
- glab-issue-board-create(1)
- glab-stack-reorder(1)
- glab-cluster-agent-get-token(1)
- glab-mr-approvers(1)
apt-get install glab
Manual
| glab(1) | glab(1) |
NAME
glab-cluster-agent-bootstrap - Bootstrap a GitLab Agent for Kubernetes in a project.
SYNOPSIS
glab cluster agent bootstrap agent-name [flags]
DESCRIPTION
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.
OPTIONS
--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.
OPTIONS INHERITED FROM PARENT COMMANDS
--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.
EXAMPLE
# 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
SEE ALSO
glab-cluster-agent(1)
| Jun 2025 | Auto generated by spf13/cobra |