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

Quick Installation and experience of SODA releases

Install SODA v1.0.0 Faroe Release Jun 2020

Quick installation from SODA Faroe Release:

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

    • Install docker-compose:

    curl -L https://github.com/docker/compose/releases/download/1.23.1/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose

    • Check golang version is at least 1.13.x

    go version

    • Otherwise install golang 1.13.9:

    wget https://storage.googleapis.com/golang/go1.13.9.linux-amd64.tar.gz && tar -C /usr/local -xzf go1.13.9.linux-amd64.tar.gz && echo export PATH=$PATH:/usr/local/go/bin >> /etc/profile && echo export GOPATH=$HOME/gopath >> /etc/profile && source /etc/profile

    • Procedure

      • Prepare the installer:

    wget https://github.com/sodafoundation/installer/releases/download/v1.0.0/installer-v1.0.0.tar.gz && tar xvzf installer-v1.0.0.tar.gz && cd installer-v1.0.0/ansible/ && chmod +x ./install_ansible.sh && ./install_ansible.sh

    • Confirm Ansible version 2.4.x or later is installed:

    ansible --version

    • 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):

    ip addr | grep inet

    export HOST_IP = <your_real_host_ip>

    • Modify host_ipin YAML file:

    vim group_vars/common.yml

    • Run the installer:

    ansible-playbook site.yml -i local.hosts

    ansible-playbook clean.yml -i local.hosts -vvv &&& 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

Install SODA v0.20.0 Elba Release Apr 2020

  • Elba Release (First Release of SODA) : Refer the “How to use the Release” section of Elba Release Notes

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