FlexDeploy HTTPS Agent - Installation Guide

The FlexDeploy HTTP Agent distribution contains the following components:

A Tomcat 9 server with required libraries, and base configurations
The Https Agent WAR

Step 1. Ensure Java 8 is installed on the server.

Setting JAVA_HOME in the configuration will be done later. This Java will be used to run the Tomcat server. A different Java version can be specified on the endpoint configuration in FlexDeploy and those will be used to actually execute plugins.

Step 2. Prepare software

Download and unzip the HTTPS Agent software using wget, curl, or manually from the Flexagon Support Portal.

# select folder location where the agent will be downloaded
export SOFTWARE_HOME=/u01/software
mkdir -p $SOFTWARE_HOME
cd $SOFTWARE_HOME

# The HTTPS agent version should match your FlexDeploy version.
# Please see https://support.flexagon.com/a/solutions/articles/5000887932 and find the corrent download link.
wget -O HttpsAgentTomcatComplete.zip <link from support site>
or
curl -L --max-redirs 5 <link from support site> --output HttpsAgentTomcatComplete.zip

If the endpoint does not have internet access you can download the agent from the Flexagon Support Portal and transfer the zip file manually.

Extract the zip file in the desired location (referred to as "HTTPS_AGENT_HOME" in this document).

export HTTPS_AGENT_HOME=/u01/flexdeployhttpsagent
cd $HTTPS_AGENT_HOME
unzip /u01/software/HttpsAgentTomcatComplete.zip .

Step 3. Configure authentication

You must configure the user to have the role 'FlexDeployHTTPSAgent'

Basic Auth

To configure basic auth, use the username and password being stored in tomcat-users.xml.

For basic configuration only, the password needs to be configured in the given HTTPS_AGENT_HOME/apache-tomcat-flexdeploy-https-agent/conf/tomcat-users.xml file. Here’s what that will look like:

<role rolename="FlexDeployHTTPSAgent" />
<user
username="tomcat" 
password="PASSWORD" 
roles="FlexDeployHTTPSAgent" />

Active Directory/LDAP

For LDAP use we will need to change the HTTPS_AGENT_HOME/apache-tomcat-flexdeploy-https-agent/conf/server.xml file. By default it is configured to use a UserDatabase realm instead of the JNDI realm we are looking for.

Start by commenting out the existing UserDatbase realm. Then let’s uncomment the included JNDI realm, that should look like the following:

Next, add the organization specific LDAP/Azure Directory configuration.

Make sure the user you are trying to connect with has the FlexDeployHTTPSAgent role or they will not be able to connect.

If you are using Active Directory, the pre-windows 2000 username will be used. See what that looks like in Active Directory below.

For more information about using LDAP/Active Directory see the tomcat documentation how to for realms, and also the configuration reference.

Step 4. Configure SSL

The use of SSL is required. Steps will be listed for self signing, as well as importing an existing certificate.

Self Signed

Run the following command and generate the self signed certificate in the HTTPS_AGENT_HOME/config directory.

When prompted enter a password for the keystore.

Then when prompted for your name input the hostname for the server. This is important, if this step is missed the FlexDeploy server will not trust the certificate. The rest of the information is not needed (although you can input it).

After that you will be prompted for the password for the tomcat key, press enter to use the same password as the keystore. This is required by Tomcat.

Next export the certificate in order to add it to the FlexDeploy server’s trust store.

Existing Certificate

First generate your certificate using whatever method you would usually use.

Next convert the certificate to pk12 format.

Now import the pk12 format cert into a java keystore. This will also generate the keystore if it does not exist. It is recommended to put the keystore into the HTTPS_AGENT_HOME/config directory.

Configure Tomcat and Import Public Key

Next configure the keystore password (and the location of the file if not generated in the config directory). Open up the HTTPS_AGENT_HOME/apache-tomcat-flexdeploy-https-agent/conf/server.xml file. Find the SSL connector (by default set for port 8444) and add the keystore password like this: If you made the alias tomcat, this will be enough. Otherwise, add key

Now import the certificate into the java trust store on the FlexDeploy server.

First copy over the certificate that was generated (with the .cer extension). If you used an existing certificate, this should be the root certificate’s public key. You may have already configured this.

Next determine the Java install used by the FlexDeploy server.

If JAVA_HOME is set in your setenvoverride.sh file, use that directory.

If it is not set, but it is already set in your system use that value. Run echo "$JAVA_HOME" to find that out.

If it’s not set in setenvoverride.sh or the environment run this command to find the path used dirname $(dirname $(readlink -f $(which javac)))

Then run the following command on the server.

The default password for the java keystore is changeit.

Now the server will be able to connect to the endpoint. It is not necessary to restart the FlexDeploy server after adding a certificate.

Step 5. Start the Agent

Execute the StartFlexDeployHttpsAgent.sh (or StartFlexDeployHttpsAgent.bat) script to start the agent.

Next Steps

To manage FlexDeploy properties locally on the endpoint without the need to send them through HTTPS requests to the agent checkout this page.

Create the endpoint on your FlexDeploy server.