flux v2.9.5

Bucket.spec

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

15 fields
Bucket.spec fields and descriptions
Field / TypeDescription
bucketName
string required

BucketName is the name of the object storage bucket.

object

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

endpoint
string required

Endpoint is the object storage address the BucketName is located at.

ignore
string

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
boolean

Insecure allows connecting to a non-TLS HTTP Endpoint.

interval
string required

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.

  • pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
prefix
string

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

provider
string

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

  • enum: ["generic","aws","gcp","azure"]
  • default: "generic"
object

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

region
string

Region of the Endpoint where the BucketName is located in.

object

SecretRef specifies the Secret containing authentication credentials for the Bucket.

serviceAccountName
string

ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the bucket. This field is only supported for the 'gcp' and 'aws' providers. For more information about workload identity: https://fluxcd.io/flux/components/source/buckets/#workload-identity

object

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

suspend
boolean

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

timeout
string

Timeout for fetch operations, defaults to 60s.

  • default: "60s"
  • pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m))+$