Table of Contents
Using This Guide
1. Glossary
2. EKM Path Variables
3. Filesystem Path Conventions
1. Introduction to EKM
1.1. Licensing and Access
1.2. License Usage
2. Overview of an EKM Server Installation
2.1. Deployment Options
2.2. How an EKM Server is Configured
2.3. Steps for Setting Up an EKM Server
3. Planning Deployment for an EKM Server
4. EKM Server Prerequisites
4.1. Prerequisite Instructions
4.1.1. Machine Prerequisites
4.1.1.1. Minimum Hardware Requirements
4.1.1.2. Supported Operating System Versions
4.1.1.3. Required Software Applications
4.1.1.3.1. Database Server Versions
4.1.1.3.2. Required Software Applications for EKM
4.1.1.4. ANSYS Licensing
4.1.1.4.1. ANSYS License Manager and EKM License Setup
4.1.1.4.2. ANSYS Client Licensing Setup
4.1.2. Prerequisite Operations
4.1.2.1. Download the JDBC Driver for the Cluster Database Server
4.1.2.1.1. MySQL (Default)
4.1.2.1.2. Oracle
4.1.2.2. Create an EKM Server Account
4.1.2.2.1. Windows
4.1.2.2.2. Linux
4.1.2.2.3. Setting the Open Files Limit
4.1.2.2.4. Setting the Max User Processes Limit
4.1.2.2.5. Configuring Access to PAM Authentication
4.1.2.3. EKM Cluster Configuration Prerequisites
4.1.2.3.1. Components of a Cluster Configuration
4.1.2.3.2. Manual Configuration of the Cluster File Server
4.1.2.3.2.1. Network File Service
4.1.2.3.2.2. Cluster File System
4.1.2.3.3. Manual Configuration of the Cluster Database Server
4.1.2.3.4. Naming the Cluster and Cluster Nodes
5. Installing an EKM Server
5.1. Installing a New EKM Server
5.1.1. Installation Requirements
5.1.2. Running ANSYS EKM Server Product Installation
5.2. Running a Silent Installation
5.3. Special Instructions for Upgrading from 17.x
5.4. Special Instructions for Upgrading from EKM 18.0 or 18.1
6. Post-Setup
6.1. Post-Setup Instructions
6.1.1. Configure the EKM Server
6.1.2. Set the Location of ANSYS 18.2 Applications
6.1.3. Set Up an X Server (Linux)
6.2. Configure the MySQL Connector/J JDBC Driver (Optional)
6.3. Grant Database Privileges for Each Cluster Node on the Cluster Database Server
6.4. Manually Configure the JBoss Domain
6.5. Manually Configure the Front-End Web Server
6.6. Special Post-Setup Instructions for Upgrade
6.7. After Installation and Post-setup
6.7.1. Configuring Job Submission Queues
7. JBoss Domain Mode and Configuration
7.1. Domain Mode
7.2. Configuration
7.3. Management
7.3.1. Create JBoss Management Users
7.3.2. Deploy the EKM Server Application
7.3.3. JBoss Domain Controller – Failure and Promotion
8. Installing a Front-End Web Server
8.1. The Architecture of an EKM Server
8.2. Installing the Web Server and Load Balancer
8.2.1. Using EKM with Apache HTTP Server and mod_proxy
8.3. Configuring the Web Server and Load Balancer
8.3.1. mod_proxy (Apache)
8.4. Configuring the Application Server
8.4.1. JBoss Setup
8.4.1.1. Configure JBoss
8.4.1.2. Configure JBoss Web Services
8.4.1.3. Configure JBoss Undertow (Optional)
8.5. Configuring EKM to Communicate with the Web Server
8.6. Testing the Connection
8.7. Enabling HTTP Compression
8.7.1. Apache
8.8. Overview of Client-Web Server Communications
8.8.1. SSL/TLS Certificates: Background
8.8.2. Enabling Secure Connections to the Web Server (Optional)
8.8.2.1. Creating an In-House Certificate Authority
8.8.2.2. Creating and Installing a Test Certificate
8.8.2.2.1. Generating a Certificate Signing Request (CSR)
8.8.2.2.2. Signing the CSR
8.8.2.2.3. Installing the Certificate on the Web Server
8.8.3. Enabling Secure Connections to JBoss for Single-Node EKM Server (Optional)
8.8.3.1. Creating and Installing a Test Certificate
8.8.3.1.1. Generating a Certificate Signing Request (CSR)
8.8.3.1.2. Signing the CSR
8.8.3.1.3. Installing the Certificate on the Application Server
8.9. Securely Connecting to EKM (Optional)
9. Configuring Login Authentication and Access Settings
9.1. Configuring Login Authentication
9.1.1. Authenticating EKM Logins to an LDAP Server
9.1.1.1. Configuring Standard LDAP Authentication
9.1.1.2. Configuring Proxy-based LDAP Authentication
9.1.2. Authenticating EKM Logins to Windows Active Directory
9.1.3. Authenticating EKM Logins to the Windows Operating System
9.1.4. Authenticating EKM Logins to the Linux Operating System
9.2. How User Logins Work
9.3. Configuring Login-related Access Settings
9.4. LDAP Mapping
9.4.1. When to Use LDAP Mapping
9.4.1.1. Logging in to EKM Using an Alternate Authentication Identity
9.4.1.2. Synchronizing User Account Information
9.4.2. Configuring LDAP Mapping
10. Installing and Configuring EnginFrame
10.1. Installing EnginFrame
10.1.1. EnginFrame Setup
10.1.2. Setting Up Self-Signed Certificates for Client-Server Authentication
10.1.3. Creating Certificates
10.1.4. Configuring Keystore and Truststore on the EnginFrame Server
10.1.5. Configuring Keystore and Truststore on the Client (EKM Server/Nodes)
10.2. Configuring EKM to Work with EnginFrame
10.3. Troubleshooting Tips
11. Starting the EKM Server and Launching the Web Client
11.1. Service Mode and Console Mode
11.2. Starting and Stopping the EKM Server in Console Mode
11.3. Launching the EKM Web Client
11.4. Registering and Running EKM as a Service
11.4.1. Service Names
11.4.1.1. Windows
11.4.1.2. Linux
11.4.2. Running EKM as a Service
11.4.2.1. Windows
11.4.2.2. Linux
11.5. Evaluating EKM Log Files
11.5.1. JBoss Log Files
11.5.2. Java Service Wrapper Log Files (Windows service only)
12. Upgrading an EKM Server from a Previous Version
12.1. Upgrading from EKM 17.x to EKM 18.2
12.1.1. Variables and Common Commands
12.1.1.1. EKM Path Variables
12.1.1.2. Common Commands
12.1.2. Prerequisites
12.1.3. Steps for Upgrading an EKM Server
12.1.3.1. Prepare the EKM 17.0 Server for an Upgrade
12.1.3.1.1. Verify the Existing EKM 17.0 Installation
12.1.3.1.2. Back Up EKM 17.0
12.1.3.2. Prepare the EKM Database for an Upgrade – Part 1
12.1.3.3. Set Up a New EKM 18.2 Server for an Upgrade
12.1.3.4. Prepare the EKM Database for an Upgrade – Part 2
12.1.3.5. Pre-Upgrade Instructions
12.1.3.6. Launch the Upgrade Wizard
12.1.3.7. Run the Upgrade Wizard
12.1.3.8. Review the Post-Upgrade Instructions
12.1.3.9. Post-Upgrade Instructions
12.1.3.9.1. Synchronize the Repository Folders on All Cluster Nodes
12.1.3.9.2. Synchronize the Revision ID for All Cluster Nodes in the Cluster Database
12.1.3.9.3. Copy Audit Log Files
12.1.3.9.4. Update Shared Applications
12.2. Upgrading from EKM 18.0 or 18.1 to EKM 18.2
12.2.1. Terminology
12.2.2. Preparing to Upgrade from EKM 18.0 or 18.1
12.2.3. Installing the EKM 18.2 Server
12.2.4. Transferring the EKM Configuration to EKM 18.2
12.2.5. After the Upgrade
13. Gathering Support Diagnostics
13.1. Launching the EKM Server Diagnostics Tool
13.2. Using the EKM Server Diagnostics Tool
14. Uninstalling an EKM Server
14.1. Uninstalling an EKM Server on Windows
14.2. Uninstalling an EKM Server on Linux
14.3. Uninstalling the Front End Web Server
15. Appendices
15.1. Appendix A: Setting Environment Variables for EKM
15.2. Appendix B: Network Ports
15.3. Appendix C: Email Configuration
15.4. Appendix D: Resolving Network Port Conflicts
15.5. Appendix E: Changing the JBoss HTTP Port
15.6. Appendix F: Setting the HTTP Session Timeout
15.7. Appendix G: Changing the MySQL Database Server Port
15.8. Appendix H: Configuring Windows Services (Windows Only)
15.9. Appendix I: Updating EKM Server Objects
15.10. Appendix J: Granting Database Privileges
15.11. Appendix K: Clearing the Repository
15.12. Appendix L: Disabling HTTP Compression
15.13. Appendix M: Changing the JVM Heap Size
15.14. Appendix N: Configuring EKM to Use Amazon S3 Data Storage
15.15. Appendix O: Creating a Silent Installation File
15.15.1. Silent Installation Options
15.15.2. Example Silent Installation Files
15.16. Appendix P: EKM Cluster Network Configuration
15.17. Appendix Q: Configuring the MySQL Connector/J JDBC Driver
15.18. Appendix R: Changing the EKM Cluster Name
15.19. Appendix S: Changing an EKM Cluster Node IP Address
Release 18.2 - © ANSYS, Inc. All rights reserved.