Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Installing AppFormix using Contrail Command

 Note

Install AppFormix during the initial installation along with the Contrail and OpenStack installation. AppFormix cannot be installed after the Contrail and OpenStack cluster is already depolyed and imported into Contrail Command.

3-Node setup includes:

Node 1Contrail Command
Node 2OpenStack and Contrail
Node 3AppFormix
  • Install Centos 7.5 on all three nodes. Install libvirt on the compute nodes using the following command:

  • Copy the SSH key from the contrail_command Docker container to all servers.

The workflow for installing AppFormix and receiving statistics is:

  1. Install AppFormix using Contrail Command.

  2. Configure AppFormix plugins using Ansible.

  3. Enable LLDP for each device and analytics you want to collect.

To install AppFormix using Contrail Command:

  1. Download the following AppFormix packages from

    https://support.juniper.net/support/downloads/ and copy the tar.gz files to /opt/software/appformix/ on the Contrail Command host.

    Note

    Contrail version 5.1 supports AppFormix version 2.19.10.

  2. Verify the command_servers.yml file was added before installing Contrail Command as specified in Installing Contrail Command.

    Copy the images and license files for AppFormix inside the contrail_command container in a directory named /opt/software/appformix to make the AppFormix images available in the container. Directory structure needs to be created inside Docker. To do this, add user_command_volumes: as shown in the following example to the command_servers.yml referenced in Installing Contrail Command.

    Note

    Using the following statements requires that the images and license file reside in /opt/software/appformix on the All-In-One (AIO) Contrail Cluster server. When adding the following statements to the command_servers.yml file, they must be placed after the "---" at the very top of the file or as the last two lines at the very bottom of the file.

  3. On the Appformix Nodes tab, select Show Advanced and enter the values for each of the following parameters:
    Figure 1: Setup > AppFormix Nodes
    Setup > AppFormix Nodes

    Table 1: Advanced Settings Descriptions and Example Corresponding Values from the instances.yml File

    Field

    Description

    AppFormix License (Required)

    Path to License

    /opt/software/appformix/<appformix-license>-<version>.sig

    AppFormix Image Dir (Required)

    Path to AppFormix image directory. The path can include platform-images, network-device-images, openstack-images, or dependencies-images depending on your installation.

    /opt/software/appformix/appformix-platform-images-2.19.10.tar.gz
    /opt/software/appformix/appformix-dependencies-images-2.19.10.tar.gz
    /opt/software/appformix/appformix-network_device-images-2.19.10.tar.gz
    /opt/software/appformix/appformix-openstack-images-2.19.10.tar.gz

    AppFormix Version (Required)

    Current version to be installed.

    appformix_version:  2.19.10
  4. Select OpenStack Platform Enabled and enter the values for:

    Table 2: OpenStack Platform Settings Descriptions and Examples Corresponding Values from the instances.yml File

    Field

    Description

    Contrail Analytics URL (Required)

    URL for the Contrail analytics API. This field should reference the All-In-One (AIO) Contrail Cluster server.

    contrail_analytics_url: 'http://192.168.0.28:8081'

    Contrail Config URL (Required)

    URL for the Contrail configuration API. port on the All-In-One (AIO) Contrail Cluster server.

    contrail_config_url: 'http://192.168.0.28:8082'

    Contrail Cluster Name

    Name by which the Contrail instance will be displayed in the Dashboard.

    contrail_cluster_name: 'ContrailCluster1'
  5. Select the following options. Most of these are enabled by default.

    Table 3: Discovery and Monitor Settings Descriptions and Examples Corresponding Values from the instances.yml File

    Field

    Description

    AppFormix kvm Instance Discovery

    Identifies instances on Linux kernel-based virtual machines (KVM.)

    appformix_kvm_instance_discovery: True

    Network Device Monitoring Enabled

    Monitors metrics from network devices, including the topology connections between devices.

    appformix_network_device_monitoring_enabled: True

    JTI Network Device Monitoring Enabled

    Enables JTI streaming telemetry for streaming metrics to AppFormix Agent. This can be enabled for devices running a supported version of Junos.

    appformix_jti_network_device_monitoring_enabled: True

    Remote Host Monitoring Enabled

    Monitor host remotely without installing AppFormix Agent on the host. Metric collection is supported using SNMP (version 2c or 3) and Intelligent Platform Management Interface (IPMI).

    appformix_remote_host_monitoring_enabled: True

    Network Device Discovery Enabled (Required)

    Network devices of a monitored network topology discovered by AppFormix.

    network_device_discovery_enabled: True
  6. Enter the values for the AppFormix Configuration parameters:
    • appformix_haproxy_datamanager_port_http: 8200

    • appformix_haproxy_datamanager_port_https: 8201

      You can also edit or remove roles from the AppFormix Configuration pane.

    Figure 2: AppFormix Configuration Parameters
    AppFormix Configuration Parameters
  7. Add the AppFormix server from the drop-down list in the Available servers section.
  8. Select a node in the Assigned AppFormix Nodes section. The roles selected are for the server added in 7. The following roles are for AppFormix:
    • appformix_controller

    • appformix_bare_host

    • appformix_openstack_controller

    • appformix_compute

  9. Click Next to continue to Summary.
  10. Verify the summary of your configuration and click Provision.
    Figure 3: Setup Configuration Summary
    Setup Configuration Summary
Note

After the AppFormix installation, you can view monitoring by selecting Monitoring > External Apps > AppFormix.

Enable AppFormix Plugins

After the Contrail Command UI- based installation is complete for Openstack, Contrail, and AppFormix, follow these steps to enable AppFormix plugins and receive statistics.

Run the following commands on the contrail-command node.

To enable the AppFormix plugins:

  1. Activate the virtual environment:
  2. Create a host file with entries from the group_vars/instances.yml.
  3. Add the following to the inventory/group_vars/all file.
  4. Call the AppFormix playbook and the AppFormix plugins are added.

Enable LLDP and Analytics To Collect

In the AppFormix software, enable LLDP for each device and any analytics that you want to collect.

  1. In the AppFormix Dashboard, select the menu in the upper-right corner, then select Settings.
  2. Select Network Devices > Add Device.
  3. In the LLDP field, complete the following:
    • Select Enabled in Device Info for LLDP.

    • Add the Management IP address, then click Next.

    • Select SNMP > + in Device Sources to input the SNMP community string. The default community string for each Junos device provisioned is public.

    Figure 4: Enable LLDP and Add Management IP for Network Device
    Enable LLDP and Add Management IP for Network Device
  4. In the Resource field, select the Resource from the list, then click Add.
    Figure 5: Add Selected Resource for Network Device MIB Configurations
    Add Selected Resource for Network Device MIB Configurations
  5. Click Submit to complete.

You can set alarms on different aspects of each network device. These alarms can be created in either the AppFormix UI or Contrail Command.