source-controller/docs/api/source.md

Source API reference

Packages:

• source.toolkit.fluxcd.io/v1beta2

source.toolkit.fluxcd.io/v1beta2

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

Resource Types:

• Bucket
• GitRepository
• HelmChart
• HelmRepository

Bucket

Bucket is the Schema for the buckets API.

Field	Description
apiVersion string	source.toolkit.fluxcd.io/v1beta2
kind string	Bucket
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec BucketSpec	provider string (Optional) Provider of the object storage bucket. Defaults to ‘generic’, which expects an S3 (API) compatible object storage. bucketName string BucketName is the name of the object storage bucket. endpoint string Endpoint is the object storage address the BucketName is located at. insecure bool (Optional) Insecure allows connecting to a non-TLS HTTP Endpoint. region string (Optional) Region on the Endpoint the BucketName is located in. secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference (Optional) SecretRef specifies the Secret containing authentication credentials for the Bucket. interval Kubernetes meta/v1.Duration Interval at which to check the Endpoint for updates. timeout Kubernetes meta/v1.Duration (Optional) Timeout for fetch operations, defaults to 60s. ignore string (Optional) 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. suspend bool (Optional) Suspend tells the controller to suspend the reconciliation of this Bucket. accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom (Optional) 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
status BucketStatus

GitRepository

GitRepository is the Schema for the gitrepositories API

Field	Description
apiVersion string	source.toolkit.fluxcd.io/v1beta2
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/S or SSH address. secretRef github.com/fluxcd/pkg/apis/meta.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, defaults to 60s. ref GitRepositoryRef (Optional) The Git reference to checkout and monitor for changes, defaults to master branch. verify GitRepositoryVerification (Optional) Verification defines the configuration to verify the OpenPGP signature for the Git commit HEAD points to. ignore string (Optional) 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. suspend bool (Optional) Suspend tells the controller to suspend the reconciliation of this source. This flag tells the controller to suspend the reconciliation of this source. gitImplementation string (Optional) Determines which git client library to use. Defaults to go-git, valid values are (‘go-git’, ‘libgit2’). recurseSubmodules bool (Optional) When enabled, after the clone is created, initializes all submodules within, using their default settings. This option is available only when using the ‘go-git’ GitImplementation. include []GitRepositoryInclude Include defines a list of GitRepository resources which artifacts should be included in the artifact produced for this resource. accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom (Optional) AccessFrom defines an Access Control List for allowing cross-namespace references to this object.
status GitRepositoryStatus

HelmChart

HelmChart is the Schema for the helmcharts API

Field	Description
apiVersion string	source.toolkit.fluxcd.io/v1beta2
kind string	HelmChart
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec HelmChartSpec	chart string The name or path the Helm chart is available at in the SourceRef. version string (Optional) The chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted. sourceRef LocalHelmChartSourceReference The reference to the Source the chart is available at. interval Kubernetes meta/v1.Duration The interval at which to check the Source for updates. reconcileStrategy string (Optional) Determines what enables the creation of a new artifact. Valid values are (‘ChartVersion’, ‘Revision’). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted. valuesFiles []string (Optional) Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted. valuesFile string (Optional) Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted. suspend bool (Optional) This flag tells the controller to suspend the reconciliation of this source. accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom (Optional) AccessFrom defines an Access Control List for allowing cross-namespace references to this object.
status HelmChartStatus

HelmRepository

HelmRepository is the Schema for the helmrepositories API

Field	Description
apiVersion string	source.toolkit.fluxcd.io/v1beta2
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 github.com/fluxcd/pkg/apis/meta.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 a certFile and keyFile, and/or caCert fields. passCredentials bool (Optional) PassCredentials allows the credentials from the SecretRef to be passed on to a host that does not match the host as defined in URL. This may be required if the host of the advertised chart URLs in the index differ from the defined URL. Enabling this should be done with caution, as it can potentially result in credentials getting stolen in a MITM-attack. interval Kubernetes meta/v1.Duration The interval at which to check the upstream for updates. timeout Kubernetes meta/v1.Duration (Optional) The timeout of index fetching, defaults to 60s. suspend bool (Optional) This flag tells the controller to suspend the reconciliation of this source. accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom (Optional) AccessFrom defines an Access Control List for allowing cross-namespace references to this object.
status HelmRepositoryStatus

Artifact

(Appears on: BucketStatus, GitRepositoryStatus, HelmChartStatus, HelmRepositoryStatus)

Artifact represents the output of a Source reconciliation.

Field	Description
path string	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.
url string	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.
revision string	(Optional) 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.
checksum string	(Optional) Checksum is the SHA256 checksum of the Artifact file.
lastUpdateTime Kubernetes meta/v1.Time	LastUpdateTime is the timestamp corresponding to the last update of the Artifact.

BucketSpec

(Appears on: Bucket)

BucketSpec specifies the required configuration to produce an Artifact for an object storage bucket.

Field	Description
provider string	(Optional) Provider of the object storage bucket. Defaults to ‘generic’, which expects an S3 (API) compatible object storage.
bucketName string	BucketName is the name of the object storage bucket.
endpoint string	Endpoint is the object storage address the BucketName is located at.
insecure bool	(Optional) Insecure allows connecting to a non-TLS HTTP Endpoint.
region string	(Optional) Region on the Endpoint the BucketName is located in.
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) SecretRef specifies the Secret containing authentication credentials for the Bucket.
interval Kubernetes meta/v1.Duration	Interval at which to check the Endpoint for updates.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout for fetch operations, defaults to 60s.
ignore string	(Optional) 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.
suspend bool	(Optional) Suspend tells the controller to suspend the reconciliation of this Bucket.
accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom	(Optional) 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

BucketStatus

(Appears on: Bucket)

BucketStatus records the observed state of a Bucket.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation of the Bucket object.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the Bucket.
url string	(Optional) URL is the dynamic fetch link for the latest Artifact. It is provided on a “best effort” basis, and using the precise BucketStatus.Artifact data is recommended.
artifact Artifact	(Optional) Artifact represents the last successful Bucket reconciliation.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

GitRepositoryInclude

(Appears on: GitRepositorySpec)

GitRepositoryInclude defines a source with a from and to path.

Field	Description
repository github.com/fluxcd/pkg/apis/meta.LocalObjectReference	Reference to a GitRepository to include.
fromPath string	(Optional) The path to copy contents from, defaults to the root directory.
toPath string	(Optional) The path to copy contents to, defaults to the name of the source ref.

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/S or SSH address.
secretRef github.com/fluxcd/pkg/apis/meta.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, defaults to 60s.
ref GitRepositoryRef	(Optional) The Git reference to checkout and monitor for changes, defaults to master branch.
verify GitRepositoryVerification	(Optional) Verification defines the configuration to verify the OpenPGP signature for the Git commit HEAD points to.
ignore string	(Optional) 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.
suspend bool	(Optional) Suspend tells the controller to suspend the reconciliation of this source. This flag tells the controller to suspend the reconciliation of this source.
gitImplementation string	(Optional) Determines which git client library to use. Defaults to go-git, valid values are (‘go-git’, ‘libgit2’).
recurseSubmodules bool	(Optional) When enabled, after the clone is created, initializes all submodules within, using their default settings. This option is available only when using the ‘go-git’ GitImplementation.
include []GitRepositoryInclude	Include defines a list of GitRepository resources which artifacts should be included in the artifact produced for this resource.
accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom	(Optional) AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

GitRepositoryStatus

(Appears on: GitRepository)

GitRepositoryStatus defines the observed state of a Git repository.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the GitRepository.
url string	(Optional) URL is the fetch link for the artifact output of the last repository sync.
artifact Artifact	(Optional) Artifact represents the output of the last successful repository sync.
includedArtifacts []*./api/v1beta2.Artifact	(Optional) IncludedArtifacts represents the included artifacts from the last successful repository sync.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

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 github.com/fluxcd/pkg/apis/meta.LocalObjectReference	SecretRef containing the public keys of all trusted Git authors.

HelmChartSpec

(Appears on: HelmChart)

HelmChartSpec defines the desired state of a Helm chart.

Field	Description
chart string	The name or path the Helm chart is available at in the SourceRef.
version string	(Optional) The chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted.
sourceRef LocalHelmChartSourceReference	The reference to the Source the chart is available at.
interval Kubernetes meta/v1.Duration	The interval at which to check the Source for updates.
reconcileStrategy string	(Optional) Determines what enables the creation of a new artifact. Valid values are (‘ChartVersion’, ‘Revision’). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.
valuesFiles []string	(Optional) Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.
valuesFile string	(Optional) Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted.
suspend bool	(Optional) This flag tells the controller to suspend the reconciliation of this source.
accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom	(Optional) AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

HelmChartStatus

(Appears on: HelmChart)

HelmChartStatus defines the observed state of the HelmChart.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation.
observedSourceArtifactRevision string	(Optional) ObservedSourceArtifactRevision is the last observed Artifact.Revision of the Source reference.
observedChartName string	(Optional) ObservedChartName is the last observed chart name as defined by the resolved chart reference.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the HelmChart.
url string	(Optional) URL is the fetch link for the last chart pulled.
artifact Artifact	(Optional) Artifact represents the output of the last successful chart sync.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

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 github.com/fluxcd/pkg/apis/meta.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 a certFile and keyFile, and/or caCert fields.
passCredentials bool	(Optional) PassCredentials allows the credentials from the SecretRef to be passed on to a host that does not match the host as defined in URL. This may be required if the host of the advertised chart URLs in the index differ from the defined URL. Enabling this should be done with caution, as it can potentially result in credentials getting stolen in a MITM-attack.
interval Kubernetes meta/v1.Duration	The interval at which to check the upstream for updates.
timeout Kubernetes meta/v1.Duration	(Optional) The timeout of index fetching, defaults to 60s.
suspend bool	(Optional) This flag tells the controller to suspend the reconciliation of this source.
accessFrom github.com/fluxcd/pkg/apis/acl.AccessFrom	(Optional) AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

HelmRepositoryStatus

(Appears on: HelmRepository)

HelmRepositoryStatus defines the observed state of the HelmRepository.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the HelmRepository.
url string	(Optional) URL is the fetch link for the last index fetched.
artifact Artifact	(Optional) Artifact represents the output of the last successful repository sync.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

LocalHelmChartSourceReference

(Appears on: HelmChartSpec)

LocalHelmChartSourceReference contains enough information to let you locate the typed referenced object at namespace level.

Field	Description
apiVersion string	(Optional) APIVersion of the referent.
kind string	Kind of the referent, valid values are (‘HelmRepository’, ‘GitRepository’, ‘Bucket’).
name string	Name of the referent.

Source

Source interface must be supported by all API types. Source is the interface that provides generic access to the Artifact and interval. It must be supported by all kinds of the source.toolkit.fluxcd.io API group.

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