Self-Managed Intelligent Advisor Command-Line Install Reference

This topic describes how to use the install.sh script in a non-interactive mode. (The install.cmd file is the equivalent file for Windows installations.) This can be used to perform a secure unattended installation.

Note: The non-interactive install process uses WebLogic Scripting Tool (WLST). If WLST is not enabled, you will need to Manually Install Self-Managed Intelligent Advisor.

In each case the first parameter must be the action command to be executed. All other parameters must be provided on the command line. For example:

./install.sh install -name=devtest ...

Note that parameters corresponding to passwords and encryption keys should be read from a secure location and piped through to install.sh.

To run the install.sh script in non-interactive mode:

  1. Type ./install.sh into the command line to launch the install.sh shell script.
  2. Type the name of the action.
  3. Enter values for the required command-line parameters.
  4. Read any sensitive parameters from a secure location and pipe them through to install.sh immediately after the final non-sensitive command-line parameter.

The following table lists the actions that can be performed using the non-interactive install.

Table 1. Install script actions
Action for install.sh Description Required parameters Further information
install

Starts a full install, which:

  • creates and configures the MySQL or Oracle application database, and
  • deploys the web applications.
 All parameters for a full install must be provided.  
install_database Installs the database only, for either MySQL or Oracle. No web applications are built. All parameters for the database must be provided.  
redeploy Rebuilds and redeploys the web applications. If the database is from a previous version, it upgrades the database (schema and data) to the current version. All parameters for a full install (except the deployment target and admin password) must be provided. See Redeploy Intelligent Advisor Web Applications
undeploy Removes the web applications and JNDI Datasource from WebLogic. WebLogic connection information must be provided. See Undeploy Intelligent Advisor Web Applications
build_webapps Builds the Intelligent Advisor Web applications so they can be manually deployed to WebLogic Database connection information and encryption key must be provided.  
reset_password Resets the admin user password. Database connection information must be provided. See Reset the Password for Intelligent Advisor Administrators
update_memcached Updates the memcached settings for an Intelligent Advisor site.    
upgrade_database Upgrades the MySQL or Oracle database schema to the current version (if older).    

There are additional actions that can be run as admin functions. To do this, execute the admin.sh script. (The admin.cmd file is the equivalent file for Windows installations.) For example:

./admin.sh list_properties -name=devtest ...

The following table lists the actions for the admin script.

Table 2. Admin script actions
Action for admin.sh Description Required parameters Further information
reset_password Resets the admin user password. Also available from the install.sh script Database connection information must be provided See Reset the Password for Intelligent Advisor Administrators
list_properties Lists the changeable (public) properties of an Intelligent Advisor site Database connection information must be provided See View a list of Intelligent Advisor Hub configuration properties and values
set_property Sets a property to a specified value Database connection information must be provided See Set an Intelligent Advisor Hub Configuration Property to a Particular Value
kick_memcached Resets all Intelligent Advisor memcached information Database connection information must be provided  
upload_deployment Uploads an Intelligent Advisor policy model to an Intelligent Advisor site   See Deploy a Project From the Command Line
download_deployment Downloads an Intelligent Advisor policy model from an Intelligent Advisor site   See Download a Deployed Project From the Command Line 

./install.sh install -name=<name> -dbconn=<mysql server:port> -dbuser=<mysql user> -wldomain=<path to wldomain> -wlstdir=<path to wlst dir> -wladmin=<admin server name> -wladminurl=<admin server url> -target=<target server or cluster> << EOF
-dbpass=<MySQL database password>
-key=<encryption key>
-resetpass=<admin user password>
EOF

./install.sh redeploy -name=<name> -dbconn=<mysql server:port> -dbuser=<mysql user> -wldomain=<path to wldomain> -wlstdir=<path to wlst dir> -wladmin=<admin server name> -wladminurl=<admin server url> << EOF
-dbpass=<MySQL database password>
-oldkey=<existing encryption key>
-key=<new encryption key>
EOF

./install.sh undeploy -name=<name> -wldomain=<path to wldomain> -wlstdir=<path to wlst dir> -wladmin=<admin server name> -wladminurl=<admin server url>

./install.sh build_webapps -name=<name> << EOF
-key=<encryption key>
EOF

Notes:

  • Once the web applications are built, you will need to manually deploy them.
  • For security reasons, delete the built web applications once they have been deployed.

The following table lists the command-line parameters that are used in the Intelligent Advisor installer.

Table 3. The command-line parameters taken by the Intelligent Advisor installer
Parameter Description Actions that require this parameter Examples

name

The deployment name for the Intelligent Advisor runtime. For more information, see Choose a Deployment Name for the Intelligent Advisor Hub Application.

Install

Redeploy

Undeploy

Build web apps

Reset password

 -name=demo

dbconn

The URL of the database connection. This is the server and port that the Intelligent Advisor runtime JDBC datasource will connect to. It is also used to create the Intelligent Advisor Hub database.

For a MySQL database connection, the format is –dbconn=localhost:<port number>.

For an Oracle database connection, the format is either –dbconn=localhost:<port number>:<DB> or –dbconn=localhost:<port number>/<PDB>, where "DB" or "PDB" is the database identifier.

Install

Redeploy

Reset password

MySQL:

-dbconn=localhost:3306

Oracle:

-dbconn=localhost:1521:OPADB

-dbconn=localhost:1521/OPAPDB1

dbuser

The name of the database user created during the steps Setup MySQL Schema or Setup Oracle Database. This is the user name that the Intelligent Advisor runtime JDBC datasource will connect to via the connection URL dbconn (see above).

Install

Redeploy

Reset password

 -dbuser=opa_user

dbpass

The password of the database user. This is the password that the Intelligent Advisor runtime JDBC datasource will connect to via the connection URL dbconn (see above). For security reasons, this password should not be passed on the command line.

Install

Redeploy

Reset password

 -dbpass=mysecretpassword

dbtype

The Intelligent Advisor database type. This parameter is optional if the database type is MySQL (the default). Valid values are "mysql" or "oracle".

Install

Redeploy

Reset password

 -dbtype=oracle

wldomain

The WebLogic domain directory to be used by the Intelligent Advisor runtime. If not provided, the script tries to determine a default WebLogic domain directory.

If any of the scripts are being run from the weblogic MIDDLEWARE_HOME directory it will use the default: MIDDLEWARE_HOME/user_projects/domains/base_domain

Install

Redeploy

Undeploy

Linux:

-wldomain=/apps/oracle/weblogic-12c/user_projects/domains/base_domain

-wldomain=/app/oracle/middleware/user_projects/domains/base_domain

Windows:

-wldomain=C:\Oracle\Middleware\Oracle_Home_12.2.1.3\user_projects\domains\base_domain

wlstdir

The location of the WebLogic Scripting Tools (wlst.sh). If not provided, the script tries to determine a default wlst directory.

If any of the scripts are being run from the weblogic MIDDLEWARE_HOME directory it will use the default: MIDDLEWARE_HOME/wlserver<version>/common/bin

Install

Redeploy

Undeploy

Linux:

-wlstdir=/Oracle/Middleware/wlserver/common/bin

Windows:

-wlstdir=C:\Oracle\Middleware\Oracle_Home\wlserver\common\bin

wladmin

The name of the WebLogic administration server for the specified domain. If not provided, the default administration server name is "AdminServer".

Install

Redeploy

Undeploy

 -wladmin=AdminServer

wladminurl

The URL of the WebLogic administration server.  If not provided, the default administration server URL is "t3://localhost:7001".

Install

Redeploy

Undeploy

 -wladminurl=t3://localhost:7001

target

The target WebLogic cluster or server for deployment of the Intelligent Advisor runtime.

 Install -target=Cluster-1

 

–target=AdminServer

key

The key to use for encrypting all database connection information. This will be used as a password for the Password Based Encryption (PBE) of sensitive data stored in the Intelligent Advisor Hub database. For security reasons, this should not be passed on the command line, and should be recorded separately from the application.

When running interactively, leaving the key blank causes a random 32 character key to be generated and displayed. On reinstall, if the key is not available, all database connection information stored in the Intelligent Advisor Hub application will need to be re-configured.

Install

Redeploy

Build web apps

 -key=motorbikepenciljanuarycanberra

oldkey

In the case where you are changing from one encryption key to another, you can provide the existing (original) key using this parameter. Usually this can only be done in a redeployment.

   -oldkey=motorbikepenciljanuarycanberra -key=monkeylondonrunninghelp

non-secure-cookie

A switch that allows your installed application to accept non-secure session cookies.

It should be used if you are running Intelligent Advisor via http (rather than https). If -non-secure-cookie is not set, then the session cookie will only be sent over SSL/TLS connections (https) and you will not be able to log into the Hub via a standard http connection.

Using this parameter is not recommended for production environments.

No value needs to be provided with this switch.

Install

Redeploy

 -non-secure-cookie

resetuser

The username of a user with the Connections or Permissions administrator user role for an Intelligent Advisor Hub. If not provided, the default username is "admin".

Reset password

 -resetuser=admin

resetpass

The password for the admin user for a newly created Intelligent Advisor Hub.

For security reasons, this password should not be passed on the command line. This password is temporary and must be changed when the admin user logs on for the first time.

When running interactively, leaving the admin user password blank during installation will cause a random password to be generated and displayed on the console.

Install

Reset password

 -resetpass=secretpass

existing-database

A switch for the install action. If this switch is set, then a database will not be created. The database connection details must still be provided. No value needs to be provided with this switch, but you will need other arguments such as -dbconn, -dbuser -dbpass, to pass database connection information.

   -existing-database

force-encryption-key

Clears all encrypted data and sets the encryption key to the value that you are passing in. No value needs to be provided with this switch.

   -force-encryption-key
no-ssl A switch to allow non-SSL connection to a MySQL database. By default, the MySQL connection is sent with useSSL=true. Set this switch to change this parameter to useSSL=false.   -no-ssl
include-js A switch to include the Oracle JET js files normally accessed via the Oracle CDN directly in the web application. If you intend to run Intelligent Advisor on a network where it does not have access to the Oracle CDN, you should choose this option and set the use_local_jet_files configuration property to use the included files.   -include-js