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
| API | storage.etorm.com/v1alpha1 |
| Resource | buckets (cluster-scoped inside its cluster) |
| Short names | bkt |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: storage.etorm.com/v1alpha1
kind: Bucket
metadata:
name: example
spec: {}
Spec
| Field | Type | Required | Default | Allowed | Description |
description | string | | | up to 1000 characters | What the bucket is for, for people. |
listIndex | boolean | | | | Keep 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
| Field | Type | Required | Default | Allowed | Description |
phase | string | | | | Pending until the bucket is ready for objects, then Ready. |
path | string | | | | Where the bucket is on the storage endpoint: /v1/<project>/<bucket>. |
keyVersion | integer | | | | The version of the platform key the bucket's encryption keys are derived from. |
conditions | list of object | | | | Detailed state, one entry per aspect; Ready says whether objects can be written. |
conditions[].type | string | | | | Aspect. |
conditions[].status | string | | | | True or False. |
conditions[].reason | string | | | | Machine-readable reason. |
conditions[].message | string | | | | Human-readable detail. |
Columns in listings
| Column | From |
|---|
| Path | .status.path |
| Phase | .status.phase |
Related guides
All resources