Search

KOTS - How to manually upload a new Jama license file

Jason De Paola
Jason De Paola

Author: Jason De Paola

Updated: September 2024

Audience: Everyone

Environmental details: Self-hosted, Replicated - KOTS

Summary

These are the instructions for manually uploading a new Jama license file (.yaml) to KOTS Admin. This works for both Internet and Airgap installations.

**WARNING**

Please get in touch with Jama Support before attempting this operation. We need to pin your application license to your specific version, or this process will try to install the latest release, potentially causing deployment issues.

Solution

1. Fetch the KOTS Admin config

kubectl kots get config jama-k8s -n default > config.yaml

2. Remove KOTS Admin

kubectl kots remove jama-k8s -n default -f

3. Restore KOTS admin with new license

  • Copy the license.yaml file to the app server or create a new file and paste the license contents.yaml file and save it somewhere on the app server filesystem.
  • Then, you can run the following command where you need the config.yaml file from step 1 and the license.yaml file from the previous step:
kubectl kots install jama-k8s --app-version-label=9.0.3 --license-file license.yaml --namespace default --config-values config.yaml
*Note "--app-version-label=9.0.3" the version should be the current version you have deployed, e.g., 9.0.3
  • This shows a successful execution, after which the KOTS admin should be available with the new license and config restored.

*Note - You may encounter the following error:

Error: failed to forward port: failed to query healthz: Get http://localhost:8800/healthz: context deadline exceeded (Client.Timeout exceeded while awaiting headers)

In this case this might solve the problem:

1. Create ssh tunnel

ssh -L 8800:<SERVER IP>:8800 <USER>@localhost

2. Repeat steps 2 and 3

Cause

  • We have noticed that licenses sometimes fail to sync. Here is a method for pushing the license file and preserving KOTS Admin settings.

Final note

If, after manually updating the license, you run into an error where the application returns an error page stating the "tenant is closed" or "tenant does not exist" then please follow the steps in KOTS - Reset tenant state.

 

Please feel free to leave feedback in the comments below.

 

Related to

Was this article helpful?

1 out of 1 found this helpful

Have more questions? Submit a request

Comments

3 comments

Date Votes
  • Comment author
    Jenna

    Update: This procedure can also be used to swap license files in KOTS without disrupting the database and assets. 

    Use case: This was done successfully in a testing environment for a Jama Connect customer that wanted to keep their production environment up, create a new instance and migrate data over, then verify the data before decommissioning the previous app server and switch the license on the new instance from nonProd to prod.

    0
  • Comment author
    Lien Bäcker

    we are using Release 9.0.3. Following the steps given above,  at the stage “Wating for admin Console to be ready”, following error comes up.

    Deploying Admin Console
      • Waiting for Admin Console to be ready ✓
    Error: failed to forward port: failed to query healthz: Get "http://localhost:8800/healthz": context deadline exceeded (Client.Timeout exceeded while awaiting headers)

    Are we missing something?

    0
  • Comment author
    Alexander Cerrato

    I had a customer ask for their YAML license file and where they can find it. Eventually they found it. It would be great if this article would mention how to obtain it as well.

    1

Article is closed for comments.