Command-line Filespace initialization

  • Updated

Filespace initialization can be performed from the command line with a number of advanced features. For specifics on --block-size to control the LucidLink data layout within your object storage account - see this FAQ

Please reach out via LucidLink Support for additional guidance.

Amazon S3 or compatible:

usage: Lucid init-s3 [--fs] name --provider name [options]

Initialize with Amazon S3 object store


    [--fs] name              The file space name (required)
    --password password      The root password used to encrypt the file space with
    --rendezvous address     Set the rendezvous server address
    --root-path path         Set root path for the file space data and metadata
    --http                   Use HTTP instead of HTTPS
    --https                  Use HTTPS (default)
    --proxy arg              Specify a proxy server to tunnel all communication. Use the following format: [protocol://][user:password@]proxyhost[:port]. Supported protocols: http.
    --access-key key         Amazon S3 access key
    --secret-key key         Amazon S3 secret key
    --bucket-name name       Use a specific bucket name (default: use unique name)
    --provider name          Specify the name of the S3 compatible provider (AWS, DigitalOcean, ...) (required)
    --region name            Specify S3 region
    --endpoint name|IP:port  Specify S3 compatible endpoint
    --virtual-addressing     Use virtual hosted-style bucket addressing instead of path-style
    --block-size size        Set the file space block size in KiB (default is 256)

Microsoft Azure Blob Storage:

Usage: Lucid init-azure [--fs] name [options]

Initialize with Azure blob store


    [--fs] name              The filespace name (required)
    --password password      The root user's password used to encrypt the filespace
    --rendezvous address     Set the rendezvous server address
    --root-path path         Set root path for the filespace data and metadata
    --http                   Use HTTP instead of HTTPS
    --https                  Use HTTPS (default)
    --account-name name      Azure account name
    --account-key key        Azure account key
    --container-name name    Use a specific container name (default: use unique name)
    --endpoint-suffix name|IP:port Specify Azure blob store compatible endpoint
    --block-size size        Set the filespace block size. Default is 256KiB. Supported unit suffixes: K(iB), M(iB). Min 1KiB. Max 32MiB.

Step 1:

  1. Create a Filespace
  2. Define Filespace name
  3. Choose Your or LucidLink storage
  4. Select Your Cloud Provider and Region 
  5. Specify a HTTP or HTTPS endpoint URL (including PORT if required)
  6. Optional: specify Region if required
  7. Optional: specify Bucket name if required
  8. Review and confirm, finally Create Filespace

Step 2:

Your Filespace is being set up - this will take a minute or two, please be patient. Once setup is complete, your Filespace will prompt "initialize". Ensure that the LucidLink OS client is downloaded and installed on the machine performing the initialization. 

We need to start a OS client daemon. we can do this from the command line, with "lucid daemon" alternatively at the point that OS client has been installed, please ensure it is open and is prompting to "connect" please leave this window open because in the background the LucidLink OS client daemon/service is successfully running.  

Step 3:

Open command line, terminal, depending on what OS client you are using and enter the following command, making sure to supply the full Filespace and domain, shared secret, endpoint:port, credentials and bucket name if required, followed by a provider "text" as a simple 1 word vendor identity ie. Minio 

Amazon S3 requires vendor identity --provider AWS

Amazon S3 or compatible:

lucid init-s3 --fs <filespace.domain> --password <rootpassword> --endpoint <ipadddress/url:port> --access-key <access-key> --secret-key <secret-key> --https --region <region> --bucket-name <bucket> --provider <vendor>

Microsoft Azure Blob Storage:

lucid init-azure --fs <filespace.domain> --https --account-name <storageaccount> --account-key <accesskey> --container-name <container>

You should receive "Daemon init request sent." for a successful initialization although should your initial attempt not complete successfully, additional information for guidance might be provided in the error output, please update your combination of parameters and try again. 

You can try multiple times, with parameters such as --http instead of --https for example, and in certain circumstances, parameters such as region are case sensitive. Until your initialization is successful your file space will be waiting patiently in the portal for this step to complete.


lucid init-s3 --fs myexample.filespace --endpoint myobjectstorageendpointandport:80 --access-key 6fa50f2185a0a0c094a3e --secret-key yAKs9SxkGsaHLS+rOef8D8UdGvELKYrBL/AfwLki/ --http --block-size 128K --provider Minio

1. If you receive a "Connection refused" error please make sure the LucidLink Client is running. Otherwise you can launch a separate command-line issuing lucid daemon.
2. Endpoint URL does not require http:// or https:// prefix like it did through the portal as this is supplied separately via command line options of --https or --http.
3. Filespace block size: Default is 256KiB. Supported unit suffixes: K(iB), M(iB). Min 1KiB. Max 32MiB.
4. You can provide the --password <rootpassword> within the initialization string, or you will be prompted upon submission.
5. a command-line initialization does not create default snapshot schedules. Snapshots and schedules must be user defined after the Filespace is initialized. 


Was this article helpful?

0 out of 0 found this helpful