bucket
The bucket commands.
A bucket is S3 compatible storage for files, such as uploads, images or backups. It belongs to the team rather than to one application, and any S3 client reaches it with an access key, so several applications and scripts can share the same files. A volume is a disk inside one application. A bucket is read and written over HTTPS, by anything that holds a key.
Every bucket has two names. name is what Out Plane calls it, and what these commands
take. bucketName adds a short random suffix that makes the address unique, and it is the
one an S3 client needs.
Clients must use virtual-hosted addressing, where the bucket name is part of the host:
https://<bucketName>.obj.outplane.dev/<file>. Path-style requests do not work. Some S3
clients switch to path-style when you set a custom endpoint, so set the addressing style
explicitly. Sign requests with the region auto. A new bucket's address can take a few
minutes to start working, so a TLS error right after creating one means wait and try
again.
A bucket is private unless it is made public, and a new one has no key.
bucket key create makes one and shows its secret once, so an agent driving the CLI hands
that command to the person rather than running it. bucket delete and bucket key delete
stop for a person's confirmation, as every deletion does. Buckets are in beta, and a team can
have up to 5. These commands need outplane v0.2.16 or newer.
Most people start in the console, where Buckets creates one and shows the variables to give an application. These commands do the same from a terminal or a script.
Commands
| Command | What It Does | Risk |
|---|---|---|
bucket list | List the team's buckets. | read |
bucket get | Show one bucket and how clients reach it. | read |
bucket create | Create a bucket, private unless told otherwise. | write |
bucket update | Make a bucket public or private. | write |
bucket delete | Permanently destroy a bucket, its files and its keys. | destructive |
bucket key list | List the access keys on a bucket. | read |
bucket key create | Add an access key to a bucket, showing its secret once. | write |
bucket key delete | Remove an access key from a bucket. | destructive |