argocd
Installation
Entrypoint
Types
Argocd

argocd

Argo CD on Kubernetes, including KCL-based cluster registration
(clusterbook) rendering.

Installation

dagger install github.com/stuttgart-things/blueprints/argocd@v2.1.4

Entrypoint

Return Type

Argocd

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \

func (m *MyModule) Example() *dagger.Argocd  {
	return dag.
			Argocd()
}

@function
def example() -> dagger.Argocd:
	return (
		dag.argocd()
	)

@func()
example(): Argocd {
	return dag
		.argocd()
}

Types

Argocd 🔗

applyConfig() 🔗

ApplyConfig applies a rendered config file to the cluster. The target namespace is created (server-side, kubectl apply on a Namespace doc) before the manifests are applied.

Return Type

String !

Arguments

Name	Type	Default Value	Description
configFile	File !	-	Rendered config file (from render-clusterbook-cluster-config or local YAML)
kubeConfig	Secret !	-	Kubeconfig secret for cluster access
namespace	String	"argocd"	Target namespace

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 apply-config --config-file file:path --kube-config env:MYSECRET

func (m *MyModule) Example(ctx context.Context, configFile *dagger.File, kubeConfig *dagger.Secret) string  {
	return dag.
			Argocd().
			ApplyConfig(ctx, configFile, kubeConfig)
}

@function
async def example(config_file: dagger.File, kube_config: dagger.Secret) -> str:
	return await (
		dag.argocd()
		.apply_config(config_file, kube_config)
	)

@func()
async example(configFile: File, kubeConfig: Secret): Promise<string> {
	return dag
		.argocd()
		.applyConfig(configFile, kubeConfig)
}

bootstrapClusterbookCluster() 🔗

BootstrapClusterbookCluster orchestrates the full cluster-registration workflow: render the clusterbook config, optionally apply it to a cluster (–deploy), and optionally commit it to a Git repo with optional PR and merge (–commit-to-git).

Returns the rendered file so callers can also export --path=... it.

Return Type

File !

Arguments

Name	Type	Default Value	Description
name	String	-	Cluster name — required unless valuesFile is provided
networkKey	String	-	/24 network key — required unless valuesFile is provided
valuesFile	File	-	YAML/JSON values file (KCL –parametersFile)
ociSource	String	"ghcr.io/stuttgart-things/clusterbook-cluster-gen:0.1.0"	OCI KCL module source
clusterName	String	-	Argo CD-side cluster name
createDns	Boolean	-	No description provided
preserveKubeconfigServer	Boolean	-	No description provided
releaseOnDelete	Boolean	-	No description provided
kubeconfigSecretName	String	-	No description provided
kubeconfigSecretNamespace	String	-	No description provided
argocdNamespace	String	-	No description provided
providerConfigName	String	-	No description provided
clusterLabels	String	-	JSON object literal, e.g. {“env”:“lab”}
entrypoint	String	"main.k"	No description provided
deploy	Boolean	false	Apply the rendered config to a cluster
kubeConfig	Secret	-	Kubeconfig secret — required when deploy=true or detect-network-key=true
deployNamespace	String	"argocd"	Target namespace for apply
detectNetworkKey	Boolean	false	Run kubectl get nodes -o json against –kube-config and use the dominant /24 InternalIP prefix as –network-key. Only fires when –network-key is empty.
renderKubeconfigSecret	Boolean	false	Render a v1/Secret wrapping a SOPS-encrypted kubeconfig source file; applied alongside the cluster config on –deploy=true and committed alongside it on –commit-to-git=true.
kubeconfigSourceFile	File	-	SOPS-encrypted kubeconfig source — required when render-kubeconfig-secret=true // pragma: allowlist secret
sopsKey	Secret	-	AGE private key for decrypting kubeconfig-source-file
agePublicKey	Secret	-	AGE public key for re-encrypting the rendered Secret — required when render-kubeconfig-secret=true and commit-to-git=true // pragma: allowlist secret
sopsConfigFile	File	-	SOPS config file (.sops.yaml) used during re-encryption
kubeconfigDataKey	String	"kubeconfig"	Data key under data: in the rendered Secret
kubeconfigFileName	String	"kubeconfig.yaml"	File name to use when committing the kubeconfig Secret (joined with destination-path)
commitToGit	Boolean	false	Commit the rendered config to a Git repository
repository	String	-	Repository in “owner/repo” — required when commitToGit=true
gitToken	Secret	-	GitHub token — required when commitToGit=true
branchName	String	"main"	Branch to commit to
destinationPath	String	"argocd/clusters/"	Destination folder within the repository
fileName	String	"cluster.yaml"	File name to write under destinationPath
commitMessage	String	"Add Argo CD cluster registration"	Commit message
createPr	Boolean	false	Open a PR from branchName into baseBranch
baseBranch	String	"main"	PR base branch
prTitle	String	-	No description provided
prBody	String	-	No description provided
mergePr	Boolean	false	Auto-merge the PR after creation
mergeMethod	String	"squash"	squash \| merge \| rebase

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 bootstrap-clusterbook-cluster

func (m *MyModule) Example() *dagger.File  {
	return dag.
			Argocd().
			BootstrapClusterbookCluster()
}

@function
def example() -> dagger.File:
	return (
		dag.argocd()
		.bootstrap_clusterbook_cluster()
	)

@func()
example(): File {
	return dag
		.argocd()
		.bootstrapClusterbookCluster()
}

commitConfig() 🔗

CommitConfig commits configFile to / on in . Optionally opens a pull request against and optionally merges that PR.

Returns a multi-line summary of what was committed / opened / merged.

Return Type

String !

Arguments

Name	Type	Default Value	Description
configFile	File !	-	Rendered config file to commit
repository	String !	-	Repository in “owner/repo” format
gitToken	Secret !	-	GitHub token for git operations
branchName	String	"main"	Branch to commit the file to
destinationPath	String	"argocd/clusters/"	Destination folder within the repository (without leading slash)
fileName	String	"cluster.yaml"	File name to write under destinationPath (used as the committed basename)
commitMessage	String	"Add Argo CD cluster registration"	Commit message
createPr	Boolean	false	Open a pull request from branchName into baseBranch
baseBranch	String	"main"	Base branch for the PR
prTitle	String	-	PR title (defaults to commitMessage when empty)
prBody	String	-	PR body
mergePr	Boolean	false	Merge the PR after creation
mergeMethod	String	"squash"	Merge method: “squash”, “merge”, or “rebase”

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 commit-config --config-file file:path --repository string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, configFile *dagger.File, repository string, gitToken *dagger.Secret) string  {
	return dag.
			Argocd().
			CommitConfig(ctx, configFile, repository, gitToken)
}

@function
async def example(config_file: dagger.File, repository: str, git_token: dagger.Secret) -> str:
	return await (
		dag.argocd()
		.commit_config(config_file, repository, git_token)
	)

@func()
async example(configFile: File, repository: string, gitToken: Secret): Promise<string> {
	return dag
		.argocd()
		.commitConfig(configFile, repository, gitToken)
}

commitFiles() 🔗

CommitFiles commits every file in sourceDir into on in as a single commit / single push. Optionally opens a pull request against and optionally merges it.

Distinct from CommitConfig in two ways:

It accepts a Directory (multiple files) so callers can push e.g. cluster.yaml + kubeconfig.yaml in one commit. Two back-to-back CommitConfig calls (one file each) hit a Dagger CloneGithub cache race — the second clone is served from cache and pre-dates the first push, so git push is rejected as non-fast-forward. Bundling into one commit avoids it entirely.
destinationFolder is a folder (without filename); each file in sourceDir is placed under that folder. Filenames in the source directory are preserved verbatim.

Returns a multi-line summary of what was committed / opened / merged.

Return Type

String !

Arguments

Name	Type	Default Value	Description
sourceDir	Directory !	-	Source directory whose files (top level) should be committed
repository	String !	-	Repository in “owner/repo” format
gitToken	Secret !	-	GitHub token for git operations
branchName	String	"main"	Branch to commit the files to
destinationFolder	String	"argocd/clusters/"	Destination folder within the repository (without leading slash)
commitMessage	String	"Add Argo CD cluster registration"	Commit message
createPr	Boolean	false	Open a pull request from branchName into baseBranch
baseBranch	String	"main"	Base branch for the PR
prTitle	String	-	PR title (defaults to commitMessage when empty)
prBody	String	-	PR body
mergePr	Boolean	false	Merge the PR after creation
mergeMethod	String	"squash"	Merge method: “squash”, “merge”, or “rebase”

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 commit-files --source-dir DIR_PATH --repository string --git-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, sourceDir *dagger.Directory, repository string, gitToken *dagger.Secret) string  {
	return dag.
			Argocd().
			CommitFiles(ctx, sourceDir, repository, gitToken)
}

@function
async def example(source_dir: dagger.Directory, repository: str, git_token: dagger.Secret) -> str:
	return await (
		dag.argocd()
		.commit_files(source_dir, repository, git_token)
	)

@func()
async example(sourceDir: Directory, repository: string, gitToken: Secret): Promise<string> {
	return dag
		.argocd()
		.commitFiles(sourceDir, repository, gitToken)
}

detectNetworkKey() 🔗

DetectNetworkKey runs kubectl get nodes -o json against the target cluster and returns the /24 prefix shared by the nodes’ InternalIP addresses (e.g. “10.31.102”). This is the format expected by render-clusterbook-cluster-config / bootstrap-clusterbook-cluster as –network-key.

When nodes span multiple /24 subnets (rare but possible with mixed pools), the most frequently observed prefix wins. IPv6 addresses are ignored.

Return Type

String !

Arguments

Name	Type	Default Value	Description
kubeConfig	Secret !	-	Kubeconfig secret for cluster access

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 detect-network-key --kube-config env:MYSECRET

func (m *MyModule) Example(ctx context.Context, kubeConfig *dagger.Secret) string  {
	return dag.
			Argocd().
			DetectNetworkKey(ctx, kubeConfig)
}

@function
async def example(kube_config: dagger.Secret) -> str:
	return await (
		dag.argocd()
		.detect_network_key(kube_config)
	)

@func()
async example(kubeConfig: Secret): Promise<string> {
	return dag
		.argocd()
		.detectNetworkKey(kubeConfig)
}

renderClusterbookClusterConfig() 🔗

RenderClusterbookClusterConfig renders the clusterbook-cluster-gen KCL module, which produces the manifests needed to register a cluster with Argo CD (kubeconfig Secret reference, provider config, cluster labels, optional DNS).

Values can come from a YAML/JSON file (–values-file) and/or individual CLI flags. When both are provided, CLI flags override matching keys in the file (KCL –parameters takes precedence over –parametersFile).

Returns the rendered multi-document YAML as a Dagger File.

Return Type

File !

Arguments

Name	Type	Default Value	Description
name	String	-	Cluster name (KCL -D name) — required unless valuesFile is provided
networkKey	String	-	/24 network key, e.g. 10.31.101 — required unless valuesFile is provided
valuesFile	File	-	YAML/JSON file with KCL parameters (passed as –parametersFile); CLI flags below override matching keys
ociSource	String	"ghcr.io/stuttgart-things/clusterbook-cluster-gen:0.1.0"	OCI KCL module source
clusterName	String	-	Argo CD-side cluster name; defaults to name when neither is set via file
createDns	Boolean	-	Create a DNS record for the cluster (default true when no values file)
preserveKubeconfigServer	Boolean	-	Preserve the existing server field from the kubeconfig Secret (default true when no values file)
releaseOnDelete	Boolean	-	Release the Argo CD cluster Secret on resource delete (default true when no values file)
kubeconfigSecretName	String	-	Name of the Secret holding the cluster kubeconfig; defaults to name when no values file
kubeconfigSecretNamespace	String	-	Namespace of the kubeconfig Secret (default “argocd” when no values file)
argocdNamespace	String	-	Argo CD namespace (default “argocd” when no values file)
providerConfigName	String	-	Crossplane ProviderConfig name (default “default” when no values file)
clusterLabels	String	-	Cluster labels as a JSON object literal, e.g. {“env”:“lab”,“role”:“mgmt”}
entrypoint	String	"main.k"	KCL entrypoint file

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 render-clusterbook-cluster-config

func (m *MyModule) Example() *dagger.File  {
	return dag.
			Argocd().
			RenderClusterbookClusterConfig()
}

@function
def example() -> dagger.File:
	return (
		dag.argocd()
		.render_clusterbook_cluster_config()
	)

@func()
example(): File {
	return dag
		.argocd()
		.renderClusterbookClusterConfig()
}

renderKubeconfigSecret() 🔗

RenderKubeconfigSecret turns a SOPS-encrypted source file (typically a cluster kubeconfig under stuttgart-things/secrets/kubeconfigs/) into a Kubernetes v1/Secret manifest. Equivalent to:

sops --decrypt <sourceFile> > kubeconfig.yaml
kubectl create secret generic <name> -n <namespace> \
  --from-file=<dataKey>=kubeconfig.yaml \
  --dry-run=client -o yaml

By default the rendered Secret is re-encrypted with SOPS using agePublicKey so it can be safely committed to git (e.g. via commit-config). Pass –encrypt=false to get the plaintext manifest for direct kubectl apply (e.g. via apply-config).

Returns the manifest as a Dagger File so it composes with apply-config and commit-config without shell round-trips.

Return Type

File !

Arguments

Name	Type	Default Value	Description
sourceFile	File !	-	SOPS-encrypted source file (e.g. kubeconfigs/kind-dev-test1.yaml)
sopsKey	Secret !	-	AGE private key for decrypting sourceFile (AGE-SECRET-KEY-…)
name	String !	-	Secret name (e.g. “kind-dev-test1” or “target-cluster-kubeconfig”)
namespace	String	"argocd"	Target namespace
dataKey	String	"kubeconfig"	Data key under data: in the rendered Secret (data.)
encrypt	Boolean	true	Re-encrypt the rendered Secret with SOPS using agePublicKey
agePublicKey	Secret	-	AGE public key for SOPS re-encryption (required when encrypt=true)
sopsConfig	File	-	SOPS config file (.sops.yaml) used during re-encryption

Example

dagger -m github.com/stuttgart-things/blueprints/argocd@49664f5476d0595cc8c66dc7fce297632e461436 call \
 render-kubeconfig-secret --source-file file:path --sops-key env:MYSECRET --name string

func (m *MyModule) Example(sourceFile *dagger.File, sopsKey *dagger.Secret, name string) *dagger.File  {
	return dag.
			Argocd().
			RenderKubeconfigSecret(sourceFile, sopsKey, name)
}

@function
def example(source_file: dagger.File, sops_key: dagger.Secret, name: str) -> dagger.File:
	return (
		dag.argocd()
		.render_kubeconfig_secret(source_file, sops_key, name)
	)

@func()
example(sourceFile: File, sopsKey: Secret, name: string): File {
	return dag
		.argocd()
		.renderKubeconfigSecret(sourceFile, sopsKey, name)
}