Quick Start Guide

This is a quickstart guide for users and new contributors to try and get familiar with SODA Foundation Release and its projects. It will help to install and try out the SODA Releases using the binaries with minimum configurations or settings.

*Note: *At present, this document also provides the installation steps to try out older OpenSDS releases. Soon, the support for old opensds releases shall be removed.**

To have more control of the installaton cofigurations, or try out various configurations refer a detailed installation guide here

Supported SODA releases

  • The following releases are supported using the installation steps given below.

    RELEASE NAME RELEASE TAG
    Hawaii v1.2.0
    Greenland v1.1.0
    Faroe v1.0.0
    Elba v0.20.0

    Use the RELEASE TAG in the commands below wherever mentioned RELEASE-TAG.

Quick Installation and experience of SODA releases

This procedure applies to Ubuntu 16.04 and 18.04 Linux distributions.

  • Prerequisite

    • Get superuser priviledges:

    sudo -s

    • Install Basic Dependencies:

    apt-get update && apt-get install -y git make curl wget libltdl7 libseccomp2 libffi-dev gawk

    • Install Docker:
      • Ubuntu 16.04:

    wget https://download.docker.com/linux/ubuntu/dists/xenial/pool/stable/amd64/docker-ce_18.06.1~ce~3-0~ubuntu_amd64.deb && dpkg -i docker-ce_18.06.1~ce~3-0~ubuntu_amd64.deb

    • Ubuntu 18.04:

    wget https://download.docker.com/linux/ubuntu/dists/bionic/pool/stable/amd64/docker-ce_18.06.1~ce~3-0~ubuntu_amd64.deb && dpkg -i docker-ce_18.06.1~ce~3-0~ubuntu_amd64.deb

    Please replace RELEASE_TAG with the corresponding value from Release Tag table above (ex: v1.2.0 etc)
    
    • wget https://github.com/sodafoundation/installer/releases/download/[RELEASE_TAG]/installer-[RELEASE_TAG].tar.gz OR Download the installer binaries from
      https://github.com/sodafoundation/installer/releases/tag/[RELEASE_TAG]

    • tar xvzf installer-[RELEASE_TAG].tar.gz

    • cd installer-[RELEASE_TAG]/ansible/

    • chmod +x ./install_ansible.sh && ./install_ansible.sh

    • ansible –version # Ansible version 2.4.x is required

    • The HOST_IP need to be set to the real_host_ip of your host (ex: 192.168.1.10 or 127.0.0.1 for localhost)

      • export HOST_IP =
      • vim group_vars/common.yml # Modify host_ip address if needed
    • Run the installer

      • ansible-playbook site.yml -i local.hosts
      • Note: If you want to clean up and test again, run
        • ansible-playbook clean.yml -i local.hosts -vvv
      • and then run:
        • ansible-playbook site.yml -i local.hosts
    • How to do a quick test

      • Open Your Browser and use the http://< actual host ip>:8088 to access the SODA Dashboard (this IP should be the IP Address of the host if you have updated the config file) Example: http://127.0.0.1:8088

      • Use admin/opensds@123 credentials to login

      • You will login to the UI Dashboard and you can verify the features through various menu options

Previous Release

Note: We are currently not supporting the older versions before Elba. However, if you have specific reasons to use older versions, please contact at #general slack channel of soda foundation slack