Installing analytics components


This topic describes how to install the following BMC AMI Ops Monitor analytics components:

  • BMC AMI Ops Analytics Datastore: Provides the infrastructure for dashboard capabilities and for storing, processing, and analyzing big data.
  • BMC AMI Ops Analytics Agent: Collects and processes data from BMC AMI Ops products and stores it in the BMC AMI Ops Analytics Datastore.

Before you begin

Before you start the installation process, see Planning section.

Important

Make sure that you install BMC AMI Ops Analytics Datastore before installing BMC AMI Ops Analytics Agent.

To install BMC AMI Ops Analytics Datastore

  1. From the Electronic Product Distribution (EPD) facility, download and extract the BMCAMIOpsAnalyticsDatastore 2.5.05.tar image to the server where it has to be installed.
  2. Navigate to BMCAMIOpsAnalyticsDatastore 2.5.05 > /Disk1/InstData/NoVM/.
    The install.bin should have execute permission.
  3. Run ./install.bin.
    The BMC AMI Ops Analytics Datastore installation wizard opens.
  4. Follow the wizard prompts to install BMC AMI Ops Analytics Datastore. When prompted to save the installation directory, enter an absolute path or press Enter to accept the default path.
    The default installation path is /root/OpsAnalyticsDatastore.
  5. Set the variables in the wizard:
    • Discovery host name
    • Discovery port
    • JWT token
    • Protocol type (Default: https)
    • SSL connection (Default: true)
    • Datastore internode port1 (Default: 9300)
    • Datastore internode port2 (Default: 9301)
    • Datastore internode port3 (Default: 9302)
    • Datastore communication port1 (Default: 8081)
    • Datastore communication port2 (Default: 8082)
    • Datastore communication port3 (Default: 8083)
  6. If the SSL property is set to true, enter the following properties:
    • Keystore full file path
    • Truststore full file path
    • Keystore type
    • Keystore Alias name
    • Truststore type
    • Keystore password
    • Truststore password
  7. Review the pre-installation summary and then press Enter to continue.
    An example of pre-installation summary is as follows:

    Product Name:
        BMCAMIOpsAnalyticsDatastore

    Install Folder:
        /root/OpsAnalyticsDatastore

    Disk Space Information (for Installation Target):
        Required:     787,299,117 Bytes
        Available: 32,957,030,400 Bytes

    After the installation is complete, the following information is displayed:

    Congratulations. OpsAnalyticsDatastore has been successfully installed to:

    /root/OpsAnalyticsDatastore

    For additional information, please refer the installation log directory at
    /root/OpsAnalyticsDatastore/_OpsAnalyticsDatastore_installer/InstallerLogs/

    For the status details of BMC AMI Ops Analytics Datastore, refer to BMC AMI
    Ops Product Health page.

    The BMC AMI Ops Analytics Datastore starts and the OpsAnalyticsDatastore installation directory includes bin  conf _OpsAnalyticsDatastore_installer  UninstallOpsAnalyticsDatastore directories and files.

  8. Press Enter to exit the installer.

You can change the variables after completing the installation to suit your environment by using the information in the following table:

Click here to expand...

BMC AMI Ops Analytics Datastore parameters

Parameter

Variable name 

Corresponding field in the installation wizard/Description

Default values

Valid values

env.properties

DISCOVERY_HOSTNAME 


Discovery host name

This is the BMC AMI Ops UI Discovery hostname.

None

Alphanumeric

env.properties

DISCOVERY_PORT 


Discovery port

This is BMC AMI Ops UI Discovery port number.

None

Numeric

env.properties

JWT

JWT token

This is the Java web token that is used for internal communication. This value should be the same for all connected components.

None

Alphanumeric

env.properties

AMIADS_PROTOCOL

Protocol type

The BMC AMI Ops Analytics Datastore server protocol type.

https

Alphanumeric

env.properties

AMIADS_SSL 

SSL connection

Indicates if the SSL is selected or not.

true

Boolean

env.properties

AMIADS_ES_TRANSPORT_PORT1

Datastore internode port1

This is the BMC AMI Ops Analytics Datastore transport port 1.

9300

Numeric

env.properties

AMIADS_ES_TRANSPORT_PORT2

Datastore internode port2

This is the BMC AMI Ops Analytics Datastore transport port 2.

9301

Numeric

env.properties

AMIADS_ES_TRANSPORT_PORT3

Datastore internode port3

This is the BMC AMI Ops Analytics Datastore transport port 3.

9302

Numeric

env.properties

AMIADS_PORT1 

Datastore communication port1

This is the BMC AMI Ops Analytics Datastore communication port 1.

8081

Numeric

env.properties

AMIADS_PORT2 

Datastore communication port2

This is the BMC AMI Ops Analytics Datastore communication port 2.

8082

Numeric

env.properties

AMIADS_PORT3 

Datastore communication port3

This is the BMC AMI Ops Analytics Datastore communication port 3.

8083

Numeric

env.properties

AMIADS_KEYSTORE 

Keystore full file path

This is the SSL certificate Keystore full file name path.

None

Alphanumeric

env.properties

AMIADS_TRUSTSTORE

Truststore full file path

User provided Truststore file name for BMC AMI Ops Analytics Datastore.

None

Alphanumeric

env.properties

AMIADS_KEYSTORE_TYPE 

Keytstore type

User provided Keystore type. It can be either JKS or PKCS.

JKS/PKCS

JKS/PKCS

env.properties

AMIADS_KEYSTORE_ALIAS 

Keystore Alias name

This is the Keystore SSL certificate alias name.

None

Alphanumeric

env.properties

AMIADS_TRUSTSTORE_TYPE 

Truststore type

User provided Truststore type. It can be either JKS or PKCS.

JKS/PKCS

JKS / PKCS 

env.properties

AMIADS_KEYSTORE_PASSWORD 

Keystore Password

This is the user provided Keystore password.

None

Alphanumeric

env.properties

AMIADS_TRUSTSTORE_PASSWORD 


Truststore  Password

User provided Truststore password for BMC AMI Ops Analytics Datastore.

None

Alphanumeric

env.properties

AMIDSC_SECURED 

If AMIADS_SSL equals YES then AMIDSC_SECURED should be set to true.

And, set AMIDSC_UNSECURED to false.

true

Boolean

env.properties

AMIDSC_UNSECURED

If AMIADS_SSL equals NO then AMIDSC_SECURED should be set to false.

And, set AMIDSC_UNSECURED to true.

false

Boolean

env.properties

AMIADS JVM_HEAP_MIN  

Minimum JVM heap size

Important

Make sure the default value is not changed.

256 m

Numeric

env.properties

AMIADS JVM_HEAP_MAX

Maximum JVM heap size

Important

Make sure the default value is not changed.

512 m

Numeric

To uninstall BMC AMI Ops Analytics Datastore, see Uninstalling-analytics-components section.

To install BMC AMI Ops Analytics Datastore on zCX

BMC.AMIOPS.SPE2501

  1. From the Electronic Product Distribution (EPD) facility, download the BMCAMIOpsAnalyticsDataStoreOnZCX_2.5.05.tar.gz image to the server where it has to be installed.
  2. To extract the BMCAMIOpsAnalyticsDataStoreOnZCX_2.5.05.tar.gz file, perform these steps:
    1. Navigate to the directory where you want to extract the file.
    2. Use the following command:
      tar -xzvf BMCAMIOpsAnalyticsDataStoreOnZCX_2.5.05.tar.gz
  3. Run ./OpsAnalyticsDataStore_install.
    The BMC AMI Ops Analytics Datastore installation wizard opens.
  4. Follow the installation wizard prompts to complete the installation process.
  5. Set the following variables in the wizard:
    • Discovery host name [Default: ]
    • Discovery port [(Default: ]
    • JWT [Default: ]
    • Protocol type [(Default: https]
    • SSL connection [Default: true]
      If the SSL variable is set to true, enter the following properties:
      • Keystore file path
      • Keystore type
      • Keystore Password
      • Keystore Alias name
      • Truststore file path
      • Truststore type
      • Truststore password
    • Datastore internode port1 [Default: 9300]
    • Datastore internode port2 [Default: 9301]
    • Datastore internode port3 [Default: 9302
    • Datastore communication port1 [Default: 8081]
    • Datastore communication port2 [Default: 8082]
    • Datastore communication port3 [Default: 8083]
  6. Press Enter to continue.
    You get the following message. Press Enter to continue.

     Copying files ..                                                                                                                                                    
    3a90822f58a0: Loading layer [==================================================>]  75.15MB/75.15MB                                                                  
    871f6e35968d: Loading layer [==================================================>]  22.26MB/22.26MB                                                                  
    cd686d275145: Loading layer [==================================================>]   2.56kB/2.56kB                                                                   
    9bdd1223f3f1: Loading layer [==================================================>]    484MB/484MB                                                                    
    c2e31b3d4482: Loading layer [==================================================>]  27.14kB/27.14kB                                                                  
    4ca0e30e1f25: Loading layer [==================================================>]  15.36kB/15.36kB                                                                  
    b95c25acefac: Loading layer [==================================================>]  8.704kB/8.704kB                                                                  
    a3ff7d5d9bd4: Loading layer [==================================================>]  505.3kB/505.3kB                                                                  
    8fccdd17db3f: Loading layer [==================================================>]  3.072kB/3.072kB                                                                  
    ac59f48edc9e: Loading layer [==================================================>]  74.59MB/74.59MB                                                                  
    daee849bd109: Loading layer [==================================================>]  36.46MB/36.46MB                                                                  
    Loaded image: ami-ops-analytics-datastore-zcx:latest                                                                                                                
    025fc462ce9b12729bdc1d6c1b630d9e298b15cf66bb2d14b9e3e0c124783950                                                                                                    
    This is the first Ops Analytics Datastore installation.                                                                                                         
    ee63e8523893ceb792170cbe84bd992be13269380e09c9946d7c62db51f993b3                                                                                                    
    5d889f9589189e718d3ffaa780c7d517b5344827fff834c27ba4b2fd04c495c5                                                                                                    
    1fd9f8d8485f61cc2f299d47cb81d870d7b899d15a8ac4abff7c02b7f1908e32                                                                                                     ===================================================================================
    Installation Complete
    --------------------
    Congratulations. Ops Analytics Datastore has been successfully installed.

    Installation directory : /media/azd_shared_volume/OpsAnalyticsDatastore/

    For additional information, please refer the installation log directory at
    /media/azd_shared_volume/OpsAnalyticsDatastoreInstaller_log/


    For the status details of BMC AMI Ops Analytics Datastore, refer to BMC AMI
    Ops Product Health page.

    PRESS <ENTER> to continue
    ===================================================================================           

    After the installation is complete, the following files are deployed:

    user@zcxdb2i1:/media/azd_shared_volume$ ls                                                                                                                        
    OpsAnalyticsDatastore  OpsAnalyticsDatastoreInstaller_log  amiads01_log  amiads02_log  amiads03_log

To install BMC AMI Ops Analytics Agent 

  1. From the Electronic Product Distribution (EPD) facility, download and extract the BMCAMIOpsAnalyticsAgent 2.5.05.tar image to the server where it has to be installed.
  2. Navigate to BMCAMIOpsAnalyticsAgent 2.5.05 > /Disk1/InstData/NoVM/.
    The install.bin should have execute permission.
  3. Run ./install.bin.
    The BMC AMI Ops Analytics Agent installation wizard opens.
  4. Follow the wizard prompts to install BMC AMI Ops Analytics Agent. When prompted to save the installation directory, either enter an absolute path or press Enter to accept the default path.
    The default installation path is /root/OpsAnalyticsAgent.
  5. Set the variables in the wizard:
    • Discovery host name 
    • Discovery port 
    • JWT
    • Protocol type (Default: https)
    • SSL connection (Default: true)
  1. If the SSL property is set to true, enter the following properties:
    • Keystore full file path
    • Truststore full file path
    • Keystore type
    • Keystore Alias name
    • Truststore type
    • Keystore password
    • Truststore password
  2. Review the pre-installation summary and then press Enter to continue.
    An example of pre-installation summary is as follows:

    Product Name:
        OpsAnalyticsAgent

    Install Folder:
        /root/OpsAnalyticsAgent

    Disk Space Information (for Installation Target):
        Required:      68,499,827 Bytes
        Available: 17,590,403,072 Bytes
  3. After the installation is complete, the following information is displayed:

    Congratulations. OpsAnalyticsAgent has been successfully installed to:

    /root/OpsAnalyticsAgent

    For additional information, please refer the installation log directory at
    /root/OpsAnalyticsAgent/_OpsAnalyticsAgent_installer/InstallerLogs/

    Use the following commands to stop, start or get the status of BMC AMI Ops
    Analytics Agent service

    Status:
    systemctl status BMC-AMI-OpsAnalyticsAgent.service

    Stop:
    systemctl stop BMC-AMI-OpsAnalyticsAgent.service

    Start:
    systemctl start BMC-AMI-OpsAnalyticsAgent.service

    The BMC AMI Ops Analytics Agent starts and the OpsAnalyticsAgent installation directory includes UninstallOpsAnalyticsAgent  _OpsAnalyticsAgent_installer  bin  conf  logs directories and files.

  4. Press Enter to exit the installer. 

You can change the variables after completing the installation to suit your environment by using the information in the following table:

Click here to expand...

BMC AMI Ops Analytics Agents parameters

Parameter

Variable name

Corresponding field in the installation wizard/Description

Default values

Valid values

env.properties

AMIAGT_HOME 

Default Installation Folder

This is the BMC AMI Ops Analytics Agent Installation directory. You can use the default path or define your own path.         

/root/OpsAnalyticsAgent

Alphanumeric

env.properties

AMIDSC_HOST 

Discovery host name

This is the Discovery server hostname for BMC AMI Analytics Agent.

None

Alphanumeric

env.properties

AMIDSC_PORT 

Discovery port

User-defined Discovery Server port number.

None

Alphanumeric

env.properties

JWT 

JWT

Java web token that is used for internal communication. This value should be the same for all connected components.

None

Alphanumeric

env.properties

AMIDSC_PROTOCOL 

Protocol type

User-defined Discovery server protocol type.

https

Alphanumeric

env.properties

AMIAGT_SSL

SSL connection

Indicates if the SSL is selected or not.

true

Boolean

env.properties

AMIAGT_KEYSTORE_NAME

Keystore full file path

User provided Keystore type.

None

Alphanumeric

env.properties

AMIAGT_TRUSTSTORE_NAME

Truststore full file path

User provided Truststore name.

None

Alphanumeric

env.properties

AMIAGT_KEYSTORE_TYPE

Keystore type

User provided Keystore type.

JKS/PKCS

JKS/PKCS

env.properties

AMIAGT_KEYSTORE_ALIAS

Keystore Alias name

User provided Keystore alias name.

None

Alphanumeric

env.properties

AMIAGT_TRUSTRORE_TYPE

Truststore type

User provided Truststore type.

JKS/PKCS

JKS/PKCS

env.properties

AMIAGT_KEYSTORE_PASSWORD

Keystore Password

User provided Keystore password.

None

Alphanumeric

env.properties

AMIAGT_TRUSTSTORE_PASSWORD

Truststore Password

User provided Truststore password.

None

Alphanumeric

env.properties

AMIDSC_SECURED

If AMIAGT_SSL equals YES then AMIDSC_SECURED should be set to true.

And, set AMIDSC_UNSECURED to false

true

Boolean

env.properties

AMIDSC_UNSECURED 

If AMIAGT_SSL equals NO then AMIDSC_SECURED should be set to false.

And, set AMIDSC_UNSECURED to true.

false

Boolean

env.properties

AMIAGT JVM_HEAP_MIN  

Minimum JVM heap size

Important

Make sure the default value is not changed.

256 m

Numeric

env.properties

AMIAGT JVM_HEAP_MAX

Maximum JVM heap size

Important

Make sure the default value is not changed.

512 m

Numeric

To uninstall BMC AMI Ops Analytics Agent, see Uninstalling-analytics-components.

Where to go from here

To start the analytics components, see Starting-and-stopping-analytics-components.

To troubleshoot the installation of analytics components, see Troubleshooting.

To upgrade the analytics components from a previous version to a new version, see Upgrading.

Important

After installing the BMC AMI Ops Analytics Datastore and BMC AMI Ops Analytics Agent components, you can check their statuses on the Product Health page.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*