Install - Java Windows Static Agent on Host with Admin Access



Installation Steps

Take the following steps to install the vFunction Java Windows Agent on a Host with Admin access:

  1. Ensure Prerequisites are met
  2. Download the vFunction Controller Windows Installation ZIP from the vFunction Portal
  3. Move the Controller ZIP package to the Windows Server
  4. Extract the ZIP to the desired directory, such as C:\vfunction\
  5. Retrieve the vFunction UI’s Application UUIDs:
  1. Log into the vFunction Server’s UI in a browser
  2. In the top-left corner, click the dropdown and select the relevant Application
  3. In the top-center menu bar, click the “Learning” tab
  4. On the left-side, click the “Select Controllers” link
  5. On the left-side, click the “Install Controller” link
  6. In the dialog box, find the YAML-formatted text box that contains the following details. You’ll need these details at a later stage below:
controller:
  name: {display name for this controller}
  host: $your_VF_Server_address
  org_id: 93af7f38-0000-0000-0000-bd9516798497
  app_id: 9fb228fc-0000-0000-0000-db8e83427e14
  client_id: caeadcd1-0000-0000-0000-9c9b37a9e119
  client_secret: 68cb85eb-0000-0000-0000-fb9e7f1d9240
  1. Open Powershell as an Administrator and unblock the files in the installation directory. Replace REPLACE_BASE_DIR with the actual value.
dir -Path "REPLACE_BASE_DIR" -Recurse | Unblock-File
  1. In Powershell, create the instance, set the environment variables and run the installation script. Replace the INSTANCE_NAME and REPLACE_BASE_DIR with the actual values.
# Replace REPLACE_BASE_DIR with the actual installation path
# Replace CHANGE_ME with the appropriate values using descriptions ...
# in https://kb.vfunction.com/installations/configurable-settings/mono-static-agent/java/windows as a guide

powershell -NoProfile -ExecutionPolicy unrestricted -Command "REPLACE_BASE_DIR\vfunction\controller-installation\create-instance.ps1 -instance viperinst -type java -viperMode true;$env:VF_CONTROLLER_VIPERINST_CONTROLLER_NAME='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_HOST='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_ORG_ID='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_APP_ID='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_ID='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_SECRET='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_INSTANCE_ID='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_TAGS='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_VIPER_JVM_MEMORY_PARAMS='CHANGE_ME';$env:VF_CONTROLLER_VIPERINST_VIPER_ARCHIVES='CHANGE_ME';REPLACE_BASE_DIR\vfunction\controller-installation\install.ps1 -instance viperinst"

### Sample Values
powershell -NoProfile -ExecutionPolicy unrestricted -Command "C:\vfunction\controller-installation\create-instance.ps1 -instance viperinst -type java -viperMode true;$env:VF_CONTROLLER_VIPERINST_CONTROLLER_NAME='prod-viper';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_HOST='http://172.31.15.51';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_ORG_ID='1111-11-11-1111';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_APP_ID='1111-11-11-1111';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_ID='1111-11-11-1111';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_CLIENT_SECRET='1111-11-11-1111';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_INSTANCE_ID='viper';$env:VF_CONTROLLER_VIPERINST_CONTROLLER_TAGS='prod,qa';$env:VF_CONTROLLER_VIPERINST_VIPER_JVM_MEMORY_PARAMS='-Xms300m -Xmx4g -Xss50m';$env:VF_CONTROLLER_VIPERINST_VIPER_ARCHIVES='C:\app\bin';C:\vfunction\controller-installation\install.ps1 -instance viperinst"
  1. Confirm that the Viper comes up as expected in the vFunction Server UI
  2. If any issues arise: