Command line file space initialization
Modified on: Sun, 4 Nov, 2018 at 12:58 PM
File space initialization can be performed from the command line with a number of advanced features, specifically --block-size to control the LucidLink data layout within an S3 compatible object storage - see this FAQ.
Please reach out via LucidLink Support for additional guidance.
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 shared secret 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)
Create a file space
Define file space name
Choose Your or LucidLink storage
Select Your Cloud Provider and Region
Specify a HTTP or HTTPS endpoint URL (including PORT if required)
Optional: specify Region if required
Optional: specify Bucket name if required
Review and confirm, finally Create file space
Your file space is being set up - this will take a minute or two, please be patient. Once setup is complete, your file space 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.
Open command line, terminal, depending on what OS client you are using and enter the following command, making sure to supply the full file space 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
lucid init-s3 --fs <filespace.domain> --password <sharedsecret> --endpoint <ipadddress/url:port> --access-key <access-key> --secret-key <secret-key> --https --region <region> --bucket-name <bucket> --Provider <vendor>
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 --password 12345 --endpoint myobjectstorageendpointandport:80 --access-key 6fa50f2185a0a0c094a3e --secret-key yAKs9SxkGsaHLS+rOef8D8UdGvELKYrBL/AfwLki/ --http --block-size 128 --provider Minio
Note: If receive "Connection refused" please ensure to open the OS client or launch a command line/terminal daemon with "lucid daemon". Also note the endpoint URL does not require http:// or https:// like it did through the portal as we supply this manually through our command line options of --https or --http
Did you find it helpful?
Sorry we couldn't be helpful. Help us improve this article with your feedback.