my-rook-config/Documentation/client.md

Using Rook

The rook client tool can be used to manage your Rook cluster once it is running as well as manage block, file and object storage. See the sections below for details on how to configure each type of storage.

If you don't yet have a Rook cluster running or for instructions to launch the rook client, refer to our Quickstart Guides.

Block Storage

1. Create a new volume image (10MB)

   rook block create --name test --size 10485760
   

2. Map the block volume and format it and mount it

   # If running in the rook client container, no need to run privileged
   rook block map --name test --format --mount /tmp/rook-volume
   
   # If running standalone, you may need to run privileged and take ownership of the folder
   sudo -E ./rook block map --name test --format --mount /tmp/rook-volume
   sudo chown $USER:$USER /tmp/rook-volume
   

3. Write and read a file

   echo "Hello Rook!" > /tmp/rook-volume/hello
   cat /tmp/rook-volume/hello
   

4. Cleanup

   # If running in the rook client container, no need to run privileged
   rook block unmap --mount /tmp/rook-volume
   
   # If running standalone, you may need to run privileged
   sudo -E ./rook block unmap --mount /tmp/rook-volume
   

Shared File System

1. Create a shared file system

   rook filesystem create --name testFS
   

2. Verify the shared file system was created

   rook filesystem ls
   

3. Mount the shared file system from the cluster to your local machine

   # If running in the rook client container, no need to run privileged
   rook filesystem mount --name testFS --path /tmp/rookFS
   
   # If running standalone, you may need to run privileged and take ownership of the folder
   sudo -E ./rook filesystem mount --name testFS --path /tmp/rookFS
   sudo chown $USER:$USER /tmp/rookFS
   

4. Write and read a file to the shared file system

   echo "Hello Rook!" > /tmp/rookFS/hello
   cat /tmp/rookFS/hello
   

5. Unmount the shared file system (this does not delete the data from the cluster)

   # If running in the rook client container, no need to run privileged
   rook filesystem unmount --path /tmp/rookFS
   
   # If running standalone, you may need to run privileged
   sudo -E ./rook filesystem unmount --path /tmp/rookFS
   

6. Cleanup the shared file system from the cluster (this does delete the data from the cluster)

   rook filesystem delete --name testFS
   

Object Storage

1. Create an object storage instance in the cluster

   rook object create
   

2. Create an object storage user

   rook object user create rook-user "my object store user"
   

Consume the Object Storage

Use an S3 compatible client to create a bucket in the object store. If you are running in Kubernetes, the s3cmd tool is included in the Rook toolbox pod.

1. Get the connection information for accessing object storage

   eval $(rook object connection rook-user --format env-var)
   

2. Create a bucket in the object store

   s3cmd mb --no-ssl --host=${AWS_ENDPOINT} --host-bucket=  s3://rookbucket
   

3. List buckets in the object store

   rook object bucket list
   

4. Upload a file to the newly created bucket

   echo "Hello Rook!" > /tmp/rookObj
   s3cmd put /tmp/rookObj --no-ssl --host=${AWS_ENDPOINT} --host-bucket=  s3://rookbucket
   

5. Download and verify the file from the bucket

   s3cmd get s3://rookbucket/rookObj /tmp/rookObj-download --no-ssl --host=${AWS_ENDPOINT} --host-bucket=
   cat /tmp/rookObj-download