Repository CRD

Reference Guide for Configuring a Repository

Packages:

dispatch.d2iq.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the Dispatch v1alpha1 API group

Resource Types:

    ConfigSource

    (Appears on: RepositorySpec)

    Field Description
    configMapKeyRef
    Kubernetes core/v1.ConfigMapKeySelector

    Set the ConfigMap key reference.

    CronAction

    (Appears on: PipelineRunResult)

    Cron action metadata as parsed from Dispatchfile

    Field Description
    name
    string

    Name of the cron action

    schedule
    string

    Schedule specified in the action

    revision
    string
    (Optional)

    Revision specified in the action

    CronPhase (string alias)

    (Appears on: CronStatus)

    Possible states for cron reconciliation. - Pending indicates work needs to be scheduled - Syncing indicates active work being done - Ready is the standby state

    CronStatus

    (Appears on: RepositoryStatus)

    Cron actions related metadata to be updated by various actors Repository CRD

    Field Description
    phase
    CronPhase
    (Optional)

    Current state of cron reconciliation

    pipelineRunRef
    string
    (Optional)

    Reference to most recently launched pipelinerun which should be used to update cron triggers

    pipelineRunResults
    []PipelineRunResult
    (Optional)

    Status array to be used by pipelineruns to reflect the parsed cron actions

    dispatchfileChecksum
    string
    (Optional)

    checksum of the Dispatchfile contents

    dispatchfileRepoRevision
    string
    (Optional)

    commit SHA of the HEAD of dispatchfile repo branch/tag

    FileRef

    (Appears on: RepositorySpec)

    Field Description
    path
    string

    The path to the file to fetch.

    repository
    RepositoryRef
    (Optional)

    Override the repository if it is different than the Repository’s RepositoryRef.

    revision
    string
    (Optional)

    Override the revision instead of using the revision from the event.

    GitopsRepository

    GitopsRepository represents a GitOps deployment backed by FluxCD.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    GitopsRepositorySpec
    (Optional)

    RepositoryRef
    RepositoryRef

    (Members of RepositoryRef are embedded into this type.)

    The repository to configure the webhook for.

    baseUrl
    string
    (Optional)

    The base URL to use when creating endpoint addresses.

    endpoint
    string
    (Optional)

    Set a fixed endpoint URL instead of letting the controller generate one.

    webhookSecret
    Kubernetes core/v1.SecretKeySelector
    (Optional)

    Set a fixed webhook secret token to use when creating webhooks. If the secret or key do not exist, then the controller will initialize the secret.

    status
    RepositoryStatus
    (Optional)

    GitopsRepositorySpec

    (Appears on: GitopsRepository)

    GitopsRepositorySpec defines the desired state of GitopsRepository

    Field Description
    RepositoryRef
    RepositoryRef

    (Members of RepositoryRef are embedded into this type.)

    The repository to configure the webhook for.

    baseUrl
    string
    (Optional)

    The base URL to use when creating endpoint addresses.

    endpoint
    string
    (Optional)

    Set a fixed endpoint URL instead of letting the controller generate one.

    webhookSecret
    Kubernetes core/v1.SecretKeySelector
    (Optional)

    Set a fixed webhook secret token to use when creating webhooks. If the secret or key do not exist, then the controller will initialize the secret.

    LogStorageRule

    Field Description
    maxBuildAge
    uint

    Maximum number of days to retain a build

    maxBuildRuns
    uint

    Maximum number of runs to retain of a build

    tasks
    string

    A csv of globs indicating tasks. * implicates all tasks in a pipeline

    LogStorageRules ([]./pkg/apis/v1alpha1/.LogStorageRule alias)

    (Appears on: RepositorySpec)

    PipelineRunResult

    (Appears on: CronStatus)

    Pipeleneruns update the status of repository CRD using this object

    Field Description
    name
    string

    Name of the pipelinerun

    cronActions
    []CronAction
    (Optional)

    Cron actions parsed by the pipelinerun

    Repository

    Repository represents an SCM repository webhook and indicates where to fetch a Dispatchfile from on events.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    RepositorySpec
    (Optional)

    RepositoryRef
    RepositoryRef

    (Members of RepositoryRef are embedded into this type.)

    The repository to configure the webhook for.

    dispatchfile
    FileRef
    (Optional)

    Override the default location to fetch the Dispatchfile from.

    serviceAccount
    string

    The service account to use when creating pipelines.

    baseUrl
    string
    (Optional)

    The base URL to use when creating endpoint addresses.

    endpoint
    string
    (Optional)

    Set a fixed endpoint URL instead of letting the controller generate one.

    webhookSecret
    Kubernetes core/v1.SecretKeySelector
    (Optional)

    Set a fixed webhook secret token to use when creating webhooks. If the secret or key do not exist, then the controller will initialize the secret.

    logStorageRules
    LogStorageRules

    Rules pertaining to log storage garbage collection

    timeout
    Kubernetes meta/v1.Duration

    Set the duration after which a PipelineRun is considered failed due to timeout. If the value is empty, the global timeout is used. If the value is set to 0, then the PipelineRun fails immediately upon encountering an error, this is equivalent to “no timeout”. See: - https://github.com/tektoncd/pipeline/issues/978 - https://github.com/tektoncd/pipeline/pull/1040

    podTemplateFrom
    ConfigSource
    (Optional)

    Set the reference of the ConfigMap to load the pod template for the PipelineRuns triggered for this repository

    disableAutoCancel
    bool
    (Optional)

    Set to true to disable auto canceling of running and pending builds when new builds are created.

    status
    RepositoryStatus
    (Optional)

    RepositoryRef

    (Appears on: FileRef, GitopsRepositorySpec, RepositorySpec)

    Field Description
    repository
    string

    Repository name, e.g., mesosphere/dispatch.

    secret
    string
    (Optional)

    Reference to the secret to use when interacting with the Git provider API. The secret should contain the following fields: username: the username (if password is not a token). password: the password or token (required). scm.provider.name: the name of the SCM provider (github, bitbucket, gitlab, gitea, gogs, stash, default: github) scm.provider.url: the URL of the SCM provider (defaults to the default for the SCM provider) The secret can be created with the dispatch login git command.

    RepositorySpec

    (Appears on: Repository)

    RepositorySpec defines the desired state of Repository

    Field Description
    RepositoryRef
    RepositoryRef

    (Members of RepositoryRef are embedded into this type.)

    The repository to configure the webhook for.

    dispatchfile
    FileRef
    (Optional)

    Override the default location to fetch the Dispatchfile from.

    serviceAccount
    string

    The service account to use when creating pipelines.

    baseUrl
    string
    (Optional)

    The base URL to use when creating endpoint addresses.

    endpoint
    string
    (Optional)

    Set a fixed endpoint URL instead of letting the controller generate one.

    webhookSecret
    Kubernetes core/v1.SecretKeySelector
    (Optional)

    Set a fixed webhook secret token to use when creating webhooks. If the secret or key do not exist, then the controller will initialize the secret.

    logStorageRules
    LogStorageRules

    Rules pertaining to log storage garbage collection

    timeout
    Kubernetes meta/v1.Duration

    Set the duration after which a PipelineRun is considered failed due to timeout. If the value is empty, the global timeout is used. If the value is set to 0, then the PipelineRun fails immediately upon encountering an error, this is equivalent to “no timeout”. See: - https://github.com/tektoncd/pipeline/issues/978 - https://github.com/tektoncd/pipeline/pull/1040

    podTemplateFrom
    ConfigSource
    (Optional)

    Set the reference of the ConfigMap to load the pod template for the PipelineRuns triggered for this repository

    disableAutoCancel
    bool
    (Optional)

    Set to true to disable auto canceling of running and pending builds when new builds are created.

    RepositoryStatus

    (Appears on: GitopsRepository, Repository)

    RepositoryStatus defines the observed state of Repository

    Field Description
    webhookEndpointPath
    string
    (Optional)

    The endpoint that was generated for the webhook (just the path portion of the URL).

    webhookId
    string
    (Optional)

    The webhook’s id as returned by the provider API (to detect if the webhook has changed since the secret was last set).

    cronStatus
    CronStatus
    (Optional)

    Cron metadata reflects any currently active pipeline(s) that are working to parse the Dispatchfile and load the cron actions. Can also be updated by event-sink to force reconciliation

    buildCounter
    uint32
    (Optional)

    Build counter that specifies the current build number in the repository object. Starts from 0 and can be reset to 0 anytime.