spiral volumes
Register Volumes and manage storage credentials
Usage: spiral volumes [OPTIONS] <COMMAND>Options
| Option | Required | Default | Description |
|---|---|---|---|
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
Subcommands
| Command | Summary |
|---|---|
spiral volumes ls | List Volumes available to your Organization |
spiral volumes register | Register an existing bucket or prefix. Does not create a bucket or test object access |
spiral volumes status | Retire, revoke, or reactivate a Volume |
spiral volumes credential | Replace a Volume's credential without changing its storage root |
spiral volumes ls
Usage: spiral volumes ls [OPTIONS]Options
| Option | Required | Default | Description |
|---|---|---|---|
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral volumes register
Usage: spiral volumes register [OPTIONS] --name <NAME> --uri <URI> --provider <PROVIDER>Options
| Option | Required | Default | Description |
|---|---|---|---|
--name <NAME> | yes | Volume name | |
--uri <URI> | yes | Storage root, such as s3://bucket/prefix/ or gs://bucket/prefix/ | |
--provider <PROVIDER> | yes | Storage provider. AWS and GCS authenticate with OIDC, Ceph with the method --auth names, and the rest with an access key | |
--auth <AUTH> | no | How a Ceph Volume authenticates: access_key, or oidc for the Volume's own identity | |
--region <REGION> | no | Storage region; also the signing region for AWS and S3-compatible storage | |
--role-arn <ROLE_ARN> | no | The role the Volume assumes: an AWS IAM role that trusts the Volume's identity, or a Ceph role as the gateway prints it | |
--endpoint <ENDPOINT> | no | S3-compatible endpoint for minio, rustfs, ceph, or s3_like | |
--account-id <ACCOUNT_ID> | no | Cloudflare account ID for R2 | |
--jurisdiction <JURISDICTION> | no | R2 jurisdiction: eu, fedramp, or us | |
--workload-identity-provider <WORKLOAD_IDENTITY_PROVIDER> | no | GCS workload identity provider resource name | |
--service-account <SERVICE_ACCOUNT> | no | GCS service account email | |
--access-key-id <ACCESS_KEY_ID> | no | Access key ID. Defaults to AWS_ACCESS_KEY_ID for access-key providers | |
--secret-file <SECRET_FILE> | no | Read the secret access key from a file; otherwise use AWS_SECRET_ACCESS_KEY | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral volumes status
Usage: spiral volumes status [OPTIONS] <VOLUME_ID> <STATUS>Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
VOLUME_ID | yes | ||
STATUS | yes |
Options
| Option | Required | Default | Description |
|---|---|---|---|
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral volumes credential
Usage: spiral volumes credential [OPTIONS] --provider <PROVIDER> <VOLUME_ID>Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
VOLUME_ID | yes |
Options
| Option | Required | Default | Description |
|---|---|---|---|
--provider <PROVIDER> | yes | Storage provider. AWS and GCS authenticate with OIDC, Ceph with the method --auth names, and the rest with an access key | |
--auth <AUTH> | no | How a Ceph Volume authenticates: access_key, or oidc for the Volume's own identity | |
--region <REGION> | no | Storage region; also the signing region for AWS and S3-compatible storage | |
--role-arn <ROLE_ARN> | no | The role the Volume assumes: an AWS IAM role that trusts the Volume's identity, or a Ceph role as the gateway prints it | |
--endpoint <ENDPOINT> | no | S3-compatible endpoint for minio, rustfs, ceph, or s3_like | |
--account-id <ACCOUNT_ID> | no | Cloudflare account ID for R2 | |
--jurisdiction <JURISDICTION> | no | R2 jurisdiction: eu, fedramp, or us | |
--workload-identity-provider <WORKLOAD_IDENTITY_PROVIDER> | no | GCS workload identity provider resource name | |
--service-account <SERVICE_ACCOUNT> | no | GCS service account email | |
--access-key-id <ACCESS_KEY_ID> | no | Access key ID. Defaults to AWS_ACCESS_KEY_ID for access-key providers | |
--secret-file <SECRET_FILE> | no | Read the secret access key from a file; otherwise use AWS_SECRET_ACCESS_KEY | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
Found a problem? Edit this page or report an issue.