GroundWork Monitor Enterprise 8.1.3

A New Install is used for a fresh GroundWork Monitor installation. If your installation is an update, please refer to Update Install

The installation process uses an installer file and does not require Internet access other than for the initial download. You will need to prepare your system, get the installer file, and run the installer. The installer will initially create a gw8 subdirectory of the directory where it runs, and will drop the configuration files into this subdirectory. It is important to complete all sections in this document starting with:

1. Pre Install

Checklist

This section outlines important information you'll need prior to installing GroundWork Monitor.  If you have any questions regarding these items, please submit a ticket at GroundWork Support.

 Release Notes for this release.

 System Requirements for this release.

 System and Install Preparation: You will need to be familiar with the Linux command line, and have a physical or virtual Linux server with root access.

  • Network Connection: Connected to network, to be accessible via HTTPS and SSH.
  • Hostname: During installation you will be prompted for the host name to be used to access your GroundWork Monitor system web interface. It is recommended to make it the FQDN, so certificates will validate correctly.
  • Partition Disk Space: It is recommended to have at least 6GB disk space in the current working directory for the download. It is recommended to have at least 200GB disk space assigned to the partition that contains the /var/lib/docker path, the location for the GroundWork Monitor 8 installation.
  • System Timezone: Setup system time, e.g., NTP and UTC. Additionally, during installation you will be prompted for the timezone to be used for the crontab. This is the timezone of those with the most access to the system, and it can be different from the server timezone, but ideally is not.
  • SELinux and Virus Software: Disable SELinux and disable any virus scan software.

 Subnets: During installation you will be prompted for a subnet to use for the Docker daemon and subnet for GroundWork Docker containers. Make sure the subnets do not conflict with your own infrastructure.

 Type of Installation: During installation you will be prompted for the type of installation to use for this GroundWork server. GroundWork Monitor can be installed as a standalone system or installed to run as part of a Parent-child distributed monitoring configuration of GroundWork servers. The choices will be as listed below, note Parent Child is available in 8.1.0 and later. For more information on distributed monitoring see Deploying Parent Child.

  • Standalone: GroundWork 8 server in a single location.
  • Parent: GroundWork 8 central server for GroundWork child servers. You will need the parent host name which needs to resolve to the parent server you are installing and be reachable by any associated child servers.
  • Parent Managed Child: GroundWork 8 child server managed from the GroundWork 8 parent. You will need the parent host name which must match the parent instance name on the parent server this child will connect and the child hostname which must match the child's Monarch Group name, be reachable by the parent, and resolve to the server you are installing.
  • Child Managed Child: GroundWork 8 child server managed independently. You will need the parent host name which must match the parent instance name on the parent server the child will connect to.

 Certificates: GroundWork includes self-signed certificates for HTTPS support out-of-the-box, however this is not intended for production. You can proceed with an installation and address certificates post-install. For certificates documentation see Adding certificates to HTTPS.

 LDAP: During the Install process you will create a gwos user for the installation as well as running the application. If you use LDAP, an LDAP based user is fine, as long as it can be added to sudo and to the docker group. For LDAP documentation see LDAP Mapping.

2. New Install

Platforms

Expand / Collapse the link below for your installation platform:

 CentOS 7.5 / Red Hat 7.5
CentOS 7.5 / Red Hat 7.5
  1. Log in as a user with sudo and get to a root shell.

  2. Disable the firewall. These steps will disable the default firewall configuration and leave your GroundWork server in a potentially vulnerable state, so be sure to set up compatible secure rules after installing or upgrading GroundWork Monitor.  

    1. If you are using the iptables utility, enter:

      iptables -F
      CODE
    2. If you are using the firewall tool firewalld, enter:

      systemctl disable firewalld
      systemctl stop firewalld
      CODE
  3. Create the user gwos to be used to run the application.

    1. Add the gwos user:

      useradd gwos
      CODE
    2. Add the gwos password:

      passwd gwos
      CODE
  4. Install Docker CE:

    1. Install yum-utils as a preparation for Docker:

      yum install -y yum-utils device-mapper-persistent-data lvm2
      CODE
    2. Add the Docker repos:

      yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
      CODE
    3. Install the Community Edition of Docker:

      yum install -y docker-ce docker-ce-cli containerd.io
      CODE
  5. Install Docker Compose, which basically enables you to interact with Docker:

    1. Download docker-compose using curl:  

      curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
      CODE
    2. Set the docker-compose binary to be executable:

      chmod +x /usr/local/bin/docker-compose
      CODE
    3. Create a symbolic link:

      ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
      CODE
  6. Verify Docker is running:

    1. Enable Docker auto-start:

      systemctl enable docker
      CODE
    2. Check the status of Docker:

      systemctl status docker --no-pager
      CODE
    3. If Docker is not running, enter the following:

      systemctl start docker
      CODE
  7. Add gwos user to the docker group, which was created by the installation of Docker:

    usermod -a -G docker gwos
    CODE
  8. As gwos user verify access to Docker commands:

    All commands, including installation commands, are performed as the gwos user, do not attempt installation as the root user.

    1. Switch user to user gwos:

      su - gwos
      CODE
    2. Verify the docker command returns usage output:

      docker
      CODE
    3. Verify the docker-compose command returns usage output:

      docker-compose
      CODE
  9. Adjust your log settings so the logs won't fill your disk space. See Log Settings.

  10. Download and prepare the GroundWork Monitor Enterprise 8.1.3 installer:

    1. Obtain the installer from the Downloads page and transfer it to your server in the gwos user home directory (/home/gwos).

    2. Log in as the gwos user:

      su - gwos
      CODE
    3. Change the directory to gwos user home directory:

      cd~
      CODE
    4. Check the MD5 sum and compare it with the MD5 sum listed on the Downloads page:

      md5sum gw8setup-8.1.3-GA.run
      CODE


      • If this does not match, re-download the installer, as you may have a corrupted download.

    5. Change ownership of the installer to the gwos user:

      chown gwos:gwos gw8setup-8.1.3-GA.run
      CODE
    6. Mark the file as executable:

      chmod +x gw8setup-8.1.3-GA.run
      CODE
  11. Run the GroundWork Installer:

    Do not run the installer as the root. Run it as user gwos. 

    1. Verify the output of the whoami command returns the gwos user:

      whoami
      CODE
    2. As gwos user, enter the following:

      ./gw8setup-8.1.3-GA.run
      CODE
    3. As the install progresses, you will be asked about Timezone, web UI host name, installation type, and subnets which are all mentioned in the Pre-Install section above.

  12. After the install has completed, you can check the containers status:

    1. Change to the gw8 directory and check the containers status:

      cd gw8
      docker-compose ps
      CODE
  13. To launch GroundWork Monitor, open a browser to the name of the host system you provided to the installer as the web UI host name. The default Administrator login is admin/admin. It may take a few minutes for the availability calculations to complete and display, as you may see warnings about this on the relevant dashboards.

 CentOS 8 / Red Hat 8
CentOS 8 / Red Hat 8
  1. Log in as a user with sudo and get to a root shell.

  2. Disable the firewall. These steps will disable the default firewall configuration and leave your GroundWork server in a potentially vulnerable state, so be sure to set up compatible secure rules after installing or upgrading GroundWork Monitor.  

    1. If you are using the iptables utility, enter:

      iptables -F
      CODE
    2. If you are using the firewall tool firewalld, enter:

      systemctl disable firewalld
      systemctl stop firewalld
      CODE
  3. Create the user gwos to be used to run the application.

    1. Add the gwos user:

      useradd gwos
      CODE
    2. Add the gwos password:

      passwd gwos
      CODE
  4. Install Docker CE:
    GroundWork Monitor 8.1.3 supports installations for Red Hat 8 and CentOS 8, however the typical commands to install Docker CE will not work, as the Red Hat (and therefore CentOS) repositories are missing the latest Docker packages. GroundWork 8 requires Docker CE (or Enterprise) installed, along with Docker Compose in order for it to be installed. The following are instructions for installing Docker CE packages that are compatible with GroundWork 8.1.3 on Red Hat 8.x or CentoOS 8.x. This is not the only way to do this, but we have found that yum does not easily connect to the repos where the latest packages reside and some work-around procedures published online are not stable. 

    1. On your GroundWork 8 server, make a new, clean directory: 

      mkdir docker-packages
      cd docker-packages
      CODE
    2. Download the rpm packages from the following links to your GroundWork 8 server: 

      wget https://download.docker.com/linux/centos/7/x86_64/stable/Packages/containerd.io-1.2.6-3.3.el7.x86_64.rpm
      wget https://download.docker.com/linux/centos/7/x86_64/stable/Packages/docker-ce-19.03.9-3.el7.x86_64.rpm
      wget https://download.docker.com/linux/centos/7/x86_64/stable/Packages/docker-ce-cli-19.03.9-3.el7.x86_64.rpm
      CODE
    3. Check the MD5 sum of the downloaded packages for safety: 

      md5sum containerd.io-1.2.6-3.3.el7.x86_64.rpm
      21f8f9bb156003e965c565dca7f2a8dc  containerd.io-1.2.6-3.3.el7.x86_64.rpm
      md5sum docker-ce-19.03.9-3.el7.x86_64.rpm
      8c82e6029624a5c3b632e45a54291c61  docker-ce-19.03.9-3.el7.x86_64.rpm
      md5sum docker-ce-cli-19.03.9-3.el7.x86_64.rpm
      34abba60e1b908ee0c4c9ca7cfdcdaae  docker-ce-cli-19.03.9-3.el7.x86_64.rpm
      CODE
    4. Remove any old installation of Docker CE:

      sudo yum remove docker  docker-client  docker-client-latest  docker-common  docker-latest  docker-latest-logrotate  docker-logrotate  docker-engine
      CODE


      • This may not find old packages installed, but it's best to be safe. 

    5. Install the Docker packages you downloaded:

      sudo yum install *.rpm
      CODE
    6. Enable and start Docker: 

      sudo systemctl enable docker
      sudo systemctl start docker
      CODE
    7. For confirmation, list the Docker version installed:

      sudo docker version
      Client: Docker Engine - Community
       Version:           19.03.9
       API version:       1.40
       Go version:        go1.13.10
       Git commit:        9d988398e7
       Built:             Fri May 15 00:25:27 2020
       OS/Arch:           linux/amd64
       Experimental:      false
      
      Server: Docker Engine - Community
       Engine:
        Version:          19.03.9
        API version:      1.40 (minimum version 1.12)
        Go version:       go1.13.10
        Git commit:       9d988398e7
        Built:            Fri May 15 00:24:05 2020
        OS/Arch:          linux/amd64
        Experimental:     false
       containerd:
        Version:          1.2.0
        GitCommit:        c4446665cb9c30056f4998ed953e6d4ff22c7c39
       runc:
        Version:          1.0.0-rc8
        GitCommit:        425e105d5a03fabd737a126ad93d62a9eeede87f
       docker-init:
        Version:          0.18.0
        GitCommit:        fec3683
      CODE
  5. Install Docker Compose, which basically enables you to interact with Docker:

    1. Download docker-compose using curl: 

      curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
      CODE
    2. Set the docker-compose binary to be executable:

      chmod +x /usr/local/bin/docker-compose
      CODE
    3. Create a symbolic link:

      ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
      CODE
  6. Verify Docker is running:

    1. Enable Docker auto-start:

      systemctl enable docker
      CODE
    2. Check the status of Docker:

      systemctl status docker --no-pager
      CODE
    3. If Docker is not running, enter the following:

      systemctl start docker
      CODE
  7. Add gwos user to the docker group, which was created by the installation of Docker:

    usermod -a -G docker gwos
    CODE
  8. As gwos user verify access to Docker commands:

    All commands, including installation commands, are performed as the gwos user, do not attempt installation as the root user.

    1. Switch user to user gwos:

      su - gwos
      CODE
    2. Verify the docker command returns usage output:

      docker
      CODE
    3. Verify the docker-compose command returns usage output:

      docker-compose
      CODE
  9. Adjust your log settings so the logs won't fill your disk space. See Log Settings.

  10. Download and prepare the GroundWork Monitor Enterprise 8.1.3 installer:

    1. Obtain the installer from the Downloads page and transfer it to your server in the gwos user home directory (/home/gwos).

    2. Log in as gwos user:

      su - gwos
      CODE
    3. Change the directory to gwos user home directory:

      cd ~
      CODE
    4. Check the MD5 sum and compare it with the MD5 sum listed on the Downloads page:

      md5sum gw8setup-8.1.3-GA.run
      CODE


      • If this does not match, re-download the installer, as you may have a corrupted download.

    5. Change ownership of the installer to the gwos user:

      chown gwos:gwos gw8setup-8.1.3-GA.run
      CODE
    6. Mark the file as executable:

      chmod +x gw8setup-8.1.3-GA.run
      CODE
  11. Run the GroundWork Installer:

    Do not run the installer as the root. Run it as user gwos. 

    1. Verify the output of the whoami command returns the gwos user:

      whoami
      CODE
    2. As gwos user, enter the following:

      ./gw8setup-8.1.3-GA.run
      CODE
    3. As the install progresses, you will be asked about Timezone, web UI host name, installation type, and subnets which are all mentioned in the Pre-Install section above.

  12. After the install has completed, you can check the containers status:

    1. Change to the gw8 directory and check the containers status:

      cd gw8
      docker-compose ps
      CODE
  13. To launch GroundWork Monitor, open a browser to the name of the host system you provided to the installer as the web UI host name. The default Administrator login is admin/admin. It may take a few minutes for the availability calculations to complete and display, as you may see warnings about this on the relevant dashboards.

 SLES 15
SLES 15

For SLES 15 you will need access to SMT/RMT server (Local mirror or direct to SuSE SMT), with access to the repository "Container Module 15 x86_64". To enable the container module, follow instructions in PROCEDURE 2.1: Enabling the container module using YAST of the Docker Open Source Engine Installation documentation.

  1. Log in as a user with sudo and get to a root shell.

  2. Disable the firewall. These steps will disable the default firewall configuration and leave your GroundWork server in a potentially vulnerable state, so be sure to set up compatible secure rules after installing or upgrading GroundWork Monitor.  

    1. If you are using the iptables utility, enter:

      iptables -F
      CODE
    2. If you are using the firewall tool firewalld, enter:

      systemctl disable firewalld
      systemctl stop firewalld
      CODE
  3. Create the user gwos to be used to run the application:

    useradd -m -d /home/gwos/ gwos
    CODE
  4. Install Docker CE packages:

    zypper in docker containerd docker-bash-completion
    CODE
  5. Install Docker Compose:

    1. Download docker-compose using curl:  

      curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
      CODE
    2. Set the docker-compose binary to be executable:

      chmod +x /usr/local/bin/docker-compose
      CODE
    3. Create a symbolic link:

      ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
      CODE
  6. Verify Docker is running:

    1. Enable Docker auto-start:

      systemctl enable docker
      CODE
    2. Check the status of Docker:

      systemctl status docker --no-pager
      CODE
    3. If Docker is not running, enter the following:

      systemctl start docker
      CODE
  7. Add gwos user to the docker group, which was created by the installation of Docker:

    usermod -a -G docker gwos
    CODE
  8. As gwos user verify access to Docker commands:

    All commands, including installation commands, are performed as the gwos user, do not attempt installation as the root user.

    1. Switch user to user gwos:

      su - gwos
      CODE
    2. Verify the docker command returns usage output:

      docker
      CODE
    3. Verify the docker-compose command returns usage output:

      docker-compose
      CODE
  9. Adjust your log settings so the logs won't fill your disk space. See Log settings.

  10. Download and prepare the GroundWork Monitor Enterprise 8.1.3 installer:

    1. Obtain the installer from the Downloads page and transfer it to your server in the gwos user home directory (/home/gwos).

    2. Login as the gwos user:

      su - gwos
      CODE
    3. Change the directory to gwos user's home directory:

      cd ~
      CODE
    4. Check the MD5 sum and compare it with the MD5 sum listed on the Downloads page:

      md5sum gw8setup-8.1.3-GA.run
      CODE


      • If this does not match, re-download the installer, as you may have a corrupted download.

    5. Change ownership of the installer to the gwos user:

      chown gwos:gwos gw8setup-8.1.3-GA.run
      CODE
    6. Mark the file as executable:

      chmod +x gw8setup-8.1.3-GA.run
      CODE
  11. Run the GroundWork Installer:

    Do not run the installer as the root. Run it as user gwos.

    1. Verify the output of the whoami command returns the gwos user:

      whoami
      CODE
    2. As gwos user, enter the following:

      ./gw8setup-8.1.3-GA.run
      CODE
    3. As the install progresses, you will be asked about Timezone, web UI host name, installation type, and subnets which are all mentioned in the Pre-Install section above.

  12. After the install has completed, you can check the containers status:

    1. Change to the gw8 directory and check the containers status:

      cd gw8
      CODE
      docker-compose ps
      CODE
  13. To launch GroundWork Monitor, open a browser to the name of the host system you provided to the installer as the web UI host name. The default Administrator login is admin/admin. It may take a few minutes for the availability calculations to complete and display, as you may see warnings about this on the relevant dashboards.

 Ubuntu 18.04 or 20.04
Ubuntu 18.04 or 20.04

  1. Log in as a user with sudo and get to a root shell (sudo su -), or use a user with rights to execute commands using sudo.

  2. Disable the firewall. These steps will disable the default firewall configuration and leave your GroundWork server in a potentially vulnerable state, so be sure to set up compatible secure rules after installing or upgrading GroundWork Monitor.  

    1. If you are using the ufw default firewall configuration tool for Ubuntu, enter:

      sudo ufw disable
      CODE
    2. If you are using the iptables utility, enter:

      sudo iptables -F
      CODE
    3. If you are using the firewall tool firewalld, enter:

      sudo systemctl disable firewalld
      sudo systemctl stop firewalld
      CODE
  3. Create the user gwos to be used to run the application. The adduser utility will walk you through options, including setting a password and other optional fields:

    sudo adduser gwos
    CODE
  4. Install Docker CE using Docker's RPM repository and installation instructions for Ubuntu:

    1. Go to Install Docker Engine on Ubuntu.

    2. Scroll down to the section Install using the repository.

    3. Then, perform the steps in the section SET UP THE REPOSITORY.

    4. Next, perform steps 1 and 3 in the INSTALL DOCKER ENGINE, then return to this page.

      Testing Docker commands creates dummy hosts you should remove. These hosts will be monitored by default in GroundWork, and will show up as being down. You can verify the test is successful with the displayed “Hello from Docker!” message, then, simply enter the following to clean up the hosts it creates:
      List all containers:
      docker ps -a
      Look for hello-world, e.g.,:
      CONTAINER ID     IMAGE                          COMMAND          CREATED                STATUS                     PORTS                      NAMES
      2b261cbe8d87     hello-world                  “/hello”                19 minutes ago      Exited (0) 19 m
      Enter the following command with that container ID, e.g.,:
      docker rm  2b261cbe8d87
      List all containers again:
      docker ps -a

  5. Install Docker Compose:

    1. Download docker-compose using curl:  

      sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
      CODE
    2. Set the docker-compose binary to be executable:

      sudo chmod +x /usr/local/bin/docker-compose
      CODE
    3. Create a symbolic link:

      sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
      CODE
  6. Verify Docker is running:

    1. Enable Docker auto-start:

      sudo systemctl enable docker
      CODE
    2. Check the status of Docker:

      sudo systemctl status docker --no-pager
      CODE
    3. If Docker is not running, enter the following:

      sudo systemctl start docker
      CODE
  7. Add gwos user to the docker group, which was created by the installation of Docker:

    sudo usermod -a -G docker gwos
    CODE
  8. As gwos user verify access to Docker commands:

    All commands, including installation commands, are performed as the gwos user, do not attempt installation as the root user.

    1. Switch user to user gwos:

      su - gwos
      CODE
    2. Verify the docker command returns usage output:

      docker
      CODE
    3. Verify the docker-compose command returns usage output:

      docker-compose
      CODE
  9. Adjust your log settings so the logs won't fill your disk space. See Log settings.

  10. Download and prepare the GroundWork Monitor Enterprise 8.1.3 installer:

    1. Obtain the installer from the Downloads page and transfer it to your server in the gwos user home directory (/home/gwos).

    2. Login as the gwos user:

      su - gwos
      CODE
    3. Change the directory to gwos user home directory:

      cd ~
      CODE
    4. Check the MD5 sum and compare it with the MD5 sum listed on the Downloads page:

      md5sum gw8setup-8.1.3-GA.run
      CODE


      • If this does not match, re-download the installer, as you may have a corrupted download.

    5. Change ownership of the installer to the gwos user:

      chown gwos:gwos gw8setup-8.1.3-GA.run
      CODE
    6. Mark the file as executable:

      chmod +x gw8setup-8.1.3-GA.run
      CODE
  11. Run the GroundWork Installer:

    Do not run the installer as the root. Run it as user gwos.

    1. Verify the output of the whoami command returns the gwos user:

      whoami
      CODE
    2. As gwos user, enter the following:

      ./gw8setup-8.1.3-GA.run
      CODE
    3. As the install progresses, you will be asked about Timezone, web UI host name, installation type, and subnets which are all mentioned in the Pre-Install section above.

  12. After the install has completed, you can check the containers status:

    1. Change to the gw8 directory and check the containers status:

      cd gw8
      CODE
      docker-compose ps
      CODE
  13. To launch GroundWork Monitor, open a browser to the name of the host system you provided to the installer as the web UI host name. The default Administrator login is admin/admin. It may take a few minutes for the availability calculations to complete and display, as you may see warnings about this on the relevant dashboards.

3. Post Install

Checklist

  • Restart Script: You'll need to put auto restart in-place in case of power outage. See Restart Script.
  • Firewall Settings: Don't forget! You will need to determine and instantiate the appropriate firewall rules or security settings for your host! GroundWork uses port TCP/443, and optionally TCP/5667 (for legacy GDMA) to the revproxy container, and it also requires container-to-container communications. You can adjust the firewalld settings to match your companies security policy as long as these conditions are met. A useful example of adjusting firewalld rulesets to secure a Docker CE host can be found here.
  • Certificates: GroundWork includes self-signed certificates out of the box. To load your own certificates, please refer to Adding Certificates to HTTPS.
  • SMTP Service: Setup SMTP for email alert notifications.
  • Docker Commands: To access logs, control containers, and navigate in Docker, see Docker Commands.
  • User, Roles, Permissions: To configure GroundWork Monitor users, see Users Roles and Permissions, and if you use LDAP see LDAP Mapping.
  • GroundWork Menu: To customize the GroundWork menu options and access, see Menu Editor.

Related Resources