Resources / Bucket

Bucket

A bucket of objects. Objects are encrypted by Etorm and read and written over HTTPS with an API token that has access to the bucket. Deleting a bucket makes every object in it unreadable at once.

Overview

APIstorage.etorm.com/v1alpha1
Resourcebuckets (cluster-scoped inside its cluster)
Short namesbkt
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

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

Spec

FieldTypeRequiredDefaultAllowedDescription
descriptionstringup to 1000 charactersWhat the bucket is for, for people.
listIndexbooleanKeep a key index so listing the bucket reads one object instead of every shard. For buckets of up to 2000 objects that are listed more than they are written; the index is rebuilt by the next listing if it is lost. Listings of an indexed bucket are in key order.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending until the bucket is ready for objects, then Ready.
pathstringWhere the bucket is on the storage endpoint: /v1/<project>/<bucket>.
keyVersionintegerThe version of the platform key the bucket's encryption keys are derived from.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether objects can be written.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Path.status.path
Phase.status.phase

Related guides

All resources