Add licence keys

Overview

Gateway Hub has two licence keys:

  • A Gateway Hub licence.
  • A MapR licence.

To acquire a Gateway Hub licence, contact ITRS support or your technical representative.

To acquire a MapR licence, you must provide information to ITRS. See How to request a permanent MapR licence for Gateway Hub.

This section describes how to install licences to Gateway Hub once they have been supplied to you.

How to install the Gateway Hub licence using the hubctl command

You should have unpacked the Gateway Hub binaries onto an installation machine creating a folder called hub. This folder contains the hubctl scripts which can be used to manage the Gateway Hub installation. See Install.

If a installation machine with hostname hubdemo has a setup user hub-setup then you can check the licence status by running:

./hubctl setup licence ~/hubdemo.json

where the JSONfile hubdemo.jsonis given by

{
    "connection": {
        "ask_pass": true,
        "user": "hub-setup"
    },
    "hosts": [
        "hubdemo"
    ]
}

You should see a response

...
Success, current licence information written to /var/folders/.../hub-lic
Hub is NOT licensed
MapR Licence summary
	Base MapR POSIX Client for fast secure file access
	MapR Base Edition
MapR cluster id is <id_number>

This indicates there is currently no licence installed.

To add a licence edit hubdemo.json to specify the path to the licence file you have been provided

{
    "connection": {
        "ask_pass": true,
        "user": "hub-setup"
    },
    "hosts": [
        "hubdemo"
    ],
    "hub": {
        "licence": "<path_to_licence>"
    }
}

You should now re-run

./hubctl setup licence ~/hubdemo.json

The output will now indicate that Gateway Hub is licensed.

How to request a permanent MapR licence for Gateway Hub

When a new Gateway Hub instance is generated, a trial licence for MapR is also generated that provides access for 30 days. This enables functionality required for install, and may be sufficient for short-term environments. For longer-term instances, a permanent licence must be acquired.

To acquire a permanent licence, follow these steps:

  1. Log in to the MCS interface using your browser. See Log in to the MapR Control System (MCS) interface.
  2. Navigate to Admin > Cluster Settings using the toolbar at the top of the page.
  3. On the Admin / Cluster Settings page, select the Licenses tab.
  4. Make a note of the Cluster ID.
  5. Contact ITRS support or your technical representative and request a new licence. Include the following information:
    • Account name.
    • Cluster ID from step 4.
    • Number of nodes in the cluster.

For how to install the licence, see How to install the MapR licence.

How to install the MapR licence

You install the MapR licence for Gateway Hub using the MapR Control System (MCS) interface.

To install the MapR licence, follow these steps:

  1. Log in to the MCS interface using your browser. See Log in to the MapR Control System (MCS) interface.
  2. Navigate to Admin > Cluster Settings using the toolbar at the top of the page.
  3. On the Admin / Cluster Settings page, select the Licenses tab.
  4. Click Upload License File.
  5. Click Browse File.
  6. Select the licence file using the file explorer and click Open.
  7. Click Submit.

If successful, the licence appears in the list under Licenses.