160 lines
7.0 KiB
Markdown
160 lines
7.0 KiB
Markdown
# Aviator-widget-on-boarding-tasks-for-OpsB_686073595
|
|
## Introduction
|
|
|
|
This documents provides a sequence of tasks required for Aviator widget on-boarding on OpsB as a reference for operations team. Follow the tasks one by one.
|
|
|
|
**Assumptions**
|
|
|
|
- The ESM SMAX tenant and ITOM Aviator services mentioned in this document refer to ITOM ESM Cloud Offering and ITOM Aviator Cloud Offering.
|
|
- The ITOM Aviator service mentioned in this document serves OpsB Cloud Offering and OpsB On-Premise.
|
|
- ITOM Cloud Service Team: ESM/ITOM Aviator Cloud Service, OpsB Cloud Service;
|
|
- The ESM tenant admin user is created for OpsB customer who own the OpsB instance;
|
|
- The OpsB instance admin is the OpsB customer admin user;
|
|
|
|
###### Training
|
|
|
|
[KT\_ How to configure ITOM Aviator Widget for OpsB-20240521\_093308-Meeting Recording.mp4](https://opentextcorporation.sharepoint.com/:v:/s/ITOMSmartObservabilityCloudService/EY2k70siNgxGgwRfQSMuu_sB9iRudgIorKwF_yGgNG_3HA?e=v45MXS)
|
|
|
|
## Compatibility
|
|
|
|
| OpsB | ESM SMAX | ITOM Aviator |
|
|
| --- | --- | --- |
|
|
| 24.4 | 24.4 | 24.4 |
|
|
|
|
## Prepare Aviator server
|
|
|
|
### Task 1: Apply for a ESM tenant
|
|
|
|
**Performed by: OpsB/NOM Cloud Service Team
|
|
**
|
|
|
|
Contact ESM Cloud Service Team to apply for a ESM tenant (SMAX Only).
|
|
|
|
Provide the following information:
|
|
|
|
- FQDN of OpsB server (for task 4), e.g. [https://obm.internal.customer.com](https://obm.internal.customer.com/)
|
|
|
|
### Task 2: Enable the Aviator capability for ESM SMAX tenant
|
|
|
|
**Performed by: ESM Cloud Service team
|
|
**
|
|
|
|
Refer to the following document to add the Aviator capability for a specific tenant.
|
|
|
|
[https://staging.docs.microfocus.com/itom/ITOM\_Aviator:Main/AddAviatorSaaS](https://staging.docs.microfocus.com/itom/ITOM_Aviator:Main/AddAviatorSaaS)
|
|
|
|
### Task 3: Import OpsB AI content
|
|
|
|
**Performed by: ESM Cloud Service team
|
|
**
|
|
|
|
A pre-defined dataset, crawled from external websites, is ready to prepare the OpsB tenant. The dataset includes:
|
|
|
|
- PostgreSQL
|
|
- Kubernetes
|
|
- OBM
|
|
- OpsBridge
|
|
- Vertica
|
|
|
|
**Pre-requisites:**
|
|
python 3 installed
|
|
pip3 install requests
|
|
|
|
**Steps:**
|
|
|
|
1. Download the **GoldenTenant-25.2.zip** file:
|
|
[GoldenTenant-25.2.zip](https://opentextcorporation.sharepoint.com/:u:/s/ITOMSmartObservabilityCloudService/EfBIA67Rb-dGpppRuVTxobwBK3UpuIbpslrz5UbGWglflw?e=Iwue0q)
|
|
2. Go to the bastion server of the farm and create a workspaces diectory and cd to there.
|
|
3. Unzip the files to your directory, which include the **GoldenTenant** folder and the **ImportGoldenTenant.py** file.
|
|
4. Use the following command to run the **ImportGoldenTenant.py** file to import the data to the target ESM tenant.
|
|
|
|
Replace <host\_name> and <tenant\_id> with the host name and tenant id of the target tenant.
|
|
Replace <password> with the credential of the system integration account
|
|
Replace <input\_path> with the import path of the Golden tenant data
|
|
```
|
|
python ImportGoldenTenant.py --host <host_name> --tenant_id <tenant_id> --integration_usr bo-integration@dummy.com --integration_pwd <password> --input_dir <input_path>
|
|
```
|
|
5. Validate the import in the **import\_process\_log.txt** log file. If the import process is triggered successfully, in the last line in the log file, the "total failed" number should be zero:
|
|
```
|
|
*********Total x split file, y split files success, 0 split files failed, total success x doc, total failed 0 doc.******
|
|
```
|
|
6. Validate remote article in Smart Analytics:
|
|
After about 8 minutes (Delay sync interval), open Smart Analytics (**Suite administration >CONFIGURATIONS >Smart analytics >XService DAH 0**), and then enter the following query:
|
|
```
|
|
https://smarta-saw-dah-0:1443/action=query&text=*&FieldText=(MATCH{RemoteArticle}:ESS-DOCUMENT-TYPE)&print=all&DatabaseMatch=xservices_idol_<tenant_id>
|
|
```
|
|
Click the **RUN** button.
|
|
|
|
|
|
## Prepare cross site configuration between OpsB and Aviator server
|
|
|
|
### Task 4: Set CORS allow domain for OpsB
|
|
|
|
**Performed by: ESM operations team**
|
|
|
|
1. Log in SMAX agent page, go to "Administration -> AI Studio -> Configurations".
|
|
2. Set the base URL of OpsB server to " **Allowed origins for Aviator service** ", e.g. [https://obm.internal.customer.com:1234](https://obm.internal.customer.com:1234/ "https://obm.internal.customer.com:1234/"))
|
|
|
|
|
|
|
|
## (Optional) Set SSO authentication
|
|
|
|
### (Optional) Task 5: Apply to setup SSO for OpsB and ESM
|
|
|
|
**Performed by: Customer / OpsB/NOM cloud service team / ESM operations team
|
|
**
|
|
|
|
Configure SAML authentication and setup SSO for OpsB and ESM. Both are following the this guide: [https://docs.microfocus.com/doc/ESM/SaaS/ConfigureSAML](https://docs.microfocus.com/doc/ESM/SaaS/ConfigureSAML "https://docs.microfocus.com/doc/esm/saas/configuresaml")
|
|
|
|
If you skip this task, then the end users will get a popup window to enter the credentials when accessing the Aviator widget.
|
|
|
|
## Configure Aviator server in OpsB
|
|
|
|
### Task 6: Provide Aviator config data
|
|
|
|
**Performed by: ESM Cloud Service team**
|
|
|
|
ESM Cloud Service team provides required information to OpsB/NOM cloud service team:
|
|
|
|
- Aviator service host name of SMAX, e.g.: [https://eu3-smax-saas.microfocus.com](https://eu3-smax-saas.microfocus.com/)
|
|
- 
|
|
- Tenant ID, e.g. 1000003
|
|
- ESM tenant admin user credential, which is used for task 8
|
|
|
|
### Task 7: Aviator server integration
|
|
|
|
**Performed by: OpsB/NOM cloud service team (Customer for on-prem)
|
|
**
|
|
|
|
After the Aviator capability has been successfully configured, ESM Cloud Service team will provide the SMAX server information to OpsB instance admin, so that OpsB instance admin can configure the Aviator integration into OBM. This requires a restart of all OBM omi servers.
|
|
|
|
- OBM URL: **https://<OBM Domain Name>/obm/?tenant=Provider**
|
|
- Administration → Infrastructure Settings → Integrations → Aviator
|
|
- Aviator URL: Acutually this is SMAX FQDN which configured tenant to connect Aviator. e.g. [https://eu3-smax-saas.microfocus.com](https://eu3-smax-saas.microfocus.com/)
|
|
- Aviator Tenant: SMAX tenant ID
|
|
- Enble Aviator: true
|
|
- Aviator Authentication Group
|
|
- If you didn't configure SSO in task 5, then the value will be "db"
|
|
- If you configured SSO in task 5, then the value will be the CONGIGURATION GROUP name for above SMAX tenant. See Aviator Authentication Group value provided in task 6.
|
|
|
|
|
|
|
|
|
|
|
|
### (Optional) Task 8: Configure AI models
|
|
|
|
**Performed by: OpsB/NOM cloud service team (24.2 only, as not supported to be done by customer yet)
|
|
**
|
|
|
|
Perform this step if you have to add new AI models.
|
|
|
|
Index external knowledge using IDOL connectors. See [Index external knowledge using IDOL connectors](https://staging.docs.microfocus.com/itom/SMAX:Main/IndexKnowledgeFromIDOL "Index external knowledge using IDOL connectors").
|
|
|
|
### Validate Aviator Widget in OBM
|
|
|
|
**Performed by**: OpsB/NOM cloud service team
|
|
|
|
Please go to OpsB home page and launch the Aviator by clicking the icon in the masthead. The widget should be launched successfully as below:
|
|
|
|
|