Performing the App Visibility server installation silently

You can install the App Visibility server unattended (also called a silent installation). A silent installation, as described in this topic, requires no user interaction during installation. Alternatively, you can use the installation wizard.

Optionally, you can install with high-availability (HA) redundancy; see App-Visibility-Manager-high-availability-deployment. In an HA environment, you install a component on one computer, and its alternate component on an identical computer.

The App Visibility server includes the following components:

  • One App Visibility portal, or in an HA environment, one pair of App Visibility portal nodes
  • One or more App Visibility collectors, or in an HA environment, one or more pairs of App Visibility collector nodes
  • One or more App Visibility proxies

For a description about the function of each component, see Installing-the-App-Visibility-server-components.

Perform the procedures in this topic to install the App Visibility server components. For a very small environment or a test environment, you can install the portal, one collector, and one proxy on the same computer. When the App Visibility portal and collector components are installed on the same computer, they share the same database.

For most production environments, you install one App Visibility portal on one computer, several App Visibility collectors (each on a separate computer), and App Visibility proxies on separate computers that are in the network's demilitarized zone (DMZ). In a high-availability deployment, the portal and collector components are installed in pairs: one active node and standby node for the portal (each on a separate computer); one or more pairs of active and standby nodes for the collectors (each on a separate computer).

The following files are used to configure the silent installation of App Visibility server:

  • (Windows) adop-silent-option.txt
  • (Linux) adop-silent-option

These files are located in the \ADOPServer\Disk1 folder in the installation file structure.

This topic presents the following sections:

Related topics

App-Visibility-installation-process-overview

App-Visibility-Manager-high-availability-deployment

TrueSight-Operations-Management-architecture

Before you begin

Note

If you have one or more App Visibility server components from an earlier version, upgrade the earlier components before you install new components.

  • Complete all preinstallation tasks .
  • (For proxy installation) The App Visibility proxy requires a Certificate Authority (CA)-signed certificate.
    The proxy uses SSL-encrypted beacons and injection requests and therefore you must have a keystore with a certificate that is trusted by end-users’ browsers. You can import the keystore during proxy installation or after installation.
    If your application web pages are only HTTP, then after installation, you can change the protocol of the JavaScript fetch API to work with HTTP, instead of the default HTTPS. With HTTP, you do not need to import a keystore file.
  • (For collector and proxy installation) You must have the host name or IP address, and the port number, of the portal.
  • (For portal and collector installation) Determine how much database space you need. For guidelines, see Sizing-App-Visibility-Manager-and-Synthetic-TEA-Agent-components.

For a high-availability environment

Before you install high-availability components for the App Visibility portal, collector, or both, set up the required third-party load balancing server or servers. When you install the App Visibility components, you must have the following information:

  • For portal installation
    • Fully qualified domain name (FQDN) and port number of the computer that has the alternate portal node
    • Database port that is used by the alternate portal node's App Visibility database
  • For collector installation
    • App Visibility portal load balancer host name or IP address, and port number
    • Fully qualified domain name (FQDN) and port number of the computer that has the alternate collector node
    • Database port that is used by the alternate collector node's App Visibility database
    • Host name or IP address, and the port number, of the HA load balancer that manages access to the collector pair
  • For proxy installation
    • App Visibility portal load balancer host name or IP address, and port number

If the keystore requires a password, prepare an encrypted password with the Maintenance Tool.

To set options for silent installation of the App Visibility portal

Click here to expand steps.
  1. On the computer where you want to install the App Visibility portal, open the adop-silent-option file in edit mode.

  2. Specify a valid installation directory.

    Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.

    -P installLocation=<directory>

    <directory> is the installation location.

    The following values are the default:

    • (Windows) -P installLocation=C:\Program Files\BMC Software\App Visibility  
    • (Linux) -P installLocation=/opt/bmc/App_Visibility 
      Best practiceOn Linux computers, use the default installation directory or you might experience issues related to permissions and access.

  3. Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the portal component is indicated for installation.

    # Install App Visibility Portal
    -A bmc_application_diagnostics_portal
    # Install App Visibility Collector
    # -A bmc_application_diagnostics_collector
    # Install App Visibility Proxy
    # -A bmc_application_diagnostics_proxy

  4. Under the Portal Configuration section, enter the portal connection details.

    Ensure that the App Visibility portal ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables this communication.

    The default values are displayed below:

    -J portal_ip=localhost
    -J portal_communication_port=8100
    -J portal_integration_supportability_port=8101

    Parameter descriptions for the portal configuration

  5. Modify the parameter values under the Database Configuration section, as necessary.

    -J db_port=8800
    -J db_retention_time=35
    -J db_max_size=100

    Parameter descriptions for the portal database

    The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
     

  6. (For a portal high-availability installation) To set up a high-availability environment, set ha_enabled to true and enter values for the current component and alternate component.

    For information about high availability, see App-Visibility-Manager-high-availability-deployment.

    The following example displays values for a portal in a high-availability environment.

    -J ha_enabled=true
    -J ha_current_node_fqdn=myPortalA.bmc.com
    -J ha_current_node_port=8102
    -J ha_alternate_node_fqdn=myPortalB.bmc.com
    -J ha_alternate_node_port=8102
    -J ha_alternate_node_db_port=8800

    Parameter descriptions for the portal's alternate component

  7. Save and close the options file.

To set options for silent installation of an App Visibility collector

Click here to expand steps.
  1. On the computer where you want to install the App Visibility collector, open the adop-silent-option file in edit mode.

  2. Specify a valid installation directory.

    Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.

    -P installLocation=<directory>

    <directory> is the installation location.

    The following values are the default:

    • (Windows) -P installLocation=C:\Program Files\BMC Software\App Visibility  
    • (Linux) -P installLocation=/opt/bmc/App_Visibility 
      Best practiceOn Linux computers, use the default installation directory or you might experience issues related to permissions and access.

  3. Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the collector component is indicated for installation.

    # Install App Visibility Portal
    # -A bmc_application_diagnostics_portal
    # Install App Visibility Collector
    -A bmc_application_diagnostics_collector
    # Install App Visibility Proxy
    # -A bmc_application_diagnostics_proxy

  4. Under the Portal Configuration section, enter the details to connect to the portal.

    Ensure that your firewall enables communication with the portal.

    The default values are displayed below:

    -J portal_ip=myPortalHost
    -J portal_communication_port=8100

    Parameter descriptions for the portal configuration

  5. Modify the parameter values under the Collector Configuration section, as necessary.

    Ensure that the App Visibility collector ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables communication with the portal.

    The default values are displayed below:

    -J collector_communication_port=8200
    -J collector_supportability_port=8201

    Parameter descriptions for the collector configuration

  6. Under the Address Configuration section, configure the listening address (host name or IP address) of the computer on which you are installing the App Visibility collector.

    The App Visibility components use this address to contact the computer on which you are installing.

    -J callback_address=

  7. Modify the parameter values under the Database Configuration section, as necessary.

    -J db_port=8800
    -J db_retention_time=35
    -J db_max_size=100

    Parameter descriptions for the collector database

  8. (For a high-availability installation) To set up a high-availability environment, set ha_enabled to true and enter values for the current component and alternate component.

    For information about high availability, see App-Visibility-Manager-high-availability-deployment.

    The following example displays values for a collector in a high-availability environment.

    -J ha_enabled=true
    -J ha_current_node_fqdn=myCollectorA.bmc.com
    -J ha_current_node_port=8202
    -J ha_alternate_node_fqdn=myCollectorB.bmc.com
    -J ha_alternate_node_port=8202
    -J ha_alternate_node_db_port=8800

    Parameter descriptions for the collector's alternate component

  9. (For a high-availability installation) Enter values for the load balancer that manages access to the collector: 

    -J ha_lb_host=myCollectorLoadBalancer
    -J ha_lb_port=2500

    Parameter descriptions for the collector's load balancer

  10. Save and close the options file.

To set options for silent installation of an App Visibility proxy

Click here to expand steps.
  1. On the computer where you want to install the App Visibility proxy, open the adop-silent-option file in edit mode.

  2. Specify a valid installation directory.

    Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.

    -P installLocation=<directory>

    <directory> is the installation location.

    The following values are the default:

    • (Windows) -P installLocation=C:\Program Files\BMC Software\App Visibility  
    • (Linux) -P installLocation=/opt/bmc/App_Visibility 
      Best practiceOn Linux computers, use the default installation directory or you might experience issues related to permissions and access.

  3. Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the proxy component is indicated for installation.

    # Install App Visibility Portal
    # -A bmc_application_diagnostics_portal
    # Install App Visibility Collector
    # -A bmc_application_diagnostics_collector
    # Install App Visibility Proxy
    -A bmc_application_diagnostics_proxy

  4. Under the Portal Configuration section, enter the details to connect to the portal.

    You must provide App Visibility portal configuration details, even if you are not currently installing the portal component.

    Ensure that your firewall enables communication with the portal from other components.

    The default values are displayed below:

    -J portal_ip=myPortalHost
    -J portal_communication_port=8100

    Parameter descriptions for the portal configuration

  5. Modify the parameter values under the Proxy Configuration section, as necessary.

    • If required, modify the port numbers for the relevant communication protocol. Ensure that the port numbers are available.

      -J proxy_communication_port=8300
      -J proxy_supportability_port=8301
      -J proxy_beacon_receiver_http_port=880
      -J proxy_beacon_receiver_https_port=8444

      Parameter descriptions for the proxy configuration

    • The App Visibility proxy requires a security certificate for use with SSL-encrypted beacons and injected requests. You can provide the location of the keystore file now, or you can import the keystore post-installation .

      -J import_proxy_keystore_now=false
      -J proxy_keystore_type=
      -J proxy_keystore_path=
      -J proxy_keystore_alias=
      -J proxy_keystore_password_enc=

      Parameter descriptions for the proxy keystore

  6. Under the Address Configuration section, configure the listening address (host name or IP address) of the computer on which you are installing the App Visibility proxy.

    The App Visibility components use this address to contact the computer on which you are installing.

    -J callback_address=

    Note

    Ensure that the address is accessible from other components. If you need to change the address after installation, see Changing App Visibility collector settings to change the callback.address property.

  7. Save and close the options file.

To set options for silent installation of one or more App Visibility server components

Click here to expand steps.
  1. On the computer where you want to install one or more App Visibility server components, open the adop-silent-option file in edit mode.

  2. Specify a valid installation directory.

    Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.

    -P installLocation=<directory>

    <directory> is the installation location.

    The following values are the default:

    • (Windows) -P installLocation=C:\Program Files\BMC Software\App Visibility  
    • (Linux) -P installLocation=/opt/bmc/App_Visibility 
      Best practiceOn Linux computers, use the default installation directory or you might experience issues related to permissions and access.

  3. Under the Install Features section, add a hash character (#) before any server component that you do not want to install, or before any component that is already installed.

    # Install App Visibility Portal
    -A bmc_application_diagnostics_portal
    # Install App Visibility Collector
    -A bmc_application_diagnostics_collector
    # Install App Visibility Proxy
    -A bmc_application_diagnostics_proxy

    Notes

    • Add a hash character before any component that is already installed on the computer; otherwise, the installation fails.
    • To set up a high-availability environment, you must install each App Visibility server component on a separate computer.

  4. Under the Portal Configuration section, enter the details to connect to the portal.

    You must provide App Visibility portal configuration details, even if you are not currently installing the portal component.

    Ensure that the App Visibility portal ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables communication with the portal.

    The default values are displayed below:

    -J portal_ip=localhost
    -J portal_communication_port=8100
    -J portal_integration_supportability_port=8101

    Parameter descriptions for the portal configuration

  5. (For collector installation)  Modify the parameter values under the Collector Configuration section, as necessary.
    Ensure that the App Visibility collector ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables communication with the portal.

    The default values are displayed below:

    -J collector_communication_port=8200
    -J collector_supportability_port=8201

    Parameter descriptions for the collector configuration

  6. (For proxy installation) Modify the parameter values under the Proxy Configuration section, as necessary.

    • If required, modify the port numbers for the relevant communication protocol. Ensure that the port numbers are available.

      -J proxy_communication_port=8300
      -J proxy_supportability_port=8301
      -J proxy_beacon_receiver_http_port=880
      -J proxy_beacon_receiver_https_port=8444

      Parameter descriptions for the proxy configuration

    • The App Visibility proxy requires a security certificate for use with SSL-encrypted beacons and injected requests. You can provide the location of the keystore file now, or you can import the keystore post-installation .

      -J import_proxy_keystore_now=false
      -J proxy_keystore_type=
      -J proxy_keystore_path=
      -J proxy_keystore_alias=
      -J proxy_keystore_password_enc=

      Parameter descriptions for the proxy keystore

  7. (For collector or proxy installation) Under the Address Configuration section, configure the listening address (host name or IP address) of the computer on which you are installing the App Visibility collector or proxy.

    The App Visibility components use this address to contact the computer on which you are installing.

    -J callback_address=

    Note

    Ensure that the address is accessible from other components. If you need to change the address after installation, see Changing App Visibility collector settings to change the callback.address property.

  8. (For portal or collector installation) Modify the parameter values under the Database Configuration section, as necessary.

    -J db_port=8800
    -J db_retention_time=35
    -J db_max_size=100

    Parameter descriptions for the portal or collector database

  9. (For portal or collector with high-availability installation) To set up a high-availability environment, set ha_enabled to true and enter values for the current component and alternate component.

    For information about high availability, see App-Visibility-Manager-high-availability-deployment.

    The following example displays values for a collector in a high-availability environment.

    -J ha_enabled=true
    -J ha_current_node_fqdn=myCollectorA.bmc.com
    -J ha_current_node_port=8202
    -J ha_alternate_node_fqdn=myCollectorB.bmc.com
    -J ha_alternate_node_port=8202
    -J ha_alternate_node_db_port=8800

    Parameter descriptions for the portal or collector's alternate component

  10. (For collector, high-availability installation) Enter values for the load balancer that manages access to the collector: 

    -J ha_lb_host=myCollectorLoadBalancer
    -J ha_lb_port=2500

    Parameter descriptions for the collector's load balancer

  11. Save and close the options file.

Examples of App Visibility silent installation settings

Example: Silent settings, installing all components together
-P installLocation=C:\Program Files\BMC Software\App Visibility
-A bmc_application_diagnostics_portal
-A bmc_application_diagnostics_collector
-A bmc_application_diagnostics_proxy
-J portal_ip=localhost
-J portal_communication_port=8100
-J portal_integration_supportability_port=8101
-J collector_communication_port=8200
-J collector_supportability_port=8201
-J db_retention_time=35
-J db_max_size=100
-J proxy_communication_port=8300
-J proxy_supportability_port=8301
-J proxy_beacon_receiver_http_port=880
-J proxy_beacon_receiver_https_port=8444
-J import_proxy_keystore_now=false
-J proxy_keystore_type=
-J proxy_keystore_path=
-J proxy_keystore_alias=
-J proxy_keystore_password_enc=
-J callback_address=myAppVisibilityServer
-J db_port=8800
-J ha_enabled=false
-J ha_current_node_fqdn=
-J ha_current_node_port=8102
-J ha_alternate_node_fqdn=
-J ha_alternate_node_port=8102
-J ha_alternate_node_db_port=8800
-J ha_lb_host=
-J ha_lb_port=


Example: Silent settings, App Visibility collector with HA

In this example, you install the App Visibility collector in a high-availability environment. For clarity, values that are not relevant to this installation are commented out.

-P installLocation=C:\Program Files\BMC Software\App Visibility
#-A bmc_application_diagnostics_portal
-A bmc_application_diagnostics_collector
#-A bmc_application_diagnostics_proxy
-J portal_ip=myAppVisibilityPortalLoadBalancer
-J portal_communication_port=8100
#-J portal_integration_supportability_port=8101
-J collector_communication_port=8200
-J collector_supportability_port=8201
-J db_retention_time=35
-J db_max_size=100
#-J proxy_communication_port=8300
#-J proxy_supportability_port=8301
#-J proxy_beacon_receiver_http_port=880
#-J proxy_beacon_receiver_https_port=8444
#-J import_proxy_keystore_now=false
-J proxy_keystore_type=
-J proxy_keystore_path=
-J proxy_keystore_alias=
-J proxy_keystore_password_enc=
-J callback_address=myCollectorA.bmc.com
-J db_port=8800
-J ha_enabled=true
-J ha_current_node_fqdn=myCollectorA.bmc.com
-J ha_current_node_port=8202
-J ha_alternate_node_fqdn=myCollectorB.bmc.com
-J ha_alternate_node_port=8202
-J ha_alternate_node_db_port=8800
-J ha_lb_host=myCollectorLoadBalancer
-J ha_lb_port=2500

To install the App Visibility server silently

  1. In a command line window, navigate to the \ADOPServer\Disk1 folder in the installation file structure.
  2. Run the silent installation of the App Visibility server with the following command:

    • (Windows)

      setup.exe -i silent -DOPTIONS_FILE=<fullFilePath>\adop-silent-option.txt

    • (Linux)

      ./setup.bin -i silent -DOPTIONS_FILE=<fullFilePath>/adop-silent-option
  3. (Optional: Only for a HA setup) Repeat the above steps to install a secondary or standby App Visibility server.
  4. (Optional: Only for a HA setup) After you install the Primary and Secondary App Visibility servers, you must configure the Load Balancer. 
    For the steps to configure a Load Balancer, you must contact your local Load Balancer administrator and provide the active and standby node details of the App Visibility server HA.

If the installation is successful, an indication is displayed in the command window.

Troubleshooting installation issues

  • If the installation fails, you must run the uninstallation process before re-running the installation. For more information about the uninstall process, see Uninstalling-the-App-Visibility-server.

Encrypting a password for silent APM proxy installation

The Maintenance Tool enables you to create an encrypted password, which the Diagnostic Server requires for importing a KeyStore. You must use an encrypted password so that the KeyStore password is not exposed in the adop-silent-option file.

You can run the Maintenance Tool in a wizard interface or from the command-line interface (CLI).

To encrypt a password by using the Maintenance Tool wizard (click here to expand steps)
  1. To open the Maintenance Tool, go to the temporaryDirectory/Disk/utility directory where you downloaded the installation files.
  2. Run the ADOPServerMaintenanceTool utility and click the Encrypt tab.
  3. Enter your password in the Password and Confirm Password fields and click Encrypt.
  4. Copy and paste the value from the Encrypted Password field to the adop-silent-option file for the proxy_keystore_password_enc parameter.
     For example, if the encrypted password output is DES\:d70cbe3669602717ce66af37cce7ecf0, modify the proxy_keystore_password_enc parameter as follows:
    -J proxy_keystore_password_enc=DES\:d70cbe3669602717ce66af37cce7ecf0
To encrypt a password by using a CLI (click here to expand steps)
  1. To open the Maintenance Tool, go to the temporaryDirectory\Disk\utility directory where you downloaded the installation files.

  2. Run the following command, entering your password for the -password and -confirm_password options:

    • Windows

      ADOPServerMaintenanceTool.cmd -silent -encrypt -encrypt -password=<password> -confirm_password=<password>

    • Linux

      ./ADOPServerMaintenanceTool.sh -silent -encrypt -encrypt -password=<password> -confirm_password=<password>

     

  3. Copy and paste the output to the adop-silent-option file for your silent installation.
    For example, if the encrypted password output is DES\:d70cbe3669602717ce66af37cce7ecf0, modify the proxy_keystore_password_enc parameter as follows:
    -J proxy_keystore_password_enc=DES\:d70cbe3669602717ce66af37cce7ecf0

Where to go from here

Verify that the App Visibility server installation is successful.

(For high availability) Follow the installation instructions again to install the alternate node for HA components. After both nodes are installed, configure the components in the load balancer.

(For App Visibility proxy) Import the KeyStore for after installation for the App Visibility proxy. If your application web pages are only HTTP, you can change the protocol to work with HTTP, instead of the default HTTPS. With HTTP, you do not need to import a keystore file.

Install agents:

Add the App Visibility portal to the TrueSight Console.

 

 

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