Configure GigaVUE Fabric Components using OpenStack

This section provides step-by-step information on how to register GigaVUE fabric components using OpenStack or a configuration file.

Recommended Instance Type

Fabric Component Machine type
GigaVUE V Series Node

m1.medium
GigaVUE V Series Proxy m1.small
UCT-V Controller m1.small

Keep in mind the following when deploying the fabric components using generic mode:

  • Ensure that the Traffic Acquisition Tunnel MTU is set to the default value of 1450. To edit the Traffic Acquisition Tunnel MTU, select the monitoring domain and click on the Edit Monitoring Domain option. Enter the Traffic Acquisition Tunnel MTU value and click Save.
  • Before deploying the monitoring session ensure that the appropriate Traffic Acquisition Tunnel MTU value is set. Otherwise, the monitoring session must be un-deployed and deployed again.
  • You can also create a monitoring domain under Third Party Orchestration and provide the monitoring domain name and the connection name as groupName and subGroupName in the registration data. Refer to Create Monitoring Domain for more detailed information on how to create monitoring domain under third party orchestration.
  • User and Password provided in the registration data must be configured in the User Management page. Refer to Configure Role-Based Access for Third Party Orchestration for more detailed information. Enter the UserName and Password created in the Add Users Section.
  • GigaVUE V Series Node must have a minimum of two Networks Interfaces (NIC) attached to it, a management NIC and a data NIC. You can add both these interfaces when deploying the GigaVUE V Series Node in OpenStack.

In your OpenStack Dashboard, you can configure the following GigaVUE fabric components:

Configure UCT-V Controller in OpenStack

You can configure more than one UCT-V Controller in a monitoring domain.

To register UCT-V Controller in OpenStack, use any one of the following methods:

Register UCT-V Controller during Instance Launch

In your OpenStack dashboard, to launch the UCT-V Controller and register UCT-V Controller using Customization Script, follow the steps given below:

  1. On the Instance page of OpenStack dashboard, click Launch instance. The Launch Instance wizard appears. For detailed information, refer to Launch and Manage Instances topic in OpenStack Documentation.
  2. On the Configuration tab, enter the Customization Script as text in the following format and deploy the instance. The UCT-V Controller uses this registration data to generate config file (/etc/gigamon-cloud.conf) used to register with GigaVUE-FM.

    Field

    		User Data

    User data without custom certificate

    Copy
    #cloud-config
     write_files:
     - path: /etc/gigamon-cloud.conf
       owner: root:root
       permissions: '0644'
       content: |
         Registration:
            groupName: <Monitoring Domain Name>
            subGroupName: <Connection Name>
            user: <Username>
            password: <Password>
            remoteIP: <IP address of the GigaVUE-FM>
            remotePort: 443

    User data with custom certificate

    Copy
    #cloud-config
     write_files:
     - path: /etc/cntlr-cert.conf
       owner: root:root
       permissions: "0644"
       content: |
          -----BEGIN CERTIFICATE-----
          <certificate content>
          -----END CERTIFICATE-----
     - path: /etc/cntlr-key.conf
       owner: root:root
       permissions: "400"
       content: |
          -----BEGIN PRIVATE KEY-----
          <private key content>
          -----END PRIVATE KEY-----
     - path: /etc/gigamon-cloud.conf
       owner: root:root
       permissions: '0644'
       content: |
         Registration:
             groupName: <Monitoring Domain Name>
             subGroupName: <Connection Name>
             user: <Username>
             password: <Password>
             remoteIP: <IP address of the GigaVUE-FM>
             remotePort: 443

The UCT-V Controller deployed in OpenStack appears on the Monitoring Domain page of GigaVUE-FM.

Register UCT-V Controller after Instance Launch

Note:  You can configure more than one UCT-V Controller for a UCT-V, so that if one UCT-V Controller goes down, the UCT-V registration will happen through another Controller that is active.

To register UCT-V after launching a Instance using a configuration file, follow the steps given below:

  1. Log in to the UCT-V Controller.
  2. Create a local configuration file (/etc/gigamon-cloud.conf) and enter the following Customization Script. 
    Copy
    Registration:
        groupName: <Monitoring Domain Name>
        subGroupName: <Connection Name>
        user: <Username>
        password: <Password>
        remoteIP: <IP address of the GigaVUE-FM>
        remotePort: 443
  3. Restart the UCT-V Controller service.
    $ sudo service uctv-cntlr restart

Assign Static IP address for UCT-V Controller

By default, the UCT-V Controller gets assigned an IP address using DHCP. If you wish to assign a static IP address, follow the steps below:

  1. Navigate to /etc/netplan/ directory.
  2. Create a new .yaml file. (Other than the default 50-cloud-init.yaml file)
  3. Update the file as shown in the following sample:
    Copy
    network:
            version: 2
            renderer: networkd
            ethernets:
                    ens3:
                            addresses:
                                    - <IP address>
                            gateway: <IP address>
                    ens4:
                            addresses:
                                    - <IP address>
                            gateway: <IP address>
                    ens5:
                            addresses:
                                    - <IP address>
                            gateway: <IP address>
  4. Save the file.
  5. Restart theUCT-V Controller service.

    $ sudo service uctv-cntlr restart

The deployed UCT-V Controller registers with the GigaVUE-FM. After successful registration the UCT-V Controller sends heartbeat messages to GigaVUE-FM every 30 seconds. If one heartbeat is missing ,the fabric node status appears as 'Unhealthy'. If more than five heartbeats fail to reach GigaVUE-FM, GigaVUE‑FM tries to reach the UCT-V Controller and if that fails as well then GigaVUE‑FM unregisters the UCT-V Controller and it will be removed from GigaVUE‑FM.

Note:  When you deploy V Series nodes or UCT-V Controllers using 3rd party orchestration, you cannot delete the monitoring domain without unregistering the V Series nodes or UCT-V Controllers.

Configure UCT-V in OpenStack

Note:  You can configure more than one UCT-V Controller for a UCT-V, so that if one UCT-V Controller goes down, the UCT-V registration will happen through another Controller that is active.

To register UCT-V using a configuration file:

  1. Install the UCT-V in the Linux or Windows platform. For detailed instructions, refer to Linux UCT-V Installation and Windows UCT-V Installation.

  2. Log in to the UCT-V.
  3. Create a local configuration file and enter the following Customization Script.
    • /etc/gigamon-cloud.conf is the local configuration file in Linux platform.
    • C:\ProgramData\uctv\gigamon-cloud.conf is the local configuration file in Windows platform.
    • When creating C:\ProgramData\uctv\gigamon-cloud.conf file, ensure that the file name extension is .conf. To view the file name extension in Windows, follow the steps given below:
      1. Go to File Explorer and open the File Location.
      2. On the top navigation bar, click View.
      3. In the View tab, enable the File name extensions check box.
     
    Copy
    Registration:
        groupName: <Monitoring Domain Name>
        subGroupName: <Connection Name>
        user: <Username>
        password: <Password>
        remoteIP: <IP address of the UCT-V Controller 1>, <IP address of the UCT-V Controller 2>
        remotePort: 8891
  4. Restart the UCT-V service.
    • Linux platform: 
      $ sudo service uctv-agent restart
    • Windows platform: Restart from the Task Manager.

The deployed UCT-V registers with the GigaVUE-FM through the UCT-V Controller. After successful registration the UCT-V sends heartbeat messages to GigaVUE-FM every 30 seconds. If one heartbeat is missing, UCT-V status appears as 'Unhealthy'. If more than five heartbeats fail to reach GigaVUE-FM, GigaVUE‑FM tries to reach the UCT-V and if that fails as well then GigaVUE‑FM unregisters the UCT-V and it will be removed from GigaVUE‑FM.

Configure GigaVUE V Series Nodes and V Series Proxy in OpenStack

Note:  It is not mandatory to register GigaVUE V Series Nodes via V Series proxy however, if there is a large number of nodes connected to GigaVUE-FM or if the user does not wish to reveal the IP addresses of the nodes, then you can register your nodes using GigaVUE V Series Proxy. In this case, GigaVUE-FM communicates with GigaVUE V Series Proxy to manage the GigaVUE V Series Nodes.

To register GigaVUE V Series Node and GigaVUE V Series Proxy in OpenStack, use any one of the following methods:

Register V Series Nodes or V Series Proxy during Instance Launch

To register V Series nodes or proxy using the Customization Script in OpenStack GUI:

  1. On the Instance page of OpenStack dashboard, click Launch instance. The Launch Instance wizard appears. For detailed information, refer to Launch and Manage Instances topic in OpenStack Documentation.

  2. On the Configuration tab, enter the Customization Script as text in the following format and deploy the instance. The V Series nodes or V Series proxy uses this customization script to generate config file (/etc/gigamon-cloud.conf) used to register with GigaVUE-FM

    Field

    		User Data

    User data without custom certificate

    Copy
    #cloud-config
     write_files:
     - path: /etc/gigamon-cloud.conf
       owner: root:root
       permissions: '0644'
       content: |
         Registration:
            groupName: <Monitoring Domain Name>
            subGroupName: <Connection Name>
            user: <Username>
            password: <Password>
            remoteIP: <IP address of the GigaVUE-FM> or <IP address of the Proxy>
            remotePort: 443

    User data with custom certificate

    Copy
    #cloud-config
     write_files:
     - path: /etc/cntlr-cert.conf
       owner: root:root
       permissions: "0644"
       content: |
          -----BEGIN CERTIFICATE-----
          <certificate content>
          -----END CERTIFICATE-----
     - path: /etc/cntlr-key.conf
       owner: root:root
       permissions: "400"
       content: |
          -----BEGIN PRIVATE KEY-----
          <private key content>
          -----END PRIVATE KEY-----
     - path: /etc/gigamon-cloud.conf
       owner: root:root
       permissions: '0644'
       content: |
         Registration:
             groupName: <Monitoring Domain Name>
             subGroupName: <Connection Name>
             user: <Username>
             password: <Password>
             remoteIP: <IP address of the GigaVUE-FM> or <IP address of the Proxy>
             remotePort: 443
  • You can register your GigaVUE V Series Nodes directly with GigaVUE‑FM or you can use V Series proxy to register your GigaVUE V Series Nodes with GigaVUE‑FM. If you wish to register GigaVUE V Series Nodes directly, enter the remotePort value as 443 and the remoteIP as <IP address of the GigaVUE‑FM> or if you wish to deploy GigaVUE V Series Nodes using V Series proxy then, enter the remotePort value as 8891 and remoteIP as <IP address of the Proxy>.
  • User and Password must be configured in the User Management page. Refer to Configure Role-Based Access for Third Party Orchestration for more detailed information. Enter the UserName and Password created in the Add Users Section.

Register V Series Node or V Series Proxy after Instance Launch

To register V Series node or proxy using a configuration file:

  1. Log in to the V Series node or proxy.
  2. Edit the local configuration file (/etc/gigamon-cloud.conf) and enter the following customization script.

    Copy
    Registration:
        groupName: <Monitoring Domain Name>
        subGroupName: <Connection Name>
        user: <Username>
        password: <Password>
        remoteIP: <IP address of the GigaVUE-FM> or <IP address of the Proxy>
        remotePort: 443
    • You can register your GigaVUE V Series Nodes directly with GigaVUE‑FM or you can use V Series proxy to register your GigaVUE V Series Nodes with GigaVUE‑FM. If you wish to register GigaVUE V Series Nodes directly, enter the remotePort value as 443 and the remoteIP as <IP address of the GigaVUE‑FM> or if you wish to deploy GigaVUE V Series Nodes using V Series proxy then, enter the remotePort value as 8891 and remoteIP as <IP address of the Proxy>.
    • User and Password must be configured in the User Management page. Refer to Configure Role-Based Access for Third Party Orchestration for more detailed information. Enter the UserName and Password created in the Add Users Section.
  3. Restart the GigaVUE V Series Node or Proxy service. 
    • GigaVUE V Series Node: 
      $ sudo service vseries-node restart
    • GigaVUE V Series Proxy: 
      $ sudo service vps restart

    The deployed V Series node or V Series proxy registers with the GigaVUE-FM. After successful registration the V Series node or proxy sends heartbeat messages to GigaVUE-FM every 30 seconds. If one heartbeat is missing ,the fabric node status appears as 'Unhealthy'. If more than five heartbeats fail to reach GigaVUE-FM, GigaVUE‑FM tries to reach the V Series node or proxy and if that fails as well then GigaVUE‑FM unregisters the V Series node or proxy and it will be removed from GigaVUE‑FM.

    Note:  When the GigaVUE V Series Node is stopped or terminated from the OpenStack, it does not send any unregistration request and GigaVUE-FM will unregister the V Series Node soon after.

    Keep in mind the following when upgrading the GigaVUE-FM to 6.1.00 or higher version (when using third party orchestration to deploy fabric components):

    When upgrading GigaVUE-FM to any version higher than 6.0.00 and if the GigaVUE V Series Nodes version deployed in that GigaVUE-FM are lower than or equal to 6.0.00, then for the seamless flow of traffic, GigaVUE-FM automatically creates Users and Roles in GigaVUE-FM with the required permission. The username would be orchestration and the password would be orchestration123A! for the user created in GigaVUE-FM. Ensure there is no existing user in GigaVUE-FM, with the username orchestration.

    It is recommended to change the password in the Users page, once the upgrade is complete. Refer to Configure Role-Based Access for Third Party Orchestration for detailed steps on how to change password in the user page.