Installing CTERA Portal Instances

Prev Next

Use the following workflow to install CTERA Portal.

  1. Creating a Portal Instance.
  2. Optionally, configure a default gateway.
  3. For the first server you install, follow the steps in Configuring the Primary Server.
  4. 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.
  5. Make sure that you replicate the database, as described in Configuring the CTERA Portal Database for Backup.
  6. Backup the server as described in Backing Up the CTERA Portal Servers and Storage.

Creating a Portal Instance

The CTERA Portal instance is created using the Microsoft Azure Marketplace.

Note

To install a CTERA Portal in Azure not using the Azure Marketplace version, see Install a CTERA Portal in Azure Not Using the Azure Marketplace Version.

To create the CTERA Portal in Azure:

  1. Log in to your Azure portal and access Marketplace.
  2. Search for ctera
    The CTERA product offerings are displayed.
    image.png
  3. Click Create for the CTERA Portal product and then click CTERA Portal in the popup.
    The Create a virtual machine window is displayed.
    image.png
  4. Enter the following in the Basics tab for the virtual machine.
    Virtual machine name – A name to uniquely identify the virtual machine.
  5. Optionally, enter the following:
    Resource group – The resource group to be used. The resource group must use premium storage. If you do not enter a resource group, one is automatically created.
    Region – The region to host the virtual machine.
    CTERA recommends leaving the other values with their defaults.
  6. Click the Disks tab, or click Next: Disks.
    image.png
  7. Under Data disks, click Create and attach a new disk.
    The Create a new disk window is displayed.
    image.png
  8. If you need to change the amount of storage from the default, 1024 GiB, click Change size and enter the size of the disk in the Custom disk size (GiB) field. CTERA recommends storage of at least 1% of the Portal Global Name Space.
  9. Click OK.
  10. Click OK.
  11. Set Host caching to None. Setting it to Read/write can cause issues during periods of heavy writes, mainly during portal upgrades.
    image.png
  12. Click the Review + Create tab, or click Review + Create.
    Note

    This procedure uses the defaults set by CTERA. Configuration details, such as network requirements, can be changed as required.

  13. Review the virtual machine details and after the virtual machine details have been validated, click Create.
    image.png
  14. Download the private key and create the resource and then click Return to create a virtual machine.
    The machine starts to be deployed.
    image.png
    Deploying the machine can take a few minutes.
    image.png
    The machine is started automatically. When the server first starts up, a data pool is automatically created from the disk you added.
  15. Click Go to resource to display the portal details.
    image.png
    Note

    The warning that the virtual machine agent status is a Microsoft Azure warning that can be ignored.

    The virtual machine includes the OS disk and the added data disks, which are used for the portal data.
  16. Note the Public IP address.
    This is the IP address that you'll use to access and set up the portal primary server, described in Configuring the Primary Server, and additional servers described in Installing and Configuring Additional CTERA Portal Servers.
  17. For the primary database server and secondary, replication, server, wait a few minutes for ctera_firstboot.sh to create the data pool and then in the navigation pane click Settings > Disks.
    image.png
  18. Click Create and attach a new disk.
    image.png
  19. Enter a name for the disk, such as archive-disk and enter the size of the disk. Change the Storage type to a Standard HDD and Host caching to None and other values for this disk as required.
    Note

    The minimum archive pool should be 200GB but it should be sized around 2% of the expected global file system size or twice the size of the data pool.


    Setting Host caching to Read/write can cause issues during periods of heavy writes, mainly during portal upgrades.

  20. Click Apply.
  21. Log in as root, using SSH or through the console (Help > Serial console).
    The default password is ctera321
    You are prompted to change the password on your first login.
    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.


    To make sure that the script completed successfully, before continuing, run docker images to check that the docker images are available, including zookeeper, which is the last docker to load 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.

  22. For the primary database server and the secondary, replication database server, continue with Creating the Archive Pool.
  23. Upgrade the portal server image and software to include the latest patch releases, as described in Upgrading the Portal Image and Software.
Note

Before changing the IP address for the portal server instance you must wait until all the portal services, such as Nomad and Consul, have loaded. Loading the portal services take at least 5 minutes.

If you changed the IP address after the installation but before the full deployment of portal services like Nomad and Consul, run portal-manage.sh resetdb before initializing the portal or joining it to an existing portal cluster.

Create the Archive Storage

You need to create an 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 as root, using SSH or through the console.
  2. Run lsblk or fdisk -l to identify the disks to use for the archive pool.
  3. 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 sdd
    This command creates both a logical volume and an LVM volume group using the specified device. Therefore, multiple disks can be specified if desired. For example: `portal-storage-util.sh create_db_archive_pool sdd sde sdf'

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

Note

Microsoft Defender reports issues when deploying a portal in Azure.