Service Management

Following are the steps to run and monitor the Infoworks services:

Navigate to the /bin directory in the Infoworks Home folder (/opt/infoworks/ by default), and execute the following commands respectively:

Starting Infoworks Services

If you are not logged in as Infoworks user, use the following commands:

# sudo -u <INFOWORKS-USER>

./start.sh <component-name>

If you are logged in to shell as Infoworks user: $ ./start.sh <component-name>, where <component-name> can be one of the following:

all: starts all services
ui: starts the user interface
hangman: starts the job controller
governor: starts the entity dependency manager
restapi: starts the rest api service
df: starts the data transformation component
queryservice: starts the query service
cube_engine: starts the data cube manager
postgres: starts the postgres component
rabbitmq: starts the rabbitmq component
platform: starts the platform component. Platform includes multiple services like scheduler, metadb, notification, messaging, security. These services can also be started independently.

Starting Infoworks Orchestrator

If you are not logged in as Infoworks user, use the following commands: # sudo -u <INFOWORKS-USER>

./start.sh orchestrator

If you are logged in to the shell as Infoworks user: $ ./start.sh orchestrator

Stopping Infoworks Services

If you are not logged in as Infoworks user, use the following commands: # sudo -u <INFOWORKS-USER>

./stop.sh <component-name>

If you are logged in to the shell as Infoworks user: $ ./stop.sh <component-name>

Monitoring Status of All Infoworks Services

If you are not logged in as Infoworks user, use the following commands:

# sudo -u <INFOWORKS-USER>

./status.sh

If you are logged in as Infoworks user: $ ./status.sh

Security Configuration

LDAP Authentication

Following are the steps to perform LDAP Authentication:

Login to the Infoworks DF with admin credentials.
Click the Admin menu.
Click the Configuration icon. Click the Authentication tab. The Authentication Configuration page is displayed.
Select the authentication type as LDAP.
Set the LDAP configurations and click Save Changes.

Following are the authentication parameters:

Parameter	Description
LDAP Connection Configurations
LDAP Host	The host on which the active directory/LDAP server is running.
LDAP Port	The port on which the server is running.
Use SSL	The option to determine if SSL should be used in the connection. The server provided SSL certificates will be used without trust verification.
Bind User DN	The Distinguished Name for the user for binding to LDAP.
Bind User Password	The password for the user for binding to LDAP.
LDAP User Configurations
Base DN Users	The base Distinguished Name for all the users allowed for login into Infoworks platform.
Login Attribute	The attribute in the active directory/LDAP which uniquely identifies a user.
Fullname Attribute	A comma-separated list of attributes which forms the full name of the user. The full name on the Infoworks DF UI displays all the attribute values separated by space.
Email Attribute	The attribute to specify the email address of the user.
Role Attribute	The attribute to determine the system role in Infoworks DF for the user.
Role Value Separator	The character used to separate the role attribute value specified in LDAP into multiple roles in the Infoworks DF. For example, if in LDAP the role attribute is Title and the values are admin, data modeller, then the Role Value Separator must be specified as, (comma).
Infoworks Login Screen Hint	The message displayed when logging in to the Infoworks DF with LDAP credentials.
LDAP Roles Configurations
System Admin	A semi colon-separated list of attribute values. User will be assigned the System Admin role if any one of the values match the value in the active directory.
Database Admin	A semi colon-separated list of attribute values. User will be assigned the Database Admin role if any one of the values match the value in the active directory.
Data Analyst	A semi colon-separated list of attribute values. User will be assigned the Data Analyst role if any one of the values match the value in the active directory.
Data Modeller	A semi colon-separated list of attribute values. User will be assigned the Data Modeller role if any one of the values match the value in the active directory.

NOTE: Infoworks Rest API and Platform services must be restarted after setting the Authentication Type to LDAP.

You must login through the Infoworks DF at least once to use the REST API service. This holds true for both default and LDAP authentication mechanism.

Secure Services with SSL

To enable SSL communication for Platform or Governor services , follow the steps below:

Navigate to Nginx configuration directory using the following command: cd ${IW_HOME}/resources/nginx-portable/conf/infoworks
Run the following command to open platform.conf.template file for editing: vi platform.conf.template .

The structure of the template file will be as follows:

server { # External Access# # Exteral port on which this service will be listening # Syntax for HTTP: listen <port-number>; # Syntax for HTTPS: listen <port-number> ssl; listen ${PROXY_SERVER_PORT}; ################################################ # SSL Certificates # # For HTTPS, the path to the certificate and key file # need to be specified in the following keys: # ssl_certificate <path-to-certificate-file> # ssl_certificate_key <path-to-certificate-key-file> # ssl_certificate /etc/nginx/ssl/infoworks_ssl.crt; # ssl_certificate_key /etc/nginx/ssl/infoworks_ssl.key;

3.Add the string sslafter the proxy server port as follows:

listen ${PROXY_SERVER_PORT} ssl;

4.Add the respective ssl certificate key path and certificate file path as described below:

Step 1: Uncomment # ssl_certificate /etc/nginx/ssl/infoworks_ssl.crt; line.
Step 2: Update it to ssl_certificate <path-to-certificate>/infoworks_ssl.crt; , where path-to-certificate is your respective path to the generated certificate file.
Step 3: Uncomment # ssl_certificate_key /etc/nginx/ssl/infoworks_ssl.key; line.
Step 4: Update it to ssl_certificate_key <path-to-certificate>/infoworks_ssl.key;,where path-to-certificate is your respective path to the generated certificate file.

5.Restart Nginx service using the following commands:

cd ${IW_HOME}/bin

./stop.sh nginx && ./stop.sh UI

./start.sh nginx && ./start.sh UI

NOTE: Infoworks Product Documentation server currently serves request over HTTP server only. Since HTTP server serves an insecure communication, Infoworks Product Documentation server can be configured to listen to a local host to hide it from the external traffic. All other Infoworks DataFoundry services serves request over HTTPS.

Last updated on