Skip to content

Latest commit

 

History

History
257 lines (163 loc) · 7.45 KB

CORTXManagerQuickstartGuide.md

File metadata and controls

257 lines (163 loc) · 7.45 KB

CORTX-Manager Quick Start Guide

This guide provides a step-by-step walkthrough for getting you CORTX-Manager ready.

1.0 Prerequisites

Before you begin

Click to view the process to manually install the full stack.

  1. You'll need to install the following components:

  2. Login with super user:

    $ sudo su

    Or

    $ sudo -s

  3. Ensure you've installed the following softwares:

    1. Install RabbitMQ

      $ wget https://www.rabbitmq.com/releases/rabbitmq-server/v3.6.1/rabbitmq-server-3.6.1-1.noarch.rpm
$ rpm --import https://www.rabbitmq.com/rabbitmq-release-signing-key.asc
$ yum install rabbitmq-server-3.6.1-1.noarch.rpm
$ systemctl enable rabbitmq-server
$ systemctl start rabbitmq-server
$ rabbitmqctl add_user admin password
$ rabbitmqctl set_user_tags admin administrator
$ rabbitmqctl set_permissions -p / admin ".*" ".*" ".*"
$ rabbitmqctl add_vhost SSPL
$ rabbitmq-plugins enable rabbitmq_management

    From your browser, navigate go to: http://:15672/

    1. Login with your admin password.

    2. Select Virtual host as SSPL.

    3. Navigate to the Admin section.

    4. Click on add user and enter the following details:

      username: sspluser

      password: sspl4ever

    5. Added user will be listed in users table. Click on added user.

    6. Set all permissions and select virtual host as SSPL

  4. Install Elastic Search:

    $ yum install -y https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.3.2-x86_64.rpm
$ vim /etc/elasticsearch/elasticsearch.yml       
$ systemctl enable elasticsearch
$ systemctl start elasticsearch

    Successful elasticsearch.yml installation

  5. Install Consul

    1. Download consule binary.

      $ wget https://releases.hashicorp.com/consul/1.8.3/consul_1.8.3_linux_amd64.zip

    2. Unzip downloaded zip.

      $ unzip consul_1.8.3_linux_amd64.zip

    3. Install unzip if not already installed.

      $ yum install unzip

      $ unzip consul_1.8.3_linux_amd64.zip

    4. Move binary to /usr/loval/bin folder.

      $ mv consul /usr/local/bin/

    5. Check if the PATH contains /usr/local/bin. If it doesn’t, add it to the path.

      $ echo $PATH
$ export PATH=$PATH:/usr/local/bin

    6. Check if consul is installed.

      $ consul

    7. Run consul in the background.

      $ nohup consul agent --dev &

  6. Install provisioner

    1. Go to your home directory.
    2. Git clone the provisioner repository, and follow the steps below:
       $ git clone [email protected]:Seagate/cortx-prvsnr.git
   $ mkdir /opt/seagate/cortx/provisioner
   $ ln -s /<path-to-cortx-prvsnr>/cortx-prvsnr/* /opt/seagate/cortx/provisioner/

Install OVA and these prerequisites to skip manual installation.

Please refer to the documentation to Import the CORTX Open Virtual Appliance (OVA).

  1. Install GitHub.

    Refer to the Contributing to CORTX Manager document to install GitHub and clone cortx-manager and its dependent repos.

  2. Install pyutils that is custom-built for CORTX project:

    1. Go to your home directory

    2. Git clone cortx-py-utils and follow the steps below:

      $ cd /home/727891/githubssh/
$ git clone --recursive [email protected]:Seagate/cortx-py-utils.git
$ cd /opt/seagate/
$ mkdir cortx
$ cd cortx
$ ln -s /<path-to-cortx-py-utils>/cortx-py-utils/src/utils

  3. Install Python 3

    $ yum –y install python3

1.2 Install Cortx-Manager

The cortx-manager repository is available at https://github.com/Seagate/cortx-manager

Follow these steps to Install CORTX-Manager

  1. Clone cortx-manager using HTTP or SSH:

    $ git clone https://github.com/Seagate/cortx-manager.git
$ git clone [email protected]:Seagate/cortx-manager.git

  2. Once you have obtained the sources, build the cortx-manager by running:

    $ cd cortx-cortx-manager
$ sudo cicd/build.sh

  3. Run $ sudo cicd/build.sh -h to list build options in more detail. - This will build an RPM on a dest directory.

    Examples:

    • To build cortx-manager with integration tests, run: $ sudo cicd/build.sh -i
    • To build cortx-manager with log level debug, run: $ sudo cicd/build.sh -q true

1.3 Deploy CORTX-Manager on Test VM

All the dependencies should be preinstalled and prerequisites met before you run the CORTX-Manager.

Follow these steps to deploy the CORTX-Manager on a Test VM

  1. SSH-Login to VM with GitHub ID and Password.

  2. Remove previously installed CORTX-Manager RPMs, if any:

    For pkg in

    $ rpm -qa | grep -E "cortx|salt"

    Run

    $ yum remove -y $pkg

  3. Install CORTX-Manager [RPM] using:

       $ yum install -i <rpm-created-by-dest-directory>

  4. Executing the cortx-manager setup commands should pass:

    $ cortx-manager_setup post_install
$ cortx-manager_setup config
$ cortx-manager_setup init

  5. Enable and Restart cortx-manager using:

    $ systemctl enable cortx_manager
$ systemctl restart cortx_manager

You're All Set & You're Awesome!

We thank you for stopping by to check out the CORTX Community. We are fully dedicated to our mission to build open source technologies that help the world save unlimited data and solve challenging data problems. Join our mission to help reinvent a data-driven world.

Contribute to CORTX Manager

Please contribute to the CORTX Open Source project and join our movement to make data storage better, efficient, and more accessible.

Refer to our CORTX Contribution Guide to get started with your first contribution.

Reach Out to Us

Please refer to the Support document to know the various communication channels for reaching out to us.