Install Enterprise Edition Web Client

Before you begin

Before starting the Plant Applications Enterprise Web Client installation, you must define your configuration in the silentinstaller.yml file. Once you are ready with the configuration you can start the installer. The silentinstaller.yml file can be found at: ~/your/path/plantapps-enterprise-webclient-<buildno>/silentinstaller.yml

About this task

During the installation, the installer displays the installation tasks on the console and in a log file at ~/your/path/wc82installer/plantapps-enterprise-webclient-<buildno>/log/ansible.log and ~/your/path/wc82installer/plantapps-enterprise-webclient-<buildno>/log/sql_script.log.

Procedure

From the ~/your/path/wc82installer/plantapps-enterprise-webclient-<buildno> directory, update the silentinstaller.yml file by using a text editor. For example, $sudo nano silentinstaller.yml

Using the text editor, update the following parameters in the silentinstaller.yml file by entering the values within the quotes ("")

Note: Ensure that you:

Do not use short names for these parameters.
Use lower case when entering the server names.


Parameter	Description
WEBCLIENT_SERVER: ""	Enter the Linux node FQDN or hostname where you are going to install Plant Applications Enterprise Web Client. For example, `WEBCLIENT_SERVER: "linuxnode.digital.com"`
WEBCLIENT_SERVER_USERNAME: ""	Enter the Linux node administrator account username. For example, `WEBCLIENT_SERVER_USERNAME: "administrator"`
WEBCLIENT_SERVER_PASSWORD: ""	Enter the Linux node administrator account password.
WEBCLIENT_INSTALLATION_PATH: ""	Enter Web Client Installation path in which you want to install. For example, `WEBCLIENT_INSTALLATION_PATH: "/home/administrator/install/"` Note: If you are performing an upgrade, provide the absolute path of the directory in which Enterprise Edition Web Client was installed, and press Enter. Unless modified, the path appears as follows: /<buildpath>/PlantApplicationsDocker The path that you provide must be a valid one. The installer will not create the directories in the given path if they do not exist.
DTR_URL: ""	Enter the URL of your local Docker Registry that you created in Create and Configure Docker Registry. For example, `DTR_URL: "registry.gear.ge.com/dig-plantapps"` Note: If you are performing an upgrade, provide the Docker Registry URL that was used during the previous installation in the following format: `<IP address or hostname>:<port number>`.
DTR_USERNAME: ""	Enter the username that have access to the Docker Registry.
DTR_PASSWORD: ""	Enter the password to the Docker Registry.
TARFILES_FOLDER_LOCATION: ""	Enter the absolute path of the directory where the .tar files provided by GE are located. For example, `TARFILES_FOLDER_LOCATION: "/path/to/images"`
WEBCLIENT_USERNAME: ""	Enter the Plant Applications Web Client username to login into the application. For example, `WEBCLIENT_USERNAME: "admin"`
WEBCLIENT_USERPASSWORD: ""	Enter the Plant Applications Web Client password.
UAA_SERVICE_ORIGIN: ""	Enter the UAA Server hostname.
UAA_SERVICE_PORT: ""	Enter the UAA Server port number. By default, the port number is 443.
UAA_SERVICE_ADMIN_CLIENT_ID: ""	Enter the admin Client ID to access the UAA server instance. Note: The default username is admin.
UAA_SERVICE_ADMIN_CLIENT_SECRET: ""	Enter the Client Secret for the username you entered.
PLANT_APPS_DB_SERVER: ""	Enter the Plant Applications database server hostname that you want to connect with the Plant Applications Web Client.
PLANT_APPS_DB_INSTANCE: ""	Enter the name of the instance of the SQL server. You can leave this parameter empty if not using an instance. For example, `PLANT_APPS_DB_INSTANCE: "sa"` Note: Do not add a backslash (\) when entering the instance name.
PLANT_APPS_DB_NAME: ""	Enter the Plant Applications Database name. For example, `PLANT_APPS_DB_NAME: "SOADB"`
PLANT_APPS_DB_USERNAME: ""	Enter the username that has permissions to access the database you entered.
PLANT_APPS_DB_PASSWORD: ""	Enter the password for the username you entered.
PLANT_APPS_MB_SERVER: ""	Enter the host name or IP address that hosts your Plant Applications Message Bridge.
PLANT_APPS_MB_USERNAME: ""	Enter the username that you set for Plant Applications Message Bridge.
PLANT_APPS_MB_PASSWORD: ""	Enter the password for the username you entered.
COUCHDB_SERVER: ""	Enter the Plant Applications CouchDB host name or IP adress.
COUCHDB_DBNAME: "node@localhost"	Do not change this parameter value.
COUCHDB_USERNAME: ""	Enter the CouchDB username.
COUCHDB_PASSWORD: ""	Enter the CouchDB password.
OPHUB_SERVER: ""	Enter the hostname of Operations HUB Server.
OPHUB_SERVER_PORT: ""	Enter the Operations Hub port number. For example, `OPHUB_SERVER_PORT: "443"`
OPHUB_TENANT_USERNAME: ""	Enter the tenant Hub username to access the Operations Hub server instance. For example, `OPHUB_TENANT_USERNAME: "OphubAdmin"`
PASSWORDS_OR_CERTS_UPDATED : ""	Default value is true. You can set this to false if you want to use OLD certificates during upgrade or apply 8.2 SIMs. For example, `PASSWORDS_OR_CERTS_UPDATED: "false"`
ENCRYPT_PASSWORDS: ""	Set to true if you want to encrypt the password. For example, `ENCRYPT_PASSWORDS: "false"`
SSL_CERT_PEM_PATH: ""	Note: Not required for Enterprise installation. Use this parameter only to replace the self-signed certificate with the trusted CA certificate. Enter the path to the SSL certificate. For example, `SSL_CERT_PEM_PATH: " /home/administrator/myca_certs/new_cert.pem"`
SSL_KEY_PEM_PATH: ""	Note: Not required for Enterprise installation. Use this parameter only to replace the self-signed certificate with the trusted CA certificate. Enter the path where the valid CA key file is located. For example, `SSL_KEY_PEM_PATH: "/home/administrator/myca_certs/new_key.pem"`
UAA_PEM_PATH: ""	Note: Not required for Enterprise installation. Use this parameter only to update the public keys of remote UAA services. Enter the path where the valid UAA public key is located. For example, `UAA_PEM_PATH: "/ home/administrator/myca_certs/new_uaa_cert.pem"`

Save the silentinstaller.yml file.
Navigate to the installer folder and and provide execute permission to the installer file by running following command.

$ sudo chmod +x ./ setup.sh
Depending on your deployment architecture, run one of the following commands to launch the installer:
- If you want to run the Enterprise Edition Web Client Installer and install Enterprise Edition Web Client on a same Linux machine, navigate to your installer folder ~/your/path/plantapps-enterprise-webclient-<buildno> and run the following command at the terminal:
  $ sudo ./setup.sh
- If you want to run the Enterprise Edition Web Client installer and install Enterprise Edition Web Client on a remote machine, run the following command at the terminal:
  $ sudo ./setup.sh -r
The shell script setup.sh is launched, and Plant Application Web Client Installation console with a welcome message appears. If the installation is successful, the following message appears:
- If the failed count is zero, the installation is successful and after few minutes, PAServices and PAContainer stacks are operational.
- If the installer encounters any errors, the installation process stops at the failed task and details of the process are displayed both on the screen and in the log file at <installation path>/plantapps-enterprise-webclient-<buildno>/log/ansible.log of the installer directory.
- Once the Web Client installation is complete, run the following two steps for configuring Message Bridge with Kafka details and import the Plant Applications into the Operations Hub.
Run Message Bridge Configuration Utility on the Plant Applications Server to update the Kafka details in the Message Bridge configuration.
Run Operations Hub Posting Utility to import the Plant Applications into the Operations Hub.
Once you have completed running Message Bridge Configuration and Operations Hub Posting utilities, Verify the Installation to verify if the Plant Applications Web Client applications are up and running.
Access REST APIs to access the REST APIs for Plant Applications Web Client.