Get started

nf ceph rgw

The nf ceph rgw command manages RADOS Gateway instances and their users.

RGW provides an S3-compatible object storage API on top of your Ceph cluster. After deploying an RGW instance, you can create users with access credentials and interact with object storage via the nf s3 commands or any S3-compatible client.

You can deploy multiple RGW instances across different nodes for high availability and load distribution.


Usage

Terminal
$ nf ceph rgw list
$ nf ceph rgw deploy --node <node-id>
$ nf ceph rgw remove --id <rgw-id>
$ nf ceph rgw user list
$ nf ceph rgw user create --id <user-id> --name <display-name>

Instance commands

nf ceph rgw
nf ceph rgw list

List all RGW instances with their ID, node hostname, and status.

FlagDescription
--jsonOutput results as JSON
nf ceph rgw deploy

Deploy a new RGW instance on a node. The deployment runs as a background task.

FlagDescription
--nodeNode ID (UUID) (required)
nf ceph rgw remove

Remove an RGW instance. The removal runs as a background task.

FlagDescription
--idRGW Instance ID (required)

User commands

nf ceph rgw user
nf ceph rgw user list

List all RGW users with their user ID, display name, and email.

FlagDescription
--jsonOutput results as JSON
nf ceph rgw user create

Create a new RGW user. The user receives S3 access and secret keys for object storage access.

FlagDescription
--idUser ID (required)
--nameDisplay name (required)
--emailEmail address

Terminals

Terminal
$ nf ceph rgw deploy --node 550e8400-e29b-41d4-a716-446655440000
RGW deployment scheduled
Terminal
$ nf ceph rgw user create --id jane --name "Jane Doe" --email jane@example.com
RGW user created
Terminal
$ nf ceph rgw list
a1b2c3d4  worker-01  active 

$ nf ceph rgw user list jane Jane Doe jane@example.com