Template Controller API reference

Template Controller API reference

Packages:

templates.kluctl.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the templates.kluctl.io v1alpha1 API group.

Resource Types:

    AppliedResourceInfo

    (Appears on: ObjectTemplateStatus)

    FieldDescription
    ref
    ObjectRef
    success
    bool
    error
    string
    (Optional)

    CommentSourceSpec

    (Appears on: CommentSpec)

    FieldDescription
    text
    string
    (Optional)

    Text specifies a raw text comment.

    configMap
    ConfigMapRef
    (Optional)

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

    textTemplate
    LocalObjectReference
    (Optional)

    TextTemplate specifies a TextTemplate to load the source content from

    CommentSpec

    (Appears on: GithubCommentSpec, GitlabCommentSpec)

    FieldDescription
    id
    string
    (Optional)

    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
    CommentSourceSpec

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

    ConfigMapRef

    (Appears on: CommentSourceSpec)

    FieldDescription
    name
    string
    key
    string

    GitFile

    (Appears on: GitProjectorSpec)

    FieldDescription
    glob
    string

    Glob specifies a glob to use for filename matching.

    parseYaml
    bool
    (Optional)

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

    GitProjector

    GitProjector is the Schema for the gitprojectors API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    GitProjectorSpec


    interval
    Kubernetes meta/v1.Duration
    (Optional)

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

    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    url
    string

    URL specifies the Git url to scan and project

    ref
    GitRef
    (Optional)

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

    files
    []GitFile
    (Optional)

    Files specifies the list of files to include in the projection

    secretRef
    LocalObjectReference
    (Optional)

    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

    status
    GitProjectorStatus

    GitProjectorResult

    (Appears on: GitProjectorStatus)

    FieldDescription
    ref
    GitRef
    files
    []GitProjectorResultFile

    GitProjectorResultFile

    (Appears on: GitProjectorResult)

    FieldDescription
    path
    string
    raw
    string
    (Optional)
    parsed
    []*k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    GitProjectorSpec

    (Appears on: GitProjector)

    GitProjectorSpec defines the desired state of GitProjector

    FieldDescription
    interval
    Kubernetes meta/v1.Duration
    (Optional)

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

    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    url
    string

    URL specifies the Git url to scan and project

    ref
    GitRef
    (Optional)

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

    files
    []GitFile
    (Optional)

    Files specifies the list of files to include in the projection

    secretRef
    LocalObjectReference
    (Optional)

    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

    GitProjectorStatus

    (Appears on: GitProjector)

    GitProjectorStatus defines the observed state of GitProjector

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    allRefsHash
    string
    (Optional)
    result
    []GitProjectorResult
    (Optional)

    GitRef

    (Appears on: GitProjectorResult, GitProjectorSpec)

    FieldDescription
    branch
    string
    (Optional)

    Branch to filter for. Can also be a regex.

    tag
    string
    (Optional)

    Tag to filter for. Can also be a regex.

    commit
    string
    (Optional)

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

    GithubComment

    GithubComment is the Schema for the githubcomments API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    GithubCommentSpec


    github
    GithubPullRequestRef
    comment
    CommentSpec
    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    status
    GithubCommentStatus

    GithubCommentSpec

    (Appears on: GithubComment)

    GithubCommentSpec defines the desired state of GithubComment

    FieldDescription
    github
    GithubPullRequestRef
    comment
    CommentSpec
    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    GithubCommentStatus

    (Appears on: GithubComment)

    GithubCommentStatus defines the observed state of GithubComment

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    commentId
    string
    (Optional)
    lastPostedBodyHash
    string
    (Optional)

    GithubProject

    (Appears on: GithubPullRequestRef, ListGithubPullRequestsSpec)

    FieldDescription
    owner
    string

    Owner specifies the GitHub user or organisation that owns the repository

    repo
    string

    Repo specifies the repository name.

    tokenRef
    SecretRef
    (Optional)

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

    GithubPullRequestRef

    (Appears on: GithubCommentSpec, PullRequestRefHolder)

    FieldDescription
    GithubProject
    GithubProject

    (Members of GithubProject are embedded into this type.)

    pullRequestId
    int

    PullRequestId specifies the pull request ID.

    GitlabComment

    GitlabComment is the Schema for the gitlabcomments API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    GitlabCommentSpec


    gitlab
    GitlabMergeRequestRef
    comment
    CommentSpec
    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    status
    GitlabCommentStatus

    GitlabCommentSpec

    (Appears on: GitlabComment)

    GitlabCommentSpec defines the desired state of GitlabComment

    FieldDescription
    gitlab
    GitlabMergeRequestRef
    comment
    CommentSpec
    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    GitlabCommentStatus

    (Appears on: GitlabComment)

    GitlabCommentStatus defines the observed state of GitlabComment

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    noteId
    string
    (Optional)
    lastPostedBodyHash
    string
    (Optional)

    GitlabMergeRequestRef

    (Appears on: GitlabCommentSpec, PullRequestRefHolder)

    FieldDescription
    GitlabProject
    GitlabProject

    (Members of GitlabProject are embedded into this type.)

    mergeRequestId
    int

    MergeRequestId specifies the Gitlab merge request internal ID

    GitlabProject

    (Appears on: GitlabMergeRequestRef, ListGitlabMergeRequestsSpec)

    FieldDescription
    project
    string

    Project specifies the Gitlab group and project (separated by slash) to use

    api
    string
    (Optional)

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

    tokenRef
    SecretRef
    (Optional)

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

    Handler

    (Appears on: ObjectHandlerSpec)

    FieldDescription
    pullRequestComment
    PullRequestCommentReporter
    (Optional)
    pullRequestApprove
    PullRequestApproveReporter
    (Optional)
    pullRequestCommand
    PullRequestCommandHandler
    (Optional)

    HandlerStatus

    FieldDescription
    key
    string
    error
    string
    (Optional)
    pullRequestComment
    PullRequestCommentReporterStatus
    (Optional)
    pullRequestApprove
    PullRequestApproveReporterStatus
    (Optional)
    pullRequestCommand
    PullRequestCommandHandlerStatus
    (Optional)

    ListGithubPullRequests

    ListGithubPullRequests is the Schema for the listgithubpullrequests API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ListGithubPullRequestsSpec


    interval
    Kubernetes meta/v1.Duration
    (Optional)

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

    GithubProject
    GithubProject

    (Members of GithubProject are embedded into this type.)

    head
    string
    (Optional)

    Head specifies the head to filter for

    base
    string
    (Optional)

    Base specifies the base to filter for

    labels
    []string
    (Optional)

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

    state
    string
    (Optional)

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

    limit
    int

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

    status
    ListGithubPullRequestsStatus

    ListGithubPullRequestsSpec

    (Appears on: ListGithubPullRequests)

    ListGithubPullRequestsSpec defines the desired state of ListGithubPullRequests

    FieldDescription
    interval
    Kubernetes meta/v1.Duration
    (Optional)

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

    GithubProject
    GithubProject

    (Members of GithubProject are embedded into this type.)

    head
    string
    (Optional)

    Head specifies the head to filter for

    base
    string
    (Optional)

    Base specifies the base to filter for

    labels
    []string
    (Optional)

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

    state
    string
    (Optional)

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

    limit
    int

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

    ListGithubPullRequestsStatus

    (Appears on: ListGithubPullRequests)

    ListGithubPullRequestsStatus defines the observed state of ListGithubPullRequests

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    pullRequests
    []k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    ListGitlabMergeRequests

    ListGitlabMergeRequests is the Schema for the listgitlabmergerequests API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ListGitlabMergeRequestsSpec


    interval
    Kubernetes meta/v1.Duration
    (Optional)

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

    GitlabProject
    GitlabProject

    (Members of GitlabProject are embedded into this type.)

    targetBranch
    string
    (Optional)

    TargetBranch specifies the target branch to filter for

    sourceBranch
    string
    (Optional)
    labels
    []string
    (Optional)

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

    state
    string
    (Optional)

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

    limit
    int

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

    status
    ListGitlabMergeRequestsStatus

    ListGitlabMergeRequestsSpec

    (Appears on: ListGitlabMergeRequests)

    ListGitlabMergeRequestsSpec defines the desired state of ListGitlabMergeRequests

    FieldDescription
    interval
    Kubernetes meta/v1.Duration
    (Optional)

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

    GitlabProject
    GitlabProject

    (Members of GitlabProject are embedded into this type.)

    targetBranch
    string
    (Optional)

    TargetBranch specifies the target branch to filter for

    sourceBranch
    string
    (Optional)
    labels
    []string
    (Optional)

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

    state
    string
    (Optional)

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

    limit
    int

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

    ListGitlabMergeRequestsStatus

    (Appears on: ListGitlabMergeRequests)

    ListGitlabMergeRequestsStatus defines the observed state of ListGitlabMergeRequests

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    mergeRequests
    []k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    LocalObjectReference

    (Appears on: CommentSourceSpec, GitProjectorSpec)

    FieldDescription
    name
    string

    Name of the referent.

    MatrixEntry

    FieldDescription
    name
    string

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

    object
    MatrixEntryObject
    (Optional)

    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
    []k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    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

    MatrixEntryObject

    (Appears on: MatrixEntry)

    FieldDescription
    ref
    ObjectRef

    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
    string
    (Optional)

    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
    bool
    (Optional)

    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

    ObjectHandler

    ObjectHandler is the Schema for the objecthandlers API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ObjectHandlerSpec


    interval
    Kubernetes meta/v1.Duration
    forObject
    ObjectRef
    handlers
    []Handler
    status
    ObjectHandlerStatus

    ObjectHandlerSpec

    (Appears on: ObjectHandler)

    ObjectHandlerSpec defines the desired state of ObjectHandler

    FieldDescription
    interval
    Kubernetes meta/v1.Duration
    forObject
    ObjectRef
    handlers
    []Handler

    ObjectHandlerStatus

    (Appears on: ObjectHandler)

    ObjectHandlerStatus defines the observed state of ObjectHandler

    ObjectRef

    (Appears on: AppliedResourceInfo, MatrixEntryObject, ObjectHandlerSpec, TextTemplateInputObject)

    FieldDescription
    apiVersion
    string
    kind
    string
    namespace
    string
    (Optional)
    name
    string

    ObjectTemplate

    ObjectTemplate is the Schema for the objecttemplates API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ObjectTemplateSpec


    interval
    Kubernetes meta/v1.Duration
    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    serviceAccountName
    string
    (Optional)

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

    prune
    bool
    (Optional)

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

    matrix
    []*github.com/kluctl/template-controller/api/v1alpha1.MatrixEntry

    Matrix specifies the input matrix

    templates
    []Template

    Templates specifies a list of templates to render and deploy

    status
    ObjectTemplateStatus

    ObjectTemplateSpec

    (Appears on: ObjectTemplate)

    ObjectTemplateSpec defines the desired state of ObjectTemplate

    FieldDescription
    interval
    Kubernetes meta/v1.Duration
    suspend
    bool
    (Optional)

    Suspend can be used to suspend the reconciliation of this object

    serviceAccountName
    string
    (Optional)

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

    prune
    bool
    (Optional)

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

    matrix
    []*github.com/kluctl/template-controller/api/v1alpha1.MatrixEntry

    Matrix specifies the input matrix

    templates
    []Template

    Templates specifies a list of templates to render and deploy

    ObjectTemplateStatus

    (Appears on: ObjectTemplate)

    ObjectTemplateStatus defines the observed state of ObjectTemplate

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    appliedResources
    []AppliedResourceInfo
    (Optional)

    PullRequestApproveReporter

    (Appears on: Handler)

    FieldDescription
    PullRequestRefHolder
    PullRequestRefHolder

    (Members of PullRequestRefHolder are embedded into this type.)

    missingReadyConditionIsError
    bool
    (Optional)

    PullRequestApproveReporterStatus

    (Appears on: HandlerStatus)

    FieldDescription
    approved
    bool
    (Optional)

    PullRequestCommandHandler

    (Appears on: Handler)

    FieldDescription
    PullRequestRefHolder
    PullRequestRefHolder

    (Members of PullRequestRefHolder are embedded into this type.)

    postHelpComment
    bool
    (Optional)
    commands
    []PullRequestCommandHandlerCommandSpec

    PullRequestCommandHandlerActionAnnotateSpec

    (Appears on: PullRequestCommandHandlerActionSpec)

    FieldDescription
    annotation
    string
    value
    string

    PullRequestCommandHandlerActionSpec

    (Appears on: PullRequestCommandHandlerCommandSpec)

    FieldDescription
    annotate
    PullRequestCommandHandlerActionAnnotateSpec
    (Optional)
    jsonPatch
    []k8s.io/apimachinery/pkg/runtime.RawExtension
    (Optional)

    PullRequestCommandHandlerCommandSpec

    (Appears on: PullRequestCommandHandler)

    FieldDescription
    name
    string
    description
    string
    (Optional)
    actions
    []PullRequestCommandHandlerActionSpec

    PullRequestCommandHandlerStatus

    (Appears on: HandlerStatus)

    FieldDescription
    lastProcessedCommentTime
    string
    (Optional)
    helpNoteId
    string
    (Optional)
    helpNoteBodyHash
    string
    (Optional)

    PullRequestCommentReporter

    (Appears on: Handler)

    FieldDescription
    PullRequestRefHolder
    PullRequestRefHolder

    (Members of PullRequestRefHolder are embedded into this type.)

    PullRequestCommentReporterStatus

    (Appears on: HandlerStatus)

    FieldDescription
    lastPostedStatusHash
    string
    (Optional)
    noteId
    string
    (Optional)

    PullRequestRefHolder

    (Appears on: PullRequestApproveReporter, PullRequestCommandHandler, PullRequestCommentReporter)

    FieldDescription
    gitlab
    GitlabMergeRequestRef
    (Optional)
    github
    GithubPullRequestRef
    (Optional)

    SecretRef

    (Appears on: GithubProject, GitlabProject)

    Utility struct for a reference to a secret key.

    FieldDescription
    secretName
    string
    key
    string

    Template

    (Appears on: ObjectTemplateSpec)

    FieldDescription
    object
    Kubernetes meta/v1/unstructured.Unstructured
    (Optional)

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

    raw
    string
    (Optional)

    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).

    TemplateRef

    (Appears on: TextTemplateSpec)

    FieldDescription
    configMap
    TemplateRefConfigMap
    (Optional)

    TemplateRefConfigMap

    (Appears on: TemplateRef)

    FieldDescription
    name
    string
    namespace
    string
    (Optional)
    key
    string

    TextTemplate

    TextTemplate is the Schema for the texttemplates API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    TextTemplateSpec


    suspend
    bool
    (Optional)

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

    serviceAccountName
    string
    (Optional)

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

    inputs
    []*github.com/kluctl/template-controller/api/v1alpha1.TextTemplateInput
    (Optional)
    template
    string
    (Optional)
    templateRef
    TemplateRef
    (Optional)
    status
    TextTemplateStatus

    TextTemplateInput

    FieldDescription
    name
    string
    object
    TextTemplateInputObject
    (Optional)

    TextTemplateInputObject

    (Appears on: TextTemplateInput)

    FieldDescription
    ref
    ObjectRef
    jsonPath
    string
    (Optional)

    TextTemplateSpec

    (Appears on: TextTemplate)

    TextTemplateSpec defines the desired state of TextTemplate

    FieldDescription
    suspend
    bool
    (Optional)

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

    serviceAccountName
    string
    (Optional)

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

    inputs
    []*github.com/kluctl/template-controller/api/v1alpha1.TextTemplateInput
    (Optional)
    template
    string
    (Optional)
    templateRef
    TemplateRef
    (Optional)

    TextTemplateStatus

    (Appears on: TextTemplate)

    TextTemplateStatus defines the observed state of TextTemplate

    FieldDescription
    conditions
    []Kubernetes meta/v1.Condition
    (Optional)
    result
    string
    (Optional)

    This page was automatically generated with gen-crd-api-reference-docs

    Last modified June 5, 2024: Sync docs (c6748cd)