Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The FlexDeploy HTTP Agent distribution contains the following components:

  • A tomcat 9 server with required libraries, and base configurations

  • The HttpAgent WAR

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

You can set JAVA_HOME in the configuration later. This Java will be used to run the tomcat server, different Java versions can be selected on the endpoint configuration in FlexDeploy and those will be used to actually execute the plugin.

Step 2. Prepare software

The HTTP Agent can be downloaded from the Flexagon Support Site. You will download specific version of agent (This will correspond with FlexDeploy version), download file is named Tomcat_Complete-X.X.X.X.zip, where X.X.X.X represents four digit version number.

Extract the zip file in the desired location (referred to as "HTTPS_AGENT_HOME" in this document). See example below, where zip was extracted in /u01/httpsagent folder.

Screenshot

Step 3. Configure authentication

We are going to configure basic auth, with the username and password being stored in tomcat-users.xml.

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

For basic configuration you will only need to configure password in the given tomcat-users.xml file. Here’s what that will look like:

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

Step 4. Configure SSL

The use of SSL is required. These steps will be for generating and using a self signed certificate. You can of course use any other certificate compatible with Tomcat. See the Tomcat Documentation for more details.

Let’s generate the self signed certificate in the HTTPS_AGENT_HOME/config directory. Run the following command.

keytool -genkey -keyalg RSA -alias tomcat -keystore tomcat.jks -validity 365 -keysize 2048

When prompted enter a password for the keystore.

Then when prompted for your name input the hostname for the server. 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.

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

keytool -export -keystore tomcat.jks -storepass <password> -alias tomcat -file httpsagent.cer

The last thing we need to do on the endpoint is 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:

<Connector port="8444" protocol="org.apache.coyote.http11.Http11NioProtocol"
           maxThreads="150" scheme="https" secure="true"
           clientAuth="false" sslProtocol="TLS" SSLEnabled="true"
           keystoreFile="../config/tomcat.jks" keystorePass="KEYSTORE PASSWORD HERE">
</Connector>

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

First copy over the certificate we generated (with the .cer extension).

Next let’s determine the java install used by the FlexDeploy server.

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

If you didn’t set it, 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 we can run the following command on the server.

keytool -import -noprompt -trustcacerts -alias tomcat -file httpsagent.cer -keystore "JAVA_INSTALL_PATH/jre/lib/security/cacerts" -storepass changeit

Now your server will be able to connect to the endpoint.

Step 5. Start the server.

Run the StartFlexDeployHttpsAgent.sh script to start the agent.

  • No labels