License

Work with, obtain, and manage licenses for Kommander clusters

Purchase a License

You can evaluate Kommander running two clusters, the Kommander host cluster and one additional cluster, for free. If you want to add more clusters, you need a valid license.

To obtain a valid Kommander license:

  • Contact your sales representative at sales@d2iq.com. After purchase download the license file from the support website using your login credentials to a place accessible by Kommander.

  • Purchase a license via the AWS Marketplace. In this case, the license information (ARN) is accessible in the AWS License Manager console after purchase.

Enter a Valid License Key

After you download the license, an administrator must add it to Kommander.

In the Kommander UI, do the following:

  1. Select Global in the workspace header drop-down.

  2. In the sidebar menu, select Administration > Licensing.

  3. Select + Add License to enter the Add License form.

  4. On the Add License form page, select D2iQ or AWS Marketplace depending on where you acquired your license.

  5. Paste your license content in the textbox and select Save.

If there is an error submitting a license acquired directly from D2iQ, you can add the license directly through kubectl.

Enter a license via kubectl

You can add a license acquired from D2iQ directly using kubectl.

  1. Create a secret, replacing MY_LICENSE in the below command with your D2iQ-provided Kommander license:

    kubectl create secret generic my-license-secret --from-literal=jwt=MY_LICENSE -n kommander
    kubectl label secret my-license-secret kommanderType=license -n kommander
    
  2. Create a license object:

    cat <<EOF | kubectl apply -f -
    apiVersion: kommander.mesosphere.io/v1beta1
    kind: License
    metadata:
      name: my-license
      namespace: kommander
    spec:
      licenseRef:
        name: my-license-secret
    EOF
    

In the above example, your license is named ‘my-license’.

You should then be able to return to the license page in the UI to see your valid license display.

Remove a license

If your license information has changed, you may need to remove an existing license from Kommander in order to add a new one. Only administrators will have the ability to remove licenses.

NOTE: Original license information can still be obtained from D2iQ or the AWS License Manager console even after removing from Kommander.

In the Kommander UI, do the following:

  1. Select Global in the workspace header drop-down.

  2. In the sidebar menu, select Administration > Licensing.

  3. Your existing licenses will be listed. Click Remove License on the license you would like to remove, and follow the prompts.

Manually remove a license using kubectl

To remove a license from Kommander using kubectl, you have to delete the Secret and License objects. In this example, the secret is named “my-license-secret”.

  1. Validate that the secret exists in the kommander namespace:

    kubectl describe secret -n kommander my-license-secret
    

    Expected output:

    Name:         my-license-secret
    Namespace:    kommander
    Labels:       kommanderType=license
    Annotations:  <none>
    
    Type:         Opaque
    
    Data
    ====
    jwt:  455 bytes
    
  2. Delete the secret from the kommander namespace:

    kubectl delete secret -n kommander my-license-secret
    

    Expected output:

    secret "my-license-secret" deleted
    
  3. We do the same with the License object. Validate that it exists in the kommander namespace:

    kubectl describe license -n kommander my-license
    

    Expected output:

    Name:         my-license
    Namespace:    kommander
    Labels:       <none>
    Annotations:  kubectl.kubernetes.io/last-applied-configuration:
                    {"apiVersion":"kommander.mesosphere.io/v1beta1","kind":"License","metadata":{"annotations":{},"name":"my-license", "namespace":"kommand...
    API Version:  kommander.mesosphere.io/v1beta1
    Kind:         License
    Metadata:
      Creation Timestamp:  2020-03-25T14:57:31Z
      Generate Name:       license-
      Generation:          1
      Resource Version:    17895
      Self Link:           /apis/kommander.mesosphere.io/v1beta1/namespaces/kommander/licenses/my-license
      UID:                 35ee9254-4094-40eb-a2d8-4687c5d212d9
    Spec:
      License Ref:
        Name:  my-license-secret
    Status:
      Cluster Capacity:  500
      Customer Id:       mesosphere-developer
      End Date:          2020-10-02T14:00:09Z
      License Id:        mesosphere-developer
      Start Date:        2019-10-02T14:00:09Z
      Valid:             true
      Version:           1.0
    Events:
      Type    Reason                Age                  From              Message
      ----    ------                ----                 ----              -------
      Normal  LicenseUpdateSuccess  7m7s (x2 over 7m7s)  LicenseSignature  License updated successfully
    
  4. Delete the license from the kommander namespace:

    kubectl delete license -n kommander my-license
    

    Expected output:

    license.kommander.mesosphere.io "my-license" deleted
    

You have now successfully removed a license.