The HTTPS_AGENT_HOME variable referenced here is the installation directory of the agent, which contains the apache-tomcat-flexdeploy-https-agent and config folders as well as the start and stop scripts.
Step 1. Stop the Agent
Linux
cd $HTTPS_AGENT_HOME ./StopFlexDeployHttpsAgent.sh
Windows
cd %HTTPS_AGENT_HOME% StopFlexDeployHttpsAgent.bat
Step 2. Download HTTPS Agent software
Download and unzip the latest version of the agent into a temporary location (for example, /u01/software/temp/agent), so it can be accessed during the upgrade process.
The agent software can be downloaded from the Flexagon Support Portal and transferred to the endpoint, or can be downloaded directly on the endpoint using wget or curl (provided internet access is available on endpoint).
Do not unzip the distribution directly into the HTTPS_AGENT_HOME directory so we can prevent existing configuration file(s) or folder(s) from being overwritten.
Linux
HTTPS_AGENT_TEMP=/u01/software/temp/agent (you may change this to any directory, but don't use HTTPS_AGENT_HOME or anything inside HTTPS_AGENT_HOME) mkdir -p ${HTTPS_AGENT_TEMP} cd ${HTTPS_AGENT_TEMP} # 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 unzip HttpsAgentTomcatComplete.zip
Windows
set HTTPS_AGENT_TEMP=c:\u01\software\temp\agent mkdir %HTTPS_AGENT_TEMP% (you may change this to any directory, but don't use HTTPS_AGENT_HOME) cd %HTTPS_AGENT_TEMP% # Download https://flexagon.com/downloads/httpsagent in HTTPS_AGENT_TEMP folder unzip HttpsAgentTomcatComplete.zip
Step 3. Backup Current Installation
Backup the current apache-tomcat-flexdeploy-https-agent folder. This will be used to reference the existing configuration.
This step is required. Otherwise the existing configuration will be lost later on.
Linux
cd $HTTPS_AGENT_HOME mv apache-tomcat-flexdeploy-https-agent apache-tomcat-flexdeploy-https-agent-old
Windows
cd %HTTPS_AGENT_HOME% rename apache-tomcat-flexdeploy-https-agent apache-tomcat-flexdeploy-https-agent-old
Step 4. Apply new version
Copy the apache-tomcat-flexdeploy-https-agent folder from the download.
Linux
cd $HTTPS_AGENT_HOME cp -r ${HTTPS_AGENT_TEMP}/apache-tomcat-flexdeploy-https-agent .
Windows
cd %HTTPS_AGENT_HOME% mkdir apache-tomcat-flexdeploy-https-agent xcopy %HTTPS_AGENT_TEMP%\apache-tomcat-flexdeploy-https-agent apache-tomcat-flexdeploy-https-agent /s
Step 5. Apply old configuration
Apply the old configuration from the backup.
Linux
cd $HTTPS_AGENT_HOME cp apache-tomcat-flexdeploy-https-agent-old/conf/server.xml apache-tomcat-flexdeploy-https-agent/conf/server.xml cp apache-tomcat-flexdeploy-https-agent-old/conf/tomcat-users.xml apache-tomcat-flexdeploy-https-agent/conf/tomcat-users.xml
Windows
cd %HTTPS_AGENT_HOME% copy apache-tomcat-flexdeploy-https-agent-old/conf/server.xml apache-tomcat-flexdeploy-https-agent/conf/server.xml copy apache-tomcat-flexdeploy-https-agent-old/conf/tomcat-users.xml apache-tomcat-flexdeploy-https-agent/conf/tomcat-users.xml
You may remove the apache-tomcat-flexdeploy-agent-old directory after testing the connection in step 7.
Step 5.1 - Adjust server.xml
Beginning with Agent version 6.5.0.8 we will be shipping a server.xml change that only allows TLS 1.2. Since the old server.xml was copied from the previous install we recommend you make this change as well.
You will need to change the sslProtocol to be TLSv1.2 instead of just TLS. Here’s what the change will look like in the connector:
<Connector port="8444" protocol="org.apache.coyote.http11.Http11NioProtocol" maxThreads="150" secure="true" clientAuth="false" sslProtocol="TLSv1.2" SSLEnabled="true" keystoreFile="../config/tomcat.jks" keystorePass="*PASSWORD_HERE*"> </Connector>
Step 6. Start Agent
Linux
cd $HTTPS_AGENT_HOME ./StartFlexDeployHttpsAgent.sh
Windows
cd %HTTPS_AGENT_HOME% StartFlexDeployHttpsAgent.bat
Step 7. Perform Test Connection of Endpoint
Visit this page for details on testing connectivity from FlexDeploy to the Agent endpoint.
Running multiple agents on the same endpoint
This is sometimes necessary when upgrading your non production environment, and you need to test the connection to that endpoint while still keeping it available for your production server.
First copy your existing install to a new location. Next follow the upgrade instructions above.
Next modify the shutdown port
... <Server port="CHANGE ME" shutdown="SHUTDOWN"> <Listener className="org.apache.catalina.startup.VersionLoggerListener" /> ...
And also the connector port
<Connector port="CHANGE ME" protocol="org.apache.coyote.http11.Http11NioProtocol" maxThreads="150" secure="true" clientAuth="false" sslProtocol="TLSv1.2" SSLEnabled="true" keystoreFile="../config/tomcat.jks" keystorePass="*PASSWORD_HERE*"> </Connector>
Make sure both of these ports are not being used by anything else.
Now when you test your connection update the ports (in FlexDeploy) to the new ports reflected here.