Scality Connect Startup Guide


#1

Scality Connect Startup Guide


Once your VM has finished deploying, please follow these steps to finish setting up Scality Connect.

Starting Scality Connect

Step 1. ssh into the VM

ssh into your virtual machine using the credentials you provided upon creation of the virtual machine

Step 2. Set Environment Variables

In the virtual machine, set the following environment variables:

export AZURE_STORAGE_ACCOUNT=<insert the name of your storage account>
export AZURE_STORAGE_ACCESS_KEY=<insert your storage account access key, can be found via the Azure portal>
# Optional FQDN variable (without http:// and without port number). For example, FQDN='example.com'
export FQDN=<The DNS name if you configured it for your VM>

Step 3. Start the Scality Connect Docker container

You can use the run.sh script that will reside in your /var/scality folder with the following format:

/var/scality/run.sh $AZURE_STORAGE_ACCOUNT $AZURE_STORAGE_ACCESS_KEY $FQDN

Or you can start Scality Connect by running the following command:

sudo docker run -d --name scalityconnect -p 8000:8000 -e FQDN=$FQDN \
-e AZURE_STORAGE_ACCESS_KEY=$AZURE_STORAGE_ACCESS_KEY \
-e AZURE_STORAGE_ACCOUNT=$AZURE_STORAGE_ACCOUNT \
--log-opt max-size=5g --log-opt max-file=10 \
--restart always scality/connect

Your Scality Connect instance is now up and running!!

To confirm your Scality Connect is running:

sudo docker ps

You should see scality/connect listed.

Using Scality Connect

Setting up your AWS CLI configuration (or other AWS S3 clients)

  • Your AWS Access Key will be your Azure Storage Account name.
  • Your AWS Secret Key will be your Azure Storage Account key.

Accessing Scality Connect within the VM instance

From the virtual machine itself, you can use http://127.0.0.1:8000 as the request endpoint.

Accessing Scality Connect from outside the VM instance

By default, Azure creates a security network group that automatically blocks all ports except for port 22 (for SSH) and also blocks any requests made from other virtual machines on the same virtual networks. Scality Connect listens on port 8000 for all API requests. If you do not change the detailed security settings for the virtual machines, all requests from outside the virtual machine will be blocked, even if you included a FQDN during startup.

In the Azure portal, find the resource group hosting your virtual machine and click on the associated network security group (by default this is <vm-name>-nsg).

After exposing port 8000, if you want to access the service from outside the virtual machine, the endpoint at which to hit your instance will be http://<your ip address or DNS name>:8000

Accessing Scality Connect with a FQDN

If you would like to have a FQDN (fully qualified domain name used in Step 2) for your endpoint, go to your virtual machine and click on “Configure” under DNS Name. The DNS name should be available as soon as you set it.

For full documentation, see attached:
Scality Connect Developer’s Guide, v1.0.pdf (3.1 MB)


About technical supports