Resources / PlatformBucket

PlatformBucket

A bucket the platform itself keeps at its storage provider (a website's files, backups, the shards behind Storage): its place, settings, lifecycle rules, cross-origin rules and public access as desired state, adopted when the bucket already exists, with every difference reported. Only buckets named etorm-... can be described, so a bucket that is not the platform's is never touched. In plan mode nothing is changed at the provider.

Overview

APIstorage.etorm.com/v1alpha1
Resourceplatformbuckets (cluster-scoped inside its cluster)
Short namespbkt
Available inthe platform only
Statuswritten by a controller through /status

Minimal example

apiVersion: storage.etorm.com/v1alpha1
kind: PlatformBucket
metadata:
  name: example
spec: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
bucketNamestringlength 8 to 63; pattern ^etorm-[a-z0-9][a-z0-9-]*$The bucket's name at the provider. Starts with etorm- (the platform's ownership mark: nothing else can be described here). Defaults to the name of this object. Cannot be changed.
descriptionstringup to 1000 charactersWhat the bucket is for, for people.
locationstring (one of)"WEUR"WNAM, ENAM, WEUR, EEUR, APAC, OCWhere the bucket's data is kept: western or eastern North America, western or eastern Europe, Asia-Pacific or Oceania. Chosen when the bucket is made and cannot be changed afterwards: a bucket in another place is reported as a difference and left as it is.
storageClassstring (one of)"Standard"Standard, InfrequentAccessThe storage class of new objects, chosen when the bucket is made; a different class is reported, not changed.
modestring (one of)"plan"plan, applyplan reports what would change and changes nothing; apply makes the provider match this object (creating a missing bucket, replacing lifecycle and cross-origin rules, changing public access). A bucket is never deleted and objects are never touched in either mode.
syncSecondsinteger21600300 to 86400How often the bucket is read and compared with this object, in seconds. A change to this object is compared at once.
managedDomainbooleanfalseWhether the bucket is public on the provider's own address. Off for every platform bucket that is not meant to be public.
customDomainslist of objectup to 10 itemsDomains under which the bucket is served.
customDomains[].domainstringyesup to 253 charactersThe domain name, for example console.etorm.com.
customDomains[].zoneIdstringyesup to 64 charactersThe identifier of the DNS zone the domain is in.
customDomains[].minTLSstring (one of)"1.2"1.0, 1.1, 1.2, 1.3The lowest TLS version accepted.
lifecyclelist of objectup to 25 itemsThe bucket's lifecycle rules, complete: a rule at the provider that is not listed here is a difference. The provider's own default rule for abandoned uploads is left as it is.
lifecycle[].idstringyeslength 1 to 255The rule's name, unique in the bucket.
lifecycle[].prefixstringup to 1024 charactersObjects whose key starts with this. Empty means all objects.
lifecycle[].expireAfterDaysinteger1 to 36500Delete objects this many days after they were written.
lifecycle[].abortIncompleteUploadsAfterDaysinteger1 to 365Abandon uploads that were not completed within this many days.
corslist of objectup to 100 itemsThe bucket's cross-origin rules, complete. None by default.
cors[].idstringup to 255 charactersThe rule's name.
cors[].allowedOriginslist of stringyesOrigins allowed to read the bucket from a browser.
cors[].allowedMethodslist of stringyesMethods allowed.
cors[].allowedHeaderslist of stringRequest headers allowed.
cors[].exposeHeaderslist of stringResponse headers a browser may read.
cors[].maxAgeSecondsinteger0 to 86400How long a browser may remember the answer.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending (not compared yet), Ready (as described), Drifted (the provider differs), Missing (plan mode and no such bucket) or Failed (the provider could not be read).
existsbooleanWhether the bucket exists at the provider.
locationstringWhere the bucket is, as read.
storageClassstringThe storage class, as read.
driftlist of stringEach difference between this object and the provider, in words. Empty when they agree.
planlist of stringIn plan mode, the changes apply mode would make.
syncedAtstringWhen the bucket was last compared with the provider.
nextSyncAtstringWhen the bucket is compared next: after the interval, or in five minutes after a failure or a repair.
observedGenerationintegerThe generation of this object last compared.
conditionslist of objectReady (as described, or reported) and Drifted, spec 0047 section 2.
conditions[].typestringReady or Drifted.
conditions[].statusstringTrue, False or Unknown.
conditions[].reasonstringA word from the reason registry.
conditions[].messagestringA sentence.
conditions[].observedGenerationintegerThe generation observed.
conditions[].lastTransitionTimestringWhen the status last changed.

Columns in listings

ColumnFrom
Bucket.spec.bucketName
Mode.spec.mode
Location.spec.location
Phase.status.phase
Drift.status.drift

All resources