Jama Connect User Guide

Install the Replicated admin console

The admin console is the Replicated user interface used to install the Jama Connect application. Docker is also installed for you using the official Docker repository, if you don't have it already. You can use the Replicated installation script to install the latest supported version of Docker and Replicated. 

During installation, the application server must have access to the internet, including the Replicated listed domains. If your security requirements don't permit this, you might consider airgap installation.  

Note

The admin console isn't compatible with Internet Explorer.

Important

If you receive a warning that docker is using the devicemapper storage driver, cancel the install and configure Docker to use the overlay2 storage driver.

  1. Check the Release Notes for the Jama Connect version you're using, because there might be a unique cURL command for that release.

  2. Connect to the command shell of the application server using SSH.

  3. Use the appropriate command as root user (or one with sudo bash privileges) to download and install the admin console. Either use the command you found in step 1, or download and install a specific version of the admin console execute the following command:

    curl -sSL "https://get.jamasoftware.com/docker?replicated_tag=<REPLICATED_VERSION>" | sudo bash -s no-auto

    where you must replace <REPLICATED_VERSION> with the Replicated versions recommended in the Release Notes for your version of Jama Connect (see step 1).

    The supported software page in the Community specifies which versions were used during regression testing of the version of Jama Connect you want to install.

    For example, your command might look like this:

    curl -sSL "https://get.jamasoftware.com/docker?replicated_tag=2.38.1" | sudo bash -s no-auto
  4. If running the cURL command results in the following message, the admin console must be installed manually.

    Either your platform is not easily detectable, is not 
    supported by this installer script, or does not yet have 
    a package for Replicated.Please visit the following URL 
    for more detailed installation instructions:
    
    https://www.replicated.com/docs/distributing-an-application/installing/

    Note

    The no-auto option is used only to make sure that questions during the installation doesn't time out (the default timeout setting is 20 seconds).

  5. Walk through the installation prompts. All questions are asked at the beginning so that you can then leave the installation unattended. 

    Important

    These questions are only shown for 20 seconds, unless you chose the "no auto" option. If you skip this question, the URL shown in step 7 doesn't work.

    First, enter the number of the network used to access Jama Connect (your DNS entry also routes to this network). This is the same network used to access the admin console and the Jama Connect application. Complex network designs vary. You might have fewer or more interfaces listed.

    Please choose one of the following network interfaces:
    
    [0] eth0 10.0.2.15
    [1] eth1 172.28.128.3
    [2] docker0 172.17.0.1
    Enter desired number (0-2):
  6. For the following prompt, if you're using a proxy, answer Y and input the proxy information. If your server is set up to use a proxy, the user environment auto-detects that configuration and asks if you want the installer to configure the proxy for you.

     Does this machine require a proxy to access the Internet?
     (y/N)
        
  7. When prompted for a service IP address, leave it blank and press Enter.

  8. Wait for the installation to complete. You will see the following line once installation is complete.

    ==> default: To continue the installation, 
    visit the following URL in your browser: 
    https://<your_ip_address>:8800
  9. Take note of the URL of the admin console that's given, because it's needed when you configure Replicated settings.

  10. In the /data directory, create a custom Replicated snapshots folder and change the ownership to the replicated user with the following command. Later you can configure the admin console to store snapshots there. 

    mkdir -p /data/replicated/{snapshots,statsd,support-bundle}
    chown -R replicated /data/replicated

    After changing ownership to Replicated with the command, the permissions look something like this:

    # ll /data/replicated/
    total 20
    drwxr-xr-x 5 replicated root 4096 Oct 21 21:27 ./
    drwxrwxrwx 10 root root 4096 Nov 7 18:48 ../
    drwxr-xr-x 5 replicated root 4096 Oct 21 21:29 snapshots/
    drwxr-xr-x 6 replicated docker 4096 Oct 21 22:11 statsd/
    drwxr-xr-x 2 replicated root 4096 Oct 21 21:27 support-bundle/