Source API reference v1

Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.

URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.

Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.

Digest is the digest of the file in the form of ‘:’.

LastUpdateTime is the timestamp corresponding to the last update of the Artifact.

Size is the number of bytes in the file.

Metadata holds upstream information such as OCI annotations.

GitRepositoryRef specifies the GitRepository which Artifact contents must be included.

FromPath specifies the path to copy contents from, defaults to the root of the Artifact.

ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.

Branch to check out, defaults to ‘master’ if no other field is defined.

Tag to check out, takes precedence over Branch.

SemVer tag expression to check out, takes precedence over Tag.

Name of the reference to check out; takes precedence over Branch, Tag and SemVer.

It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: “refs/heads/main”, “refs/tags/v0.1.0”, “refs/pull/420/head”, “refs/merge-requests/1/head”

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

This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist.

URL specifies the Git repository URL, it can be an HTTP/S or SSH address.

SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain ‘username’ and ‘password’ fields for basic auth or ‘bearerToken’ field for token auth. For SSH repositories the Secret must contain ‘identity’ and ‘known_hosts’ fields.

Interval at which the GitRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.

Timeout for Git operations like cloning, defaults to 60s.

Reference specifies the Git reference to resolve and monitor for changes, defaults to the ‘master’ branch.

Verification specifies the configuration to verify the Git commit signature(s).

ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the Git server.

Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.

Suspend tells the controller to suspend the reconciliation of this GitRepository.

RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings.

Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository.

ObservedGeneration is the last observed generation of the GitRepository object.

Conditions holds the conditions for the GitRepository.

Artifact represents the last successful GitRepository reconciliation.

IncludedArtifacts contains a list of the last successfully included Artifacts as instructed by GitRepositorySpec.Include.

ObservedIgnore is the observed exclusion patterns used for constructing the source artifact.

ObservedRecurseSubmodules is the observed resource submodules configuration used to produce the current Artifact.

ObservedInclude is the observed list of GitRepository resources used to produce the current Artifact.

SourceVerificationMode is the last used verification mode indicating which Git object(s) have been verified.

(Members of ReconcileRequestStatus are embedded into this type.)

Mode specifies which Git object(s) should be verified.

The variants “head” and “HEAD” both imply the same thing, i.e. verify the commit that the HEAD of the Git repository points to. The variant “head” solely exists to ensure backwards compatibility.

SecretRef specifies the Secret containing the public keys of trusted Git authors.