GitRepository

io.fluxcd.toolkit.source.v1beta2.GitRepository

GitRepository is the Schema for the gitrepositories API.

apiVersionstring = "source.toolkit.fluxcd.io/v1beta2"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kindstring = "GitRepository"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to.Cannot be updated. In CamelCase.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadataobject
specobjectGitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository.
accessFromobjectAccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092
namespaceSelectors[]object requiredNamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.
matchLabelsmap[string]stringMatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
gitImplementationstringGitImplementation specifies which Git client library implementation to use. Defaults to 'go-git', valid values are ('go-git', 'libgit2'). Deprecated: gitImplementation is deprecated now that 'go-git' is the only supported implementation.
ignorestringIgnore 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.
include[]objectInclude specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository.
fromPathstringFromPath specifies the path to copy contents from, defaults to the root of the Artifact.
repositoryobject requiredGitRepositoryRef specifies the GitRepository which Artifact contents must be included.
namestring requiredName of the referent.
toPathstringToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.
intervalstring requiredInterval at which to check the GitRepository for updates.
recurseSubmodulesbooleanRecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings.
refobjectReference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.
branchstringBranch to check out, defaults to 'master' if no other field is defined.
commitstringCommit 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.
namestringName 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"
semverstringSemVer tag expression to check out, takes precedence over Tag.
tagstringTag to check out, takes precedence over Branch.
secretRefobjectSecretRef 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.
namestring requiredName of the referent.
suspendbooleanSuspend tells the controller to suspend the reconciliation of this GitRepository.
timeoutstringTimeout for Git operations like cloning, defaults to 60s.
urlstring requiredURL specifies the Git repository URL, it can be an HTTP/S or SSH address.
verifyobjectVerification specifies the configuration to verify the Git commit signature(s).
modestring requiredMode specifies what Git object should be verified, currently ('head').
secretRefobject requiredSecretRef specifies the Secret containing the public keys of trusted Git authors.
namestring requiredName of the referent.
statusobject read-onlyGitRepositoryStatus records the observed state of a Git repository.
artifactobject read-onlyArtifact represents the last successful GitRepository reconciliation.
digeststring required read-onlyDigest is the digest of the file in the form of '<algorithm>:<checksum>'.
lastUpdateTimestring (date-time) required read-onlyLastUpdateTime is the timestamp corresponding to the last update of the Artifact.
metadatamap[string]string read-onlyMetadata holds upstream information such as OCI annotations.
pathstring required read-onlyPath 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.
revisionstring required read-onlyRevision 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.
sizeinteger (int64) read-onlySize is the number of bytes in the file.
urlstring required read-onlyURL 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.
conditions[]object read-onlyConditions holds the conditions for the GitRepository.
lastTransitionTimestring (date-time) required read-onlylastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
messagestring required read-onlymessage is a human readable message indicating details about the transition. This may be an empty string.
observedGenerationinteger (int64) read-onlyobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reasonstring required read-onlyreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
statusstring required read-onlystatus of the condition, one of True, False, Unknown.
typestring required read-onlytype of condition in CamelCase or in foo.example.com/CamelCase.
contentConfigChecksumstring read-onlyContentConfigChecksum is a checksum of all the configurations related to the content of the source artifact:
  • .spec.ignore
  • .spec.recurseSubmodules
  • .spec.included and the checksum of the included artifacts
observed in .status.observedGeneration version of the object. This can be used to determine if the content of the included repository has changed. It has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`.Deprecated: Replaced with explicit fields for observed artifact content config in the status.
includedArtifacts[]object read-onlyIncludedArtifacts contains a list of the last successfully included Artifacts as instructed by GitRepositorySpec.Include.
digeststring required read-onlyDigest is the digest of the file in the form of '<algorithm>:<checksum>'.
lastUpdateTimestring (date-time) required read-onlyLastUpdateTime is the timestamp corresponding to the last update of the Artifact.
metadatamap[string]string read-onlyMetadata holds upstream information such as OCI annotations.
pathstring required read-onlyPath 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.
revisionstring required read-onlyRevision 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.
sizeinteger (int64) read-onlySize is the number of bytes in the file.
urlstring required read-onlyURL 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.
lastHandledReconcileAtstring read-onlyLastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.
observedGenerationinteger (int64) read-onlyObservedGeneration is the last observed generation of the GitRepository object.
observedIgnorestring read-onlyObservedIgnore is the observed exclusion patterns used for constructing the source artifact.
observedInclude[]object read-onlyObservedInclude is the observed list of GitRepository resources used to to produce the current Artifact.
fromPathstring read-onlyFromPath specifies the path to copy contents from, defaults to the root of the Artifact.
repositoryobject required read-onlyGitRepositoryRef specifies the GitRepository which Artifact contents must be included.
namestring required read-onlyName of the referent.
toPathstring read-onlyToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.
observedRecurseSubmodulesboolean read-onlyObservedRecurseSubmodules is the observed resource submodules configuration used to produce the current Artifact.
urlstring read-onlyURL is the dynamic fetch link for the latest Artifact. It is provided on a "best effort" basis, and using the precise GitRepositoryStatus.Artifact data is recommended.