Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
= Deploying the web application=
 
= Deploying the web application=
−
{{NoteFormat|If you're deploying Web Services and Applications version 8.5.201.09 or earlier, complete the steps on [[DeployWebAppLegacy|Deploying the web application for 8.5.201.09 or earlier]] instead.}}
+
{{NoteFormat|
 +
*If you're deploying Web Services and Applications version 8.5.201.50 or earlier, complete the steps on [[DeployWebAppLegacy50|Deploying the web application for 8.5.201.50 or later]] instead.
 +
*If you're deploying Web Services and Applications version 8.5.201.09 or earlier, complete the steps on [[DeployWebAppLegacy|Deploying the web application for 8.5.201.09 or earlier]] instead.}}
  
−
As of version 8.5.201.18, you can install Web Services as a service. Complete the following steps for each Web Services node.
 
  
−
'''Start'''
+
Complete the following steps for each Web Services node.
−
#Create a new folder on your Web Services node. For example, '''web-services'''. This is the home folder for the web application.
+
 
−
#Copy the '''gws.jar''' file from the installation CD to your new Web Services home folder.
+
'''Start'''  
−
#Copy the '''''installation_CD''/etc/default/gws''' file to the '''/etc/default''' folder on your Web Services host.
+
 
−
#Copy the '''''installation_CD''/etc/init.d/gws''' file to the '''/etc/init.d''' folder on your host.
+
# Copy the '''installation_CD/ gws-<version>.noarch.rpm''' file to a local folder.
−
#Open '''/etc/default/gws''' on your host and update the following environment variables to values appropriate for your Web Services node:
+
# Perform the installation using the RPM package manager:
−
#*<tt>GWS_HOST</tt> &mdash; This value should match the [[HTCCConfigurationOptionsReference#host|Jetty host]] you'll define later in the jetty section of the '''application.yaml''' configuration file.
+
#: <tt>rpm -ivh [--prefix installation_location] gws-<version>.noarch.rpm</tt>
−
#*<tt>GWS_PORT</tt> &mdash; This value should match the [[HTCCConfigurationOptionsReference#port|Jetty port]] you'll define later in the jetty section of the '''application.yaml''' configuration file.
+
#: If --prefix is not specified, the default installation location is '''/usr/share''' folder.
−
#*<tt>GWS_HOME</tt> &mdash; The Web Services home folder you created in Step 1.
+
# Copy the <nowiki>*.sample</nowiki> files from the '''/installation_path/gws/config/config-templates''' directory to the '''/installation_path/gws/config''' directory and remove the '''.sample''' extension.  
−
#*<tt>GWS_LOGS</tt> &mdash; The location where you want Web Services to store log files. If this folder doesn't exist, Web Services creates it during application startup. 
+
# Run following command to register the new service on your host: <tt>chkconfig gws on</tt>
−
#*<tt>GWS_TEMP</tt> &mdash; The location where you want Web Services to store temp files. If this folder doesn't exist, Web Services creates it during application startup. 
+
 
−
#*<tt>GWS_CONF</tt> &mdash; The location where you want to store the Web Services configuration files. If you don't specify a value for <tt>GWS_CONF</tt>, Web Services uses <tt>GWS_HOME</tt>/'''etc'''.
 
−
#Create the <tt>GWS_CONF</tt> folder you specified in Step 5. If you didn't set <tt>GWS_CONF</tt>, create a folder called '''etc''' in <tt>GWS_HOME</tt> &mdash; for example, '''web-services/etc'''. 
 
−
#Create the following configuration files in the folder you created in Step 6. You can simply copy the files from '''''installation_CD''/config-templates''' and remove the '''.sample''' extension. You'll learn more about the settings in these files as you go through the configuration steps for Web Services and its features later in this guide.
 
−
#*'''application.yaml'''
 
−
#*'''elasticsearch.yml'''
 
−
#*'''hystrix.properties'''
 
−
#*'''logback.xml'''
 
−
#*'''statistics.yaml'''
 
−
#Copy the '''routing-templates''' folder from '''''installation_CD''/routing-templates''' to your <tt>GWS_HOME</tt> folder.
 
−
#Create the user group '''gws'''.
 
−
#Create the '''gws''' user in the '''gws''' user group. The user should have read and write permissions for the folders defined in the <tt>GWS_HOME</tt>, <tt>GWS_LOGS</tt>, <tt>GWS_TEMP</tt>, and <tt>GWS_CONF</tt> environment variables.
 
−
#Use the following command to register the new service on your host: <tt>chkconfig gws on</tt>
 
 
'''End'''  
 
'''End'''  
  
−
==Next Step==
+
==Next Steps==
−
*[[ConfigurationPremise|Configuring Web Services]]
+
# [[ConfigurationPremise|Configuring Web Services]]
 +
# [[InitializingCassandra|Initializing Cassandra]]
 +
# [[Documentation:HTCC:Dep:StartHTCC|Starting and Testing Web Services]]
 +
 
 +
==Installation package files==
 +
 
 +
=== Web Services configuration and initialization files (Red Hat Enterprise Linux 6)===
 +
 
 +
{| border="1"
 +
|-
 +
! File/folder name
 +
! Description
 +
|-
 +
| /etc/default/gws
 +
| The configuration file for the Web Services service.
 +
|-
 +
| /etc/init.d/gws
 +
| The initialization script for the Web Services service.
 +
|}
 +
 
 +
 
 +
===Web Services configuration and initialization files (Red Hat Enterprise Linux 7)===
 +
 
 +
{| border="1"
 +
|-
 +
! File/folder name
 +
! Description
 +
|-
 +
|-
 +
| /usr/bin/gws
 +
| The initialization script for the Web Services service.
 +
|-
 +
| /usr/lib/systemd/system/gws.service
 +
| The default configuration file for the Web Services service.
 +
 
 +
The following scripts extend service functionality on the Red Hat Enterprise Linux 7 platform:
 +
 
 +
* /usr/libexec/initscripts/legacy-actions/gws/config
 +
* /usr/libexec/initscripts/legacy-actions/gws/version
 +
|-
 +
| /usr/lib/systemd/system/gws.service.d/gws.conf
 +
| The custom configuration file for the Web Services service. The settings defined in this file override the default settings.
 +
|}
 +
 
 +
===Web Services and Applications files===
 +
 
 +
{| border="1"
 +
|-
 +
! File/folder name
 +
! Description
 +
|-
 +
| /installation_path/gws
 +
| The home directory of Web Services and Applications.
 +
|-
 +
| /installation_path/gws/gws.jar
 +
| The application .jar file.
 +
|}
 +
 
 +
===GWS Configuration files===
 +
 
 +
{| border="1"
 +
|-
 +
! File/folder name
 +
! Description
 +
|-
 +
| /installation_path/gws/config
 +
| The folder containing configuration files of Web Services and Applications, including:
 +
* /installation_path/gws/config/feature-definitions.json
 +
* /installation_path/gws/config/hystrix.properties
 +
* /installation_path/gws/config/logback.xml
 +
|-
 +
| /installation_path/gws/config-templates
 +
| The folder that contains templates of the Web Services and Applications configuration files. After installation, files from the folder must be modified according to ''Web Services and Applications Configuration Guide'' and moved to '''/installation_path/gws/config'''. The templates include:
 +
* /installation_path/gws/config-templates/application.yaml.sample
 +
* /installation_path/gws/config-templates/elasticsearch.yml.sample
 +
* /installation_path/gws/config-templates/statistics.yaml.sample
 +
|}
 +
 
 +
===Cassandra schema===
 +
 
 +
{| border="1"
 +
|-
 +
! File/folder name
 +
! Description
 +
|-
 +
| /installation_path/gws/data
 +
| The folder that contains scripts to deploy database schema. Files include:
 +
* Scripts for Cassandra schema deployment using the '''cqlsh''' tool:
 +
** /installation_path/gws/data/ks-schema-local.cql
 +
** /installation_path/gws/data/ks-schema-prod.cql
 +
** /installation_path/gws/data/ks-schema-prod_HA.cql
 +
** /installation_path/gws/data/cf-schema.cql
 +
* Scripts for Cassandra schema deployment using the '''cassandra-cli''' tool:
 +
** /installation_path/gws/data/ks-schema-local.txt
 +
** /installation_path/gws/data/ks-schema-prod.txt
 +
** /installation_path/gws/data/ks-schema-prod_HA.txt
 +
** /installation_path/gws/data/cf-schema.txt
 +
|}
 +
 
 +
===Elastic search templates and routing templates===
 +
 
 +
* /installation_path/gws/elasticsearch
 +
* /installation_path/gws/routing-templates
 +
 
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 07:40, June 25, 2019

Deploying the web application

Important


Complete the following steps for each Web Services node.

Start

  1. Copy the installation_CD/ gws-<version>.noarch.rpm file to a local folder.
  2. Perform the installation using the RPM package manager:
    rpm -ivh [--prefix installation_location] gws-<version>.noarch.rpm
    If --prefix is not specified, the default installation location is /usr/share folder.
  3. Copy the *.sample files from the /installation_path/gws/config/config-templates directory to the /installation_path/gws/config directory and remove the .sample extension.
  4. Run following command to register the new service on your host: chkconfig gws on

End

Next Steps

  1. Configuring Web Services
  2. Initializing Cassandra
  3. Starting and Testing Web Services

Installation package files

Web Services configuration and initialization files (Red Hat Enterprise Linux 6)

File/folder name Description
/etc/default/gws The configuration file for the Web Services service.
/etc/init.d/gws The initialization script for the Web Services service.


Web Services configuration and initialization files (Red Hat Enterprise Linux 7)

File/folder name Description
/usr/bin/gws The initialization script for the Web Services service.
/usr/lib/systemd/system/gws.service The default configuration file for the Web Services service.

The following scripts extend service functionality on the Red Hat Enterprise Linux 7 platform:

  • /usr/libexec/initscripts/legacy-actions/gws/config
  • /usr/libexec/initscripts/legacy-actions/gws/version
/usr/lib/systemd/system/gws.service.d/gws.conf The custom configuration file for the Web Services service. The settings defined in this file override the default settings.

Web Services and Applications files

File/folder name Description
/installation_path/gws The home directory of Web Services and Applications.
/installation_path/gws/gws.jar The application .jar file.

GWS Configuration files

File/folder name Description
/installation_path/gws/config The folder containing configuration files of Web Services and Applications, including:
  • /installation_path/gws/config/feature-definitions.json
  • /installation_path/gws/config/hystrix.properties
  • /installation_path/gws/config/logback.xml
/installation_path/gws/config-templates The folder that contains templates of the Web Services and Applications configuration files. After installation, files from the folder must be modified according to Web Services and Applications Configuration Guide and moved to /installation_path/gws/config. The templates include:
  • /installation_path/gws/config-templates/application.yaml.sample
  • /installation_path/gws/config-templates/elasticsearch.yml.sample
  • /installation_path/gws/config-templates/statistics.yaml.sample

Cassandra schema

File/folder name Description
/installation_path/gws/data The folder that contains scripts to deploy database schema. Files include:
  • Scripts for Cassandra schema deployment using the cqlsh tool:
    • /installation_path/gws/data/ks-schema-local.cql
    • /installation_path/gws/data/ks-schema-prod.cql
    • /installation_path/gws/data/ks-schema-prod_HA.cql
    • /installation_path/gws/data/cf-schema.cql
  • Scripts for Cassandra schema deployment using the cassandra-cli tool:
    • /installation_path/gws/data/ks-schema-local.txt
    • /installation_path/gws/data/ks-schema-prod.txt
    • /installation_path/gws/data/ks-schema-prod_HA.txt
    • /installation_path/gws/data/cf-schema.txt

Elastic search templates and routing templates

  • /installation_path/gws/elasticsearch
  • /installation_path/gws/routing-templates
This page was last edited on June 25, 2019, at 07:40.
Comments or questions about this documentation? Contact us for support!