Installing the Management System

To install Management System, Platform Packages dependencies must be installed prior.

Install the Management System Software

The management system consists of a set of containers that require the following environment variables to be set.

Required Environment Variables

HOST_IP

Check if the variable exists in /opt/rain-infra-services/.env; if the file or the variable is missing, set it to the Management System's public IP.

REDPANDA_CPUS

The maximum number of CPUs Redpanda is configured to (non-exclusively) use.

Default value: 32

Do not set this variable if:

• The server has more than the recommended default value

• The variable already exists in /opt/rain-infra-services/.env

Set this variable if the server has less than the recommended default value, the minimum number can be set is 8.

EDR_FLOW_PARTITIONS

The variable controls the number of partitions used for the edr-flow-network-intelligence and edr-flow-network-optimization topics when they are created.

Default value: 1

Set the value to 3 if the expected system throughput is greater than 160Gbps.

Applying a New Partition Value

If this variable has been changed or is missing from /opt/redpanda-connect-pipelines/conf/redpanda-connect-pipelines.local.env, follow the steps below to ensure the new value is applied correctly.

1. SSH into the MS server

2. cd /opt/redpanda-connect-pipelines/

3. sudo docker compose down

4. Log into the Redpanda console at https://{ms_ip}/redpanda-console.

• The credentials can be found by sudo cat /opt/rain-infra-services/conf/basic-auth.local.env

Click on Topics in the sidebar and delete the following topics:

• edr-flow-network-intelligence

• edr-flow-network-optimization

Optional Environment Variables

SMTP Variables

To configure SMTP, set the following environment variables:

SMTP_SERVER

This variable is required to connect to the Simple Mail Transfer Protocol (SMTP) server for sending notifications.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the desired SMTP server address.

SMTP_PORT

This variable is required to connect to the server to send notifications.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the desired SMTP server port.

SMTP_USERNAME

Do not set this variable if the server does not require authentication.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the required username for authentication.

SMTP_PASSWORD

Do not set this variable if the server does not require authentication.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the required password for the corresponding SMTP_USERNAME.

SMTP_FROM_EMAIL

The sender's email address is required to send notifications.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the required sender email address.

SMTP_TO_EMAIL

The recipient's email address is required to send notifications.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the required recipient email address.

SMTP_USE_TLS

Specifies whether Transport Layer Security (TLS) is enabled for the connection. Values are true or false.

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to either true or false based on the TLS configuration of the SMTP server.

SNMP Variables

To configure SNMP, set the following environment variables:

SNMP_HOST

This variable is required to specify the address for the Simple Network Management Protocol (SNMP) server used for sending notifications.

The format is IP/port. For example, 0.0.0.0/1161

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the desired SNMP server address.

SNMP_TARGET_IP

This variable is required to specify the target IP address for the Simple Network Management Protocol (SNMP) server used for sending notifications.

The format is IP. For example, 127.0.0.1

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the desired SNMP target IP address.

SNMP_TARGET_HOST

This variable is required to specify the target address for the Simple Network Management Protocol (SNMP) server used for sending notifications.

The format is IP/port. For example, 127.0.0.1/164

Check for the variable in /opt/rain-infra-services/conf/alert-settings.local.env. If the file is missing or the variable is not defined, set the variable to the desired SNMP target address.

Deploy containers

Execute the following commands to set up the management server API service and Web Application:

export HOST_IP={Management System public IP}
export FLOW_NETWORK_INTELLIGENCE_ENABLED={optional for MinIO storage}
export REDPANDA_CPUS={optional, set to number of available CPU cores if fewer than 32}
export EDR_FLOW_PARTITIONS={optional, dependent on throughput}
export SMTP_SERVER={IP of the SMTP server}
export SMTP_PORT={Port to the SMTP}
export SMTP_USERNAME={optional if no authentication required}
export SMTP_PASSWORD={optional if no authentication required}
export SMTP_FROM_EMAIL={The email of the sender}
export SMTP_TO_EMAIL={The email of the receiver}
export SMTP_USE_TLS={TLS is enabled or not}
export SNMP_HOST={IP/port for SNMP server}
export SNMP_TARGET_IP={IP for SNMP target}
export SNMP_TARGET_HOST={IP/port for SNMP target}
sudo -E rpm -Uvh rain-infra-services-{VERSION}.x86_64.rpm
sudo rpm -Uvh data-management-configuration-{VERSION}.x86_64.rpm
sudo rpm -Uvh minio-client-{VERSION}.x86_64.rpm
sudo -E rpm -Uvh redpanda-connect-pipelines-{VERSION}.x86_64.rpm
sudo rpm -Uvh opanga-services-{VERSION}.x86_64.rpm
sudo rpm -Uvh rain-ms-{VERSION}.x86_64.rpm

Validate the Health of Management System Services

Ensure that all service containers’ statuses are healthy by running the following commands:

sudo docker compose -f /opt/rain-infra-services/docker-compose.yml ps
sudo docker compose -f /opt/redpanda-connect-pipelines/docker-compose.yml ps
sudo docker compose -f /opt/opanga-services/docker-compose.yml ps
sudo docker compose -f /opt/rain-ms/docker-compose.yml ps

Ensure that all logs don't contain any warning or errors:

sudo docker compose -f /opt/rain-infra-services/docker-compose.yml logs -n 100 -f
sudo docker compose -f /opt/rain-infra-services/docker-compose.yml logs elasticsearch -n 100 -f
sudo docker compose -f /opt/rain-infra-services/docker-compose.yml logs postgres -n 100 -f
sudo docker compose -f /opt/minio-client/docker-compose.yml logs -n 100 -f
sudo docker compose -f /opt/redpanda-connect-pipelines/docker-compose.yml logs -t -n 100 -f
sudo docker compose -f /opt/opanga-services/docker-compose.yml logs -t -n 100 -f
sudo docker compose -f /opt/rain-ms/docker-compose.yml logs -n 100 -f

Validate Redpanda Topic Partitions

To validate the number of partitions for the topics are set properly:

Log into the Redpanda console at https://{ms_ip}/redpanda-console.

Credentials found by:

sudo cat /opt/rain-infra-services/conf/basic-auth.local.env

From the Redpanda console home page, navigate to the Topics tab in the sidebar. Next you can select the row, corresponding to the topic you're checking, and navigate to the Partitions tab in the topic's menu.

Each row in the topic partitions tab corresponds to a single partition. The number of rows for the following topics should be configured according to what was exported for the variables set on installation:

Repeat this process to validate partition count for each of the topics in the table above.

Access Management System Web Application

The management system Web UI can be accessed through Firefox or Chrome by entering https://{Management Server Hostname or IP Address}.

Uploading License Files

NOTE: If this is an upgrade from a previous version, skip this entire section. Proceed directly to the next installation phase.

To activate the software you must upload the generated license archive to the management system UI.

Log into the management system with an account of Superadmin status (provided by Cisco). Upon logging in, you will be directed to a page that has an option to upload the license archive.