Installing AppFormix in a Standalone Environment

 

Getting Started with Standalone

AppFormix can monitor hosts and network devices in a standalone cluster without a management platform (for example, OpenStack or vCenter) from which to discover entities.

This topic explains how to install a standalone version of AppFormix. See the AppFormix General Requirements before reading this topic.

Requirements

  • AppFormix software package, Ansible playbooks, and Docker images.

Installing AppFormix for Standalone

Installation consists of the following steps:

  1. Create Ansible inventory.
  2. Complete installation prerequisites.
  3. Install AppFormix.

Creating Ansible Inventory

Ansible is used to deploy the software to the compute node(s) and the Platform Host. An Ansible inventory file describes groups of hosts in your cluster. Define the inventory in a separate location than the release files, so that the inventory can be reused for an upgrade.

Create a directory inventory (or name of your choice) that contains a hosts file and a group_vars/all file. For example:

The inventory/hosts file contains the list of hosts in each host group. AppFormix requires one host group appformix_controller. Optionally, you may define the bare_host group. Each host group contains a list of hosts in that group. The AppFormix platform services and the AppFormix Agent will be installed on the appformix_controller host. Only the AppFormix Agent will be installed on the bare_host hosts. For example:

For more information, see Ansible inventory documentation.

Ansible Configuration Variables

The AppFormix software includes a number of Ansible roles to perform the configuration of AppFormix settings. Define the values of variables in the inventory/group_vars/all file, in order to be able to use the settings and inventory for future upgrades.

In the inventory/group_vars/all file, configure the following mandatory variables for installation of AppFormix for a user managed cluster.

Refer to Platform Dependencies for steps to install dependencies on a Platform Host that cannot fetch files from the Internet.

Configuring an HTTP Proxy for Fetching Prerequisites

The Ansible playbook will fetch files from the Internet to install prerequisites on the Platform Host. If the Platform Host requires an HTTP proxy to access the Internet, configure the following variables in inventory/group_vars/all:

The prerequisites_env is a dictionary that defines environment variables that will be used when invoking commands to install prerequisites. In the above example, the same proxy URL (http://proxy.example.com:1234) is used for both the http_proxy and https_proxy environment variables because the single proxy can be used to access HTTP and HTTPS URLs. As a convenience, the proxy URL is defined once in the http_proxy_url variable. Adjust prerequisites_env as necessary for the proxy requirements of your network.

Installation Prerequisites

Ansible is used to deploy AppFormix to the AppFormix Platform Host and any hosts on which the AppFormix Agent executes. Ansible can be installed and executed from the AppFormix Platform Host, or any host with Ansible and SSH access to the compute node(s) and Platform Host.

Ansible requires Python on the target host (for example, AppFormix Platform or host where Agent will be installed). Additionally, AppFormix requires pip to install Python packages.

If Ansible, Python, and/or pip are not present, see the following steps to install them. Examples are given for Ubuntu or Debian systems.

To install Ansible, Python, and pip:

To install Python and pip:

Installing AppFormix

The following commands should be executed on the host from which Ansible will be run. This may be the AppFormix Platform Host, or any host with Ansible and SSH access to the compute node(s) and Platform Host.

  1. Copy the following files to the host on which Ansible playbooks will be executed. The path of the images files should match the configuration setting made in the Ansible inventory. See the Ansible configuration variables.

  2. Unpack the tarball, and change to the created directory:

  3. Deploy and configure AppFormix by executing the appformix_standalone.yml playbook. Specify the path to the inventory directory that you created earlier.

  4. Open the AppFormix Dashboard in a Web browser. For example:

    Select Skip Installation because the initial configuration was performed by Ansible. Log in to AppFormix Dashboard using the token generated during the Ansible installation step. The token is stored in a file on the appformix_controller host:

To configure AppFormix to monitor network devices, see Network Devices.

Upgrading AppFormix for Standalone

AppFormix can be easily upgraded by running the appformix_standalone.yml playbook of the new release. Follow the same procedure as for the installation.

Uninstalling AppFormix from Standalone

If you want to uninstall AppFormix and destroy all data, execute the following command: