Skip to main content

Online Installation

This topic explains how to install iceDQ in an online environment.


Before you start

Please ensure that all prerequisites have been met before starting the installation and the servers can access to the internet. See the Embedded Cluster Install Requirements.


Preparation

Please log on to your linux machine or VM on which you would like to install the application and follow below steps.

Install Required Packages

Install below packages based on your OS distribution.

For APT based distribution

sudo apt install nfs-common -y

For YUM based distribution

sudo yum install nfs-utils –y

Create Installation Directory

  1. Create an installation directory on the VM
  2. Change to the newly created directory before downloading the installer
mkdir icedq-installation
cd icedq-installation/

Installation

Important

Please reach out your sales or customer success contact to get access to your download portal. You can get the auth code from your download portal, it is different for every customer.

Below is the screenshot of what the download portal looks like.

embedded-curl-auth-code.png

Download Installer

  1. Log into Download Portal
  2. Copy Download the installation assets command
  3. Copy Extract the installation assets command

It should look something like below.

curl -f "https://resource.icedq.com/embedded/icedq/stable" -H "Authorization: <auth code>" -o icedq-stable.tgz 
tar -xvzf icedq-stable.tgz

Note: The extraction will create an icedq folder and license.yaml file in the installation directory.

embedded-untar.png

Run Installer

After the extraction, run the following commands in the installation directory to start the process. Replace <desired-password> and note it as it would be required for console login.

sudo ./icedq install --license license.yaml --admin-console-password <desired-password>

Upon successful installation of the admin console you will see an Admin Console Web URL. Please copy it for the next steps. For reference see the screenshot below.

embedded-admin-console-url.png

Secure the Installer (Admin Console)

In this step, you can either provide your own TLS certificates to enable SSL for the admin console application or use the self-signed certificates we provide.

  1. Open the Admin Console Web URL in a browser
  2. Click on Start
  3. Click on Continue
  4. Click on Advance
  5. Click on Continue to ...
  6. Choose if you would like to use Self Signed or Upload your own certificate
  7. Click Continue

embedded-secure-installer.png

Cluster Configuration

  1. Input the admin console password & Click Login
  2. Optional: Click Copy Command to save it for future use if you plan to perform a multi-node cluster installation. You may skip this step if you're setting up a single-node installation.
  3. Click Continue

embedded-cluster-config.png

Application Configuration (iceDQ)

  1. Choose Ingress Controller as Embedded
  2. Enable Expose the application to NodePort Checkbox (Keep the default value 32222)
  3. Input Hostname (This can be the IP address of the node or DNS)
  4. Copy the iceDQ application URL
  5. Input Username for the super admin of the application
  6. Input Password for the super admin of the application
  7. Choose Deployment Type as Embedded for Metadata Repository
  8. Choose Deployment Type as Embedded for Messaging Queue
  9. Choose Deployment Type as Embedded for Storage
  10. Choose Deployment Type as Embedded for Vault
  11. Click Continue

embedded-app-config.png

Deploy Application

  1. Ensure all preflight checks are a success
  2. If successful, Click Deploy
  3. Monitor deployment status of all services/ pods by clicking on Detail
  4. Once all the services are successfully deployed verify status is Ready
important

It may take 10–15 minutes for all services to deploy and for the application status to transition from Unavailable to Ready.

embedded-deploy-app.png


Access the Application

  1. Open the Application URL in a browser (Copied in Step 4 of Application Configuration)
  2. Input Username and Password of the supper admin.
  3. Click Sign In

embedded-app-login.png


Adding Nodes

The above installation supports a single-node setup. If you wish to expand your deployment for load balancing, high availability, scalability, or other purposes, please follow the steps outlined below.

To begin, log in to the Linux machine or virtual machine (VM) that you intend to add as a new node to the cluster, and then proceed with the following instructions.

  1. Repeat the Install Required Packages step on the node
  2. Repeat the Create Installation Directory step on the node
  3. Repeat the Download Installer step on the node
  4. Log into the Admin Console
  5. Go to Cluster Management tab
  6. Click on Add node
  7. Click Copy command
  8. Run the Join command on the node
  9. Go to Cluster Management tab in Admin Console to verify that node has been added
important

Pods/ Services will be redistributed across the nodes automatically

embedded-add-node.png