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 of the Endpoint where 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 fluxcd/flux2#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 URL specifies the Git repository URL, it can be an HTTP/S or SSH address. secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference (Optional) SecretRef specifies the Secret containing authentication credentials for the GitRepository. 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 Interval at which to check the GitRepository for updates. timeout Kubernetes meta/v1.Duration (Optional) Timeout for Git operations like cloning, defaults to 60s. ref GitRepositoryRef (Optional) Reference specifies the Git reference to resolve and monitor for changes, defaults to the ‘master’ branch. verify GitRepositoryVerification (Optional) Verification specifies the configuration to verify the Git commit signature(s). 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 GitRepository. gitImplementation string (Optional) GitImplementation specifies which Git client library implementation to use. Defaults to ‘go-git’, valid values are (‘go-git’, ‘libgit2’). recurseSubmodules bool (Optional) RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings. This option is available only when using the ‘go-git’ GitImplementation. include []GitRepositoryInclude Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository. 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 fluxcd/flux2#2092
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 Chart is the name or path the Helm chart is available at in the SourceRef. version string (Optional) Version is the chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted. sourceRef LocalHelmChartSourceReference SourceRef is the reference to the Source the chart is available at. interval Kubernetes meta/v1.Duration Interval is the interval at which to check the Source for updates. reconcileStrategy string (Optional) ReconcileStrategy 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) ValuesFiles is an 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) ValuesFile is an 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 specified here is merged before the ValuesFiles items. Ignored when omitted. suspend bool (Optional) Suspend tells the controller to suspend the reconciliation of this source. 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 fluxcd/flux2#2092 verificationKeyring VerificationKeyring (Optional) VerificationKeyring for verifying the packaged chart’s signature using a provenance file.
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 URL of the Helm repository, a valid URL contains at least a protocol and host. secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference (Optional) SecretRef specifies the Secret containing authentication credentials for the HelmRepository. 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 Interval at which to check the URL for updates. timeout Kubernetes meta/v1.Duration (Optional) Timeout of the index fetch operation, defaults to 60s. suspend bool (Optional) Suspend tells the controller to suspend the reconciliation of this HelmRepository. 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 fluxcd/flux2#2092
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.
size int64	(Optional) Size is the number of bytes in the file.

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 of the Endpoint where 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 fluxcd/flux2#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 specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.

Field	Description
repository github.com/fluxcd/pkg/apis/meta.LocalObjectReference	GitRepositoryRef specifies the GitRepository which Artifact contents must be included.
fromPath string	(Optional) FromPath specifies the path to copy contents from, defaults to the root of the Artifact.
toPath string	(Optional) ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.

GitRepositoryRef

(Appears on: GitRepositorySpec)

GitRepositoryRef specifies the Git reference to resolve and checkout.

Field	Description
branch string	(Optional) Branch to check out, defaults to ‘master’ if no other field is defined. When GitRepositorySpec.GitImplementation is set to ‘go-git’, a shallow clone of the specified branch is performed.
tag string	(Optional) Tag to check out, takes precedence over Branch.
semver string	(Optional) SemVer tag expression to check out, takes precedence over Tag.
commit string	(Optional) Commit SHA to check out, takes precedence over all reference fields. When GitRepositorySpec.GitImplementation is set to ‘go-git’, this can be combined with Branch to shallow clone the branch, in which the commit is expected to exist.

GitRepositorySpec

(Appears on: GitRepository)

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

Field	Description
url string	URL specifies the Git repository URL, it can be an HTTP/S or SSH address.
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) SecretRef specifies the Secret containing authentication credentials for the GitRepository. 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	Interval at which to check the GitRepository for updates.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout for Git operations like cloning, defaults to 60s.
ref GitRepositoryRef	(Optional) Reference specifies the Git reference to resolve and monitor for changes, defaults to the ‘master’ branch.
verify GitRepositoryVerification	(Optional) Verification specifies the configuration to verify the Git commit signature(s).
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 GitRepository.
gitImplementation string	(Optional) GitImplementation specifies which Git client library implementation to use. Defaults to ‘go-git’, valid values are (‘go-git’, ‘libgit2’).
recurseSubmodules bool	(Optional) RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings. This option is available only when using the ‘go-git’ GitImplementation.
include []GitRepositoryInclude	Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository.
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 fluxcd/flux2#2092

GitRepositoryStatus

(Appears on: GitRepository)

GitRepositoryStatus records the observed state of a Git repository.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation of the GitRepository object.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the GitRepository.
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 GitRepositoryStatus.Artifact data is recommended.
artifact Artifact	(Optional) Artifact represents the last successful GitRepository reconciliation.
includedArtifacts []*./api/v1beta2.Artifact	(Optional) IncludedArtifacts contains a list of the last successfully included Artifacts as instructed by GitRepositorySpec.Include.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

GitRepositoryVerification

(Appears on: GitRepositorySpec)

GitRepositoryVerification specifies the Git commit signature verification strategy.

Field	Description
mode string	Mode specifies what Git object should be verified, currently (‘head’).
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	SecretRef specifies the Secret containing the public keys of trusted Git authors.

HelmChartSpec

(Appears on: HelmChart)

HelmChartSpec specifies the desired state of a Helm chart.

Field	Description
chart string	Chart is the name or path the Helm chart is available at in the SourceRef.
version string	(Optional) Version is the chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted.
sourceRef LocalHelmChartSourceReference	SourceRef is the reference to the Source the chart is available at.
interval Kubernetes meta/v1.Duration	Interval is the interval at which to check the Source for updates.
reconcileStrategy string	(Optional) ReconcileStrategy 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) ValuesFiles is an 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) ValuesFile is an 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 specified here is merged before the ValuesFiles items. Ignored when omitted.
suspend bool	(Optional) Suspend tells the controller to suspend the reconciliation of this source.
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 fluxcd/flux2#2092
verificationKeyring VerificationKeyring	(Optional) VerificationKeyring for verifying the packaged chart’s signature using a provenance file.

HelmChartStatus

(Appears on: HelmChart)

HelmChartStatus records the observed state of the HelmChart.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation of the HelmChart object.
observedSourceArtifactRevision string	(Optional) ObservedSourceArtifactRevision is the last observed Artifact.Revision of the HelmChartSpec.SourceRef.
observedChartName string	(Optional) ObservedChartName is the last observed chart name as specified by the resolved chart reference.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the HelmChart.
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 output of the last successful reconciliation.
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus	(Members of ReconcileRequestStatus are embedded into this type.)

HelmRepositorySpec

(Appears on: HelmRepository)

HelmRepositorySpec specifies the required configuration to produce an Artifact for a Helm repository index YAML.

Field	Description
url string	URL of the Helm repository, a valid URL contains at least a protocol and host.
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) SecretRef specifies the Secret containing authentication credentials for the HelmRepository. 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	Interval at which to check the URL for updates.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout of the index fetch operation, defaults to 60s.
suspend bool	(Optional) Suspend tells the controller to suspend the reconciliation of this HelmRepository.
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 fluxcd/flux2#2092

HelmRepositoryStatus

(Appears on: HelmRepository)

HelmRepositoryStatus records the observed state of the HelmRepository.

Field	Description
observedGeneration int64	(Optional) ObservedGeneration is the last observed generation of the HelmRepository object.
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the HelmRepository.
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 HelmRepositoryStatus.Artifact data is recommended.
artifact Artifact	(Optional) Artifact represents the last successful HelmRepository reconciliation.
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.

VerificationKeyring

(Appears on: HelmChartSpec)

VerificationKeyring contains enough info to get the public GPG key to be used for verifying the chart signature using a provenance file.

Field	Description
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference	SecretRef is a reference to the secret that contains the public GPG key.
key string	(Optional) Key in the SecretRef that contains the public keyring in legacy GPG format.

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