Installing on Linux

Linux GUI Program Installation

To download and install APM Stream for a Linux platform:

1. Change the permissions on the copied install.bin file to make the file executable by entering:

   $ chmod u+x install.bin

2. Begin the installation program by entering:

   $ sh ./install.bin

3. Click Next to start the installation.

4. Choose the installation location, then click Next.

5. Choose to connect APM Stream to connect to a Standalone Master or to a TA Fault-Tolerant instance, then click Next.

6. Do one of these, and then click Next:

   • If you selected, Standalone Master, provide the Environment Name, Primary Server hostname or IP address, and Primary Server Port (client port) number for the Standalone Master.

   • If you selected Fault Tolerance, specify the Environment Name, then specify the hostnames or IP addresses and client port numbers for the Primary Server, Backup Server, and Fault Monitor.

7. Indicate whether the connection to Master is SSL Enabled, then click Next.

   If SSL is enabled, provide the Keystore and Truststore details of the Master SSL, then click Next.

9. In the Configure Kafka, Prometheus Pushgateway, Store in Data Files dialog:

   • If you selected Configure Kafka, perform these steps:

     1. Enter one or more comma-separated Bootstrap Server hostnames or IP addresses and port numbers in the form hostname:port.

     2. Specify one or more Topics as a comma-separated string.

     3. Choose the required Security Protocol, then click Next.

        If SSL was selected, enter the Keystore and Truststore details, then click Next.

        If SASL was selected, choose the SASL Communication Protocol needed, then click Next.

        If SSL was selected, enter the SSL Truststore and SSL Truststore Password details, then click Next.

        Enter the SASL PLAIN Username and Password, then click Next.

   • If you selected Configure Prometheus Pushgateway, perform these steps:

     1. Specify the hostname or IP address of the Pushgateway Server.

     2. Specify the Port number for the server connection.

        Note: If the Pushgateway requires authentication, choose Basic Authentication Enabled.

     3. Click Next.

        Note: If you enabled basic authentication, specify the required Username and Password.

   • Click Next if you selected Store in Data Files and perform these steps:

     1. Choose Override default data directory to enable the Data Directory text field and specify a directory location to store the data and log files. Click Browse to navigate to the required location.

        Note: Make sure you have the write permission to the specified directory.

     2. Click Next.

10. Confirm the information in the Pre-Installation Summary dialog and click Install.

11. Click Done on the Install Done dialog.

Linux GUI Program Upgrade

To upgrade an existing APM Stream installation:

1. Stop the APMService process.

2. Change the permissions on the copied install.bin file to make the file executable by entering:

   $ chmod u+x install.bin

3. Begin the installation program after copying the file to the directory by entering:

   $ sh ./install.bin

4. Click Next. The Readme dialog opens with a recommendation to make a backup copy of the APMService directory.

5. Click Next. The Location of APMService to upgrade dialog is displayed.

6. Specify the Path to APMService installation by identifying the location of the current installation, then click Next.

7. Click Next.

   Note: If the APMService process is currently running, the APMService Running dialog asks for confirmation to stop the process. Click OK to continue.

9. Review the summary on the Pre-Installation Summary dialog and click Install.

   When the upgrade completes, the Install Complete dialog is displayed.

10. Click Done.

Linux Command Line Installation

To download and install APM Stream for a Linux platform:

1. Change the permissions on the install.bin file to make the file executable by entering:

   $ chmod u+x install.bin

2. Begin the installation program by entering:

   $ sh ./install.bin -i console

   The Introduction is displayed and press Enter.

3. Enter the location for installation and press Enter.

4. Confirm the install folder location by selecting Y.

   Note: For Master Type, choose whether you want APM Stream to connect to a Standalone Master or to a Fault-Tolerant instance of Tidal Automation, then press Enter.

5. Do one of these, and then press Enter:

   • If you selected, Standalone Master, provide the Environment Name, Primary Server hostname or IP address, and Primary Server Port (client port) number for the Standalone Master.

   • If you selected Fault Tolerance, specify the Environment Name, then specify the hostnames or IP addresses and client port numbers for the Primary Server, Backup Server, and Fault Monitor.

7. Indicate whether the connection to Master is SSL Enabled, then press Enter.

   Note: If SSL is enabled, provide the Keystore and Truststore details of the Master SSL, then press Enter.

9. In the Configure Kafka, Prometheus Pushgateway, Store in Data Files screen.

   • If you entered 1 (Configure Kafka), perform these steps:

     1. Enter one or more comma-separated Bootstrap Servers hostname or IP addresses and port numbers in the form: <hostname>:<port> and press Enter.

     2. Specify one or more Topics as a comma-separated string and press Enter.

     3. Choose the required Security Protocol, then click Next.

        If SSL was selected, enter the Keystore and Truststore details, then click Next.

        If SASL was selected, choose the SASL Communication Protocol needed, then click Next.

        If SSL was selected, enter the SSL Truststore and SSL Truststore Password details, then click Next.

        Enter the SASL PLAIN Username and Password, then click Next.

   • If you entered 2(Configure Prometheus Pushgateway), perform these steps:

     1. Specify the hostname or IP address of the Pushgateway Server.

     2. Specify the Port number for the server connection.

     3. If the Pushgateway requires authentication, choose Basic Authentication Enabled.

     4. Press Enter.

     5. If you enabled basic authentication, specify the required Username and Password.

   • If you entered 3 (Store in Data Files), perform these steps:

     1. In the Data Directory field on the Override default data directory screen, specify the directory to which the data and log files should be written.

        Note: Make sure you have the write permission to the specified directory.

     2. Press Enter.

10. Confirm the information provided in the Pre-Installation Summary dialog, and press Enter.

Linux Command Line Upgrade

To upgrade an existing APM Stream installation:

1. Stop the APMService process.

2. Change the permissions on the copied install.bin file to make the file executable by entering:

   $ chmod u+x install.bin

3. Begin the installation program after copying the file to the directory by entering:

   $ sh ./install.bin -i console 

   The Introduction is displayed.

4. Press Enter. The Readme note shows a recommendation to make a backup copy of the APMService directory.

5. Press Enter. The Location of APMService to upgrade prompt is displayed.

6. Specify the location of the current installation, then press Enter.

   Note: If the APMService process is currently running, the APMService Running message asks for confirmation to stop the process. Press 1 to stop the process and continue the upgrade installation.

7. Review the summary in the Pre-Installation Summary message and press Enter.

   When the upgrade completes, the Install Complete message is displayed.

9. Press Enter to exit the installer.