Get started

nf s3

The nf s3 command provides S3-compatible object storage operations backed by Ceph RGW.

All nf s3 commands require S3 credentials passed as top-level flags: --accessKey and --secretKey. You can obtain these credentials by creating an RGW user with nf ceph rgw user create.


Usage

Terminal
$ nf s3 --accessKey <key> --secretKey <key> bucket list
$ nf s3 --accessKey <key> --secretKey <key> bucket create --name <name>
$ nf s3 --accessKey <key> --secretKey <key> object list --bucket <name>

Global options

These flags must be passed on the nf s3 parent command, before the subcommand:

FlagDescription
--accessKeyS3 Access Key (required for all operations)
--secretKeyS3 Secret Key (required for all operations)

Commands

nf s3 bucket list
nf s3 bucket list

List all S3 buckets accessible with the provided credentials.

FlagDescription
--jsonOutput results as JSON
nf s3 bucket create
nf s3 bucket create

Create a new S3 bucket.

FlagDescription
--nameBucket name (required)
nf s3 object list
nf s3 object list

List objects in a bucket. Returns JSON output.

FlagDescription
--bucketBucket name (required)

Examples

Terminal
$ nf s3 --accessKey AKID123 --secretKey SKEY456 bucket create --name backups
Bucket created 

$ nf s3 —accessKey AKID123 —secretKey SKEY456 object list —bucket backups

Terminal
$ nf s3 --accessKey AKID123 --secretKey SKEY456 bucket list
backups
logs
media