Documentation update To provide a better user experience, we have now created a separate documentation space for Helix Vulnerability Management. Users of Helix Vulnerability Management (includes BMC Helix Automation Console) can find the latest documentation at BMC Helix Vulnerability Management.

Installing in the interactive mode


This topic provides the instructions to install the TrueSight Automation Console database and the application components using the Stack Manager tool. 

Warning

TrueSight Automation Console is delivered to customers bundled as a set of Docker Containers. The Docker Containers and the software installed on them should not be taken out of Automation Console or used separately. Installing additional third-party software or updating existing software packages in the Docker Containers is not permitted, unless explicitly authorized by BMC Software.

Build numbers

If you have multiple images of the Stack Manager tool available on the host, BMC recommends that you provide the exact version and build number depending on the version that you want to install.

Version

Build number

Details

20.08

865

The TrueSight Automation Console installer

20.08.01

1121

The TrueSight Automation Console installer

20.08

1905

The TrueSight Automation Console installer that contains Log4j fixes

20.08.01

1909

The TrueSight Automation Console installer that contains Log4j fixes


Installing the Stack Manager tool

  1. Open a terminal and SSH into the host where you have set up the local registry, and run the following command to install the Stack Manager tool. 

    docker run -it --rm --network=host 127.0.0.1:5000/bmcsoftware/truesight-stack-manager

    Here, 127.0.0.1:5000 is the host:port of the local registry that contains the BMC Helix Automation Console images.  
    You are prompted to specify a location to install the product.  

    Note

    If you have any images of Stack Manager in your environment, ensure that you use the exact version and build number for installing the latest Stack Manager tool.

    Example
    docker run -it --rm --network=host <hostname>:<port>/bmcsoftware/truesight-stack-manager:20.08.01.1121
  2. Enter a username and password. 

    Note

    You can use a root or a non-root user. If using a non-root user, ensure that the user has read and write permissions to the installation directory and is a part of the docker user group on the host.

  3. Enter a location or continue with the default /opt/bmc location. The Stack Manager tool is installed at the specified location. 

    Tip

    To see the commands typically used during installation and other help, run this command:

    <stackmanager-install-dir>/stackmanager --help

    You can now continue with installing the database and the application.

Installing the database

By default, PostgreSQL database is installed with the product. However, BMC recommends that you do not use the containerized DB for your production environments. Use an external PostgreSQL database instead. 

  1. On the host where the Stack Manager tool is installed, run any of the following commands to start installing the database. 

    <stackmanager-install-dir>/stackmanager install --deployment=database

    or 

    <stackmanager-install-dir>/stackmanager install --deployment database
  2. Verify whether the default Docker registry details are accurate and press Enter to continue. 
    The End User License Agreement is displayed. 
  3. Read, and type y to continue with the installation. 
  4. After accepting the license agreement, you must provide the values that match your environment (for external database) or accept the default values: 

    Field

    Default value

    Notes

    Docker network subnet prefix

    -

    Note: Ensure that the subnet prefix does not conflict with the subnet CIDR or the IP address (172.xx.0.0/16) of your datacenter for the docker0 (docker network adapter/ bridge).

    The IP address can be set to either a single octet (For example, 192 which will create the docker networks as 192.X.X.X and so on) or two octets (For example, 192.112 which will create docker networks as 192.112.X.X and so on). This value is used to create internal docker network (application and data network) for container communications and is not visible outside the host machine.

    Note

    You have to avoid the subnet/IP of the network, the host is connected to.

    To view the current docker settings, run the docker network inspect bridge command.

    Alternatively, if you have created a daemon.json configuration file after setting up Docker, verify the current settings in the file.

    For example, go to cat /etc/docker/daemon.json
    The file shows the current setting as { "bip": "172.17.0.1/16" }. 

    Port number for PostgreSQL server

    5432

    Do not change the default port number.

    PostgreSQL Admin username

    postgres


    PostgreSQL Admin password

    -


    PostgreSQL database installation is complete. 

  5. To verify whether the installation is successful, run the following command:

    <stackmanager-install-dir>/stackmanager status  --deployment=database

    The following status is displayed.

    Components status for database:

    Name        Container Name               Version      Status
    ----        --------------               -------      ------
    PostgreSQL  database-infra-ext-postgres  12-alpine  running

Now that you have successfully installed the database, you can begin installing the application.

Note

BMC recommends to install TrueSight Automation Console Application Server and the database on different host servers. However, for a proof-of-concept or a test environment, both the TrueSight Automation Console application and database can be installed on the same host.

Installing the Automation Console application

Install the application after successfully installing the database. 

  1. On the host where the Stack Manager tool is installed, run any of the following commands to start installing the application. 

    ./stackmanager install  --deployment=tsac+

    or

    ./stackmanager install  --deployment tsac+

    If installing the application on a host where containerized database is installed, the installer will confirm whether the database is already installed.
    If using an external database (containerized or non-containerized), the installer asks for the additional inputs during application installation. The End User License Agreement is displayed. 

  2. Read, and type y to continue with the installation. 
  3. After accepting the license agreement, you must provide the values that match your environment or accept the default values: 

    Field

    Default value/notes

    Docker network subnet prefix (The installer prompts for this field only if a containerized or an external database is installed on a different host.)

    Ensure that the subnet prefix does not conflict with the subnet CIDR or the IP address (172.xx.0.0/16) of your data center for the docker0 (docker network adapter/ bridge).

    The IP address can be set to either a single octet (For example, 192 which will create the docker networks as 192.X.X.X and so on) or two octets (For example, 192.112 which will create docker networks as 192.112.X.X and so on). This value is used to create internal docker network (application and data network) for container communications and is not visible outside the host machine.

    Note

    You have to avoid the subnet/IP of the network, the host is connected to.

    To view the current docker settings, run the docker network inspect bridge command.

    Alternatively, if you have created a daemon.json configuration file after setting up Docker, verify the current settings in the file.

    For example, go to cat /etc/docker/daemon.json
    The file shows the current setting as { "bip": "172.17.0.1/16" }.

    This field is required when you install the database and application on separate hosts.

    Port number for internal application components

    9443

    Fully-qualified domain name or IP address of the PostgreSQL server installed in the previous step

    BMC recommends that you do not use the containerized DB for your production environments. Use an external PostgreSQL database instead. 

    Port number of the PostgreSQL server

    5432. This field is required when you install the database and application on separate hosts.

    Password for the PostgreSQL Admin user 'postgres':


    Name of the database

    tsac_database

    New username for the database

    tsac_database_user

    Password for the new database user

    -

    PostgreSQL tablespace

    tsac_tablespace

    Directory for the system tablespace on the PostgreSQL server

    - For containerized PostgreSQL server installed by the StackManager, the default directory, which is not configurable, is: /var/lib/postgresql/data/tsac_tablespace - For an external non-containerized PostgreSQL database, provide a different database directory.

    Automation Console port number

    10443

    TrueSight Server Automation hostname

    Fully-qualified domain name or IP address of TrueSight Server Automation

    TrueSight Server Automation port number

    9843

    TrueSight Server Automation protocol

    https

    TrueSight Server Automation admin role name

    BLAdmins

    TrueSight Server Automation Service Account username

    BLAdmin

    TrueSight Server Automation password for the Service Account user


    TrueSight Server Automation role name for the Service Account user

    BLAdmins

    TrueSight Server Automation login authentication type for the Service Account user

    SRP  Valid values: SRP, Domain

    Do you want to configure support for RSSO authentication (y/n)

    If using BMC Remedy Single Sign-On for TrueSight Server Automation, specify y.

    If not, specify n.

    Enter the RSSO Server URL

    If specified y in the previous field, enter the BMC Remedy Single Sign-On URL in a fully-qualified domain name format.

    Automation Console application is installation is complete. 

  4. To verify whether the installation is successful, run the following command: 

    ./stackmanager status  --deployment=application

    The following status is displayed.

    Components status for application:

    Name                          Container Name                                 Version            Status
    ----                          --------------                                 -------            ------
    Catalog service              truesight-app-catalog-service                   20.08.00.748       running
    Connector Service            truesight-connectors-service                    20.08.00.1300      running
    Data Refresh Worker          truesight-app-drw                               20.08.00.120       running
    Discovery OnPrem Connector   truesight-common-discovery-onprem-connector     20.08.00.88        running
    Exceptions-service           truesight-common-exceptions-service             20.08.00.384       running
    ITIL Service                 truesight-common-itil                           20.08.00.240       running
    Identity Management Service  truesight-identitymanagement-service            20.08.00.969       running
    Login service                truesight-common-login                          20.08.00.729       running
    Nginx                        truesight-app-nginx                             20.08.00.792       running
    Organization Service         truesight-organization-service                  20.08.00.256       running
    Patch Manager portal         truesight-app-patch-manager-portal              20.08.00.9304      running
    Patch Manager service        truesight-app-patch-manager-core                20.08.00.1144      running
    Platform Portal              truesight-platform-portal                       20.08.00.1213      running
    Policy service               truesight-app-policy-service                    20.08.00.1133      running
    Redis                        truesight-infra-ext-redis                       20.08.00.92        running
    Redis-common                 truesight-infra-ext-redis-common                20.08.00.92        running
    Resource service             truesight-common-resource-service               20.08.00.597       running
    TSO Connector                truesight-common-tso-connector                  20.08.00.233       running
    TSSA Connector               truesight-common-tssa-connector                 20.02.00.502       running
    Tenant Onboarding Utility    truesight-common-tenant-onboarding-utility      20.08.00.96        running
    Users Service                truesight-users-service                         20.08.00.328       running
    rsso-portal                  truesight-rsso-portal                           20.08.00.120       running
    workmanager-service          truesight-workmanager-service                   20.08.00.417       running

Where to go next?

Now that you have installed the product successfully, administrators can start setting up the application for your patch and vulnerability management needs. You can start using its features based on your role and requirements. 

If you want to integrate with BMC Discovery to identify discovered assets, and TrueSight Orchestration to enable change automation, configure the connectors. For details, see Managing-connectors

 

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