GitRepository
source.toolkit.fluxcd.io / v1
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
name: example
apiVersion
string
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
kind
string
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
metadata
object
spec object
GitRepositorySpec specifies the required configuration to produce an
Artifact for a Git repository.
ignore
string
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.
include []object
Include specifies a list of GitRepository resources which Artifacts
should be included in the Artifact produced for this GitRepository.
fromPath
string
FromPath specifies the path to copy contents from, defaults to the root
of the Artifact.
repository object required
GitRepositoryRef specifies the GitRepository which Artifact contents
must be included.
name
string required
Name of the referent.
toPath
string
ToPath specifies the path to copy contents to, defaults to the name of
the GitRepositoryRef.
interval
string required
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.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
provider
string
Provider used for authentication, can be 'azure', 'github', 'generic'.
When not specified, defaults to 'generic'.
enum:
generic, azure, githubproxySecretRef object
ProxySecretRef specifies the Secret containing the proxy configuration
to use while communicating with the Git server.
name
string required
Name of the referent.
recurseSubmodules
boolean
RecurseSubmodules enables the initialization of all submodules within
the GitRepository as cloned from the URL, using their default settings.
ref object
Reference specifies the Git reference to resolve and monitor for
changes, defaults to the 'master' branch.
branch
string
Branch to check out, defaults to 'master' if no other field is defined.
commit
string
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.
name
string
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"
semver
string
SemVer tag expression to check out, takes precedence over Tag.
tag
string
Tag to check out, takes precedence over Branch.
secretRef object
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.
name
string required
Name of the referent.
serviceAccountName
string
ServiceAccountName is the name of the Kubernetes ServiceAccount used to
authenticate to the GitRepository. This field is only supported for 'azure' provider.
sparseCheckout
[]string
SparseCheckout specifies a list of directories to checkout when cloning
the repository. If specified, only these directories are included in the
Artifact produced for this GitRepository.
suspend
boolean
Suspend tells the controller to suspend the reconciliation of this
GitRepository.
timeout
string
Timeout for Git operations like cloning, defaults to 60s.
pattern:
^([0-9]+(\.[0-9]+)?(ms|s|m))+$
url
string required
URL specifies the Git repository URL, it can be an HTTP/S or SSH address.
pattern:
^(http|https|ssh)://.*$verify object
Verification specifies the configuration to verify the Git commit
signature(s).
mode
string
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.
enum:
head, HEAD, Tag, TagAndHEADsecretRef object required
SecretRef specifies the Secret containing the public keys of trusted Git
authors.
name
string required
Name of the referent.
status object
GitRepositoryStatus records the observed state of a Git repository.
artifact object
Artifact represents the last successful GitRepository reconciliation.
digest
string required
Digest is the digest of the file in the form of '<algorithm>:<checksum>'.
pattern:
^[a-z0-9]+(?:[.+_-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$
lastUpdateTime
string required
LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
format:
date-time
metadata
object
Metadata holds upstream information such as OCI annotations.
path
string required
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.
revision
string required
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.
size
integer
Size is the number of bytes in the file.
format:
int64
url
string required
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.
conditions []object
Conditions holds the conditions for the GitRepository.
lastTransitionTime
string required
lastTransitionTime 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.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration 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.
format:
int64minimum:
0
reason
string required
reason 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.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316includedArtifacts []object
IncludedArtifacts contains a list of the last successfully included
Artifacts as instructed by GitRepositorySpec.Include.
digest
string required
Digest is the digest of the file in the form of '<algorithm>:<checksum>'.
pattern:
^[a-z0-9]+(?:[.+_-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$
lastUpdateTime
string required
LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
format:
date-time
metadata
object
Metadata holds upstream information such as OCI annotations.
path
string required
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.
revision
string required
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.
size
integer
Size is the number of bytes in the file.
format:
int64
url
string required
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.
lastHandledReconcileAt
string
LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration
integer
ObservedGeneration is the last observed generation of the GitRepository
object.
format:
int64
observedIgnore
string
ObservedIgnore is the observed exclusion patterns used for constructing
the source artifact.
observedInclude []object
ObservedInclude is the observed list of GitRepository resources used to
produce the current Artifact.
fromPath
string
FromPath specifies the path to copy contents from, defaults to the root
of the Artifact.
repository object required
GitRepositoryRef specifies the GitRepository which Artifact contents
must be included.
name
string required
Name of the referent.
toPath
string
ToPath specifies the path to copy contents to, defaults to the name of
the GitRepositoryRef.
observedRecurseSubmodules
boolean
ObservedRecurseSubmodules is the observed resource submodules
configuration used to produce the current Artifact.
observedSparseCheckout
[]string
ObservedSparseCheckout is the observed list of directories used to
produce the current Artifact.
sourceVerificationMode
string
SourceVerificationMode is the last used verification mode indicating
which Git object(s) have been verified.
No matches. Try .spec.ignore for an exact path