Installation - Java Linux Agent on an Open Liberty Application Server
Open Liberty Compatibility
vFunction supports Open Liberty version 21 and later.
Installation Wizard
To help with the installation process, vFunction offers an Installation Wizard. This Wizard provides additional information about the Prerequisites as well as steps for deploying the vFunction Agent to your environment.
Please contact support@vfunction.com or your vFunction Contact(s) for the password to start using this Wizard.
Installation Workflow
- Ensure Prerequisites are met
- Download the vFunction Sudoless Controller Installation TGZ
- SSH to the Linux VM as the user who runs the Application / Application Server
- Move the Installation TGZ to the location on the Linux VM where vFunction should run
- Extract the vFunction Installation Package
### Replace VERSION with the actual value
tar -xvzf vfunction-controller-sudo-less-installation.vVERSION.tgz
- Optional: Add Environment Variables for the vFunction Dynamic Agent
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-dynamic-agent/java/linux
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_NAME="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_HOST="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_ORG_ID="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_APP_ID="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_CLIENT_ID="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_CLIENT_SECRET="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_CONTROLLER_INSTANCE_ID="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_AGENT_APPLICATION_SERVER="CHANGE_ME"
export VF_CONTROLLER_DEFAULT_JAVA_AGENT_APPLICATION_JAVA_VERSION="CHANGE_ME"
- Optional: Alternatively to Step #6, open the BASE_DIR/vfunction/etc/sysconfig/vfunction/installation/instances/default-java/installation.yaml to set the same values instead of using Environment Variables
# See description in https://kb.vfunction.com/installations/configurable-settings/mono-dynamic-agent/java/linux
controller:
name: qa-liberty1
host: http://10.0.0.1
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: qa-lib1
type: java
instrconf_additions:
inclusions:
# - a.b.c.
exclusions:
# - a.b.c.
tags:
- qa
server_application:
# name:
# include_classes: com.
# allowed_users:
# new_user_default_password:
agent:
### Disable JDBC DB Tracking ###
disable_jdbc: false
### Disable Spring Tracking ###
disable_spring: false
### Optional application servers: weblogic, websphere85, websphere9, liberty, tomcat, wildfly, payara, other ###
application_server: liberty
### Indicate the application java version when greater than 8. (optional - default to 8) ###
application_java_version: 11
override_properties:
# - key=value
- Run the installation script
### Replace the BASE_DIR with the actual value, such as /tmp/
bash BASE_DIR/vfunction/opt/vfunction/controller-installation/install.sh -i default-java
- Find and note the base path to your Open Liberty Application Server
### This should return the location of the Open Liberty's SERVER_CONFIG_DIR
find / -name 'server.xml' -type f 2&>/dev/null
- Add the startup parameters to your Open Liberty Application Server’s jvm.options:
### Replace the BASE_DIR with the actual value, such as /tmp
### Replace SERVER_CONFIG_DIR below with the actual value
cat BASE_DIR/vfunction/etc/sysconfig/vfunction/agent/instances/default-java/vmargs-examples/liberty >> SERVER_CONFIG_DIR/jvm.options
- Restart the Open Liberty instance
- Confirm that the Application comes up and functions as expected
- If any issues arise: