Installing CTERA Portal Instances

Prev Next

The following procedure is for CTERA Portal 8.3.3000.x. and not 8.3.3300.x

Use the following workflow to install CTERA Portal.

  1. Creating a Portal Instance using a CTERA Portal image obtainable from CTERA support.
  2. Configuring Network Settings.
  3. Optionally, if it is not set correctly, configure a default gateway.
  4. Additional Installation Instructions for Customers Without Internet Access.
  5. For the first server you install, follow the steps in Configuring the Primary Server.
  6. For any additional servers beside the primary server, install the server as described below and configure it as an additional server, as described in Installing and Configuring Additional CTERA Portal Servers.
  7. Make sure that you replicate the database, as described in Configuring the CTERA Portal Database for Backup.
  8. Backup the server as described in Backing Up the CTERA Portal Servers and Storage.
Note

You can use block-storage-level snapshots for backup, but snapshots are periodical in nature, configured to run every few hours. Therefore, you cannot recover the metadata to any point-in-time, and can lose a significant amount of data on failure. Also, many storage systems do not support block-level snapshots and replication, or do not do so efficiently.

Creating a Portal Instance

You can install the CTERA Portal on Red Hat OpenShift console. The installation requires the CTERA Portal qcow2 image, that you get from CTERA support and save to the client computer.

To install the CTERA Portal Server:

  1. Log in to the Red Hat OpenShift console.
    Image
    The Projects page is displayed.
  2. Click Virtualization > VirtualMachines in the navigation pane.
    Image
  3. Click Create > From template.
    Image
    The Create new VirtualMachine page is displayed.
    Image
  4. Click User templates.
    Image
  5. Click the VM from uploaded QCOW2 - UEFI + 1 disk option.
    The VM from uploaded QCOW2 - UEFI + 1 disk blade is displayed.
    Image
  6. For Disk source select Upload (Upload a new file to a PVC).
    Image
  7. Browse to the CTERA Portal qcow2 image file, Portal_Image_<version>.qcow2 where version is the CTERA Portal version and select it.
  8. Set the Disk size to 32 Gib.
  9. Click CPU | Memory and set 8 vCPUs and 32GiB memory.
    Image
  10. Click Saveand then click Optional parameters in the VM from uploaded QCOW2 - UEFI + 1 disk blade.
    Image
  11. Change the ROOTDISK_SIZE to 32Gi and the EXTRA1_SIZE to 1% of the expected global file system size or a minimum of 200Gi.
  12. Enter a name for the portal server in the VirtualMachine name field In the VM from uploaded QCOW2 - UEFI + 1 disk blade. The name must be only lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
  13. Click Customize VirtualMachine.
    The upload of the qcow2 image starts.
  14. When the upload finishes, click Create VirtualMachine.
    Image
    The virtual machine is created.
    Image
  15. Click the YAML tab.
    Image
  16. Add the following highlighted text under Interfaces.
    - bridge: {}
      model: virtio
      name: ctera-vlan
    
    Image
  17. Add the following highlighted text under networks:
    - multus:
        networkName: ctera-vlan
      name: ctera-vlan
    
    Image
  18. Click Save.
    Image
  19. Click Actions > Start.
    Image
    Note

    The VM contains two network interfaces:

    • eth0 has a fixed IP 10.0.2.2 (nat IP)
    • eth1 has an IP from the network, for example 192.168.x.x. This IP is bridged to a physical interface and routable.
  20. Click the Console tab or click the Overview tab and then Open web console.
    Note

    When opening the web console from the Overview tab, the console is displayed in a new brower tab.

  21. If necessary, click Connect.
    Image
  22. Log in as root using the default password ctera321.
  23. You are promptd to change the password.
    Image
  24. Navigate to /etc/ctera and open portal.cfg configuration file for editing.
    Note

    You can also edit portal.cfg directly from any directory by entering vi $portalcfg

    Image
  25. Add CTERA_DEFAULT_INTERFACE=eth1 to portal.cfg and save the file.
    Image
  26. Run the command portal.sh restart to restart the portal.
  27. To make sure that the script to create the data pool completed successfully, run docker images to check that the docker images are available, including zookeeper, which is the last docker to load to the data pool.
    Note

    If the script to create the data pool does not successfully run, it will start on every boot until it completes. The script has a timeout which means it will exit if the data pool is not created within the timeout after boot time. If the data pool is not created, dockers required by the portal are not loaded to the data pool.

    If all the dockers do not load you need to run the script /usr/bin/ctera_firstboot.sh

    Also, refer to Troubleshooting the Installation if the script does not complete successfully.

  28. Continue with Create the Archive Storage.
  29. You can assign a static IP, as described in configure network settings.
    Note

    The VM is assigned an IP you can use, which is displayed in the VM Overview under the Network panel for the network name set up by the Red Hat OpenShift administrator and added to the YAML, in this screenshot, the ctera-vlan network.
    Image

  30. Start CTERA Portal services, by running the following command: portal-manage.sh start
Note

Do not start the portal until both the sdconv and envoy dockers have been loaded to the data pool. You can check that these dockers have loaded in /var/log/ctera_firstboot.log or by running docker images

Create the Archive Storage

You need to create the archive pool on the primary database server and when PostgreSQL streaming replication is required, also on the secondary, replication database, server. See Using PostgreSQL Streaming Replication for details about PostgreSQL streaming replication.

To create the archive pool:

  1. Log in to the Red Hat OpenShift console.
  2. Click Virtualization > VirtualMachines in the navigation pane and select the CTERA Portal VM.
    The Overview panel for the VM is displayed.
    Image
  3. Scroll down to display the Storage panel.
    Image
  4. Click Storage (2).
    The Configuration > Disks panel is displayed.
    !Image
  5. Click Actions > Stop.
  6. Click Add disk.
    Image
  7. Select Empty disk (blank).
    Image
  8. Specify the Disk size.
    Note

    The minimum archive pool should be 200GB but it should be sized around 2% of the expected global file system size. For more details, see Requirements.

  9. Speify the StorageClass and click Save.
    Image
  10. Click Actions > Start.
  11. Click the Console tab or click the Overview tab and then Open web console.
    Note

    When opening the web console from the Overview tab, the console is displayed in a new brower tab.

  12. If necessary, click Connect.
    Image
  13. Log in as root using the default password ctera321.
  14. Run lsblk or fdisk -l to identify the disk to use for the data and archive pool.
  15. Run the following command to create the archive pool: portal-storage-util.sh create_db_archive_pool Device
    where Device is the device name of the disk to use for the archive pool.
    For example: portal-storage-util.sh create_db_archive_pool vdc
    Image
    This command creates both a logical volume and an LVM volume group using the specified device. Therefore, multiple devices can be specified if desired. For example: portal-storage-util.sh create_db_archive_pool vdc vdd vde

Troubleshooting the Installation

You can check on the progress of the docker loads in one of the following ways to ensure that all the dockers are loaded: The last docker to load is called zookeeper:

  • In /var/log/ctera_firstboot.log
  • By running docker images to check that the docker images are available.
  • By checking if /var/lib/ctera_firstboot_completed is present with the date and time when the installation was performed.

If all the dockers do not load you need to run the script /usr/bin/ctera_firstboot.sh