Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To unpack the Universal Controller distribution file, use the following method appropriate for your platform:

Linux/Unix


Panel
tar xvf uc-controller-N.N.N.N.tar


Windows

Use an appropriate archiving / unzipping product.

...

To install the Controller, issue the following command that is appropriate for your platform:

Linux


Panel
> sh install-controller.sh 


Windows


Panel
> install-controller.bat


You must include command line switches that specify information the Controller needs to access the Tomcat installation directory, the war file, and the database. You can include additional command line switches, but they are not required.

...

Command Line Switch

Description

Default

Required

Controller Property


Panel
--controller-file


Full path of the Universal Controller war file from the downloaded Universal Controller package.

none

Yes



Panel
--dbname


Universal Controller database name.

uc

No

uc.db.name=


Panel
--dbpass


Database user's password.

none

Yes

uc.db.password=


Panel
--dburl


JDBC connection URL.
 
Format:   jdbc:<jdbc vendor>:<other jdbc vendor data>
 
Examples (for MS SQLServer, uc is the database name; for Oracle, XE is the SID):
 

Include Page
UC70IL:dburl examples - 7.0.0.0UC70
IL:dburl examples - 7.0.0.0

jdbc:mysql://localhost

No

uc.db.url=


Panel
--dbuser


Database user name.

none

Yes

uc.db.user=


Panel
--port


Used by the Universal Controller to generate a unique Cluster Node Node Id in the format of hostname:port-dbname.

Note
titleNote

This is meant to represent the value of the Tomcat HTTP/1.1 Connector port configured in the server.xml.

It is used solely for Node Id generation and does not impact the Tomcat HTTP/1.1 Connector configuration.


8080

No

uc.servlet.port


Panel
--rdbms


Database type.
 
Valid values are:

  • mysql
  • sqlserver
  • oracle
Note
iconfalse

* --rdbms is required if --dburl is used in the command.


mysql

No *

uc.db.rdbms=


Panel
--tomcat-dir


Path to the Tomcat installation directory (contains the directories:/bin, /conf, /logs, webapps).

none

Yes


...

Shown below are sample commands for installing the Controller on Linux and Windows platforms, using defaults for the database:

Linux


Panel
sh install-controller.sh --tomcat-dir ~/tomcat --controller-file ./uc-controller-N.N.N.N-build.N.war --dbuser root --dbpass userpass


Windows


Panel
install-controller.bat --tomcat-dir "c:\Program Files\Apache Software Foundation\Tomcat 8.5"
--controller-file uc-controller-N.N.N.N-build.N.war --dbuser root --dbpass userpass


Note
titleNote

In the Tomcat directory (--tomcat-dir), when quoting the directory is necessary due to spaces, do not use a single backslash before the ending quotation mark; use either a double backslash or no backslash to avoid the command shell from treating \" as an escape character.


...

Step 1

Start Tomcat as follows:
 
Linux
Start the Tomcat daemon using the script placed in the /etc/init.d directory for Tomcat.
 

Panel
service [name of Tomcat service] start

 
Windows
We recommend you use Windows Services to start Tomcat. Or, you can start Tomcat from the command line as follows:
 

Panel
net start [name of Tomcat service]

 
Linux or Windows
You can start the service using the $CATALINA_HOME/bin/startup.bat or $CATALINA_HOME/bin/startup.sh scripts.

Anchor
Opswise log
Opswise log
Step 2

You can view details of the start-up in the Tomcat window or monitor the Controller log, as described below:
 
Linux/Unix
Users can tail the uc.log to monitor the deployment process, as follows:
 

Panel
tail -f $TOMCAT_DIR/uc_logs/uc.log

 
Windows
Users can use a third-party tailing utility or open the log file using Notepad or other editor and scroll to the bottom to view the latest activity.
 

Panel
$TOMCAT_DIR/uc_logs/uc.log


Step 3

When you see the following, the Controller is ready:

  • INFO [Ops.Cluster.Monitor.0] Server is now Running in Passive mode.
  • INFO [Ops.Cluster.Monitor.0] Setting server to PASSIVE.

Step 4

AIX and z/Linux only: Follow this procedure to change two default values in the Universal Controller start-up properties file, uc.properties, which is read by the Controller.
 
(The uc.properties file resides in <tomcat directory>/webapps/uc/WEB-INF/properties).
 

  1. Change the following two properties from their default value to the AIX - z/Linux value:
     
    • uc.trustmanager.algorithm= (Java trust manager algorithm)
      • Default value = SunX509
      • AIX - z/Linux value = IbmX509
         
    • uc.trustmanager.provider= (Java trust manager provider)
      • Default value = SunJSSE
      • AIX - z/Linux value = IBMJSSE2
         
  2. Restart Tomcat.

...