Bucket

io.fluxcd.toolkit.source.v1beta2.Bucket

Bucket is the Schema for the buckets API.

apiVersionstring = "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

kindstring = "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

metadataobject

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

accessFromobjectAccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092

namespaceSelectors[]object requiredNamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.

matchLabelsmap[string]stringMatchLabels 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.

bucketNamestring requiredBucketName is the name of the object storage bucket.

certSecretRefobjectCertSecretRef 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 bucket. 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`.This field is only supported for the `generic` provider.

namestring requiredName of the referent.

endpointstring requiredEndpoint is the object storage address the BucketName is located at.

ignorestringIgnore 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.

insecurebooleanInsecure allows connecting to a non-TLS HTTP Endpoint.

intervalstring requiredInterval 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.

prefixstringPrefix to use for server-side filtering of files in the Bucket.

providerstringProvider of the object storage bucket. Defaults to 'generic', which expects an S3 (API) compatible object storage.

proxySecretRefobjectProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the Bucket server.

namestring requiredName of the referent.

regionstringRegion of the Endpoint where the BucketName is located in.

secretRefobjectSecretRef specifies the Secret containing authentication credentials for the Bucket.

namestring requiredName of the referent.

stsobjectSTS specifies the required configuration to use a Security Token Service for fetching temporary credentials to authenticate in a Bucket provider.This field is only supported for the `aws` and `generic` providers.

certSecretRefobjectCertSecretRef 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 STS endpoint. 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`.This field is only supported for the `ldap` provider.

namestring requiredName of the referent.

endpointstring requiredEndpoint is the HTTP/S endpoint of the Security Token Service from where temporary credentials will be fetched.

providerstring requiredProvider of the Security Token Service.

secretRefobjectSecretRef specifies the Secret containing authentication credentials for the STS endpoint. This Secret must contain the fields `username` and `password` and is supported only for the `ldap` provider.

namestring requiredName of the referent.

suspendbooleanSuspend tells the controller to suspend the reconciliation of this Bucket.

timeoutstringTimeout for fetch operations, defaults to 60s.

statusobject read-onlyBucketStatus records the observed state of a Bucket.

artifactobject read-onlyArtifact represents the last successful Bucket reconciliation.

digeststring required read-onlyDigest is the digest of the file in the form of '<algorithm>:<checksum>'.

lastUpdateTimestring (date-time) required read-onlyLastUpdateTime is the timestamp corresponding to the last update of the Artifact.

metadatamap[string]string read-onlyMetadata holds upstream information such as OCI annotations.

pathstring required read-onlyPath 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.

revisionstring required read-onlyRevision 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.

sizeinteger (int64) read-onlySize is the number of bytes in the file.

urlstring required read-onlyURL 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.

conditions[]object read-onlyConditions holds the conditions for the Bucket.

lastTransitionTimestring (date-time) required read-onlylastTransitionTime 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.

messagestring required read-onlymessage is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger (int64) read-onlyobservedGeneration 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.

reasonstring required read-onlyreason 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.

statusstring required read-onlystatus of the condition, one of True, False, Unknown.

typestring required read-onlytype of condition in CamelCase or in foo.example.com/CamelCase.

lastHandledReconcileAtstring read-onlyLastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.

observedGenerationinteger (int64) read-onlyObservedGeneration is the last observed generation of the Bucket object.

observedIgnorestring read-onlyObservedIgnore is the observed exclusion patterns used for constructing the source artifact.

urlstring read-onlyURL 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.