Skip to content

Latest commit

 

History

History
1708 lines (1320 loc) · 142 KB

README.md

File metadata and controls

1708 lines (1320 loc) · 142 KB

source-controller

Index

Schemas

GitRepository

GitRepository is the Schema for the gitrepositories API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1"
kind required readOnly "GitRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "GitRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1GitRepositorySpec spec
status SourceToolkitFluxcdIoV1GitRepositoryStatus status

HelmChart

HelmChart is the Schema for the helmcharts API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1"
kind required readOnly "HelmChart" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "HelmChart"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1HelmChartSpec spec
status SourceToolkitFluxcdIoV1HelmChartStatus status

HelmRepository

HelmRepository is the Schema for the helmrepositories API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1"
kind required readOnly "HelmRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "HelmRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1HelmRepositorySpec spec
status SourceToolkitFluxcdIoV1HelmRepositoryStatus status

SourceToolkitFluxcdIoV1GitRepositorySpec

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

Attributes

name type description default value
ignore str 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.
include [SourceToolkitFluxcdIoV1GitRepositorySpecIncludeItems0] Include specifies a list of GitRepository resources which Artifacts
should be included in the Artifact produced for this GitRepository.
interval required str Interval at which the GitRepository URL is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
proxySecretRef SourceToolkitFluxcdIoV1GitRepositorySpecProxySecretRef proxy secret ref
recurseSubmodules bool RecurseSubmodules enables the initialization of all submodules within
the GitRepository as cloned from the URL, using their default settings.
ref SourceToolkitFluxcdIoV1GitRepositorySpecRef ref
secretRef SourceToolkitFluxcdIoV1GitRepositorySpecSecretRef secret ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
GitRepository.
timeout str Timeout for Git operations like cloning, defaults to 60s. "60s"
url required str URL specifies the Git repository URL, it can be an HTTP/S or SSH address.
verify SourceToolkitFluxcdIoV1GitRepositorySpecVerify verify

SourceToolkitFluxcdIoV1GitRepositorySpecIncludeItems0

GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.

Attributes

name type description default value
fromPath str FromPath specifies the path to copy contents from, defaults to the root
of the Artifact.
repository required SourceToolkitFluxcdIoV1GitRepositorySpecIncludeItems0Repository repository
toPath str ToPath specifies the path to copy contents to, defaults to the name of
the GitRepositoryRef.

SourceToolkitFluxcdIoV1GitRepositorySpecIncludeItems0Repository

GitRepositoryRef specifies the GitRepository which Artifact contents must be included.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1GitRepositorySpecProxySecretRef

ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the Git server.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1GitRepositorySpecRef

Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.

Attributes

name type description default value
branch str Branch to check out, defaults to 'master' if no other field is defined.
commit str Commit SHA to check out, takes precedence over all reference fields.

This can be combined with Branch to shallow clone the branch, in which
the commit is expected to exist.
name str Name of the reference to check out; takes precedence over Branch, Tag and SemVer.

It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description
Examples: "refs/heads/main", "refs/tags/v0.1.0", "refs/pull/420/head", "refs/merge-requests/1/head"
semver str SemVer tag expression to check out, takes precedence over Tag.
tag str Tag to check out, takes precedence over Branch.

SourceToolkitFluxcdIoV1GitRepositorySpecSecretRef

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.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1GitRepositorySpecVerify

Verification specifies the configuration to verify the Git commit signature(s).

Attributes

name type description default value
mode "head" "HEAD" "Tag"
secretRef required SourceToolkitFluxcdIoV1GitRepositorySpecVerifySecretRef secret ref

SourceToolkitFluxcdIoV1GitRepositorySpecVerifySecretRef

SecretRef specifies the Secret containing the public keys of trusted Git authors.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1GitRepositoryStatus

GitRepositoryStatus records the observed state of a Git repository.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1GitRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1GitRepositoryStatusConditionsItems0] Conditions holds the conditions for the GitRepository.
includedArtifacts [SourceToolkitFluxcdIoV1GitRepositoryStatusIncludedArtifactsItems0] IncludedArtifacts contains a list of the last successfully included
Artifacts as instructed by GitRepositorySpec.Include.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation of the GitRepository
object.
observedIgnore str ObservedIgnore is the observed exclusion patterns used for constructing
the source artifact.
observedInclude [SourceToolkitFluxcdIoV1GitRepositoryStatusObservedIncludeItems0] ObservedInclude is the observed list of GitRepository resources used to
produce the current Artifact.
observedRecurseSubmodules bool ObservedRecurseSubmodules is the observed resource submodules
configuration used to produce the current Artifact.
sourceVerificationMode str SourceVerificationMode is the last used verification mode indicating
which Git object(s) have been verified.

SourceToolkitFluxcdIoV1GitRepositoryStatusArtifact

Artifact represents the last successful GitRepository reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1GitRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1GitRepositoryStatusIncludedArtifactsItems0

Artifact represents the output of a Source reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1GitRepositoryStatusObservedIncludeItems0

GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.

Attributes

name type description default value
fromPath str FromPath specifies the path to copy contents from, defaults to the root
of the Artifact.
repository required SourceToolkitFluxcdIoV1GitRepositoryStatusObservedIncludeItems0Repository repository
toPath str ToPath specifies the path to copy contents to, defaults to the name of
the GitRepositoryRef.

SourceToolkitFluxcdIoV1GitRepositoryStatusObservedIncludeItems0Repository

GitRepositoryRef specifies the GitRepository which Artifact contents must be included.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1HelmChartSpec

HelmChartSpec specifies the desired state of a Helm chart.

Attributes

name type description default value
chart required str Chart is the name or path the Helm chart is available at in the
SourceRef.
ignoreMissingValuesFiles bool IgnoreMissingValuesFiles controls whether to silently ignore missing values
files rather than failing.
interval required str Interval at which the HelmChart SourceRef is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
reconcileStrategy "ChartVersion" "Revision" 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.
sourceRef required SourceToolkitFluxcdIoV1HelmChartSpecSourceRef source ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
source.
valuesFiles [str] 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.
verify SourceToolkitFluxcdIoV1HelmChartSpecVerify verify
version str Version is the chart version semver expression, ignored for charts from
GitRepository and Bucket sources. Defaults to latest when omitted.
"*"

SourceToolkitFluxcdIoV1HelmChartSpecSourceRef

SourceRef is the reference to the Source the chart is available at.

Attributes

name type description default value
apiVersion str APIVersion of the referent.
kind required "HelmRepository" "GitRepository" "Bucket"
name required str Name of the referent.

SourceToolkitFluxcdIoV1HelmChartSpecVerify

Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic. This field is only supported when using HelmRepository source with spec.type 'oci'. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.

Attributes

name type description default value
matchOIDCIdentity [SourceToolkitFluxcdIoV1HelmChartSpecVerifyMatchOIDCIdentityItems0] MatchOIDCIdentity specifies the identity matching criteria to use
while verifying an OCI artifact which was signed using Cosign keyless
signing. The artifact's identity is deemed to be verified if any of the
specified matchers match against the identity.
provider required "cosign" "notation" Provider specifies the technology used to sign the OCI Artifact.
secretRef SourceToolkitFluxcdIoV1HelmChartSpecVerifySecretRef secret ref

SourceToolkitFluxcdIoV1HelmChartSpecVerifyMatchOIDCIdentityItems0

OIDCIdentityMatch specifies options for verifying the certificate identity, i.e. the issuer and the subject of the certificate.

Attributes

name type description default value
issuer required str Issuer specifies the regex pattern to match against to verify
the OIDC issuer in the Fulcio certificate. The pattern must be a
valid Go regular expression.
subject required str Subject specifies the regex pattern to match against to verify
the identity subject in the Fulcio certificate. The pattern must
be a valid Go regular expression.

SourceToolkitFluxcdIoV1HelmChartSpecVerifySecretRef

SecretRef specifies the Kubernetes Secret containing the trusted public keys.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1HelmChartStatus

HelmChartStatus records the observed state of the HelmChart.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1HelmChartStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1HelmChartStatusConditionsItems0] Conditions holds the conditions for the HelmChart.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedChartName str ObservedChartName is the last observed chart name as specified by the
resolved chart reference.
observedGeneration int ObservedGeneration is the last observed generation of the HelmChart
object.
observedSourceArtifactRevision str ObservedSourceArtifactRevision is the last observed Artifact.Revision
of the HelmChartSpec.SourceRef.
observedValuesFiles [str] ObservedValuesFiles are the observed value files of the last successful
reconciliation.
It matches the chart in the last successfully reconciled artifact.
url str 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.

SourceToolkitFluxcdIoV1HelmChartStatusArtifact

Artifact represents the output of the last successful reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1HelmChartStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1HelmRepositorySpec

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

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1HelmRepositorySpecAccessFrom access from
certSecretRef SourceToolkitFluxcdIoV1HelmRepositorySpecCertSecretRef cert secret ref
insecure bool Insecure allows connecting to a non-TLS HTTP container registry.
This field is only taken into account if the .spec.type field is set to 'oci'.
interval str Interval at which the HelmRepository URL is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
passCredentials bool 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.
provider "generic" "aws" "azure"
secretRef SourceToolkitFluxcdIoV1HelmRepositorySpecSecretRef secret ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
HelmRepository.
timeout str Timeout is used for the index fetch operation for an HTTPS helm repository,
and for remote OCI Repository operations like pulling for an OCI helm
chart by the associated HelmChart.
Its default value is 60s.
type "default" "oci"
url required str URL of the Helm repository, a valid URL contains at least a protocol and
host.

SourceToolkitFluxcdIoV1HelmRepositorySpecAccessFrom

AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of fluxcd/flux2#2092

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1HelmRepositorySpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1HelmRepositorySpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1HelmRepositorySpecCertSecretRef

CertSecretRef can be given the name of a Secret containing either or both of - a PEM-encoded client certificate (tls.crt) and private key (tls.key); - a PEM-encoded CA certificate (ca.crt) and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. The Secret must be of type Opaque or kubernetes.io/tls. It takes precedence over the values specified in the Secret referred to by .spec.secretRef.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1HelmRepositorySpecSecretRef

SecretRef specifies the Secret containing authentication credentials for the HelmRepository. For HTTP/S basic auth the secret must contain 'username' and 'password' fields. Support for TLS auth using the 'certFile' and 'keyFile', and/or 'caFile' keys is deprecated. Please use .spec.certSecretRef instead.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1HelmRepositoryStatus

HelmRepositoryStatus records the observed state of the HelmRepository.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1HelmRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1HelmRepositoryStatusConditionsItems0] Conditions holds the conditions for the HelmRepository.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation of the HelmRepository
object.
url str 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.

SourceToolkitFluxcdIoV1HelmRepositoryStatusArtifact

Artifact represents the last successful HelmRepository reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1HelmRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

Bucket

Bucket is the Schema for the buckets API

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta1"
kind required readOnly "Bucket" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "Bucket"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta1BucketSpec spec
status SourceToolkitFluxcdIoV1beta1BucketStatus status

GitRepository

GitRepository is the Schema for the gitrepositories API

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta1"
kind required readOnly "GitRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "GitRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta1GitRepositorySpec spec
status SourceToolkitFluxcdIoV1beta1GitRepositoryStatus status

HelmChart

HelmChart is the Schema for the helmcharts API

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta1"
kind required readOnly "HelmChart" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "HelmChart"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta1HelmChartSpec spec
status SourceToolkitFluxcdIoV1beta1HelmChartStatus status

HelmRepository

HelmRepository is the Schema for the helmrepositories API

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta1"
kind required readOnly "HelmRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "HelmRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta1HelmRepositorySpec spec
status SourceToolkitFluxcdIoV1beta1HelmRepositoryStatus status

SourceToolkitFluxcdIoV1beta1BucketSpec

BucketSpec defines the desired state of an S3 compatible bucket

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta1BucketSpecAccessFrom access from
bucketName required str The bucket name.
endpoint required str The bucket endpoint address.
ignore str 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.
insecure bool Insecure allows connecting to a non-TLS S3 HTTP endpoint.
interval required str The interval at which to check for bucket updates.
provider "generic" "aws" "gcp"
region str The bucket region.
secretRef SourceToolkitFluxcdIoV1beta1BucketSpecSecretRef secret ref
suspend bool This flag tells the controller to suspend the reconciliation of this source.
timeout str The timeout for download operations, defaults to 60s. "60s"

SourceToolkitFluxcdIoV1beta1BucketSpecAccessFrom

AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta1BucketSpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta1BucketSpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta1BucketSpecSecretRef

The name of the secret containing authentication credentials for the Bucket.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta1BucketStatus

BucketStatus defines the observed state of a bucket

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta1BucketStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta1BucketStatusConditionsItems0] Conditions holds the conditions for the Bucket.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation.
url str URL is the download link for the artifact output of the last Bucket sync.

SourceToolkitFluxcdIoV1beta1BucketStatusArtifact

Artifact represents the output of the last successful Bucket sync.

Attributes

name type description default value
checksum str Checksum is the SHA256 checksum of the artifact.
lastUpdateTime str LastUpdateTime is the timestamp corresponding to the last update of this
artifact.
path required str Path is the relative file path of this artifact.
revision str 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.
url required str URL is the HTTP address of this artifact.

SourceToolkitFluxcdIoV1beta1BucketStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta1GitRepositorySpec

GitRepositorySpec defines the desired state of a Git repository.

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta1GitRepositorySpecAccessFrom access from
gitImplementation "go-git" "libgit2" Determines which git client library to use.
Defaults to go-git, valid values are ('go-git', 'libgit2').
ignore str 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.
include [SourceToolkitFluxcdIoV1beta1GitRepositorySpecIncludeItems0] Extra git repositories to map into the repository
interval required str The interval at which to check for repository updates.
recurseSubmodules bool 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.
ref SourceToolkitFluxcdIoV1beta1GitRepositorySpecRef ref
secretRef SourceToolkitFluxcdIoV1beta1GitRepositorySpecSecretRef secret ref
suspend bool This flag tells the controller to suspend the reconciliation of this source.
timeout str The timeout for remote Git operations like cloning, defaults to 60s. "60s"
url required str The repository URL, can be a HTTP/S or SSH address.
verify SourceToolkitFluxcdIoV1beta1GitRepositorySpecVerify verify

SourceToolkitFluxcdIoV1beta1GitRepositorySpecAccessFrom

AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta1GitRepositorySpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta1GitRepositorySpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta1GitRepositorySpecIncludeItems0

GitRepositoryInclude defines a source with a from and to path.

Attributes

name type description default value
fromPath str The path to copy contents from, defaults to the root directory.
repository required SourceToolkitFluxcdIoV1beta1GitRepositorySpecIncludeItems0Repository repository
toPath str The path to copy contents to, defaults to the name of the source ref.

SourceToolkitFluxcdIoV1beta1GitRepositorySpecIncludeItems0Repository

Reference to a GitRepository to include.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta1GitRepositorySpecRef

The Git reference to checkout and monitor for changes, defaults to master branch.

Attributes

name type description default value
branch str The Git branch to checkout, defaults to master.
commit str The Git commit SHA to checkout, if specified Tag filters will be ignored.
semver str The Git tag semver expression, takes precedence over Tag.
tag str The Git tag to checkout, takes precedence over Branch.

SourceToolkitFluxcdIoV1beta1GitRepositorySpecSecretRef

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 and known_hosts fields.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta1GitRepositorySpecVerify

Verify OpenPGP signature for the Git commit HEAD points to.

Attributes

name type description default value
mode required readOnly "head" Mode describes what git object should be verified, currently ('head'). "head"
secretRef SourceToolkitFluxcdIoV1beta1GitRepositorySpecVerifySecretRef secret ref

SourceToolkitFluxcdIoV1beta1GitRepositorySpecVerifySecretRef

The secret name containing the public keys of all trusted Git authors.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta1GitRepositoryStatus

GitRepositoryStatus defines the observed state of a Git repository.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta1GitRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta1GitRepositoryStatusConditionsItems0] Conditions holds the conditions for the GitRepository.
includedArtifacts [SourceToolkitFluxcdIoV1beta1GitRepositoryStatusIncludedArtifactsItems0] IncludedArtifacts represents the included artifacts from the last successful repository sync.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation.
url str URL is the download link for the artifact output of the last repository
sync.

SourceToolkitFluxcdIoV1beta1GitRepositoryStatusArtifact

Artifact represents the output of the last successful repository sync.

Attributes

name type description default value
checksum str Checksum is the SHA256 checksum of the artifact.
lastUpdateTime str LastUpdateTime is the timestamp corresponding to the last update of this
artifact.
path required str Path is the relative file path of this artifact.
revision str 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.
url required str URL is the HTTP address of this artifact.

SourceToolkitFluxcdIoV1beta1GitRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta1GitRepositoryStatusIncludedArtifactsItems0

Artifact represents the output of a source synchronisation.

Attributes

name type description default value
checksum str Checksum is the SHA256 checksum of the artifact.
lastUpdateTime str LastUpdateTime is the timestamp corresponding to the last update of this
artifact.
path required str Path is the relative file path of this artifact.
revision str 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.
url required str URL is the HTTP address of this artifact.

SourceToolkitFluxcdIoV1beta1HelmChartSpec

HelmChartSpec defines the desired state of a Helm chart.

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta1HelmChartSpecAccessFrom access from
chart required str The name or path the Helm chart is available at in the SourceRef.
interval required str The interval at which to check the Source for updates.
reconcileStrategy "ChartVersion" "Revision" 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.
sourceRef required SourceToolkitFluxcdIoV1beta1HelmChartSpecSourceRef source ref
suspend bool This flag tells the controller to suspend the reconciliation of this source.
valuesFile str 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.
valuesFiles [str] 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.
version str The chart version semver expression, ignored for charts from GitRepository
and Bucket sources. Defaults to latest when omitted.
"*"

SourceToolkitFluxcdIoV1beta1HelmChartSpecAccessFrom

AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta1HelmChartSpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta1HelmChartSpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta1HelmChartSpecSourceRef

The reference to the Source the chart is available at.

Attributes

name type description default value
apiVersion str APIVersion of the referent.
kind required "HelmRepository" "GitRepository" "Bucket"
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta1HelmChartStatus

HelmChartStatus defines the observed state of the HelmChart.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta1HelmChartStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta1HelmChartStatusConditionsItems0] Conditions holds the conditions for the HelmChart.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation.
url str URL is the download link for the last chart pulled.

SourceToolkitFluxcdIoV1beta1HelmChartStatusArtifact

Artifact represents the output of the last successful chart sync.

Attributes

name type description default value
checksum str Checksum is the SHA256 checksum of the artifact.
lastUpdateTime str LastUpdateTime is the timestamp corresponding to the last update of this
artifact.
path required str Path is the relative file path of this artifact.
revision str 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.
url required str URL is the HTTP address of this artifact.

SourceToolkitFluxcdIoV1beta1HelmChartStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta1HelmRepositorySpec

HelmRepositorySpec defines the reference to a Helm repository.

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta1HelmRepositorySpecAccessFrom access from
interval required str The interval at which to check the upstream for updates.
passCredentials bool 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.
secretRef SourceToolkitFluxcdIoV1beta1HelmRepositorySpecSecretRef secret ref
suspend bool This flag tells the controller to suspend the reconciliation of this source.
timeout str The timeout of index downloading, defaults to 60s. "60s"
url required str The Helm repository URL, a valid URL contains at least a protocol and host.

SourceToolkitFluxcdIoV1beta1HelmRepositorySpecAccessFrom

AccessFrom defines an Access Control List for allowing cross-namespace references to this object.

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta1HelmRepositorySpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta1HelmRepositorySpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta1HelmRepositorySpecSecretRef

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 caFile fields.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta1HelmRepositoryStatus

HelmRepositoryStatus defines the observed state of the HelmRepository.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta1HelmRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta1HelmRepositoryStatusConditionsItems0] Conditions holds the conditions for the HelmRepository.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation.
url str URL is the download link for the last index fetched.

SourceToolkitFluxcdIoV1beta1HelmRepositoryStatusArtifact

Artifact represents the output of the last successful repository sync.

Attributes

name type description default value
checksum str Checksum is the SHA256 checksum of the artifact.
lastUpdateTime str LastUpdateTime is the timestamp corresponding to the last update of this
artifact.
path required str Path is the relative file path of this artifact.
revision str 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.
url required str URL is the HTTP address of this artifact.

SourceToolkitFluxcdIoV1beta1HelmRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

Bucket

Bucket is the Schema for the buckets API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta2" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta2"
kind required readOnly "Bucket" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "Bucket"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta2BucketSpec spec
status SourceToolkitFluxcdIoV1beta2BucketStatus status

GitRepository

GitRepository is the Schema for the gitrepositories API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta2" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta2"
kind required readOnly "GitRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "GitRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta2GitRepositorySpec spec
status SourceToolkitFluxcdIoV1beta2GitRepositoryStatus status

HelmChart

HelmChart is the Schema for the helmcharts API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta2" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta2"
kind required readOnly "HelmChart" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "HelmChart"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta2HelmChartSpec spec
status SourceToolkitFluxcdIoV1beta2HelmChartStatus status

HelmRepository

HelmRepository is the Schema for the helmrepositories API.

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta2" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta2"
kind required readOnly "HelmRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "HelmRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta2HelmRepositorySpec spec
status SourceToolkitFluxcdIoV1beta2HelmRepositoryStatus status

OCIRepository

OCIRepository is the Schema for the ocirepositories API

Attributes

name type description default value
apiVersion required readOnly "source.toolkit.fluxcd.io/v1beta2" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "source.toolkit.fluxcd.io/v1beta2"
kind required readOnly "OCIRepository" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "OCIRepository"
metadata ObjectMeta metadata
spec SourceToolkitFluxcdIoV1beta2OCIRepositorySpec spec
status SourceToolkitFluxcdIoV1beta2OCIRepositoryStatus status

SourceToolkitFluxcdIoV1beta2BucketSpec

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

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta2BucketSpecAccessFrom access from
bucketName required str BucketName is the name of the object storage bucket.
endpoint required str Endpoint is the object storage address the BucketName is located at.
ignore str 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.
insecure bool Insecure allows connecting to a non-TLS HTTP Endpoint.
interval required str Interval at which the Bucket Endpoint is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
prefix str Prefix to use for server-side filtering of files in the Bucket.
provider "generic" "aws" "gcp"
region str Region of the Endpoint where the BucketName is located in.
secretRef SourceToolkitFluxcdIoV1beta2BucketSpecSecretRef secret ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
Bucket.
timeout str Timeout for fetch operations, defaults to 60s. "60s"

SourceToolkitFluxcdIoV1beta2BucketSpecAccessFrom

AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of fluxcd/flux2#2092

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta2BucketSpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta2BucketSpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta2BucketSpecSecretRef

SecretRef specifies the Secret containing authentication credentials for the Bucket.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2BucketStatus

BucketStatus records the observed state of a Bucket.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta2BucketStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta2BucketStatusConditionsItems0] Conditions holds the conditions for the Bucket.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation of the Bucket object.
observedIgnore str ObservedIgnore is the observed exclusion patterns used for constructing
the source artifact.
url str 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.

SourceToolkitFluxcdIoV1beta2BucketStatusArtifact

Artifact represents the last successful Bucket reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1beta2BucketStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta2GitRepositorySpec

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

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta2GitRepositorySpecAccessFrom access from
gitImplementation "go-git" "libgit2" 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.
ignore str 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.
include [SourceToolkitFluxcdIoV1beta2GitRepositorySpecIncludeItems0] Include specifies a list of GitRepository resources which Artifacts
should be included in the Artifact produced for this GitRepository.
interval required str Interval at which to check the GitRepository for updates.
recurseSubmodules bool RecurseSubmodules enables the initialization of all submodules within
the GitRepository as cloned from the URL, using their default settings.
ref SourceToolkitFluxcdIoV1beta2GitRepositorySpecRef ref
secretRef SourceToolkitFluxcdIoV1beta2GitRepositorySpecSecretRef secret ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
GitRepository.
timeout str Timeout for Git operations like cloning, defaults to 60s. "60s"
url required str URL specifies the Git repository URL, it can be an HTTP/S or SSH address.
verify SourceToolkitFluxcdIoV1beta2GitRepositorySpecVerify verify

SourceToolkitFluxcdIoV1beta2GitRepositorySpecAccessFrom

AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of fluxcd/flux2#2092

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta2GitRepositorySpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta2GitRepositorySpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta2GitRepositorySpecIncludeItems0

GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.

Attributes

name type description default value
fromPath str FromPath specifies the path to copy contents from, defaults to the root
of the Artifact.
repository required SourceToolkitFluxcdIoV1beta2GitRepositorySpecIncludeItems0Repository repository
toPath str ToPath specifies the path to copy contents to, defaults to the name of
the GitRepositoryRef.

SourceToolkitFluxcdIoV1beta2GitRepositorySpecIncludeItems0Repository

GitRepositoryRef specifies the GitRepository which Artifact contents must be included.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2GitRepositorySpecRef

Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.

Attributes

name type description default value
branch str Branch to check out, defaults to 'master' if no other field is defined.
commit str Commit SHA to check out, takes precedence over all reference fields.

This can be combined with Branch to shallow clone the branch, in which
the commit is expected to exist.
name str Name of the reference to check out; takes precedence over Branch, Tag and SemVer.

It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description
Examples: "refs/heads/main", "refs/tags/v0.1.0", "refs/pull/420/head", "refs/merge-requests/1/head"
semver str SemVer tag expression to check out, takes precedence over Tag.
tag str Tag to check out, takes precedence over Branch.

SourceToolkitFluxcdIoV1beta2GitRepositorySpecSecretRef

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.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2GitRepositorySpecVerify

Verification specifies the configuration to verify the Git commit signature(s).

Attributes

name type description default value
mode required readOnly "head" Mode specifies what Git object should be verified, currently ('head'). "head"
secretRef required SourceToolkitFluxcdIoV1beta2GitRepositorySpecVerifySecretRef secret ref

SourceToolkitFluxcdIoV1beta2GitRepositorySpecVerifySecretRef

SecretRef specifies the Secret containing the public keys of trusted Git authors.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2GitRepositoryStatus

GitRepositoryStatus records the observed state of a Git repository.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta2GitRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta2GitRepositoryStatusConditionsItems0] Conditions holds the conditions for the GitRepository.
contentConfigChecksum str ContentConfigChecksum is a checksum of all the configurations related to
the content of the source artifact:
- .spec.ignore
- .spec.recurseSubmodules
- .spec.included and the checksum of the included artifacts
observed in .status.observedGeneration version of the object. This can
be used to determine if the content of the included repository has
changed.
It has the format of <algo>:<checksum>, for example: sha256:<checksum>.

Deprecated: Replaced with explicit fields for observed artifact content
config in the status.
includedArtifacts [SourceToolkitFluxcdIoV1beta2GitRepositoryStatusIncludedArtifactsItems0] IncludedArtifacts contains a list of the last successfully included
Artifacts as instructed by GitRepositorySpec.Include.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation of the GitRepository
object.
observedIgnore str ObservedIgnore is the observed exclusion patterns used for constructing
the source artifact.
observedInclude [SourceToolkitFluxcdIoV1beta2GitRepositoryStatusObservedIncludeItems0] ObservedInclude is the observed list of GitRepository resources used to
to produce the current Artifact.
observedRecurseSubmodules bool ObservedRecurseSubmodules is the observed resource submodules
configuration used to produce the current Artifact.
url str 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.

SourceToolkitFluxcdIoV1beta2GitRepositoryStatusArtifact

Artifact represents the last successful GitRepository reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1beta2GitRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta2GitRepositoryStatusIncludedArtifactsItems0

Artifact represents the output of a Source reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1beta2GitRepositoryStatusObservedIncludeItems0

GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.

Attributes

name type description default value
fromPath str FromPath specifies the path to copy contents from, defaults to the root
of the Artifact.
repository required SourceToolkitFluxcdIoV1beta2GitRepositoryStatusObservedIncludeItems0Repository repository
toPath str ToPath specifies the path to copy contents to, defaults to the name of
the GitRepositoryRef.

SourceToolkitFluxcdIoV1beta2GitRepositoryStatusObservedIncludeItems0Repository

GitRepositoryRef specifies the GitRepository which Artifact contents must be included.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2HelmChartSpec

HelmChartSpec specifies the desired state of a Helm chart.

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta2HelmChartSpecAccessFrom access from
chart required str Chart is the name or path the Helm chart is available at in the
SourceRef.
ignoreMissingValuesFiles bool IgnoreMissingValuesFiles controls whether to silently ignore missing values
files rather than failing.
interval required str Interval at which the HelmChart SourceRef is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
reconcileStrategy "ChartVersion" "Revision" 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.
sourceRef required SourceToolkitFluxcdIoV1beta2HelmChartSpecSourceRef source ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
source.
valuesFile str 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.
valuesFiles [str] 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.
verify SourceToolkitFluxcdIoV1beta2HelmChartSpecVerify verify
version str Version is the chart version semver expression, ignored for charts from
GitRepository and Bucket sources. Defaults to latest when omitted.
"*"

SourceToolkitFluxcdIoV1beta2HelmChartSpecAccessFrom

AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of fluxcd/flux2#2092

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta2HelmChartSpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta2HelmChartSpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta2HelmChartSpecSourceRef

SourceRef is the reference to the Source the chart is available at.

Attributes

name type description default value
apiVersion str APIVersion of the referent.
kind required "HelmRepository" "GitRepository" "Bucket"
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2HelmChartSpecVerify

Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic. This field is only supported when using HelmRepository source with spec.type 'oci'. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.

Attributes

name type description default value
matchOIDCIdentity [SourceToolkitFluxcdIoV1beta2HelmChartSpecVerifyMatchOIDCIdentityItems0] MatchOIDCIdentity specifies the identity matching criteria to use
while verifying an OCI artifact which was signed using Cosign keyless
signing. The artifact's identity is deemed to be verified if any of the
specified matchers match against the identity.
provider required "cosign" "notation" Provider specifies the technology used to sign the OCI Artifact.
secretRef SourceToolkitFluxcdIoV1beta2HelmChartSpecVerifySecretRef secret ref

SourceToolkitFluxcdIoV1beta2HelmChartSpecVerifyMatchOIDCIdentityItems0

OIDCIdentityMatch specifies options for verifying the certificate identity, i.e. the issuer and the subject of the certificate.

Attributes

name type description default value
issuer required str Issuer specifies the regex pattern to match against to verify
the OIDC issuer in the Fulcio certificate. The pattern must be a
valid Go regular expression.
subject required str Subject specifies the regex pattern to match against to verify
the identity subject in the Fulcio certificate. The pattern must
be a valid Go regular expression.

SourceToolkitFluxcdIoV1beta2HelmChartSpecVerifySecretRef

SecretRef specifies the Kubernetes Secret containing the trusted public keys.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2HelmChartStatus

HelmChartStatus records the observed state of the HelmChart.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta2HelmChartStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta2HelmChartStatusConditionsItems0] Conditions holds the conditions for the HelmChart.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedChartName str ObservedChartName is the last observed chart name as specified by the
resolved chart reference.
observedGeneration int ObservedGeneration is the last observed generation of the HelmChart
object.
observedSourceArtifactRevision str ObservedSourceArtifactRevision is the last observed Artifact.Revision
of the HelmChartSpec.SourceRef.
observedValuesFiles [str] ObservedValuesFiles are the observed value files of the last successful
reconciliation.
It matches the chart in the last successfully reconciled artifact.
url str 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.

SourceToolkitFluxcdIoV1beta2HelmChartStatusArtifact

Artifact represents the output of the last successful reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1beta2HelmChartStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta2HelmRepositorySpec

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

Attributes

name type description default value
accessFrom SourceToolkitFluxcdIoV1beta2HelmRepositorySpecAccessFrom access from
certSecretRef SourceToolkitFluxcdIoV1beta2HelmRepositorySpecCertSecretRef cert secret ref
insecure bool Insecure allows connecting to a non-TLS HTTP container registry.
This field is only taken into account if the .spec.type field is set to 'oci'.
interval str Interval at which the HelmRepository URL is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
passCredentials bool 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.
provider "generic" "aws" "azure"
secretRef SourceToolkitFluxcdIoV1beta2HelmRepositorySpecSecretRef secret ref
suspend bool Suspend tells the controller to suspend the reconciliation of this
HelmRepository.
timeout str Timeout is used for the index fetch operation for an HTTPS helm repository,
and for remote OCI Repository operations like pulling for an OCI helm
chart by the associated HelmChart.
Its default value is 60s.
type "default" "oci"
url required str URL of the Helm repository, a valid URL contains at least a protocol and
host.

SourceToolkitFluxcdIoV1beta2HelmRepositorySpecAccessFrom

AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of fluxcd/flux2#2092

Attributes

name type description default value
namespaceSelectors required [SourceToolkitFluxcdIoV1beta2HelmRepositorySpecAccessFromNamespaceSelectorsItems0] NamespaceSelectors is the list of namespace selectors to which this ACL applies.
Items in this list are evaluated using a logical OR operation.

SourceToolkitFluxcdIoV1beta2HelmRepositorySpecAccessFromNamespaceSelectorsItems0

NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.

Attributes

name type description default value
matchLabels {str:str} MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

SourceToolkitFluxcdIoV1beta2HelmRepositorySpecCertSecretRef

CertSecretRef can be given the name of a Secret containing either or both of - a PEM-encoded client certificate (tls.crt) and private key (tls.key); - a PEM-encoded CA certificate (ca.crt) and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. The Secret must be of type Opaque or kubernetes.io/tls. It takes precedence over the values specified in the Secret referred to by .spec.secretRef.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2HelmRepositorySpecSecretRef

SecretRef specifies the Secret containing authentication credentials for the HelmRepository. For HTTP/S basic auth the secret must contain 'username' and 'password' fields. Support for TLS auth using the 'certFile' and 'keyFile', and/or 'caFile' keys is deprecated. Please use .spec.certSecretRef instead.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2HelmRepositoryStatus

HelmRepositoryStatus records the observed state of the HelmRepository.

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta2HelmRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta2HelmRepositoryStatusConditionsItems0] Conditions holds the conditions for the HelmRepository.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation of the HelmRepository
object.
url str 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.

SourceToolkitFluxcdIoV1beta2HelmRepositoryStatusArtifact

Artifact represents the last successful HelmRepository reconciliation.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1beta2HelmRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta2OCIRepositorySpec

OCIRepositorySpec defines the desired state of OCIRepository

Attributes

name type description default value
certSecretRef SourceToolkitFluxcdIoV1beta2OCIRepositorySpecCertSecretRef cert secret ref
ignore str 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.
insecure bool Insecure allows connecting to a non-TLS HTTP container registry.
interval required str Interval at which the OCIRepository URL is checked for updates.
This interval is approximate and may be subject to jitter to ensure
efficient use of resources.
layerSelector SourceToolkitFluxcdIoV1beta2OCIRepositorySpecLayerSelector layer selector
provider "generic" "aws" "azure"
ref SourceToolkitFluxcdIoV1beta2OCIRepositorySpecRef ref
secretRef SourceToolkitFluxcdIoV1beta2OCIRepositorySpecSecretRef secret ref
serviceAccountName str ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate
the image pull if the service account has attached pull secrets. For more information:
https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account
suspend bool This flag tells the controller to suspend the reconciliation of this source.
timeout str The timeout for remote OCI Repository operations like pulling, defaults to 60s. "60s"
url required str URL is a reference to an OCI artifact repository hosted
on a remote container registry.
verify SourceToolkitFluxcdIoV1beta2OCIRepositorySpecVerify verify

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecCertSecretRef

CertSecretRef can be given the name of a Secret containing either or both of - a PEM-encoded client certificate (tls.crt) and private key (tls.key); - a PEM-encoded CA certificate (ca.crt) and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. The Secret must be of type Opaque or kubernetes.io/tls. Note: Support for the caFile, certFile and keyFile keys have been deprecated.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecLayerSelector

LayerSelector specifies which layer should be extracted from the OCI artifact. When not specified, the first layer found in the artifact is selected.

Attributes

name type description default value
mediaType str MediaType specifies the OCI media type of the layer
which should be extracted from the OCI Artifact. The
first layer matching this type is selected.
operation "extract" "copy" Operation specifies how the selected layer should be processed.
By default, the layer compressed content is extracted to storage.
When the operation is set to 'copy', the layer compressed content
is persisted to storage as it is.

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecRef

The OCI reference to pull and monitor for changes, defaults to the latest tag.

Attributes

name type description default value
digest str Digest is the image digest to pull, takes precedence over SemVer.
The value should be in the format 'sha256:'.
semver str SemVer is the range of tags to pull selecting the latest within
the range, takes precedence over Tag.
semverFilter str SemverFilter is a regex pattern to filter the tags within the SemVer range.
tag str Tag is the image tag to pull, defaults to latest.

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecSecretRef

SecretRef contains the secret name containing the registry login credentials to resolve image metadata. The secret must be of type kubernetes.io/dockerconfigjson.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecVerify

Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic.

Attributes

name type description default value
matchOIDCIdentity [SourceToolkitFluxcdIoV1beta2OCIRepositorySpecVerifyMatchOIDCIdentityItems0] MatchOIDCIdentity specifies the identity matching criteria to use
while verifying an OCI artifact which was signed using Cosign keyless
signing. The artifact's identity is deemed to be verified if any of the
specified matchers match against the identity.
provider required "cosign" "notation" Provider specifies the technology used to sign the OCI Artifact.
secretRef SourceToolkitFluxcdIoV1beta2OCIRepositorySpecVerifySecretRef secret ref

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecVerifyMatchOIDCIdentityItems0

OIDCIdentityMatch specifies options for verifying the certificate identity, i.e. the issuer and the subject of the certificate.

Attributes

name type description default value
issuer required str Issuer specifies the regex pattern to match against to verify
the OIDC issuer in the Fulcio certificate. The pattern must be a
valid Go regular expression.
subject required str Subject specifies the regex pattern to match against to verify
the identity subject in the Fulcio certificate. The pattern must
be a valid Go regular expression.

SourceToolkitFluxcdIoV1beta2OCIRepositorySpecVerifySecretRef

SecretRef specifies the Kubernetes Secret containing the trusted public keys.

Attributes

name type description default value
name required str Name of the referent.

SourceToolkitFluxcdIoV1beta2OCIRepositoryStatus

OCIRepositoryStatus defines the observed state of OCIRepository

Attributes

name type description default value
artifact SourceToolkitFluxcdIoV1beta2OCIRepositoryStatusArtifact artifact
conditions [SourceToolkitFluxcdIoV1beta2OCIRepositoryStatusConditionsItems0] Conditions holds the conditions for the OCIRepository.
contentConfigChecksum str ContentConfigChecksum is a checksum of all the configurations related to
the content of the source artifact:
- .spec.ignore
- .spec.layerSelector
observed in .status.observedGeneration version of the object. This can
be used to determine if the content configuration has changed and the
artifact needs to be rebuilt.
It has the format of <algo>:<checksum>, for example: sha256:<checksum>.

Deprecated: Replaced with explicit fields for observed artifact content
config in the status.
lastHandledReconcileAt str LastHandledReconcileAt holds the value of the most recent
reconcile request value, so a change of the annotation value
can be detected.
observedGeneration int ObservedGeneration is the last observed generation.
observedIgnore str ObservedIgnore is the observed exclusion patterns used for constructing
the source artifact.
observedLayerSelector SourceToolkitFluxcdIoV1beta2OCIRepositoryStatusObservedLayerSelector observed layer selector
url str URL is the download link for the artifact output of the last OCI Repository sync.

SourceToolkitFluxcdIoV1beta2OCIRepositoryStatusArtifact

Artifact represents the output of the last successful OCI Repository sync.

Attributes

name type description default value
digest str Digest is the digest of the file in the form of ':'.
lastUpdateTime required str LastUpdateTime is the timestamp corresponding to the last update of the
Artifact.
metadata {str:str} Metadata holds upstream information such as OCI annotations.
path required str 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.
revision required str 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.
size int Size is the number of bytes in the file.
url required str 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.

SourceToolkitFluxcdIoV1beta2OCIRepositoryStatusConditionsItems0

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

Attributes

name type description default value
lastTransitionTime required str lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message required str message is a human readable message indicating details about the transition.
This may be an empty string.
observedGeneration int observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
reason required str reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
status required "True" "False" "Unknown"
type required str

SourceToolkitFluxcdIoV1beta2OCIRepositoryStatusObservedLayerSelector

ObservedLayerSelector is the observed layer selector used for constructing the source artifact.

Attributes

name type description default value
mediaType str MediaType specifies the OCI media type of the layer
which should be extracted from the OCI Artifact. The
first layer matching this type is selected.
operation "extract" "copy" Operation specifies how the selected layer should be processed.
By default, the layer compressed content is extracted to storage.
When the operation is set to 'copy', the layer compressed content
is persisted to storage as it is.