Skip to content

Commit 4819ac3

Browse files
kvpreethikvpreethi
authored
Merge branch 'main' into main
2 parents 37063da + 5fbb138 commit 4819ac3

File tree

1 file changed

+10
-54
lines changed

1 file changed

+10
-54
lines changed

‎README.md‎

Lines changed: 10 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
- [Accessing the container images](#accessing-the-container-images)
1111
- [AIDA structure](#aida-structure)
1212
- [AIDA Installation](#aida-installation)
13-
- [Managing Workload Automation server credentials](#managing-workload-automation-server-credentials)
1413
- [Updating AIDA installation](#updating-aida-installation)
1514
- [Uninstalling AIDA](#uninstalling-aida)
1615
- [AIDA.sh script](#aida.sh-script)
@@ -159,15 +158,8 @@ To install AIDA, run the following procedure:
159158
``./AIDA.sh build-start``
160159
161160
Accept the product license when prompted.
162-
163-
8. AIDA is now up and running. Configure the first server to be monitored by running the command
164-
165-
``./AIDA.sh add-credentials``
166-
167-
This command starts a guided configuration of the server.
168-
For details, see [Managing Workload Automation server credentials](#managing-workload-automation-server-credentials).
169161
170-
9. If Keycloak is included in your AIDA deployment, you can connect AIDA user interface at the following link
162+
8. If Keycloak is included in your AIDA deployment, you can connect AIDA user interface at the following link
171163
172164
``https://aida-ip:aida-port/``
173165
@@ -177,45 +169,13 @@ To install AIDA, run the following procedure:
177169
**Note**: The **common.env** environment file contains all the environment variables. For details, see [Configuration parameters](#configuration-parameters).
178170
After AIDA installation, if you want to modify the configuration parameters, edit the common.env file and then run the command: ./AIDA.sh restart.
179171
180-
## Managing Workload Automation server credentials
181-
You can manage the credentials needed to connect to a Workload Automation server using AIDA.sh script.
182-
With a single AIDA instance you can monitor hybrid environments with a mix of HCL Workload Automation for distributed and z/OS systems.
183-
184-
**Limitations:**
185-
With AIDA.sh script you can add, update, and delete credentials. You cannot list credentials since this function is not currently available.
186-
187-
To **add new credentials**, run the following steps:
188-
1. From [docker_deployment_dir], run the following command
189-
190-
``./AIDA.sh add-credentials``.
191-
192-
A guided configuration procedure will start.
193-
2. Follow the guided procedure and answer the prompts to add your credentials, specify the engine type (if HCL Workload Automation for distributed systems or HCL Workload Automation for Z) and, for HCL Workload Automation for Z only, also the engine name.
194-
195-
**Note:** If you are connecting HCL Workload Automation for distributed systems, you must use the Engine credentials.
196-
If you are connecting HCL Workload Automation for Z, you must use the Dynamic Workload Console credentials instead.
197-
198-
To **update existing credentials**, run the following steps:
199-
1. From [docker_deployment_dir], run the following command
200-
201-
``./AIDA.sh update-credentials``.
202-
203-
A guided configuration procedure will start.
204-
2. Follow the guided procedure and answer the prompts to add your credentials, specify the engine type (if HCL Workload Automation for distributed systems or HCL Workload Automation for Z) and, for HCL Workload Automation for Z only, also the engine name.
205-
206-
207-
To **delete existing credentials**, run the following steps:
208-
1. From [docker_deployment_dir], run the following command
209-
210-
``./AIDA.sh delete-credentials``.
211-
212-
A guided configuration procedure will start.
213-
2. Follow the guided procedure and answer the prompts to delete your credentials.
214172
215173
216174
## Updating AIDA installation
217175
176+
218177
If you are using AIDA V10.1 or V10.2.0.0 with Keycloak V17.0.0 and want to update your AIDA installation to V10.2.3, you must first migrate your previous Keycloak V17.0.0 data to Keycloak V24.0.0.
178+
219179
Run the following procedure.
220180
221181
1. Download data from Keycloak V17.0.0 to a file named `aida-realm.json` by running the following commands:
@@ -275,12 +235,6 @@ For the command usage, run
275235
276236
``down-volumes`` Removes AIDA's containers and volumes
277237
278-
``add-credentials`` Lets you add credentials to connect to a HCL Workload Automation engine
279-
280-
``update-credentials`` Lets you update previously added credentials
281-
282-
``delete-credentials`` Lets you delete previously added credentials
283-
284238
``set-custom-port`` Sets a custom port to access AIDA (default value is 9432)
285239
286240
@@ -330,12 +284,13 @@ The following tables list the configurable parameters of each service in the com
330284
331285
| **Parameter** | **Description** | **Mandatory** | **Customizable** | **Default** |
332286
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------- | -------------------------------- |
333-
|SMTP_SERVER|The smtp server. Example: smtp-mail.outlook.com | Y (if you want to receive anomaly notification by email) | | |
334-
|SMTP_PORT|The port of the smtp server | Y (if you want to receive anomaly notification by email)| | |
335-
|SENDER_MAILID| The email account of the alert sender | Y (if you want to receive anomaly notification by email) | | |
336-
|SENDER_MAILPWD|The email password of the alert sender | Y (if you want to receive anomaly notification by email)| | |
337-
|RECIPIENT_MAILIDS|The list of recipient emails. Example: `jack@gmail.com,jessie@live.com` | Y (if you want to receive anomaly notification by email) | | |
287+
|SMTP_SERVER|The smtp server. Example: smtp-mail.outlook.com | Y (if you want to receive anomaly notification by email) | | smtp.server.com |
288+
|SMTP_PORT|The port of the smtp server | Y (if you want to receive anomaly notification by email)| | 587 |
289+
|SENDER_MAILID| The email account of the alert sender | Y (if you want to receive anomaly notification by email) | | smtp@server.com |
290+
|SENDER_MAILPWD|The email password of the alert sender | Y (if you want to receive anomaly notification by email)| | smtpPassword |
291+
|RECIPIENT_MAILIDS|The list of recipient emails. Example: `jack@gmail.com,jessie@live.com` | Y (if you want to receive anomaly notification by email) | | test1@email.com,test2@email.com |
338292
|HOST_IP|AIDA Host IP address and Port. Example: 10.14.32.141:9432| Y (if you want to receive anomaly notification by email) | | |
293+
|EXTERNAL_HOSTNAME=|AIDA Hostname to resolve vulnerabilities| | | |
339294
340295
341296
@@ -387,6 +342,7 @@ The following tables list the configurable parameters of each service in the com
387342
| **Parameter** | **Description** | **Mandatory** | **Customizable** | **Default** |
388343
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------- | -------------------------------- |
389344
|PREDICT_EVERYTHING|For debugging purposes| N | N |false|
345+
|TOGGLE_HISTORICAL_DATA|For debugging purposes| N | N |true|
390346
391347
392348

0 commit comments

Comments
 (0)