Skip to content

Latest commit

 

History

History
211 lines (124 loc) · 7.93 KB

CORTX_on_Open_Virtual_Appliance.rst

File metadata and controls

211 lines (124 loc) · 7.93 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.

Recommended Hypervisors

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

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. From our release page, download and then uncompress the cortx-va-1.0.1.zip file that 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 the following command.

    • 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. Start the CORTX services by running this bootstrap.sh script:

    sh /opt/seagate/cortx/provisioner/cli/virtual_appliance/bootstrap.sh
    
  7. Run the below mentioned commands 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
    hctl status
    systemctl status csm_agent
    systemctl status csm_web
    

    The below images 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 the below commands.

    /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 the below mentioned command.

    systemctl start|restart <service_name>
    
  8. By default, port 80 may be closed. Run the below mentioned command to open port 80.

    salt '*' cmd.run "firewall-cmd --zone=public-data-zone --add-port=80/tcp --permanent"
    
    salt '*' cmd.run "firewall-cmd --reload"
    
  9. Run ip a l and record the IP addresses of the following interfaces:

    • ens192 - management
    • ens256 - public data
    images/networks.png
    • If you do not see IP addresses like in the above image, you might need to change your virtual networking configuration for which these instructions are hopefully useful.
  10. 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
    
  11. Using the management IP from the ip a l command, refer to these instructions to configure the CORTX GUI.

  12. 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
  13. 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.

  14. 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.

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>

Restarting CORTX OVA

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

  • Shutdown CORTX
  • Restart CORTX

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. Start CORTX I/O subsystem by running the following command.
    • hctl start