Installing OIA (Operations Intelligence & Analytics)
This document provides instructions about fresh Installation & Upgrades for OIA application (Operations Intelligence & Analytics, a.k.a AIOps). It is an application that is installed on top of RDA Fabric platform.
1. Setup & Install
Pre-requisites:
Below are the pre-requisites which need to be in place before installing the OIA (AIOps) application services.
RDAF Deployment CLI Version: 1.4.0
RDAF Infrastructure Services Tag Version: 1.0.3 / 1.0.3.3 (haproxy)
RDAF Core Platform & Worker Services Tag Version: 8.0.0
RDAF Client (RDAC) Tag Version: 8.0.0
Warning
Please complete all of the above pre-requisites before installing the OIA (AIOps) application services.
Login as rdauser user into on-premise docker registry or RDA Fabric Platform VM on which RDAF deployment CLI was installed (ex: putty)
Run the below rdaf
or rdafk8s
command, to make sure all of the RDAF infrastructure services are up and running.
Run the below rdac pods
command, to make sure all of the RDAF core platform and worker services are up and running.
+-------+----------------------------------------+----------------+----------+-------------+----------+--------+--------------+---------------+--------------+
| Cat | Pod-Type | Host | ID | Site | Age | CPUs | Memory(GB) | Active Jobs | Total Jobs |
|-------+----------------------------------------+----------------+----------+-------------+----------+--------+--------------+---------------+--------------|
| App | asset-dependency | rda-asset-depe | 090669bf | | 20:18:21 | 8 | 47.03 | | |
| App | authenticator | rda-identity-5 | 57905b20 | | 20:19:11 | 8 | 47.03 | | |
| App | cfxdimensions-app-access-manager | rda-access-man | 6338ad29 | | 20:18:44 | 8 | 47.03 | | |
| App | cfxdimensions-app-notification-service | rda-notificati | bb9e3e7b | | 20:09:52 | 8 | 31.33 | | |
| App | cfxdimensions-app-resource-manager | rda-resource-m | e5a28e16 | | 20:18:34 | 8 | 47.03 | | |
| App | user-preferences | rda-user-prefe | fd09d3ba | | 20:18:08 | 8 | 47.03 | | |
| Infra | api-server | rda-api-server | b1b910d9 | | 20:19:22 | 8 | 47.03 | | |
| Infra | collector | rda-collector- | 99553e51 | | 20:18:17 | 8 | 47.03 | | |
| Infra | registry | rda-registry-7 | a46cd712 | | 20:19:15 | 8 | 47.03 | | |
| Infra | scheduler | rda-scheduler- | d5537051 | *leader* | 20:18:26 | 8 | 47.03 | | |
| Infra | worker | rda-worker-54d | 1f769792 | rda-site-01 | 20:06:48 | 4 | 15.6 | 0 | 0 |
+-------+----------------------------------------+----------------+----------+-------------+----------+--------+--------------+---------------+--------------+
Run the below rdac healthcheck
command to check the health status of all of the RDAF core platform and worker services.
All of the dependency checks should show as ok under Status column.
+-----------+----------------------------------------+--------------+----------+-------------+-----------------------------------------------------+----------+-------------------------------------------------------+
| Cat | Pod-Type | Host | ID | Site | Health Parameter | Status | Message |
|-----------+----------------------------------------+--------------+----------+-------------+-----------------------------------------------------+----------+-------------------------------------------------------|
| rda_infra | api-server | rda-api-serv | b1b910d9 | | service-status | ok | |
| rda_infra | api-server | rda-api-serv | b1b910d9 | | minio-connectivity | ok | |
| rda_app | asset-dependency | rda-asset-de | 090669bf | | service-status | ok | |
| rda_app | asset-dependency | rda-asset-de | 090669bf | | minio-connectivity | ok | |
| rda_app | authenticator | rda-identity | 57905b20 | | service-status | ok | |
| rda_app | authenticator | rda-identity | 57905b20 | | minio-connectivity | ok | |
| rda_app | authenticator | rda-identity | 57905b20 | | DB-connectivity | ok | |
| rda_app | cfxdimensions-app-access-manager | rda-access-m | 6338ad29 | | service-status | ok | |
| rda_app | cfxdimensions-app-access-manager | rda-access-m | 6338ad29 | | minio-connectivity | ok | |
| rda_app | cfxdimensions-app-access-manager | rda-access-m | 6338ad29 | | service-dependency:registry | ok | 1 pod(s) found for registry |
| rda_app | cfxdimensions-app-access-manager | rda-access-m | 6338ad29 | | service-initialization-status | ok | |
| rda_app | cfxdimensions-app-access-manager | rda-access-m | 6338ad29 | | DB-connectivity | ok | |
| rda_app | cfxdimensions-app-notification-service | rda-notifica | bb9e3e7b | | service-status | ok | |
| rda_app | cfxdimensions-app-notification-service | rda-notifica | bb9e3e7b | | minio-connectivity | ok | |
| rda_app | cfxdimensions-app-notification-service | rda-notifica | bb9e3e7b | | service-initialization-status | ok | |
| rda_app | cfxdimensions-app-notification-service | rda-notifica | bb9e3e7b | | DB-connectivity | ok | |
| rda_app | cfxdimensions-app-resource-manager | rda-resource | e5a28e16 | | service-status | ok | |
| rda_app | cfxdimensions-app-resource-manager | rda-resource | e5a28e16 | | minio-connectivity | ok | |
| rda_app | cfxdimensions-app-resource-manager | rda-resource | e5a28e16 | | service-dependency:registry | ok | 1 pod(s) found for registry |
| rda_app | cfxdimensions-app-resource-manager | rda-resource | e5a28e16 | | service-dependency:cfxdimensions-app-access-manager | ok | 1 pod(s) found for cfxdimensions-app-access-manager |
| rda_app | cfxdimensions-app-resource-manager | rda-resource | e5a28e16 | | service-initialization-status | ok | |
| rda_app | cfxdimensions-app-resource-manager | rda-resource | e5a28e16 | | DB-connectivity | ok | |
| rda_infra | collector | rda-collecto | 99553e51 | | service-status | ok | |
| rda_infra | collector | rda-collecto | 99553e51 | | minio-connectivity | ok | |
| rda_infra | collector | rda-collecto | 99553e51 | | opensearch-connectivity:default | ok | |
| rda_infra | registry | rda-registry | a46cd712 | | service-status | ok | |
| rda_infra | registry | rda-registry | a46cd712 | | minio-connectivity | ok | |
| rda_infra | scheduler | rda-schedule | d5537051 | | service-status | ok | |
| rda_infra | scheduler | rda-schedule | d5537051 | | minio-connectivity | ok | |
| rda_infra | scheduler | rda-schedule | d5537051 | | DB-connectivity | ok | |
| rda_app | user-preferences | rda-user-pre | fd09d3ba | | service-status | ok | |
| rda_app | user-preferences | rda-user-pre | fd09d3ba | | minio-connectivity | ok | |
| rda_app | user-preferences | rda-user-pre | fd09d3ba | | service-dependency:registry | ok | 1 pod(s) found for registry |
| rda_app | user-preferences | rda-user-pre | fd09d3ba | | service-initialization-status | ok | |
| rda_app | user-preferences | rda-user-pre | fd09d3ba | | DB-connectivity | ok | |
| rda_infra | worker | rda-worker-5 | 1f769792 | rda-site-01 | service-status | ok | |
| rda_infra | worker | rda-worker-5 | 1f769792 | rda-site-01 | minio-connectivity | ok | |
+-----------+----------------------------------------+--------------+----------+-------------+-----------------------------------------------------+----------+-------------------------------------------------------+
Installing OIA (AIOps) Application Services:
Tip
If the user is not installing any App (OIA/AIA), please run the below command, Incase the user needs to install App (OIA/AIA) please use aiops
for OIA and asset
for AIA inplace of rda
Set RDA Fabric platform's application configuration as rda
using the below command.
Note
Other supported options for above command are below:
-
rda
: Choose this option when only RDA Fabric platform need to be installed along with RDA Worker and RDA Event Gateway services without AIOps (OIA) or Asset Intelligence (AIA) applications. -
aiops
: Choose this option when Operations Intelligence (OIA, a.k.a AIOps) application need to be installed. -
asset
: Choose this option when Asset Intelligence (AIA) application need to be installed. (Note: AIA application type is deprecated and all of it's capabilities are available through base RDA Fabric platform itself. For more information, please contact cfx-support@cloudfabric.com) -
all
: Choose this option, when all of the supported applications need to be installed.
Configure OIA Services For Specific Deployment Requirements
Please review the values specified in the /opt/rdaf/deployment-scripts/values.yaml
file on the CLI VM under the relevant service section. Adjust the configuration based on the allocated memory limits (mem_limit) and the system's desired throughput requirements.
- alert_ingester / cfx-rda-alert-ingester
Environment Variable |
Description | Default Value |
---|---|---|
INBOUND_PARTITION_WORKERS_MAX |
Specifies the maximum number of worker processes used for mapping inbound events received by OIA | 1 |
OUTBOUND_TOPIC_WORKERS_MAX |
Specifies the maximum number of worker processes for mapping outbound requests to external systems | 3 |
Note
Memory Considerations for Inbound Worker Processes
-
Each inbound worker consumes approximately 700–800 MB of memory.
- this estimation is based on inbound mapping rules that typically use one or a few datasets, each around 10–20 MB in size.
-
An inbound worker is created for each partition assigned to a service instance.
-
Event sources can be assigned to partitions either:
- manually check the reference guide, or
- automatically by the system.
-
Based on the number of active sources and the partitions assigned to an instance, one or more worker processes are launched in the service container.
-
Therefore, the number of workers to configure should be calculated based on:
- the available memory allocated to the service container, and
- the number of partitions assigned to the instance.
Run the below command to deploy RDAF OIA (AIOps) application services. (Note: Below shown tag name is a sample one for a reference only, for actual tag, please contact CloudFabrix support team at support@cloudfabrix.com)
After installing the OIA (AIOps) application services, run the below command to see the running status of the deployed application services.
+--------------------+----------------+-------------------+--------------+---------+
| Name | Host | Status | Container Id | Tag |
+--------------------+----------------+-------------------+--------------+---------+
| rda-alert-ingester | 192.168.131.47 | Up 54 Minutes ago | 4c38f1f1ab76 | 8.0.0 |
| rda-alert-ingester | 192.168.131.49 | Up 49 Minutes ago | 2c55eda2dd7a | 8.0.0 |
| rda-alert- | 192.168.131.49 | Up 44 Minutes ago | 8319c5927e29 | 8.0.0 |
| processor | | | |
| rda-alert- | 192.168.131.50 | Up 54 Minutes ago | e99d07f8bcd6 | 8.0.0 |
| processor | | | |
| rda-alert- | 192.168.131.47 | Up 54 Minutes ago | d16d8fae566c | 8.0.0 |
| processor- | | | |
| companion | | | |
| rda-alert- | 192.168.131.49 | Up 48 Minutes ago | 16f12b91060d | 8.0.0 |
| processor- | | | |
| companion | | | |
| rda-app-controller | 192.168.131.47 | Up 54 Minutes ago | 658a64049e35 | 8.0.0 |
| rda-app-controller | 192.168.131.46 | Up 54 Minutes ago | 1c27230025a1 | 8.0.0 |
| rda-collaboration | 192.168.131.49 | Up 43 Minutes ago | 32ea58ca8e39 | 8.0.0 |
| rda-collaboration | 192.168.131.50 | Up 53 Minutes ago | 67a5e5ef8c1d | 8.0.0 |
| rda-configuration- | 192.168.131.46 | Up 54 Minutes ago | af292efd663c | 8.0.0 |
| service | | | |
| rda-configuration- | 192.168.131.49 | Up 51 Minutes ago | 7b23b8f033a6 | 8.0.0 |
| service | | | |
+--------------------+----------------+-------------------+--------------+---------+
+--------------------+------------ --+------------+---------------+--------+
| Name | Host | Status | Container Id | Tag |
+--------------------+------------ --+------------+---------------+--------+
| cfx-rda-app- | 192.168.133.96 | Up 10 hours | e0a3b011092b | 8.0.0 |
| controller | | | | |
| cfx-rda-app- | 192.168.133.92 | Up 10 hours | dd729df4567f | 8.0.0 |
| controller | | | | |
| cfx-rda-reports- | 192.168.133.96 | Up 10 hours | d62ddb342bc2 | 8.0.0 |
| registry | | | | |
| cfx-rda-reports- | 192.168.133.92 | Up 10 hours | 4b30336152fe | 8.0.0 |
| registry | | | | |
| cfx-rda- | 192.168.133.96 | Up 10 hours | 6f2a8c2ff9fa | 8.0.0 |
| notification- | | | | |
| service | | | | |
| cfx-rda- | 192.168.133.92 | Up 10 hours | 4fbfe27f8006 | 8.0.0 |
| notification- | | | | |
| service | | | | |
| cfx-rda-file- | 192.168.133.96 | Up 10 hours | bd41100a456c | 8.0.0 |
| browser | | | | |
| cfx-rda-file- | 192.168.133.92 | Up 10 hours | e420ec5ee26c | 8.0.0 |
| browser | | | | |
| cfx-rda- | 192.168.133.96 | Up 10 hours | 8b4615d2c2e9 | 8.0.0 |
| configuration- | | | | |
| service | | | | |
| cfx-rda- | 192.168.133.92 | Up 10 hours | 4d2d749ec170 | 8.0.0 |
| configuration- | | | | |
| service | | | | |
| cfx-rda-alert- | 192.168.133.96 | Up 10 hours | 595524b429c3 | 8.0.0 |
| ingester | | | | |
| cfx-rda-alert- | 192.168.133.92 | Up 10 hours | 2a3a686a9355 | 8.0.0 |
| ingester | | | | |
+--------------------+----------------+-------------+--------------+--------+
2. Upgrades
Please refer to the following documents for guidance on upgrading the OIA (AIOps) application services to the newer version.