Page tree
Skip to end of metadata
Go to start of metadata
Note

To install or upgrade Ribbon Analytics by manually creating the Configuration Drive and the VM(s), use these procedures to manage the Configuration Drive.

If you are installing or upgrading Ribbon Analytics using the Analytics Director CLI or UI automated process, you do not need to perform these procedures.

A Configuration Drive (Config Drive) is an ISO file that provides information needed for Ribbon Analytics VM creation, and is required during boot up to provision the VM. If no Config Drive is provided, the system will boot but will not run as expected. 

The Analytics Director UI guides you through the creation of a Config Drive. When the Config Drive has been created, you can download it and use SFTP to transfer it to the VM host for manual VM creation, or save it as the starting point for creating other Config Drives. 

If you do not have access to the Internet from your data center, you can create the ISO file elsewhere in the network and then transfer it to the datacenter, or you can install and host Analytics Director on a server in your network using one of the following procedures.

Supported browsers:

  • Windows:
    • Chrome 60+ (recommended)
    • Firefox 55+
    • IE 10+
    • Edge 38+
  • Mac OSX:
    • Chrome 60+ (recommended)
    • Firefox 55+

Creating a Configuration Drive

Analytics Director supports creating Config Drives for VMware, KVM, and AWS platforms, and supports both single-node and multi-node deployments. Use the following procedure to create a new configuration drive. 

Note

Analytics Director 20.12 includes an updated UI. Differences in UI versions are indicated throughout these procedures.

Prerequisites

  • To create the Config Drive, you need information about the node(s) and the internal, MAG (Management Access Gateway), and DIG (Device Interface Gateway) networks, including the gateway IP address, DNS server IP addresses, and CIDR. To get the latest CIQ to record the required data about your deployment, refer to Ribbon Analytics Customer Information Questionnaire.

Procedure Steps

Use the following steps to create a Config Drive.

Tip

In 20.10 and earlier, when you open the Analytics Director UI, all fields contain the default values. Click Reset to defaults anytime during a configuration session to reset the fields back to these previously set values.

  1. Access the Analytics Director UI. If the UI is hosted by your internal network, access it at the following:
    • In versions 20.10 and earlier: https://<ip>:8443
    • In version 20.12: https://<ip>
  2. In Analytics Director 20.10 and earlier, use the Select Webportal Mode drop-down list to select New Config.
    In Analytics Director 20.12, click New System

    Modified: for 20.12

  3. In Analytics Director 20.12, enter the following in the Initial Config section, then click Next:

    Field

    Description
    Install Type

    To create a configuration from scratch, select Start Fresh.
    To import a configuration, select From Current Config File and either drag and drop the .json file to the space indicated, or click Browse to locate and select the .json file.

    Host TypeSelect the host type.
    Number of NodesSelect 1 for lab installations, select 3 for multi-node production systems.
    Release

    Select the version of Ribbon Analytics to create a config file for.

  4. Enter the Cluster Config settings:

    FieldDescription
    Installation Mode

    Select installation mode as OFFLINE to create a configuration file for upgrading Ribbon Analytics, otherwise select INSTALL.

    Version

    In Analytics Director 20.10 and earlier, use the drop-down list to specify the Ribbon release version you are installing or upgrading to.

    Number of Nodes

    In Analytics Director 20.10 and earlier, for a single-node deployment, select 1. For a multi-node deployment, select 3.

    Number of DIG pods

    For a single DIG pod, select 1. To use DIG clustering, select 3

    Availability: Since 20.04

    Installation TypeIn Analytics Director 20.10 and earlier, specify the VM type - KVM, VMware, or AWS.
    PCIG

    Enable or Disable the PCIG network interface. This interface is required to ingest QoS metrics from Ribbon SBC Core devices. The default is Disabled. 

    Availability: Since 20.08

    If you select Enabled, the PCIG Network form displays in the Network Config section.

    TimezoneSelect the VM(s) time zone.
    Number of Hadoop Disks

    Specify the number of disks to be configured. The range is between 1 and 10. This selection applies to all nodes in the cluster. 

    Availability: Since 20.08

    Flavor Selection

    Specify whether the system is a default or custom deployment size.

    If you select Default, continue by selecting the applicable option in the Flavor drop-down list.

    If you select Custom, enter the vCPU (number of vCPUs) and Memory (amount of memory in GB).

    Image Name
    If you selected the AWS installation type, enter the ID of the Ribbon Analytics AMI.
    Availability ZonesIf you selected the AWS installation type, select the AWS region that includes the availability zones the system uses.
  5. Availability: Since 20.08

    Select Network Config and, using the information from the Ribbon Analytics Customer Information Questionnaire, enter the configuration information for the Internal NetworkManagement Network, Device Network, PCIG Network, and Cluster Network
  6. Select Node Config and enter the Node Name and Node IP information for each node. For a single-node deployment, this will be Node 0. For a multi-node deployment, this will be Node 0, Node 1, and Node 2. You are prompted to configure DIG IP addresses based on the Device Network setting (IPv4, IPv6, or both IPv4 and IPv6). 

    Note

    The node name cannot use uppercase letters and must be 15 characters or less.

    It cannot start with a number or special character.

    It cannot end with a special character.

  7. In the Host Config section, ensure Install is set to No. This section is used for automated installation of Ribbon Analytics. 
  8. In Analytics Director 20.12, use the Disk Config section to enter the desired disk allocations, as recorded in the Ribbon Analytics Customer Information Questionnaire.
  9. In Analytics Director 20.10 and earlier, select Generate ISO and click Generate to generate the ISO file.
    In 20.12, click Save to save the configuration; the .json file is downloaded.  
  10. In 20.10 and earlier, when a file has been generated, click Download; extract the downloaded .tar file to get the required ISO (for KVM and VMware) or CFN template (for AWS).
  11. Optionally, in 20.10 and earlier, to download the configuration in the .json file, click Download Config.

    Note

    Enable Save as default to save the current settings; these settings are restored when you click the Reset to default button. 

Downloading a .json Configuration File

In Analytics Director 20.10 and earlier, after you have generated an ISO, you can download the edited .json configuration file for later use. This allows you to re-use the configuration settings to generate an ISO at a later time, or to use the configuration settings as a starting point for generating a new ISO. In 20.12, the .json file is automatically downloaded when you save the configuration.

  1. Use the procedure in Creating a Configuration Drive to create a .json file.
  2. Generate the ISO, then click Download Config to download the .json file.

Uploading a .json Configuration File

In Analytics Director 20.10 and earlier:

Use this procedure in Analytics Director 20.10 and earlier to create an ISO from an existing .json configuration file

  1. Access the Analytics Director UI. If the UI is hosted by your internal network, access it at https://<ip>:8443.
  2. In the Select Webportal Mode drop-down list, select Upload Config.
  3. Select the Number of Nodes represented in the .json file.
  4. Click Browse Config File to browse to and select the .json file.
  5. Click Upload Config.
Note

 If the number of nodes configured in the .json file does not match the Number of Nodes selected, an error message appears and the file is not uploaded.

In Analytics Director 20.12:

In Analytics Director 20.12, existing .json files are uploaded during configuration of a new system. See step 3 in Creating a Configuration Drive.

Creating a Configuration File for Upgrading Ribbon Analytics

Note

If you are upgrading to Ribbon Analytics 20.04 from an earlier version, you must use Analytics Director 20.10 or earlier to generate the Config Drives for performing the offline upgrade of Ribbon Analytics.

In Analytics Director 20.12:

To create a config file for upgrading the Ribbon Analytics system, follow the steps in Creating a Configuration Drive, ensuring you select Offline in the Cluster Config Installation Mode drop-down list.


In Analytics Director 20.10 and earlier:

To upgrade the Ribbon Analytics system, use the procedure in this section to create a .json config file that is based on the config file of the existing Ribbon Analytics system.

  1. If you are not using the .json file of the existing Ribbon Analytics system, create an .json config file using the procedure in Creating a Configuration Drive, ensuring you select the OFFLINE installation mode.
  2. After downloading the ISO file, select Upgrade Protect in the Select Webportal Mode drop-down list.
  3. Specify the Upgrade VersionNumber of Nodes.
  4. In version 20.04 and later, specify the Number of DIG pods

    Availability: Since 20.04

  5. Click Upload Config File, then browse to select the .json config file generated in step #1.

  6. OR
    Select the json file of the existing Ribbon Analytics system.
  7. Following successful upload of the config file:
    1. For 1-DIG systems, the new .json configuration file for the upgrade is downloaded automatically. Click Download ISO to download the new ISO file. 
    2. For 3-DIG system, the New Config screen is displayed. Continue with step #5 in Creating a Configuration Drive.

Generating a CSR for Analytics Director 20.10 and Earlier

Analytics Director 20.10 and earlier includes a default host certificate that requires updating for production use. Use the Generate CSR tool in the Analytics Director UI to generate a host Certificate Signing Request (CSR).

  1. Access the Analytics Director UI. If the UI is hosted by your internal network, access it at https://<ip>:8443.
  2. In the Select Webportal Mode drop-down list, select Generate CSR.
  3. Complete the following fields, then click Generate CSR.

    FieldDescription
    Common Name
    This must match the domain name used during installation of the Ribbon Analytics node.
    SANUse this field (subject alternate name) to specify additional hostnames to be included in the certificate.
    OrganizationThe legal name of your organization.
    UnitThe organizational unit within your organization requesting the certificate.
    EmailThe email address used to contact your organization.
    Locality or CityThe full (unabbreviated) name of your city.
    Province or StateThe full (unabbreviated) name of your province or state
    CountrySelect your country from the drop-down list.
  4. When the CSR is generated, click Download CSR.

Managing Certificates 

Analytics Director includes a default self-signed host certificate (web server certificate). Perform the following tasks to update the host certificate with a new certificate signed by a trusted authority.

  1. Generate a CSR. You can import only certificates for which the corresponding CSR was generated by Analytics Director; you cannot import certificates based on CSRs that have been generated elsewhere, so you must generate the CSR in Analytics Director.
  2. Get the certificate signed by a CA (Certificate Authority). Analytics Director supports the .p12 certificate format.
  3. Save the certificate in a location that is accessible by the machine that will be used to import it, and, if applicable, ensure you know the P12 password.
  4. In Analytics Director 20.12, import the signed host certificate.

Generating a CSR

To obtain a signed host certificate, you must first generate a CSR using the following steps. 

  1. Access the Analytics Director UI. If the UI is hosted by your internal network, access it at https://<ip>:8443 (version 20.10 and earlier or https://<ip> (version 20.12).
  2. Access the Generate CSR functionality:
    1. In 20.10 and earlier: In the Select Webportal Mode drop-down list, select Generate CSR.
    2. In 20.12: Click the Settings icon , the select CertificatesGenerate CSR.
  3. Complete the following fields.

    Field

    Description

    Common Name

    Enter a common name using the following format. The domain must match the domain name entered during installation of the Ribbon Analytics node.

    <name><domain>

    SANUse this field (subject alternate name) to specify additional hostnames to be included in the certificate.
    Organization NameThe legal name of your organization.
    Organization Unit NameThe organizational unit within your organization requesting the certificate.
    EmailThe email address used to contact your organization.
    Locality or CityThe full (unabbreviated) name of your city.
    Province or StateThe full (unabbreviated) name of your province or state
    CountrySelect your country from the drop-down list.
  4. Click Save. The CSR is generated and downloaded to the default download location on your machine.

Importing a Host Certificate for Analytics Director 20.12

Availability: Since 20.12

Use the following procedure to import an Analytics Director host certificate. Use this procedure for certificates that have been generated by either Analytics Director or a third-party tool.

The supported certificate format is .p12.

  1. Access the Analytics Director UI.
  2. Click the Settings icon. 
  3. Select Certificates.
  4. Click Import Certificate.
  5. In the relevant certificate section (Trusted, Intermediate, and/or X.509), drag and drop the certificate file onto the indicated space, or click Browse to browse to and select the certificate file.
  6. Click Deploy.
  7. Enter the Certificate Name and Certificate Password Phrase.
  8. Click SubmitUpon successful import of the certificate, the server is restarted, and the main page is displayed.