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:

    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.

    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.

    status
    RepositoryStatus
    (Optional)

    RepositoryRef

    (Appears on: FileRef, 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 from which to fetch the Dispatchfile.

    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.

    RepositoryStatus

    (Appears on: 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).