Set Up ObjectiveFS With IBM COS

This document covers the steps to set up your ObjectiveFS filesystem with IBM Cloud Object Storage on the IBM Cloud Platform. For on-premise IBM COS setup, see the on-premise IBM COS setup guide.

What You Need

  1. Your IBM Cloud Object Storage Account is set up
  2. ObjectiveFS license key from the Filesystem section on your profile page

Steps

  1. Download and install ObjectiveFS

  2. Get your IBM COS keys

    On your IBM Cloud Console
    → Go to the Cloud Object Storage section
    → Select “Service Credentials” from the left menu
    → Click on “New Credentials” to create a new key (OR use an existing key)
    → Select the key and click the copy icon
    
    The json file copied has your “access_key_id” and “secret_access_key”

  3. Get your IBM COS endpoint

    On your IBM Cloud Console
    → Go to the Cloud Object Storage section
    → Select “Endpoints” from the left menu
    → Select the resiliency and location that you would like
    → Get the endpoint address (e.g. s3.us.cloud-object-storage.appdomain.cloud)
    

  4. Configure Objectivefs
    The config parameters will be stored in /etc/objectivefs.env/

    $ sudo mount.objectivefs config
    Enter ObjectiveFS license: <your ObjectiveFS license>
    Enter Access Key Id: <your access_key_id from step 2>
    Enter Secret Access Key: <your secret_access_key from step 2>
    Enter Default Region: http://<endpoint from step 3>  // e.g. http://s3.us.cloud-object-storage.appdomain.cloud
    

  5. Create your filesystem (one-time only)

    • Use a globally unique name for your filesystem name. ObjectiveFS will create a new IBM COS bucket with this name in the region you selected.
    • Choose a strong passphrase, write it down and store it somewhere safe.
      IMPORTANT: Without the passphrase, there is no way to recover any files.

    $ sudo mount.objectivefs create <your filesystem name>
    Passphrase (for <filesystem>): <your passphrase>
    Verify passphrase (for <filesystem>): <your passphrase>
    
    Note: If you need to use an existing empty IBM COS bucket, see this doc.

  6. Mount your filesystem
    Mount your filesystem on an existing empty directory, e.g. /ofs. The ObjectiveFS process will run in the background.

    $ sudo mkdir /ofs
    $ sudo mount.objectivefs <your filesystem name> /ofs
    Passphrase (for <filesystem>): <your passphrase>
    

  7. [Optional] Multi-server setup
    Mount this filesystem on as many servers as you wish by running steps 1, 4 and 6 on each server. Each server can read and write to the same filesystem at the same time.

Tips

  1. Store your filesystem passphrase in /etc/objectivefs.env/OBJECTIVEFS_PASSPHRASE to mount the filesystem without manually entering the passphrase each time.
  2. To mount the filesystem via /etc/fstab, see the mount on boot guide.

Reference

If you have questions, please email us at support@objectivefs.com.

Last updated by ObjectiveFS staff, May 4, 2022


ObjectiveFS is a shared filesystem for Linux and macOS that automatically scales up and out with high performance. In production use by Fortune 500 companies since 2013.