Installing the Agile Service Manager services

The Agile Service Manager application consists of several micro-services, which are provided as containers. You can deploy these on a single server, though a multi-server deployment is required if the network and application discovery services are deployed in a production environment.

yum install -y --exclude=nasm-common*el9* nasm*

Prepare the installation files

1. Move all Agile Service Manager packages to the installation target host.
   • Copy only the observers you intend to deploy to the installation directory, or delete any unwanted observer packages after you have downloaded them. Remember that the Docker Observer is required.
   • Place the Agile Service Manager Base eAssembly and observer packages into the same directory.
     Important: To prevent unwanted observers being installed and thereby placing unnecessary strain on your infrastructure, ensure that this directory contains only the observers you wish to install.
   • For a multi-server production deployment of the application and (or) network discovery services, ensure that only the Network Discovery Observer and the Application Discovery Observer are present in the installation directory.

Install Agile Service Manager core, UI and observers

2. Run the install command.

   For a RHEL 8 installation

   yum install -y --exclude=nasm-common*el9* nasm*

   For a RHEL 9 installation

   sudo yum install nasm-*.rpm

   Inventory service: If you are upgrading from Agile Service Manager Version 1.1.16 (or earlier), this update removes Search, but not Elasticsearch.

   Tip: While it is possible to specify each individual installation image, it is recommended that you perform a wildcard (*) installation to ensure that all components are installed. Remember that you must ensure that only the observers you wish to install are present. To install an individual observer later, see the information in the following topic: Adding new observers to an existing on-prem installation

   Troubleshooting: The installation process may generate an excessive number of temporary 'docker-tar*' files in the /var/tmp/ directory, which may result in a warning about your server running out of space. (The docker-tar* files are generated regardless of whether Podman or Docker is used.)
   The workaround is to delete the temporary files from your machine:

   rm -rf /var/tmp/docker-tar*

   Yum will install Podman and all other nasm-* components as required, including all observers found in that directory. During the installation of the packages, the related images are loaded. No data can be retrieved, however, until observer jobs are defined.
3. Remove the Elasticsearch service and data.
   1. Uninstall the Elasticsearch service.

      sudo yum remove -y nasm-elasticsearch

   2. Remove the Elasticsearch data directory.

      sudo rm -r /opt/ibm/netcool/asm/data/elasticsearch
      

4. Required: During a first installation or during upgrades, you will be prompted to review and accept the license. You must do so after installation has completed using the following command:

   /opt/ibm/netcool/asm/bin/license-review.sh

   Note: Agile Service Manager can only start after the license has been accepted, and after all additional components have been installed, as described in the following steps.

Install application discovery and network discovery (optional)

5. Optionally, you can install the application discovery and network discovery services, either as part of a single- or a multi-server deployment.

   Single-server deployment

   Only install the application discovery and network discovery services on the same server as the other Agile Service Manager components for a non-production deployment, for example for proof-of-concept or testing purposes.

   From the directory where you placed the application discovery or network discovery packages, install one or both of these services using the yum install command, as in the following examples:

   • Install the application discovery components:

     sudo yum install nasm-db2 nasm-app-disco-discovery nasm-app-disco-primarystorage nasm-appdisco-observer

   • Install network discovery components:

     sudo yum install nasm-net-disco-config nasm-net-disco-consul nasm-net-disco-control nasm-net-disco-sidecar nasm-net-disco-worker nasm-net-disco-schema-registry nasm-net-disco-security nasm-net-disco-status nasm-net-disco-swagger-service nasm-net-disco-swagger-ui nasm-net-disco-topogram nasm-netdisco-observer nasm-net-disco-collector nasm-net-disco-sftp

   Multi-server deployment

   For any production environment, you must install the application discovery and network discovery services on separate servers.

   In the following installation scenarios, Agile Service Manager servers are identified as follows:

   Agile Service Manager core server

   <host-asmcore>

   Application discovery server

   <host-appdisco>

   Network discovery server

   <host-netdisco>

   1. To allow the application and network discovery observers to connect to their remotely deployed services, edit the files that specify the connections between components.

      For application discovery

      Edit the environment variables in the $ASM_HOME/.env file. Add the following host and port details:

      APPDISCO_SERVICE_HOST=<host-appdisco>
      APPDISCO_SERVICE_PORT=<443>

      For network discovery

      Edit the environment variables in the $ASM_HOME/.env file. Add the following host details:

      KAFKA_ROUTABLE_HOSTNAME=host-asmcore
      NETDISCO_SWAGGER_SERVICE_HOST=<host-netdisco>
      NETDISCO_SCHEMA_REGISTRY_HOST=<host-netdisco>

      Edit the KAFKA_SERVER host and port in the etc/nasm-netdisco-observer.yml file. Change the following line:

      KAFKA_SERVER: <host-asmcore:19093>

   2. Install the components for the application and network discovery services:

      For application discovery

      On your application discovery host (<host-appdisco>):

      yum install nasm-db2 nasm-app-disco-discovery nasm-app-disco-primarystorage nasm-nginx nasm-common

      Remove the redundant references to the application discovery services (now installed on a separate server) from the $ASM_HOME/docker-compose.yml file. Run the following bash command from the command line:

      for service in [ "cassandra" "layout" "merge" "inventory" "topology" "ui-api" "kafka" "kafkarest" "zookeeper" "postgres" ]; do
          /opt/ibm/netcool/asm/bin/update-docker-compose.py /opt/ibm/netcool/asm/docker-compose.yml delete $service
      done
      

      For network discovery

      On your network discovery host (<host-netdisco>):

      yum install nasm-nginx nasm-net-disco-collector nasm-net-disco-config nasm-net-disco-consul nasm-net-disco-control nasm-net-disco-sidecar nasm-net-disco-worker nasm-net-disco-schema-registry nasm-net-disco-security nasm-net-disco-sftp nasm-net-disco-status nasm-net-disco-swagger-service nasm-net-disco-swagger-ui nasm-net-disco-topogram nasm-common nasm-elasticsearch nasm-kafka nasm-zookeeper

      Remove the redundant references to the network discovery services (now installed on a separate server) from the $ASM_HOME/docker-compose.yml file. Run the following bash command from the command line:

      for service in [ "cassandra" "layout" "merge" "search" "topology" "ui-api" "kafka" "kafkarest" "zookeeper" ]; do
          /opt/ibm/netcool/asm/bin/update-docker-compose.py /opt/ibm/netcool/asm/docker-compose.yml delete $service
      done

      Remove the following references to Kafka and Zookeeper from the $ASM_HOME/docker-compose.yml file:

      # egrep '(kafka|zookeeper)' $ASM_HOME/docker-compose.yml 
          - kafka
          - kafka
          - zookeeper
          - kafka

      Add the following environment variables to the $ASM_HOME/.env file to set up a connection to the Agile Service Manager core version of Kafka:

      SHERPA_ROUTABLE_HOSTNAME=<host-netdisco>
      KAFKA_EXTERNAL_SERVER=<host-asmcore:19093>

   Note: During the installation of the packages, the related images are loaded. However, the database required by the discovery services is only created and configured when Agile Service Manager is started. If in addition you are deploying the probe and gateway services, you must configure them before starting the services. No data can be retrieved or discovered until you have also defined observer jobs for the discovery services (and any other observers you are deploying).
6. Required: Again review and accept the license after installation has completed using the following command:

   /opt/ibm/netcool/asm/bin/license-review.sh

   Note: If you do not complete this step and accept the license, Agile Service Manager will not start. You only start Agile Service Manager once you have completed all installation tasks for your optional components (that is, one or more of the probe and gateway, application discovery, or network discovery services).

Optional (required for SE Linux only)

7. If required, allow SSH for sysadmins:

   sudo setsebool -P ssh_sysadm_login on
   

8. Enable SELinux.

   SELinux not disabled

   If you installed Agile Service Manager with SELinux not disabled (and completed the double installation of the nasm-common package etc), perform the following steps:

   1. Edit the /etc/selinux/config file with a suitable editor and set SELINUX=enforcing.
   2. Use one of the following to apply your changes:

      fixfiles onboot

      Or

      touch /.autorelabel

   3. Reboot your system.

   SELinux disabled

   If you installed Agile Service Manager with SELinux disabled, perform the following steps:

   1. Edit the /etc/selinux/config file with a suitable editor and set SELINUX=permissive.
   2. Use one of the following to apply your changes:

      fixfiles onboot

      Or

      touch /.autorelabel

   3. Reboot your system.
   4. Check /var/log/messages and /var/log/audit/audit.log for new SELinux messages.
   5. Edit the /etc/selinux/config file with a suitable editor and set SELINUX=enforcing.
   6. Use one of the following to apply your changes:

      fixfiles onboot

      Or

      touch /.autorelabel

   7. Reboot your system.

9. Provide write access to log and data directories.
   To allow Podman write access to the logs, data and security directories, you must apply the semanage and restorecon SELinux commands after the Agile Service Manager packages have been installed.

   semanage fcontext -a -t container_file_t '/opt/ibm/netcool/asm/logs(/.*)?'
   semanage fcontext -a -t container_file_t '/opt/ibm/netcool/asm/data(/.*)?'
   semanage fcontext -a -t container_file_t '/opt/ibm/netcool/asm/security(/.*)?'
   restorecon -vrF /opt/ibm/netcool/asm/logs/
   restorecon -vrF /opt/ibm/netcool/asm/data/
   restorecon -vrF /opt/ibm/netcool/asm/security/
   

10. To allow couchDB to start with SELinux, apply the following settings:

    sudo semanage fcontext -a -t container_file_t '/opt/ibm/netcool/asm/etc/couchdb/entrypoint/couchdbEntrypoint.sh'
    sudo restorecon -vrF /opt/ibm/netcool/asm/etc/couchdb/entrypoint/couchdbEntrypoint.sh
    

Required for Docker Observer only

11. Enable podman access for Docker Observer.
    To grant access to the podman socket file, run the following commands:

    semanage fcontext -a -t container_file_t /var/run/user/984/podman/podman.sock
    restorecon -vrF /var/run/user/984/podman/podman.sock 
    

    Docker Observer SELinux errors: When Docker Observer is run for the first time, errors may occur.

    1. Run the following command:

       grep "SELinux is preventing" /var/log/messages | tail -2

    2. From the log message, apply the suggested SE Linux policy, which will be similar to the following example:

       ausearch -c 'epollEventLoopG' --raw | audit2allow -M my-epollEventLoopG
       

       semodule -i my-epollEventLoopG.pp
       

Configure integration and verify deployment

12. To configure communication between DASH and the Agile Service Manager UI, run the following script:

    bin/set-dash-config.sh

    You are prompted to enter the following information:

    DASH URL endpoint

    DASH server root URL

    Enter a complete path so that it can be reached from the Agile Service Manager server (including the protocol, host name, and port number).

    Example: https://dash-host.ibm.com:16311

    DASH administrator username

    The DASH administrator user name.

    Example: smadmin

    DASH administrator password

    The password for the DASH administrator user.

    ASM hostname

    Enter the fully-qualified host name of the server on which Agile Service Manager is installed.

    Example: asm-host.ibm.com

    This hostname must match the one entered when the Netcool Hybrid Deployment Option Integration Kit is installed, as documented here.

13. Optional: You can verify that the images have been loaded running the podman images command as the nasm user.