Skip to main content

Jama Connect User Guide

Install Jama Connect and KOTS (airgap)

The installation script and the installation wizard guide you through the process of installing the KOTS-required software and Jama Connect, then configuring the KOTS Admin Console.

The following is included in the Welcome email you received from Jama Software:

  • License file

  • URL to the airgap-safe portal for downloading the Jama Connect application file

  • A unique password to access the airgap-safe portal

To install Jama Connect and KOTS:

  1. Open the Welcome email from Jama Connect and save the attached license file to your local system.

  2. Log in to the download portal, select the Embedded cluster option, then download the Embedded Kubernetes Installer and App Bundle to your local system.

    image.png
  3. Move the downloaded Embedded Kubernetes Installer to your application server. Alternatively, run these commands to download the Embedded Kubernetes Installer directly to the application server:

    export REPLICATED_APP=jama-k8s
    export REPLICATED_CHANNEL=standardkots
    
    curl -LS https://k8s.kurl.sh/bundle/$REPLICATED_APP-$REPLICATED_CHANNEL.tar.gz \
    -o $REPLICATED_APP-$REPLICATED_CHANNEL.tar.gz
    
  4. Replace <installer-name> with the name of the downloaded installer in the following commands, then run these commands to extract the installer and run it:

    tar -zxvf <installer-name>.tar.gz
    
    cat install.sh | sudo bash -s airgap
  5. After the command runs (which might take several minutes), save the KOTS admin URL, password, and other configuration options for future reference. This is the only time these credentials appear, so make sure you save them.

  6. In a supported browser, enter the URL for Kotsadm, which was generated when you installed KOTS.

    step_2.png
  7. Log in to the KOTS Admin Console using the password you just saved.

    step_3.png
  8. Select the appropriate option:

    • Have key/certificate — Select Choose file under Private key and Certificate, navigate to the files and select them, then select Upload & Continue.

    • No key/certificate — Select Use Self-Signed Cert.

  9. Upload the license file saved on your local system.

  10. Upload your jama-k8s airgap bundle, then select Continue.

    airgap_bundle.png

    The Config tab in the KOTS Admin Console opens, where you can configure Jama Connect.

  11. Configure the settings for each group, as needed. Scroll down to see each group of settings.

    • Database Settings — Select your database type, then use information from Preparing your database server to complete the settings.

    • Host Name — Enter the host name for the cluster.

    • TLS Key Pair Source — (Optional) If you have a custom key and certificate for the host name, select Custom TLS Configuration. In the TLS Configuration section, upload the key and certificate.

    • Assets Size — Enter the estimated size of the assets that you are planning to store in Jama Connect.

    • Elasticsearch Settings > Volume Size — Enter the amount of disk space that each Elasticsearch node is allowed to use.

  12. (Optional) From the Config tab in the KOTS Admin Console, follow the steps to configure KOTS to save tenant assets in the Amazon EFS.

  13. Scroll to the bottom of the page and select Save config.

    The system performs the preflight checks.

    preflight.png
  14. From the Preflight checks screen, select Continue to open the KOTS Admin Console.

  15. In the Application section of the dashboard, wait until the status changes to Ready.

    ready.png
  16. Log in to Jama Connect as root using the hostname configured for Jama Connect.

  17. Important: Once Jama Connect is installed, use these instructions to provision a Jama Connect dataset.

Important

You must provision a Jama Connect dataset before you allow your users access to Jama Connect. If you need the link to the dataset, contact your Customer Success Manager.