Configuring the DX Platform

This section provides information about how to configure the DX Platfrom.
This section provides the following configuration information:   
 
Set Master Sender and Reply-To E-mail Addresses
Upon installation, the emails sent by the
DX Platform
have [email protected] as the default value for sender and replyTo fields. You can change these values using the
update_mcc_notify_msg_template.sh
script that is provided in the installation directory.
Follow these steps:
  1. Navigate to the install directory.
    cd <install dir>
  2. Run the following command to set the master sender and receiver email addresses to send the notification emails. 
    ./update_mcc_notify_msg_template.sh -n=<namespace> -s=<sender email address> -r=<replyTo email address>
Set the SMTP Server Details
Perform the following steps to set or reset the SMTP server details after the installation.
Follow these steps:
  1. Navigate to the install folder.
  2. Run the following command to update the details:
    ./update-smtp-details.sh --url=<smtp_service_url> --account=<smtp_account> --credential=<password> --namespace=<namespace> For example, ./update-smtp-details.sh --url=<smtp://mail.ca.com:25 --account=test_account [email protected] --namespace=dxi
  3. Run the following command if the SMTP authentication is not required. This command sets empty values for the account and credential.
    ./update-smtp-details.sh --url=<smtp_service_url> -n=<namespace>
Add Elasticsearch Warm Nodes
You can use the 
add-eswarm-nodes.sh
 script that is available in the 
<install_folder/tools>
 directory to add the warm nodes. This script supports adding only two warm nodes to the cluster.
Important!  
Do not modify this script.
Prerequisites:
Before you deploy the Elasticsearch Warm nodes, ensure that:
  • All the nodes requirements for Elasticsearch are met. For more information, see the Hardware and Software Requirements section.
  • The HOTWARM_ROLLOVER_PERIOD environment variable (retention period) is configured as per the sizing guidelines section. Run the following command to update this variable:
    kubectl set env deployment jarvis-esutils HOTWARM_ROLLOVER_PERIOD=<value> -n <namespace>
Follow these steps:
 
  1. Get the list of node names.
    Kubectl get nodes –show-labels
  2. Identify the nodes without labels where Elasticsearch Warm nodes need to be deployed.
  3. Navigate to the
    <installation_folder/tools>
    directory.
  4. Run the following script:
    Sh add-eswarm-nodes.sh
  5. Provide the following information at the prompts:
    • Enter the namespace
    • Enter the ES Warm Node1 Name
    • Enter the ES Warm Node2 Name
    Once the script runs, the nodes are labeled and the ES warm nodes are deployed.
  6. Check the status of the warm nodes:
    Kubectl get deploy -n dxi | grep warm
  7. Check if the nodes are added to the cluster:
     
    curl -v http://es_URL>.nip.io/_cat/nodes?v
Enable DX Operational Intelligence (DX OI)
If you have not enabled DX OI during the installation, use the 
dxi-component-scale.sh
 script to enable DX OI any time after the installation:
Follow these steps:
  1. Navigate to the 
    <install dir>
     directory
    cd install dir>
  2. Run the following commands to start the services:
    DX OI
    ./dxi-component-scale.sh <namespace> oi core up
    Self Monitoring
    ./dxi-component-scale.sh <namespace> selfmonitoring self-monitoring up
    JAF
    ./dxi-component-scale.sh <namespace> jaf core up
Enable DX App Experience Analytics
To enable DX App Experience Analytics, you must start the services and you must also onboard the jobs.
Start the Services
After the installation, only the core DX App Experience Analytics services (axa-readserver, axa-scheduler, and axa-adminui) are enabled by default. To enable DX App Experience Analytics, you must enable the rest of the services.
Follow these steps:
  1. Navigate to the installation directory.
    cd install dir>
  2. Run the following command to start the services.
    ./dxi-component-scale.sh namespace> axa core up
    All the DX App Experience Analytics services are now enabled
    Alternatively, you can run the 
    axa-scale.sh
     script to enable the services. You can also check the status of the services in the Cluster Management UI.
Onboard the Jobs
After you have started the services, the next step is to onboard the jobs using the Jarvis APIs Swagger endpoint. The APIs are categorized into the following types:
  • Speed Jobs (/onboarding/speedjob):
     This API helps you onboard a speed job into Jarvis and schedule it to run either immediately. A speed job runs continuously.
  • Batch Jobs 
    (/onboarding/batchjob):
     This API helps you onboard a batch job into Jarvis and schedule it to run at a specified time. A batch job runs at the scheduled time. A batch job has a final state after every run (for example, FINISHED / FAILED).
In the Jarvis Swagger, use POST to onboard a job for the first time. Use PATCH to update the configuration for an existing job. For more information about how to run these jobs, see the 
Onboarding
 section.
Enable Capacity Analytics
To enable Capacity Analytics, you must start the service. Perform the following steps to enable the CPA deployment.
Follow these steps:
  1. Run the following command for CPA:
    kubectl edit deployments/doi-cpa
  2. Change the value from replicas: 0 to replicas: 1.