Install - Java Linux Static Agent on Host with Sudo / Root Access



Installation Wizard

To help with the installation process, vFunction offers an Installation Wizard. This Wizard provides additional information about the Prerequisites as well as the Required and Optional Settings for installing the vFunction Server and Agents. This Wizard also walks you through each step in the Installation process.

Please contact support@vfunction.com or your vFunction Contact(s) for the password to start using this Wizard.


Installation Steps

  1. Ensure Prerequisites are met
  2. Download the vFunction Sudo Controller Installation TGZ
  3. SSH to the Linux VM as the root user or a user with Sudo access
  4. Move the Installation TGZ to the Linux VM
  5. Extract the vFunction Installation Package
### Replace VERSION with the actual value
tar -Pxvzf vfunction-controller-installation.vVERSION.tgz
  1. Create the Viper vFunction instance
bash /opt/vfunction/controller-installation/create-instance.sh -i viperinst -t java -v
  1. Optional: Add Environment Variables for the vFunction Static Agent
# See descriptions in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux
export VF_CONTROLLER_VIPERINST_CONTROLLER_NAME="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_HOST="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_ORG_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_APP_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_CIENT_SECRET="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_INSTANCE_ID="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_CONTROLLER_TAGS="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_VIPER_JVM_MEMORY_PARAMS="CHANGE_ME"
export VF_CONTROLLER_VIPERINST_VIPER_ARCHIVES="CHANGE_ME"

### Sample Values
export VF_CONTROLLER_VIPERINST_CONTROLLER_NAME="prod-viper"
export VF_CONTROLLER_VIPERINST_CONTROLLER_HOST="http://172.31.15.51"
export VF_CONTROLLER_VIPERINST_CONTROLLER_ORG_ID="1111-11-11-1111"
export VF_CONTROLLER_VIPERINST_CONTROLLER_APP_ID="1111-11-11-1111"
export VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_ID="1111-11-11-1111"
export VF_CONTROLLER_VIPERINST_CONTROLLER_CIENT_SECRET="1111-11-11-1111"
export VF_CONTROLLER_VIPERINST_CONTROLLER_INSTANCE_ID="viper"
export VF_CONTROLLER_VIPERINST_CONTROLLER_TAGS="prod,qa"
export VF_CONTROLLER_VIPERINST_VIPER_JVM_MEMORY_PARAMS="-Xms300m -Xmx4g -Xss50m"
export VF_CONTROLLER_VIPERINST_VIPER_ARCHIVES="/opt/payara/deployments/*.ear"
  1. Optional: Alternatively to Step #7, open the /etc/sysconfig/vfunction/installation/instances/viperinst/installation.yaml to set the same values instead of using Environment Variables
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/linux
controller:
  name: prod-viper
  host: http://172.31.15.51
  org_id: 1111-11-11-1111
  app_id: 1111-11-11-1111
  client_id: 1111-11-11-1111
  client_secret: 1111-11-11-1111
  instace_id: viper
  type: java
  instrconf_additions:
    inclusions:
#      - a.b.c.
    exclusions:
#      - a.b.c.
  tags:
    - prod
    - qa
  client_certificate:
    crt: |
      -----BEGIN CERTIFICATE-----
      ...
      -----END CERTIFICATE-----      
    key: |
      -----BEGIN PRIVATE KEY-----
      ...
      -----END PRIVATE KEY-----      

server_application:
#  name:
#  include_classes: com.
#  allowed_users:
#  new_user_default_password:

viper:
  jvm_memory_params: "-Xms300m -Xmx4g -Xss50m"
  archives:
    - /opt/payara/deployments/*.ear
#    - /opt/<my-application>/**/*.jar
#    - /opt/<my-application>/**/*.
  ### Supported only for Oracle databases!
  stored_procedure:
#    db_url:
#    db_user:
#    db_password:
  spring:
    custom_context_roots:
#      - path/to/custom-conf.xml
#      - another-custom-conf.xml
    root_bean_classes:
#      - a.b.c.Foo
#      - a.b.c.Bar
  1. Run the installation script
bash /opt/vfunction/controller-installation/install.sh -i viperinst
  1. Confirm that the Viper comes up as expected in the vFunction Server UI

  2. If any issues arise: