Setting up the AppViewX Cloud Connector using a Virtual Image for an On-prem Deployment

  1. To download the release package in the OVA format, from the respective AppViewX's product line landing page, under GET STARTED menu > Connectivity section, click .
  2. Log in to the vmware client.
  3. From the Navigation pane on the left, right click Virtual Machines.
  4. Click Create/Register VM.
    The New Virtual machine window is displayed.
  5. From the navigation pane in the left, select Select creation type.
  6. In the Select creation type window, select the Deploy a virtual machine from an OVA or OVF file option.
  7. Click Next.
  8. In the Select OVF and VMDK files window:
    1. Enter a name for the virtual machine.
      For the purpose of this document, we will name it test-cc-deployment.
    2. In the Click to select files or drag/drop area, click and, from the file explorer, navigate to the location of the file, select the file, and click Open.
  9. Click Next.
  10. In the Select storage window, from the available options, select a datastore for storing the virtual machine's files and all of its virtual disks.
  11. Click Next.
  12. In the Deployment options window:
    1. Select the network mapping.
    2. Select the disk provisioning required.
    3. Select the Power on automatically checkbox.
  13. Click Next.
  14. In the Ready to complete window, review your settings.
  15. Click Finish.
    • The progress of the OVA deployment is shown in the Recent Tasks section.
    • On successful completion of the OVA deployment, the new virtual machine is displayed in the Virtual Machines inventory. For each virtual machine in the inventory, the following details are displayed:
  16. From the Virtual Machines inventory, click the virtual machine just added.
    The terminal window for the virtual machine is displayed. The script for configuring the network IP is executed automatically.
  17. To configure the IP address, when prompted, enter the required values for the following requested parameters: 
    ============================================
IPADDR    =  XXX.XXX.XXX.XXX
NETMASK   =  XXX.XXX.XXX.XXX
GATEWAY   =  XXX.XXX.XXX.XXX
================================

    For example, refer to the sample screenshot below:

  18. To configure the hostname and the DNS, when prompted, press Y. If you prefer to configure the hostname and DNS manually, to skip this step, press N.
  19. To configure an NTP server(s):
    1. When prompted, Do you want to configure ntpd server (default public server)press Y.
    2. Enter the number of NTP servers to be configured.
    3. For the number of servers entered above, enter the IP address of each NTP server on a new line.
    4. To update the ntp.conf file with the IP addresses provided above, press Y.
    After the execution of this step, if the cloud connector does not exist on this host machine, the following prompt is displayed: Would you like to opt for automated installation of the cloud connector? (y/n):.
  20. Since these instructions are for setting up the cloud connector via the user interface, enter n.
  21. When prompted, login to the VM as the appviewx user, using the credentials shared by AppViewX's customer support team.
    Note: Root user access is required for maintaining the OS configuration and for patching security updates. Since direct root access is not provided, you can:
    1. Login as the appviewx user.
    2. Switch to the root user by executing the command sudo -i.
    Note: It is recommended that, after the first login, change the default credentials.
  22. Since these instructions are for setting up the cloud connector via the user interface, when prompted Would you like to opt for automated installation of the cloud connector? (y/n):, enter y.
  23. When prompted Are you sure you want to continue connecting, press y and then press Enter.
  24. To check if the Docker is up and running, execute the command: systemctl status docker.
    If the Docker status is active (running), as shown in the screenshot below, it means that the OVA has been deployed successfully.
    Note: To check if the Docker is accessible to the appviewx user, execute the following command: 
    docker image ls
    If the command does not return an error, it means that the Docker is accessible to the appviewx user:
  25. Enter your account URL (for example, https://tenant-name.appvx.com/appviewx/login) in the address bar of your browser.
    The AppViewX login page is displayed.
  26. Login to AppViewX.
  27. Navigate to the cloud connector's setup interface.
    There are three ways you can access the interface for setting up the AppViewX Cloud Connector:
    • From the product landing page (that you will see as soon as you have logged in)
      • Expand the Connectivity section and click .You will be redirected to the Settings :: Cloud Connector page.
    • From the new navigation menu (displayed by default starting product version 2022.1.0 FP3 onwards):
      1. From the menu in the top-right corner of the page, select Platform.
      2. From the Platform menu, under Connectivity, click Cloud Connector.
        The Settings :: Cloud Connector page is displayed.
    • From the old navigation menu:
      Note: For instructions on switching between the new and the old navigation menus, click here.
      1. From the top right corner of the landing page, click the menu icon.
      2. From the menu displayed, navigate to Settings > Cloud Connector.

        The Settings :: Cloud Connector page is displayed.

  28. On the Setting :: Cloud Connector page, click Add Cloud Connector.
    The Cloud Connector Setup screen is displayed.

    The landing page gives you a quick introduction to the AppViewX Cloud Connector, with a graphical representation of how the infrastructure is deployed and works.

  29. To start with the process of adding the cloud connector, from the bottom-right corner of the screen, click Get Started.
    You will be redirected to the Basic Information page.
  30. On the Basic Information page, configure the basic cloud connector settings.
    1. To install the cloud connector via the virtual image, from Installation Type, select Virtual Image.
      Note: Click here to read how a virtual image-based installation is different from a native OS installation.
    2. In the Cloud Connector Name (FQDN) field, enter the hostname of the machine on which the AppViewX Cloud Connector will be installed.
      Tip: To retrieve the hostname, from the command line terminal of the host machine, execute the following command: hostname -f:
      Note: The hostname entered here is added to the license file that will be generated and downloaded as part of the installer. Therefore, the license file can be used to install the cloud connector only on the machine with the entered hostname and no other.
      Tip: The Setup Cloud Connector section to the right of the Basic Information screen lists hyperlinks to the prerequisites required for setting up the AppViewX Cloud Connector. To read more about what the AppViewX Cloud Connector offers, click Learn More.
    3. Click Next.
  31. [Optional] Execute a prerequisite check script.
    Note: This is an optional step. The prerequisite check script is executed automatically at the time of installing the AppViewX Cloud Connector and the results are shown as a part of the installation logs.

    To simplify compliance to the AppViewX Cloud Connector installation prerequisites, you can execute a script to identify and rule out any deviations from the prerequisites.

    1. On the Basic Information screen, under Setup Cloud Connector, you will see a list of the installation prerequisites.
      From this list, for Executing the Prerequisites Check Script, to download the script, click .
      The pre-requisite-check.sh script file is downloaded.
    2. Securely copy the pre-requisite-check.sh via SCP/SFTP to the host machine where the AppViewX Cloud Connector is to be installed
    3. Convert the downloaded script file into an executable file using the chmod command, as shown below:chmod 755 pre-requisite-check.sh
    4. Execute the .sh prerequisite check script file: ./pre-requisite-check.sh
      If the node does not meet the prerequisites for the AppViewX Cloud Connector installation, the output of the command returns an error code and the corresponding error message, causes, and fixes, if any.

      For example, as seen in the sample output in the image below, the prerequisite check for the memory requirement has failed.

      Note: For resolutions to the prerequisite check failure scenarios, click here.
  32. Click Next.
    You will be navigated to the AssignData Center screen, where, for deploying the AppViewX Cloud Connector, you can either select an existing data center or add a new one.
  33. To use an existing data center, select one from the options displayed on the Assign Data Center screen.
    Tip: Alternatively, you can use the Search… field on this screen to search for an existing data center.
    To add a new data center:
    1. Click Add Data Center.
    2. In the Add Data Center dialog box, enter a name for the new data center.
    3. Click Save.
      The new data center will now be displayed on the Assign Data Center screen along with the other existing data centers.
    4. Select the required data center.
    Tip: The Data Center based routing section to the right of the Assign Data Center screen explains the concept of data center-based routing and how you can achieve high availability. To read more on this, click Learn More from the top-right corner of this screen.
  34. Click Next.
    The Advanced Configuration screen is displayed.
  35. On the Advanced Configuration page, to configure the TLS authentication and proxy server settings for your cloud connector:
    1. Enter/Select the advanced configuration settings for the AppViewX Cloud Connector.
      Note: The Data center field is auto-populated based on your selection on the Assigning a Data Center screen.
      Field Description
      TLS Authentication
      Tip: The section on the right of the screen gives you a brief context of what is TLS Authentication. To read more, click Learn More (next to the TLS Authentication heading).

      • To auto-generate a TLS certificate, select Auto-generate (default selection).

        By default, the certificate is generated using the AppViewX CA.

        Note: The created certificate is available in the certificate inventory. You can:
        • Assign this certificate to a certificate group
        • Configure a certificate expiry alert for this certificate group from the Server Certificate dashboard, using the Certificate Summary Report widget settings

      • To enter details of a custom TLS certificate, select Custom.

        The TLS Certificate Password and Custom TLS Certificate fields are displayed. The instructions for filling these fields are given below.
      TLS Certificate Password*
      Note: This field is displayed only if you have selected to enter details of a Custom TLS certificate in the TLS Authentication field.

      Password of the TLS certificate (that will be uploaded in the next step)

      Note: This is a mandatory field if a Custom TLS certificate is uploaded. AppViewX supports only password-protected Custom TLS certificates.
      TLS Certificate
      Note: This field is displayed only if you have selected to enter details of a Custom TLS certificate in the TLS Authentication field.

      To upload a custom TLS certificate:

      1. To navigate to the location of the custom TLS certificate, click within the field.

      2. Select the certificate file.

      3. Click Open.

      4. To upload the custom TLS certificate selected, click Upload.

      Note: AppViewX supports only password-protected Custom TLS Certificates.
      Use proxy
      Tip: The section on the right of the screen gives you a brief context of what is Proxy based routing. To read more, click Learn More (next to the Proxy based routing heading).

      A proxy server is required if the AppViewX Cloud Connector is unable to connect to your endpoints available in the internet.

      To use a proxy server for the deployment:

      1. Select the Use proxy checkbox.

      2. To select a preconfigured proxy (for the selected data center), from the Select Proxy dropdown list, select a proxy server.

      OR

      To create a new proxy server setting:

      1. Use the option shown below the Select Proxy dropdown list.

        The Add Proxy pop-up screen is displayed.

      2. Enter/Select the details required to add a proxy.
        Table 1. Field descriptions for the Add Proxy details
        Field Description
        *Proxy Name Name of the proxy server
        *Server IP IP address/FQDN of the proxy server
        *Port Port number of the proxy server
        URL From the dropdown menu, select the URL.
        Authentication To enable authentication for accessing the proxy server, select this checkbox.
        *Username
        Note: This field is enabled only when Authentication is selected.
        Enter the username required for accessing the proxy server.
        *Password
        Note: This field is enabled only when Authentication is selected.
        Enter the password required for accessing the proxy server.
    2. Click Finish.
      A confirmation message is displayed. AppViewX begins preparing the installer and the license file. Once the license file is ready, you can download it and proceed with the installation of the AppViewX Cloud Connector.
  36. Download the license file.
    Note: The installer is prepackaged with the OVA, so, for a virtual image-based installation, you only need to download the license file.
    1. On the Cloud Connector Added Successfully dialog box, when the License is Ready for Download, click Download License file.
      Tip: At this point, if the installer has been deleted or is not usable, and you wish to revert to a native installation, click Go to Inventory. It will take you back to the cloud connector inventory, from where you can download the license file and installer for the native OS download.
      Tip: You can also choose to download the license file and the installer package individually. To do this:

      1. Click the Cloud Connector Name.

        The selected Cloud Connector’s details are shown in a pane to your right.

      2. To download the AppViewX Cloud Connector installer package, click Download Cloud Connector. This is useful in the event that the installer has been deleted or is no longer usable.

        To download the license file, click Download License.

      Note: A installer download is made available even for a virtual-image based deployment, to help you with reconfiguration in case the existing OVA configuration is deleted.
    2. Save the license file on the OVA node.
      On the Settings :: Cloud Connector page, details of this AppViewX Cloud Connector are added in the inventory table, which is explained here.
  37. Install the AppViewX Cloud Connector Agent.
    Note: The following steps assume that:
    • All system prerequisites are fulfilled by the host machine.
    • The AppViewX Cloud Connector installer (downloaded in the above step) is securely copied via SCP/SFTP to the host machine where the AppViewX Cloud Connector is to be installed.
    1. On the node where the AppViewX Cloud Connector agent will be installed, from the extracted installation package, run the ./install.sh script.
      The script will check if the installation prerequisites for the AppViewX Cloud Connector have been fulfilled.
      Note: Ensure that the license file is placed in the same location as the install.sh script. If the license file is placed in another location, run the install.sh script using the following command:
      ./install.sh <complete path of the license file with the filename>
      On successful verification of the prerequisites, you will be prompted to specify if you want to manage f5 BIG-IP devices and if you need auto-enrollment of the certificates.
    2. When prompted, enter the required input value(s):
      Important: If you choose to not enable any of the following features, to enable them later, you will have to reinstall the AppViewX Cloud Connector.
      1. If you want manage f5 BIG-IP devices, enter y/n for yes/no, respectively.
      2. When prompted to enable auto-enrollment of the certificate using one of the following supported auto-enrollment protocols, enter y only if the cloud connector is being installed in a demilitarized zone (DMZ) or devices in a restricted environment (that disables them from connecting to the <tenant>-aep directly.
        • If you choose y (yes) here, enter the required protocol(s) name.
        Note: By default, the AppViewX certificate is enabled for auto-enrollment. To enable custom certificate for auto-enrollment:
        1. Execute the command ./avxctl upgrade gateway-cert.
        2. When prompted, enter the location of the custom certificate.
        Note: If you are a KUBE+ customer, the auto-enrollment gateway should be enabled as part of the installation for your KUBE+ use cases to work via the cloud connector.
      3. If you want to enable Syslog receiver for a near-real time configuration updates from the devices, enter y/n for yes/no, respectively. For configuring Syslog reception, refer to the Platform User guide section, Syslog Reception.

        In case you have an older version of AppViewX on cloud and want to make use of Syslog capabilities for ADC, you must manually activate the Syslog flag by setting SYSLOG_ENABLED=true in the path ccpath/deps/properties.

    3. Enter the sudo password.
      After the relevant details have been entered, the installation proceeds. Installation logs, according to the outcome of the installation, are displayed.

      Given below are sample installation logs:

      Loaded image: rancher/k3s:v1.23.3-k3s1
Loaded image: rancher/k3d-tools:5.2.2
Loaded image: rancher/mirrored-pause:3.6
[36mINFO[0m[0000] [SimpleConfig] Hostnetwork selected - disabling injection of docker host into the cluster, server load balancer and setting the api port to the k3s default 
[33mWARN[0m[0000] No node filter specified                     
[33mWARN[0m[0000] No node filter specified                     
[33mWARN[0m[0000] No node filter specified                     
[36mINFO[0m[0000] Prep: Network                                
[36mINFO[0m[0000] Re-using existing network 'host' (8bebb4ae61001f74487d0aa6b315396405d0127c938da1206614d113295ae139) 
[36mINFO[0m[0000] Created volume 'k3d-cc-images'               
[36mINFO[0m[0000] Starting new tools node...                   
[36mINFO[0m[0000] Starting Node 'k3d-cc-tools'                 
[36mINFO[0m[0001] Creating node 'k3d-cc-server-0'              
[36mINFO[0m[0001] Using the k3d-tools node to gather environment information 
[36mINFO[0m[0001] Starting cluster 'cc'                        
[36mINFO[0m[0001] Starting servers...                          
[36mINFO[0m[0001] Starting Node 'k3d-cc-server-0'              
[36mINFO[0m[0033] All agents already running.                  
[36mINFO[0m[0033] All helpers already running.                 
[36mINFO[0m[0033] Cluster 'cc' created successfully!           
[36mINFO[0m[0034] You can now use it like this:                
kubectl cluster-info
Cluster setup is completed. Will start the deployment shortly...
Importing the required images...
[36mINFO[0m[0000] Importing image(s) into cluster 'cc'         
[36mINFO[0m[0000] Importing images from 1 tarball(s)...        
[36mINFO[0m[0000] Importing images '[/home/appviewx/CCTEST/deps/tools/mid-server-docker-image/avx-mid-server-base-22.1.0.0.tar]' into node 'k3d-cc-server-0'... 
[36mINFO[0m[0024] Successfully imported image(s)               
[36mINFO[0m[0024] Successfully imported 1 image(s) into 1 cluster(s) 
Import in progress...
[36mINFO[0m[0000] Importing image(s) into cluster 'cc'         
[36mINFO[0m[0000] Importing images from 1 tarball(s)...        
[36mINFO[0m[0000] Importing images '[/home/appviewx/CCTEST/deps/tools/mid-server-docker-image/k3d-tools-5.2.2.tar]' into node 'k3d-cc-server-0'... 
[36mINFO[0m[0005] Successfully imported image(s)               
[36mINFO[0m[0005] Successfully imported 1 image(s) into 1 cluster(s) 
Import in progress...
[36mINFO[0m[0000] Importing image(s) into cluster 'cc'         
[36mINFO[0m[0000] Importing images from 1 tarball(s)...        
[36mINFO[0m[0000] Importing images '[/home/appviewx/CCTEST/deps/tools/mid-server-docker-image/rancher-mirrored-coredns-coredns-1.8.6.tar]' into node 'k3d-cc-server-0'... 
[36mINFO[0m[0007] Successfully imported image(s)               
[36mINFO[0m[0007] Successfully imported 1 image(s) into 1 cluster(s) 
[36mINFO[0m[0000] Importing image(s) into cluster 'cc'         
[36mINFO[0m[0000] Importing images from 1 tarball(s)...        
[36mINFO[0m[0000] Importing images '[/home/appviewx/CCTEST/deps/tools/mid-server-docker-image/rancher-local-path-provisioner-v0.0.21.tar]' into node 'k3d-cc-server-0'... 
[36mINFO[0m[0004] Successfully imported image(s)               
[36mINFO[0m[0004] Successfully imported 1 image(s) into 1 cluster(s) 
[36mINFO[0m[0000] Importing image(s) into cluster 'cc'         
[36mINFO[0m[0000] Importing images from 1 tarball(s)...        
[36mINFO[0m[0000] Importing images '[/home/appviewx/CCTEST/deps/tools/mid-server-docker-image/rancher-mirrored-pause-3.6.tar]' into node 'k3d-cc-server-0'... 
[36mINFO[0m[0003] Successfully imported image(s)               
[36mINFO[0m[0003] Successfully imported 1 image(s) into 1 cluster(s) 
Deploying the Cloud Connector...
NAME: avx-mid-server-starter
LAST DEPLOYED: Mon May 30 15:51:13 2022
NAMESPACE: cc
STATUS: deployed
REVISION: 1
NOTES:
1. It may take a couple of minutes for the Cloud Connector to be up.
  kubectl get pod --namespace cc
********************************************************************
*    Congratulations!!! The installation completed successfully.   *
*    Please wait till the Cloud Connector is up and running.       *
********************************************************************
(1%) Cloud Connector status: Running
[32m Cloud Connector is up and running. (B[m
      Troubleshooting: For installation errors, refer to the Troubleshooting section.
      The AppViewX Cloud Connector consists of two important components—the starter plugin and the platform. The starter plugin component is installed along with the AppViewX Cloud Connector, in the same installation process.

      When installed, the starter plugin is used to initiate the download of the platform component. The platform component is used to host business use cases related to the AppViewX Cloud Connector. When the platform component download is in progress, it is indicated by the symbol prefixed to the platform component version number in the AppViewX Cloud Connector inventory details . A completed download/upgrade is indicated by the symbol in the same location .

      Note: Based on the internet bandwidth and the number of cloud connectors being installed, the downloading of the cloud connector may vary between 5 to 15 minutes.
  38. To approve the cloud connector installation:
    1. Go to (Menu) > Platform > Connectivity > Cloud Connector.
      The Settings :: Cloud Connector inventory page is displayed.
    2. For the cloud connector instance installed, from the Actions column, click Approve.
    Troubleshooting: If the AppViewX Cloud Connector instance has been approved but is not moved to the Running state, you can check the pod status and/or restart the pod(s), as required.