Planning your installation

Plan a Kubernetes Jama Connect installation by reviewing the software, infrastructure, resource sizing, database requirements, supported software, and authentication options needed to prepare your environment before installation.

IDENTIFY JAMA CONNECT VERSION

Review the Jama Connect Release Notes and decide which version to install from our Supported Versions list. For example: 9.35.2.

REQUIRED SOFTWARE FOR INSTALLATION

• Kubectl access
• Helm CLI with support for OCI repositories

APPLICATION REQUIREMENTS

Provided by Jama Software 

A welcome email that includes:

• Artifactory credentials
• Jama Connect license

Provided by customer

• An existing Kubernetes cluster
• Supported Kubernetes versions — 1.34
• A DNS hostname for accessing Jama Connect
• An ingress controller OR the Traefik ingress controller included in our Helm chart (controller runs on node ports 80 and 443; the Traefik ingress controller must be enabled)
• Virtual memory setting (vm.max_map_count) is set to 262144 or higher, or our Helm chart is configured to set it. For information on how to set up the virtual memory, see Configure custom memory settings for OpenSearch (KOTS) in the Installing and Upgrading Jama Connect KOTS Guide.
• Nodes with the topology.kubernetes.io/zone labels unless the default topologySpreadConstraints is changed
• A dedicated namespace
• Allowed users and capabilities required by containers (see Prepare security context constraints in Preparing your environment).
• (Airgap only) A private registry to host the Jama Connect container images.
• CPU, memory, and disk — By default, our application requires:
  • 11 GB for storing container images per release
  • 4705 m of CPU, with limits set to 13250 m
  • 16.32 GB of memory, with limits set to 32.85 GB
  • A CSI driver is able to provision 26.84 GB of disk space for a persistent volume claim

           If our HA sample values file is used, our application:

• Requests 18915 m of CPU, with limits set to 61550 m
• Requests 83.67 GB of memory, with limits set to 168.27 GB
• Requires a CSI driver able to provision 74.09 GB of disk space for persistent volume claims

Important considerations

• To allow for upgrades, provision enough space for multiple releases.
• To fit your own expected usage, adjust the default values for persistent volume claims.

Database server requirements

The database must be hosted on a server separate from the Jama Connect application. This server can host other databases, but running other applications on the same server as the database is not supported.

Minimum

• 4–8 CPU
• 16–24 GB RAM

Recommended

• 8 CPU
• 24 GB RAM
• Dedicated volumes for data

Database software

• MySQL 8.4.x
• Microsoft SQL Server 2022

Musts

• The database is hosted on a server separate from the Jama Connect application.
• The database server can host other databases, but no other applications.
• Accessible by admin with permissions.
• Uses only supported software and environments.
• Databases must be able to accept a minimum of 300 concurrent connections.

Not supported

• Azure database
• MariaDB
• Custom configurations of Jama Connect databases (for example, query optimization and additional indexes that aren’t shipped with Jama Connect)

Resource sizing for database server

For optimal performance, estimate your database server requirements before installing Jama Connect.

Important considerations

• Total system RAM for your database server can vary depending on the workloads you run, such as reuse, exporting, moving items, integrations, and batch updates. Database sizing is based on your usage patterns and your platform. You must have 4–8 cores and 16–24 GB of memory. Consult with your database admin when determining database size.
• The memory allocation provides minimal headroom. If you need to run additional software for monitoring and analysis, consider its system requirements.

Use the information in this table to determine the resources your database server needs.

If your usage approaches the Enterprise threshold, contact Support for customized recommendations and advanced, multi-server setup.

Supported software

Make sure your environment uses only supported software.

BROWSERS

• Edge Chromium
• Firefox*
• Google Chrome*

• Safari*

  * Versions released over the past 12 months are supported.

IMPORTANT:

• Browser zoom is supported only at 100%. Using browser extensions/addons or enabling Compatibility View is not supported when using Jama Connect.
• To prevent session issues, use the application in a single browser window.

WORD PROCESSOR AND SPREADSHEET PROGRAM

• Office 365 for Mac
• Office 365 for Windows (used for exports and reports)

AUTHENTICATION

• LDAP
• SAML

In This Section

• Overview
• Planning your installation
• Preparing your environment
• Installing and upgrading
• FAQ
• Appendix A: Configuring the Helm chart
• Appendix B: Back up to .jama or XML file
• Appendix C: Mapping KOTS configuration to Helm values