33 KiB
Source API reference
Packages:
source.toolkit.fluxcd.io/v1beta1
Package v1beta1 contains API Schema definitions for the source v1beta1 API group
Resource Types:Bucket
Bucket is the Schema for the buckets API
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
source.toolkit.fluxcd.io/v1beta1
|
||||||||||||||||||||
kind string |
Bucket
|
||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec BucketSpec |
|
||||||||||||||||||||
status BucketStatus |
GitRepository
GitRepository is the Schema for the gitrepositories API
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
source.toolkit.fluxcd.io/v1beta1
|
||||||||||||||||||||
kind string |
GitRepository
|
||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec GitRepositorySpec |
|
||||||||||||||||||||
status GitRepositoryStatus |
HelmChart
HelmChart is the Schema for the helmcharts API
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
source.toolkit.fluxcd.io/v1beta1
|
||||||||||||||
kind string |
HelmChart
|
||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec HelmChartSpec |
|
||||||||||||||
status HelmChartStatus |
HelmRepository
HelmRepository is the Schema for the helmrepositories API
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
source.toolkit.fluxcd.io/v1beta1
|
||||||||||
kind string |
HelmRepository
|
||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec HelmRepositorySpec |
|
||||||||||
status HelmRepositoryStatus |
Artifact
(Appears on: BucketStatus, GitRepositoryStatus, HelmChartStatus, HelmRepositoryStatus)
Artifact represents the output of a source synchronisation.
Field | Description |
---|---|
path string |
Path is the relative 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 Git commit SHA, Git tag, a Helm index timestamp, a Helm chart version, etc. |
checksum string |
(Optional)
Checksum is the SHA1 checksum of the artifact. |
lastUpdateTime Kubernetes meta/v1.Time |
LastUpdateTime is the timestamp corresponding to the last update of this artifact. |
BucketSpec
(Appears on: Bucket)
BucketSpec defines the desired state of an S3 compatible bucket
Field | Description |
---|---|
provider string |
(Optional)
The S3 compatible storage provider name, default (‘generic’). |
bucketName string |
The bucket name. |
endpoint string |
The bucket endpoint address. |
insecure bool |
(Optional)
Insecure allows connecting to a non-TLS S3 HTTP endpoint. |
region string |
(Optional)
The bucket region. |
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference |
(Optional)
The name of the secret containing authentication credentials for the Bucket. |
interval Kubernetes meta/v1.Duration |
The interval at which to check for bucket updates. |
timeout Kubernetes meta/v1.Duration |
(Optional)
The timeout for download operations, defaults to 20s. |
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)
This flag tells the controller to suspend the reconciliation of this source. |
BucketStatus
(Appears on: Bucket)
BucketStatus defines the observed state of a bucket
Field | Description |
---|---|
observedGeneration int64 |
(Optional)
ObservedGeneration is the last observed generation. |
conditions []Kubernetes meta/v1.Condition |
(Optional)
Conditions holds the conditions for the Bucket. |
url string |
(Optional)
URL is the download link for the artifact output of the last Bucket sync. |
artifact Artifact |
(Optional)
Artifact represents the output of the last successful Bucket sync. |
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus |
(Members of |
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 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 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)
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. |
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 download link for the artifact output of the last repository sync. |
artifact Artifact |
(Optional)
Artifact represents the output of the last successful repository sync. |
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus |
(Members of |
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 |
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 |
---|---|
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. |
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. |
HelmChartStatus
(Appears on: HelmChart)
HelmChartStatus defines the observed state of the HelmChart.
Field | Description |
---|---|
observedGeneration int64 |
(Optional)
ObservedGeneration is the last observed generation. |
conditions []Kubernetes meta/v1.Condition |
(Optional)
Conditions holds the conditions for the HelmChart. |
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. |
ReconcileRequestStatus github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus |
(Members of |
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. |
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 downloading, defaults to 60s. |
suspend bool |
(Optional)
This flag tells the controller to suspend the reconciliation of this source. |
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 download 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 |
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.
This page was automatically generated with gen-crd-api-reference-docs