ECS Software 3.0 - Single-Node Docker Configuration Instructions

Table of Contents


Introduction

EMC's Elastic Cloud Storage (ECS) 3.0 Software Docker single node deployment is intended to be used by developers and has a range of deployment options for them. The most universal method for deploying ECS software is through Docker applied across whatever means are at your disposal (IaaS/PaaS/Hypervisor). In addition to this, you can leverage Vagrant for local VirtualBox instances.

In terms of cloud deployments, there are a range of options. The most compatible methods of deployment across any provider are the CentOS and CoreOS options to run the Docker instances.

While these instructions will cover Docker installations, you can find documentation on alternate deployment methods such as Vagrant and Google Compute Engine (as well as previous releases) from the repository on GitHub.

Global Requirements

All instances currently require the following minimum requirements:

  • Operating system: CentOS 7
  • CPU/Cores: 4 Cores
  • Memory: Minimum of 16 GB RAM
  • Disks: An unpartitioned/raw disk with at least 100 GB.

 

Installation also requires internet connectivity to recieve the requisite utility packages and Docker images.

Supported Host Operative Systems and Docker Version

The ECS Docker installation has been tested and verified against the following configuration(s):

OS NameVersionDocker Version
CentOS7.11.8.2 (latest)

Installation Steps

The installation script is comprised of three main steps:

StepNameDescriptionExecution Time
1Host & ECS Container ConfigurationThis step controls the flow and contains the configuration changes required for the host OS that will run the ECS Software Docker container. In addition, this step updates the ECS Docker container so it can run as a single node and with limited resources3-15 min
2ECS Object ConfigurationThis step performs the ECS configuration so it can start serving objects.10-30 min

CentOS Installation

CentOS is a well-known Linux distribution with the ability to deploy containers with Docker. Common public cloud platforms have CentOS templates ready to be used, so getting ECS Software on a Docker container up is extremely easy.

Pre-Installation Steps

These steps are to be performed prior running the installation scripts on each of the ECS nodes:

  1. Attach Data Disk(s): ECS requires one or more disks to be attached to the host. The disk(s) will hold the object data store. The disk(s) will be formatted as XFS by the installation script.
    The data disk(s) attached to each host must be unpartitioned or RAW. For example: We have a new host where we execute the command fdisk -l:Fdisk in a new Host In the picture, we can see two disks: sda and sdb. A mount -l looks like this: Mount in a new HostNow we attach a new disk to the host VM. The new disk /dev/sdc looks like this after executing fdisk -l again:Fdisk in New Host with a new disk attachedNote: Depending on the environment or the cloud provider you may be using, the attached disk name(s) will be different. In this example, the attached disk came as /dev/sdc. The attached disk will be formatted and mounted during step 1, so do not mount the ECS data disk before executing step 1:Fdisk after the STEP 1 script has executed
  2. Open Ports: ECS requires the following ports to be open:
    Port NumberPort Description
    22SSH, needed if using remote access
    443Port used for accessing the ECS management Website
    3218Port used by the CAS service
    4443ECS Management API Port
    9020Port used for the S3 API
    9021Port used for the S3 API on HTTPS
    9022Port used for Atmos API
    9023Port used for Atmos API on HTTPS
    9024Port used for SWIFT API
    9025Port used for SWIFT API on HTTPS
    9100Port used for DT Query service
    9101Port used for Diagnostic Service Index
    Note: These are the most commonly-used ports by ECS; please refer to List of Ports to be Open on the troubleshooting page for a full list. In addition, please refer to the ECS Security Configuration Guide and our the troubleshooting page if you encounter any issues.

Host and Container Configuration

‼️ WARNING: This is a destructive operation. Existing data on selected storage devices will be overwritten. Existing Docker installations AND images will be removed.

  1. Perform Updates: Perform a Yum update using sudo yum update and download packages required for installation using sudo yum install git tar wget
  2. Git Clone/Pull the repository: https://github.com/EMCECS/ECS-CommunityEdition
  3. Navigate to the /ecs-single-node folder.
  4. Gather the IP address, desired hostname, ethernet adapter name (which can be obtained by executing ifconfig on the host), and designated data disk(s). For example:
    HostnameIP AddressEthernet AdapterDisk Name
    ecstestnode110.0.1.10eth0sdc
  5. Run the step 1 script for single-node ECS. For our example values the command would bethe one below, but your environment's specifics will differ. Be advised that the hostname can not be localhost. The execution of this script will take about 3-15 minuted depending on how many packages need to be installed or updated and the speed of certain services on the host.
    sudo python step1_ecs_singlenode_install.py --disks sdc --hostname ecstestnode1 --ethadapter eth0
    For a list of all arguments with their full descriptions and including more detailed options, use the --help flag, e.g. python step1_ecs_singlenode_install.py --help

  6. At the conclusion of step 1, you may have to wait a few minutes until the administrative web UI becomes available. ECS' administrative portal can be accessed from the data node on port 443 ( https://<ecs-node-ip-address> ). Once you see the screen below, you are ready to execute step 2. ECS UI

ECS Object Configuration

The next step is the ECS Object configuration. This can be accomplished in two ways:

Both methods provide the same results; the first walks you through ECS' administrative web interface and the second uses ECS' Management API (exposed on port 4443 and 9011)


ECS Object Configuration via an automated script

  1. Navigate to the /ecs-single-node folder.
  2. Verify that the step2_object_provisioning.py script for the environment you are in can access the 4443 and 9011 ports of the host machine, such as through the output of nmap -sT -O localhost
  3. Before executing step2_object_provisioning.py, decide upon values for the following variables:
    Variable NameVariable DescriptionExample Value
    ECSNodesIP Address of the ECS Node. For Single-Node deployment, only one IP is necessary.10.0.1.10
    NameSpaceThe objects' Namespacens1
    ObjectVArrayThe objects' Virtual Arrayova1
    ObjectVPoolThe objects' Virtual Poolov1
    DataStoreNameThe name of the Data Store.ds1
    VDCNameThe name of the Virtual Data Center.vdc1
    MethodNameThe name of the specific step to be executed. Leave blank to complete all provisioning steps.[empty]

    Once the variables are defined, they should be placed in the script command. Using the example values, the command becomes:

    sudo python step2_object_provisioning.py --ECSNodes=10.0.1.10 --Namespace=ns1 --ObjectVArray=ova1 --ObjectVPool=ovp1 --UserName=emccode --DataStoreName=ds1 --VDCName=vdc1 --MethodName= 

    For more granular way of executing the Object Configuration, you can follow the instructions on this document showing how to run the process step by step.

    The execution of this script may take 10 to 30 minutes to complete.

ECS Web Environment Access and Object Testing

After the successful execution of the ECS Object Configuration, the system is ready to begin serving objects. Object users can read and write objects using free tools like S3 browser

In addition, access to the ECS's administrative panel is available via https://<ecs-node-ip-address>. The default login and password for the portal is root/ChangeMe (which you will be prompted to change when first accessing the portal)

Cleanup/Uninstall

To remove an existing installation of ECS Community Edition and clean up its associated resources, you can run the step1 script with the --cleanup option enabled, e.g.

sudo python step1_ecs_singlenode_install.py --disks sdc --hostname ecstestnode1 --ethadapter eth0 --cleanup

 

This will remove the ECS Community Edition docker container, remove local directories linked to resources within the container, and de-partition, unmount, and de-register any associated data disks.

 

Troubleshooting

If you have any issues with the installation, you can review this page for troubleshooting tips and/or go to the support section bellow.

Support

Please file bugs and issues at the Github issues page. For more general discussions you can contact the EMC Code team at Google Groups or tagged with EMC on stackoverflow.com. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community-driven process.