flux v2.0.1

GitRepository.spec

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

12 fields
GitRepository.spec fields and descriptions
Field / TypeDescription
object

AccessFrom 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

gitImplementation
string

GitImplementation 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.

  • enum: ["go-git","libgit2"]
  • default: "go-git"
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 to check the GitRepository for updates.

  • pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
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.

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).