Skip to main content

Objects

Object storage architecture

Object storage is a storage architecture that manages data in a flat namespace of individual objects. The object storage system is self-contained, with metadata for each object stored with the object. Object stores can contain a massive amount of unstructured data.

Before you begin

To create an object filesystem with the S1 system, you must:

  1. Create at least one floating IP.
  2. Create at least one access key.

Creating access keys

To create an access key, use the applications objects access_keys create command. You must create an access key before you can use an object filesystem (OFS).

Usage

applications objects access_keys create <accessKey> --secretKey=<secretKey> --role=<objectPermissions>

Options

Options and arguments Description
<accessKey> Specify the name of the key. Replace the positional argument <accessKey> with s1: and append it with a name of your choice containing at least five characters.
--secretKey=<secretKey> Create a master access key for all the objects. Replace <secretKey> with your chosen password. Your password must be at least eight characters long.
--role=<objectPermissions> Grant a user with permissions. Replace <objectPermissions> with either Admin or Regular (Regular grants read and write privileges).

Examples

  1. To create access key s1:Abraham with secrete key pwd123456 and role Admin; run: 
    applications objects access_keys create s1:Abraham --secretKey pwd123456 --role Admin

Listing access keys

To list all access keys, use the applications objects access_keys list command.

Usage

applications objects access_keys list [--accessKey=<text> --showSecretKeys]

Options

Options and arguments Description
--accessKey=<text> To list only results for a specific access key, replace <text> with the name of the access key.
--showSecretKeys Show secret keys.

Examples

  1. To list all access keys, run:

    applications objects access_keys list
  2. To list a specific access key and display its secret key, run: 
    applications objects access_keys list --accessKey s1:object01-admin --showSecretKeys

Editing access keys

You can edit the access key using the application access_keys edit command.

Usage

applications objects access_keys edit <accessKey> [--newAccessKey=<accessKey> --secretKey=<secretKey> --role=<objectPermissions>] [--force]

Options

Options and arguments Description
<accessKey> Specify the access key you want to delete. Replace the positional argument <accessKey> with the existing access key name you want to delete.
--newAccessKey=<accessKey> To rename the access key. Replace the positional argument <accessKey> with s1: and append it with a name of your choice with at least five characters.
--secretKey=<secretKey> To create a master access key for all the objects. Replace <secretKey> with your chosen password. Your password must be at least eight characters long.
--role=<objectPermissions> To grant the user with permissions. Replace <objectPermissions> with either Admin or Regular (Regular user grants read and write privileges).
--force To force editing the access key, even though it might be associated with an existing object filesystem.

Examples

  1. To change access key name s1:Abraham to s1:Jacob; change password from pwd123456 to pwd654321, and restrict his permission access to Regular; and to force the edit, run:

    applications objects access_keys edit s1:Abraham --newAccessKey s1:Jacob --secretKey pwd654321 --role Regular --force

Deleting access keys

You can delete an access key using the applications objects access_keys delete command.

Usage

applications objects access_keys delete <accessKey>

Options

Options and arguments Description
<accessKey> Specify the name of the access key you want to delete. Replace <accessKey> with the existing access key you want to delete.

Examples

  1. To delete access key s1:Jacob; run

    applications objects access_keys delete s1:Jacob

Creating an object store

To create an object storage file system on a volume, use the applications objects stores create command.

Usage

applications objects stores create --application=<app_name> --volume=<vol_name> --floatingIp=<name> --port=<port> --accessKeys=<text…> [--enableUseSsl]

Options

Options and arguments Description
--application=<app_name> Specify the app instance of the volume. Replace <app_name> with the name of the application instance name.
--volume=<vol_name> Specify the volume where the object file system is to create. Replace <vol_name> with the name of the volume.
--floatingIp=<name> Specify the floating IP which will be used for this object. Replace <name> with the floating IP name.
--port=<port> Specify the TCP port for the object storage file system.
--accessKeys=<text…> Grant users with the specified access-keys permission to use the object filesystem. Replace <text…> with a list of access keys.
--enableUseSsl To enable communication through a secure socket layer (SSL).

Remark:

  • The access key option allows access from multiple users, where each of the users has its key.

Example

  1. To create an object file system on volume vol1 (mapped to application instance sales) with floating IP name connect1 on port 8088 over SSL communication with access keys s1:Abraham and s1:Jacob, run:

    applications object stores create --application sales --volume vol1 --floatingIp connect1 --port 8088 --accessKeys s1:Abraham s1:Jacob --enableusessl

Listing object stores

You can list all object storage using the applications objects stores list command.

Usage

applications objects stores list [(--application=<app_name> --volume=<vol_name>)]

Options

Options and arguments Description
--application=<app_name> To specify the app instance of the volume, replace <app_name> with the name of the application instance name.
--volume=<vol_name> To specify the volume from where the object file system will be listed, replace <vol_name> with the name of the volume.

Examples

  1. To list all object file systems, run:

    applications objects stores list

  2. To list all objects file systems on a volume vol1 mapped to an application instance sales, run

    applications objects stores list --application sales --volume vol1

Editing object stores

To edit the object filesystem, use the applications objects stores edit command.

Usage

applications objects stores edit --application=<app_name> --volume=<vol_name> [--floatingIp=<name> --port=<port> --accessKeys=<text…> --enableUseSsl | --disableUseSsl]

Options

Options and arguments Description
--application=<app_name> Specify the app instance of the volume. Replace <app_name> with the name of the application instance name.
--volume=<vol_name> Specify the volume where the object file system is to create. Replace <vol_name> with the name of the volume.
--floatingIp=<name> To specify the floating IP which will be used for this object. Replace <name> with the floating IP name.
--port=<port> To specify the TCP port for the object storage file system.
--accessKeys=<text…> To edit the granted user list. Replace <text…> with a list of access keys.
--enableUseSsl To enable communication through a secure socket layer (SSL).
--disableUseSsl To disable communication through a secure socket layer (SSL).

Examples

  1. Suppose that we have an object filesystem on volume vol1 (mapped to application instance sales) with floating IP name connect1 on port 8088 over SSL communication with access keys s1:Isaac s1:Jacob. To disable SSL communication, run:

    applications objects stores edit --application sales --volume vol1 --disableUseSsl

  2. Suppose that we have an object filesystem on volume vol1 (mapped to application instance sales) with floating IP name connect1 on port 8088 over SSL communication with access keys s1:Isaac s1:Jacob. To rewrite the list of access keys replacing it with the list s1:David s1:Jonathan; to change floating IP name to mycel; and to change the port to 9090, run:

    application objects stores edit --application sales --volume vol1 --floatingIp mycel --port 9090 --accessKeys s1:David s1:Jonathan

Deleting object stores

To delete an object filesystem, use the applications objects stores delete command.

Usage

applications objects stores delete --application=<name> --volume=<name>

Options

Options and arguments Description
--application=<app_name> Specify the app instance of the volume. Replace <app_name> with the name of the application instance name.
--volume=<vol_name> Specify the volume where the object store that you want to delete resides. Replace <vol_name> with the name of the volume.

Example

  1. To delete all object filesystems on volume vol1; mapped to application instance sales; run: 
     applications objects stores delete --application sales --volume vol1

Adding access keys to object stores

Use this command when you want to add existing access keys to the Object filesystems (OFSs) in a volume. To add access keys that already exist to an object, use the applications objects stores access_keys add command.

Usage

applications objects stores access_keys add --application=<app_name> --volume=<vol_name> --accessKeys=<text…>

Options

Options and arguments Description
--application=<app_name> Specify the app instance of the volume. Replace <app_name> with the name of the application instance name.
--volume=<vol_name> Specify the volume of the OFSs. Replace <vol_name> with the name of the volume.
--accessKeys=<text…> Add object keys of the OFSs. Replace <text…> with a list of existing access keys.

Examples

  1. To add new access keys s1:Abraham s1:Isaac s1:Jacob to all object filesystems on volume vol1 that mapped to application instance sales, run:

    applications objects stores access_keys add --application sales --volume vol1 --accessKeys s1:Abraham s1:Isaac s1:Jacob

Removing access keys from object stores

Use this command to restrict users from using the object filesystems of a volume. To delete access keys from volume objects, use the applications objects stores access_keys delete command.

Usage

applications objects stores access_keys delete --application=<app_name> --volume=<vol_name> --accessKeys=<text…>

Options

Options and arguments Description
--application=<app_name> Specify the app instance of the volume. Replace <app_name> with the name of the app instance name.
--volume=<vol_name> Specify the volume of the OFSs. Replace <vol_name> with the name of the volume.
--accessKeys=<text…> Delete the object keys of the OFSs. Replace <text…> with a list of access keys.

Examples

  1. To delete access keys s1:Abraham and s1:Isaac from all object sotres on a volume vol1 ( mapped to application instance sales), run:

    applications objects stores access_keys delete --application sales --volume vol1 --accessKeys s1:Abraham s1:Isaac
No Comments
Back to top