Skip to content

Latest commit

 

History

History
349 lines (210 loc) · 14.1 KB

CORTX_on_Open_Virtual_Appliance.rst

File metadata and controls

349 lines (210 loc) · 14.1 KB

CORTX on Open Virtual Appliance

An Open Virtual Appliance (OVA) is a Virtual Machine (VM) image that consists of a pre-installed and pre-configured operating system as well as one or more applications packaged for easy deployment and testing. This document describes how to use a CORTX OVA for the purposes of single-node CORTX testing. The minimum recommended system should have at least 4 CPU cores, at least 8 GB of RAM, and at least 120 GB of local storage. Current version of the OVA requires DHCP server to assign IPs to all 3 network interfaces. For our Japanese community, this document has been translated and is available here.

Recommended Hypervisors

All of the following hypervisors should work: VMware ESX Server, VMware vSphere, VMware Fusion, VMware Workstation, and Oracle VM VirtualBox.

Important: If you are running the VM in any of the VMWare hypervisors, it is not recommended to use VMware Tools, as CORTX may break due to kernel dependencies. For the same reason, please do not update the operating system in the image as that also might cause it to fail.

Procedure

The procedure to install CORTX on OVA is mentioned below.

  1. Download the cortx-va-1.0.3.ova file from our release page. This contains the virtual machine image.

  2. Import the OVA image by referring to these instructions.

    • For VMware related troubleshooting, please refer to VM Documents.

  3. Open the VM console, and login with the below credentials.

    • Username: cortx
    • Password: opensource!

  4. Become the root user by running this:

    sudo su -

  5. Change the hostname by running the following command:

    • hostnamectl set-hostname --static --transient --pretty <new-name>

      If you receive Access denied message, remove immutable settings on the /etc/hostname file and run the command again. To remove immutable setting from /etc/hostname, run the following command.

      • chattr -i /etc/hostname

      To verify the change in hostname, run the following command:

      • hostnamectl status

    Note: Both short hostnames and FQDNs are accepted. If you do not have a DNS server with which to register the VM, you can access it directly using its IP addresses. However, the hostname is mandatory and should be configured.

  6. For Oracle VM VirtualBox Users ONLY:

    Expand

    You need to change the Network Device Name from enp0s3, enp0s8, enp0s9 to ens32, ens33 and ens34:

    1. Use the following command to get your Network Device MAC address (Shown after link/ether)

      • ip a l

    2. Record the MAC addresses and go to the following directory:

      • cd /etc/sysconfig/network_scripts/
      • vi ifcfg-ens32
      • Add a new line under BOOTPROTO=dhcp
      • Add a new parameter with the MAC Address HWADDR=<MAC-Address>
      • Repeat the steps for enp0s8 and enp0s9 respectively
      • vi ifcfg-ens33
      • vi ifcfg-ens34

      Sample output cat ifcfg-ens34:

      DEVICE="ens34"
USERCTL="no"
TYPE="Ethernet"
BOOTPROTO="dhcp"
HWADDR=08:00:27:25:65:74
ONBOOT="yes"
PREFIX="24"
PREDNS="no"
DEFROUTE="no"
NM_CONTROLLED="no"
ZONE=trusted

    3. Poweroff the machine by using Poweroff command and start again.

    4. To verify the change in Network Device Name, run the following command:

      • ip a l

    5. The Date/Time would sometimes be incorrect as it uses local time as UTC

      • date

      If the time displayed is incorrect, use the following command to list and change your timezone accordingly, then change your date/time as necessary (Otherwise, you might face SSL certificate problems later)

      • timedatectl list-timezones
      • timedatectl set-timezone Asia/Kuala_Lumpur
      • date +%Y%m%d -s "20201231"
      • date +%T -s "11:14:00"

  7. Start the CORTX services by running this bootstrap.sh script:

    sh /opt/seagate/cortx/provisioner/cli/virtual_appliance/bootstrap.sh

    Run the bootstrap script to ensure all the necessary services are operational.

  8. Before you begin:

    • Ensure that you have configured your ipv4 network.
      • If you do not see an ipv4 network configured, you might need to change your virtual networking configuration using these instructions.
    • From the Virtual Network Editor dialog, ensure you uncheck Automatic Settings and select the correct VMNet connection and NIC.
      • Once you select an NIC, ensure that you do not have conflicting NICs selected.

  9. Check the health of CORTX using hctl by running this command

    hctl status

    The output should be similar to the image below

    images/hctl_status_output.png

  10. Run the commands below to check the status of different services that are part of CORTX.

    systemctl status rabbitmq-server
systemctl status elasticsearch
systemctl status haproxy
systemctl status s3authserver
systemctl status sspl-ll
systemctl status csm_agent
systemctl status csm_web
systemctl status hare-consul-agent

    The image below shows the output of a successful systemctl command; notice how the service is active.

    images/systemctl_output.png

    If the SSPL service is inactive, run these command.

    /opt/seagate/cortx/sspl/bin/sspl_setup post_install -p SINGLE

/opt/seagate/cortx/sspl/bin/sspl_setup config -f

systemctl start sspl-ll

    If any other service is inactive, run this command.

    systemctl start|restart <service_name>

  11. Run ip a l and record the IP addresses of the following interfaces:

    • ens32 - Management IP
    • ens33 - Public data IP
    • ens34 - Private data IP (if present)
    images/networks.png

  12. At this point, CORTX should be running on your system. Confirm this by running the S3 sanity test using the script mentioned below.

    sh /opt/seagate/cortx/s3/scripts/s3-sanity-test.sh -e 127.0.0.1

    • The script performs several operations on S3 API and LDAP backend:
      • create account
      • create user
      • create bucket
      • put object
      • delete all the above in reverse order

    If s3client(s) is / are deployed in separate VMs, then the below entry must be updated in s3client /etc/hosts file as follows:

    • <<Data IP>> s3.seagate.com sts.seagate.com iam.seagate.com sts.cloud.seagate.com

  13. Using the management IP from the ip a l command, refer to these instructions to configure the CORTX GUI.

  14. Now that you have the complete system up and running, using the data IP from the ip a l command, use these instructions to test the system and observe activity in the GUI. For example, the below picture shows a CORTX dashboard after a user did an S3 put followed by an S3 get.

    images/dashboard_read_write.png

  15. Please use these instructions which describe how to use the command line interface to query and monitor the configuration, health, and activity of your CORTX system.

  16. BOOM. You're all done and you're AWESOME. Thanks for checking out the CORTX system; we hope you liked it. Hopefully you'll stick around and participate in our community and help make it even better.

Note: The Lyve Pilot (LP) will be available in the future releases.

Miscellaneous

If you have a firewall between CORTX and the rest of your infrastructure, including but not limited to S3 clients, web browser, and so on, ensure that the ports mentioned below are open to provide access to CORTX.

Port number Protocols Destination network on CORTX
22 TCP Management network
53 TCP/UDP Management network and Public Data network
123 TCP/UDP Management network
443 HTTPS Public Data network
9443 HTTPS Public Data network
28100 TCP (HTTPS) Management network

If your disk does not have space, run the following command to clean up the logs from the /var/log file.

rm /var/log/<file to be deleted>

This step is applicable only if the earlier s3 sanity fails. Run the below mentioned script to delete the account and objects that were created as part of the earlier sanity.

sh /opt/seagate/cortx/s3/scripts/s3-sanity-test.sh -c

Restarting CORTX OVA

To restart the CORTX OVA, follow the below mentioned procedures, in the order of listing.

  • Shutdown CORTX
  • Restart CORTX

Note: If the virtual machine (VM) is forcefully shutdown then some of the services will be impacted as well as the cluster might not start so you have to run the bootstrap script again to avoid importing the OVA image again.

Shutdown CORTX

Click here to view the procedure.
  1. Stop all S3 I/O traffic from S3 clients to VA.
  2. Login to the CORTX Virtual Appliance as cortx and run the following.
    • sudo su -
  3. Stop CORTX I/O subsystem by running the following command.
    • hctl shutdown
  4. After executing the previous command, shutdown the OVA by running the following command.
    • poweroff

Restart CORTX

Click here to view the procedure.

  1. Power on the Virtual Appliance VM.

  2. Login to the CORTX OVA as cortx and run the following.

    • sudo su -

  3. Restart openldap and s3 auth server services by the below mentioned commands.

    $ systemctl restart slapd

$ systemctl restart s3authserver

  4. Start CORTX I/O subsystem by running the following command.

    • hctl start

Tested by: