Template Controller API reference

Text specifies a raw text comment.

ConfigMap specifies a ConfigMap and a key to load the source content from

TextTemplate specifies a TextTemplate to load the source content from

Id specifies the identifier to be used by the controller when it needs to find the actual comment when it does not know the internal id. This Id is written into the comment inside a comment, so that a simple text search can reveal the comment

Source specifies the source content for the comment. Different source types are supported: Text, ConfigMap and TextTemplate

Glob specifies a glob to use for filename matching.

ParseYaml enables YAML parsing of matching files. The result is then available as parsed in the result for the corresponding result file

Interval is the interval at which to scan the Git repository Defaults to 5m.

Suspend can be used to suspend the reconciliation of this object

URL specifies the Git url to scan and project

Reference specifies the Git branch, tag or commit to scan. Branches and tags can contain regular expressions

Files specifies the list of files to include in the projection

SecretRefs specifies a Secret use for Git authentication. The contents of the secret must conform to: https://kluctl.io/docs/flux/spec/v1alpha1/kluctldeployment/#git-authentication

Branch to filter for. Can also be a regex.

Tag to filter for. Can also be a regex.

Commit SHA to check out, takes precedence over all reference fields.

Suspend can be used to suspend the reconciliation of this object

Owner specifies the GitHub user or organisation that owns the repository

Repo specifies the repository name.

TokenRef specifies a secret and key to load the GitHub API token from

(Members of GithubProject are embedded into this type.)

PullRequestId specifies the pull request ID.

Suspend can be used to suspend the reconciliation of this object

(Members of GitlabProject are embedded into this type.)

MergeRequestId specifies the Gitlab merge request internal ID

Project specifies the Gitlab group and project (separated by slash) to use, or the numeric project id

API specifies the GitLab API URL to talk to. If blank, uses https://gitlab.com/.

TokenRef specifies a secret and key to load the Gitlab API token from

Interval is the interval at which to query the Gitlab API. Defaults to 5m.

(Members of GithubProject are embedded into this type.)

Head specifies the head to filter for

Base specifies the base to filter for

Labels is used to filter the PRs that you want to target

State is an additional PR filter to get only those with a certain state. Default: “all”

Limit limits the maximum number of pull requests to fetch. Defaults to 100

Interval is the interval at which to query the Gitlab API. Defaults to 5m.

(Members of GitlabProject are embedded into this type.)

TargetBranch specifies the target branch to filter for

Labels is used to filter the MRs that you want to target

State is an additional MRs filter to get only those with a certain state. Default: “all”

Limit limits the maximum number of merge requests to fetch. Defaults to 100

Name of the referent.

Name specifies the name this matrix input is available while rendering templates

Object specifies an object to load and make available while rendering templates. The object can be accessed through the name specified above. The service account used by the ObjectTemplate must have proper permissions to get this object

List specifies a list of plain YAML values which are made available while rendering templates. The list can be accessed through the name specified above

Ref specifies the apiVersion, kind, namespace and name of the object to load. The service account used by the ObjectTemplate must have proper permissions to get this object

JsonPath optionally specifies a sub-field to load. When specified, the sub-field (and not the whole object) is made available while rendering templates

ExpandLists enables optional expanding of list. Expanding means, that each list entry is interpreted as individual matrix input instead of interpreting the whole list as one matrix input. This feature is only useful when used in combination with jsonPath

Suspend can be used to suspend the reconciliation of this object

ServiceAccountName specifies the name of the Kubernetes service account to impersonate when reconciling this ObjectTemplate. If omitted, the “default” service account is used

Prune enables pruning of previously created objects when these disappear from the list of rendered objects

Matrix specifies the input matrix

Templates specifies a list of templates to render and deploy

Object specifies a structured object in YAML form. Each field value is rendered independently.

Raw specifies a raw string to be interpreted/parsed as YAML. The whole string is rendered in one go, allowing to use advanced Jinja2 control structures. Raw object might also be required when a templated value must not be interpreted as a string (which would be done in Object).

Suspend can be used to suspend the reconciliation of this object.

ServiceAccountName specifies the name of the Kubernetes service account to impersonate when reconciling this TextTemplate. If omitted, the “default” service account is used