10.2. Configuring EKM to Work with EnginFrame

Engineering Knowledge Manager

Installation Guide | Chapter 10: Installing and Configuring EnginFrame |

10.1.5. Configuring Keystore and Truststore on the Client (EKM Server/Nodes) |  | 10.3. Troubleshooting Tips
Prev |  | Next

## 10.2. Configuring EKM to Work with EnginFrame

Once EnginFrame has been installed and started, you must execute the steps below to configure EKM to connect with EnginFrame.

1. Stop the EKM server.

2. During the EnginFrame installation we created ekmServer.domainname.com.client.keystore and ekmServer.domainname.com.client.truststore certificate files for each EKM cluster node (for example, in the /opt/nice/enginframe/tools folder). Copy the ekmServer.domainname.com.client.keystore and ekmServer.domainname.com.client.truststore files of each EKM server to the EKM_HOME/conf folder of that server.

3. Configure JBoss to use the certificate files by modifying the bin/ekm_start.(cmd|sh) control script. These instructions are already present but commented out in the script. You will need to uncomment these instructions and change the certificate file names and password. The password is the one that was used for creating certificate files.

   If you are running EKM as a service on Windows, these instructions are present in the wrapper.conf file as shown below:

       #wrapper.app.parameter.27=-Djavax.net.ssl.keyStore=${EKM_HOME}/conf/
       ekmServer.domainname.com.client.keystore
       #wrapper.app.parameter.28=-Djavax.net.ssl.keyStorePassword=ekmansys
       #wrapper.app.parameter.29=-Djavax.net.ssl.trustStore=${EKM_HOME}/conf/
       ekmServer.domainname.com.client.truststore
       #wrapper.app.parameter.30=-Djavax.net.ssl.trustStorePassword=ekmansys

   If you are running EKM in console mode on Windows, these instructions are present in the ekm_start.cmd control script as shown below:

       rem set JAVA_OPTS=%JAVA_OPTS% -Djavax.net.ssl.keyStore="%EKM_HOME%\conf\
       ekmServer.domainname.com.client.keystore"
       rem set JAVA_OPTS=%JAVA_OPTS% -Djavax.net.ssl.keyStorePassword=ekmansys
       rem set JAVA_OPTS=%JAVA_OPTS% -Djavax.net.ssl.trustStore="%EKM_HOME%\conf\
       ekmServer.domainname.com.client.truststore"
       rem set JAVA_OPTS=%JAVA_OPTS% -Djavax.net.ssl.trustStorePassword=ekmansys

   If you are running EKM on Linux, these instructions are present in the ekm_start.sh control script as shown below:

       #JAVA_OPTS="$JAVA_OPTS -Djavax.net.ssl.keyStore=$EKM_HOME/conf/
       ekmServer.domainname.com.client.keystore"
       #JAVA_OPTS="$JAVA_OPTS -Djavax.net.ssl.keyStorePassword=ekmansys"
       #JAVA_OPTS="$JAVA_OPTS -Djavax.net.ssl.trustStore=$EKM_HOME/conf/
       ekmServer.domainname.com.client.trustStore"
       #JAVA_OPTS="$JAVA_OPTS -Djavax.net.ssl.trustStorePassword=ekmansys"

4. Edit the ekm.xml file and define the `<enginframe>` settings in the `<remoteProcess>` section. A template that is commented out is provided for your convenience. You can uncomment this template and modify it as needed. The supplied template definition is shown below:

       <enginframe>
         <serviceDefinitionFile>https://<enginframe-server-name>:8443/enginframe/demo/showcase/showcase.xml
         </serviceDefinitionFile>
         <adminUser>efadmin</adminUser>
         <queue>
           <name>Windows Remote Viz Queue</name>
           <os>windows</os>
           <scheduler>neutro</scheduler>
           <schedulerQueue></schedulerQueue>
           <remoteType>dcv</remoteType>
         </queue>
         <queue>
           <name>Linux Remote Viz Queue</name>
           <os>linux</os>
           <scheduler>lsf</scheduler>
           <schedulerQueue></schedulerQueue>
           <remoteType>dcv</remoteType>
         </queue>
       </enginframe>

   Below is a description of the settings that you need to specify:

   - `serviceDefinitionFile`: Replace the `<enginframe-server-name>` with the Fully Qualified Domain Name (FQDN) of the EnginFrame server.

   - `adminUser`: The name of the EnginFrame admin user. The default name is `efadmin`.

   - `queue`: There can be any number of interactive queues defined. When the EKM server starts, these queues will be automatically created in the `/Administration/Servers/Master` folder. You can specify the following settings for each queue:

     - `name`: The name of the queue as it appears in EKM.

     - `os`: The operating system of the visualization server. The value can be either `windows` or `linux`.

     - `scheduler`: The job scheduling system used for creating the session. The value can be `lsf`, `neutro`, `pbs`, `moab`, or `torque`. The value `lsf` is used for the openlava scheduler.

     - `schedulerQueue`: This is an optional setting that can be used to specify the name of a queue on the scheduler for creating the session.

     - `remoteType`. The remote visualization technology used. The value can be `vnc`, `dcv`, `rgs` or `virtualgl`.

5. If you want to add logging for EnginFrame integration for troubleshooting purposes, you will need to edit the ekm.log4j.properties file in the JBoss configuration directory (see JBoss Domain Mode and Configuration). You will need to add the following line:

   `log4j.logger.com.enginframe=DEBUG, ekmStdout`

6. Start the EKM server.

7. Edit the settings of each newly created interactive queue by navigating to the `/Administration/Servers/Master` folder in EKM and then right-clicking the queue and selecting Edit > Job Submission Settings. For more information, see Editing Job Submission Queue Settings in the EKM Administration Guide.

8. When an interactive queue is created, it will automatically include a predefined application called `remoteDesktop.app.xml` that can be used to start a remote desktop session. You can also create additional applications in a queue if you want a particular application (for example, ANSYS Workbench) to launch automatically when the remote session starts. For details on how to do this, see Defining External Applications Directly in EKM in the EKM Administration Guide.

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.

Prev | Up / Contents | Next

Release 18.2 - © ANSYS, Inc. All rights reserved.