source-controller/docs/api/source.md

Source API reference

Packages:

• source.fluxcd.io/v1alpha1

source.fluxcd.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the source v1alpha1 API group

Resource Types:

• GitRepository
• HelmChart
• HelmRepository

GitRepository

GitRepository is the Schema for the gitrepositories API

Field	Description
apiVersion string	source.fluxcd.io/v1alpha1
kind string	GitRepository
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec GitRepositorySpec	url string The repository URL, can be a HTTP or SSH address. secretRef Kubernetes core/v1.LocalObjectReference (Optional) The secret name containing the Git credentials. For HTTPS repositories the secret must contain username and password fields. For SSH repositories the secret must contain identity, identity.pub and known_hosts fields. interval Kubernetes meta/v1.Duration The interval at which to check for repository updates. timeout Kubernetes meta/v1.Duration (Optional) The timeout for remote git operations like cloning, default to 20s. ref GitRepositoryRef (Optional) The git reference to checkout and monitor for changes, defaults to master branch. verify GitRepositoryVerification (Optional) Verify OpenPGP signature for the commit that HEAD points to.
status GitRepositoryStatus

HelmChart

HelmChart is the Schema for the helmcharts API

Field	Description
apiVersion string	source.fluxcd.io/v1alpha1
kind string	HelmChart
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec HelmChartSpec	name string The name of the Helm chart, as made available by the referenced Helm repository. version string (Optional) The chart version semver expression, defaults to latest when omitted. helmRepositoryRef Kubernetes core/v1.LocalObjectReference The name of the HelmRepository the chart is available at. interval Kubernetes meta/v1.Duration The interval at which to check the Helm repository for updates.
status HelmChartStatus

HelmRepository

HelmRepository is the Schema for the helmrepositories API

Field	Description
apiVersion string	source.fluxcd.io/v1alpha1
kind string	HelmRepository
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec HelmRepositorySpec	url string The Helm repository URL, a valid URL contains at least a protocol and host. secretRef Kubernetes core/v1.LocalObjectReference (Optional) The name of the secret containing authentication credentials for the Helm repository. For HTTP/S basic auth the secret must contain username and password fields. For TLS the secret must contain caFile, keyFile and caCert fields. interval Kubernetes meta/v1.Duration The interval at which to check the upstream for updates.
status HelmRepositoryStatus

Artifact

(Appears on: GitRepositoryStatus, HelmChartStatus, HelmRepositoryStatus)

Artifact represents the output of a source synchronisation

Field	Description
path string	Path is the local file path of this artifact.
url string	URL is the HTTP address of this artifact.
revision string	(Optional) Revision is a human readable identifier traceable in the origin source system. It can be a commit sha, git tag, a helm index timestamp, a helm chart version, a checksum, etc.
lastUpdateTime Kubernetes meta/v1.Time	LastUpdateTime is the timestamp corresponding to the last update of this artifact.

GitRepositoryRef

(Appears on: GitRepositorySpec)

GitRepositoryRef defines the git ref used for pull and checkout operations.

Field	Description
branch string	(Optional) The git branch to checkout, defaults to master.
tag string	(Optional) The git tag to checkout, takes precedence over branch.
semver string	(Optional) The git tag semver expression, takes precedence over tag.
commit string	(Optional) The git commit sha to checkout, if specified tag filters will be ignored.

GitRepositorySpec

(Appears on: GitRepository)

GitRepositorySpec defines the desired state of a Git repository.

Field	Description
url string	The repository URL, can be a HTTP or SSH address.
secretRef Kubernetes core/v1.LocalObjectReference	(Optional) The secret name containing the Git credentials. For HTTPS repositories the secret must contain username and password fields. For SSH repositories the secret must contain identity, identity.pub and known_hosts fields.
interval Kubernetes meta/v1.Duration	The interval at which to check for repository updates.
timeout Kubernetes meta/v1.Duration	(Optional) The timeout for remote git operations like cloning, default to 20s.
ref GitRepositoryRef	(Optional) The git reference to checkout and monitor for changes, defaults to master branch.
verify GitRepositoryVerification	(Optional) Verify OpenPGP signature for the commit that HEAD points to.

GitRepositoryStatus

(Appears on: GitRepository)

GitRepositoryStatus defines the observed state of a Git repository.

Field	Description
conditions []SourceCondition	(Optional)
url string	(Optional) URL is the download link for the artifact output of the last repository sync.
artifact Artifact	(Optional) Artifact represents the output of the last successful repository sync.

GitRepositoryVerification

(Appears on: GitRepositorySpec)

GitRepositoryVerification defines the OpenPGP signature verification process.

Field	Description
mode string	Mode describes what git object should be verified, currently (‘head’).
secretRef Kubernetes core/v1.LocalObjectReference	The secret name containing the public keys of all trusted git authors.

HelmChartSpec

(Appears on: HelmChart)

HelmChartSpec defines the desired state of a Helm chart.

Field	Description
name string	The name of the Helm chart, as made available by the referenced Helm repository.
version string	(Optional) The chart version semver expression, defaults to latest when omitted.
helmRepositoryRef Kubernetes core/v1.LocalObjectReference	The name of the HelmRepository the chart is available at.
interval Kubernetes meta/v1.Duration	The interval at which to check the Helm repository for updates.

HelmChartStatus

(Appears on: HelmChart)

HelmChartStatus defines the observed state of the HelmChart.

Field	Description
conditions []SourceCondition	(Optional)
url string	(Optional) URL is the download link for the last chart pulled.
artifact Artifact	(Optional) Artifact represents the output of the last successful chart sync.

HelmRepositorySpec

(Appears on: HelmRepository)

HelmRepositorySpec defines the reference to a Helm repository.

Field	Description
url string	The Helm repository URL, a valid URL contains at least a protocol and host.
secretRef Kubernetes core/v1.LocalObjectReference	(Optional) The name of the secret containing authentication credentials for the Helm repository. For HTTP/S basic auth the secret must contain username and password fields. For TLS the secret must contain caFile, keyFile and caCert fields.
interval Kubernetes meta/v1.Duration	The interval at which to check the upstream for updates.

HelmRepositoryStatus

(Appears on: HelmRepository)

HelmRepositoryStatus defines the observed state of the HelmRepository.

Field	Description
conditions []SourceCondition	(Optional)
url string	(Optional) URL is the download link for the last index fetched.
artifact Artifact	(Optional) Artifact represents the output of the last successful repository sync.

Source

Source interface must be supported by all API types.

SourceCondition

(Appears on: GitRepositoryStatus, HelmChartStatus, HelmRepositoryStatus)

SourceCondition contains condition information for a source.

Field	Description
type string	Type of the condition, currently (‘Ready’).
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the timestamp corresponding to the last status change of this condition.
reason string	Reason is a brief machine readable explanation for the condition’s last transition.
message string	(Optional) Message is a human readable description of the details of the last transition, complementing reason.

This page was automatically generated with gen-crd-api-reference-docs