flux v2.9.5

GitRepository.spec

GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository.

14 fields
GitRepository.spec fields and descriptions
Field / TypeDescription
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.

object[]

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

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 'aws', 'azure', 'github', 'generic'. When not specified, defaults to 'generic'.

  • enum: ["generic","aws","azure","github"]
object

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

recurseSubmodules
boolean

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

object

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

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.

serviceAccountName
string

ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate to the GitRepository. This field is only supported for 'azure' and 'aws' providers.

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.

  • default: "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)://.*$
object

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