Installing the AppViewX Cloud Connector

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. To extract the installer, from the downloaded package, extract the tar.gz file using the command given below: tar -zxvf <filename>.tar.gz
    For example: tar - zxvf pesrv07-test-94-99-appviewx-appviewx-net-cloud-connector.tar.gz
  2. 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.
  3. Enter the required input value:
    Important: If you choose to not enable any of the following features, you will have to reinstall the AppViewX Cloud Connector to enable them later.
    1. If you want to manage f5 BIG-IP devices, enter y/n for yes/no, respectively.
    2. Choose from the available installation modes for configuring the cloud connector:
      • Standard mode: This is the default installation mode, enabling basic Cloud Connector features, including Auto enrollment gateways for certificate management.
      • Advanced mode: In this mode, you gain access to advanced functionalities such as managing F5 devices, receiving Syslog from endpoints, and SSH Web Terminal for SSH+.

      Read the descriptions for the standard and advanced modes, and enter your choice. (Enter 1 for standard mode and 2 for advanced mode.)

    3. If you need auto-enrollment of the certificate using one of the following supported auto-enrollment protocols, enter y/n for yes/no, respectively.
      • If you choose y (yes) here, enter the required protocol(s) name. SSH server is installed.
      • If you choose n(no), you will see this prompt:

        Do you want to enable SSH Terminal Server for using SSH terminal usecase (y/n)?

        If you choose y, SSH server is installed.

    4. 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 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.

  4. 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.