License Server Installation

a license server provides an efficient and secure way to install and manage licenses to multiple edge devices (bare metal, docker, vm, k8s) a built in license server is available with litmus edge manager, so you don't need to complete any additional setup for it you can also set up and install a license server separately in an air gapped environment after receiving a site license key from the litmus central portal https //central litmus io/ , a respective site license can then be activated and added to the license server if you set up the license server with litmus edge manager, see license server management docid 5u hnnsavs e5hqjeq0o for more information on managing site licenses if you set up the license server without litmus edge manager, see the section below install licenses in license server for more information on adding licenses through the license server you can also add site based licenses to individual litmus edge instances see the section below register license server to individual litmus edge instance to learn more license server with litmus edge manager (easy) if your organization has an instance of litmus edge manager along with instances of litmus edge, then you can install and manage the license server in litmus edge manager see license server management docid 5u hnnsavs e5hqjeq0o and activate an edge device docid\ odxkra2uhii7rg92cw2q for more information set up license server without litmus edge manager (advanced) you can set up a license server without litmus edge manager by completing the steps below before you begin to set up the license server, you will need to do the following install docker engine 19 03+ on an ubuntu or similar linux system it can be a vm or bare metal it must be installed separately from any litmus edge and litmus edge manager make sure the host system has the correct system time and is connected to any ntp server for proper time sync any change in the system time on the host system will invalidate the license have administrative permissions to execute docker commands on the host system ensure the docker engine is configured to run a docker run command obtain access to a license server docker image, which is available from the litmus central portal https //central litmus io/ configure firewall inbound port access to the host and docker container from an external edge device 8443 tcp, 8445 tcp step 1 generate api key (optional) note you can deploy the license server without uuid/generating the api key this step is optional to generate the api key, enter the following command in a command prompt window \# generate a random apikey secret \# copy the apikey to a safe storage apikey secret=$(uuidgen) && echo $apikey secret note after the key is generated, make sure to copy it and store it securely step 2 set server ip and dns to set the server ip and dns, enter the following command in a command prompt window \# set the server ip/dns it should be accessible from the edge device on port 8445 server url=172 17 0 1 8445 the server url is the ip address or the dns address of the host system the server ip/dns you configure in the command should be accessible from the edge device on port 8445 step 3 download license server docker image to download the license server docker image 1\ download the service account json file from the litmus central portal 2\ open a command prompt window on the host system 3\ enter the following linux command to authenticate cat \<file name> json | docker login u json key password stdin https //us docker pkg dev the \<file name> json parameter is the service account file requested from step 1 example if the json file is named abc123 json, enter cat abc123 json | docker login u json key password stdin https //us docker pkg dev refer to google's setting up authentication service account key https //cloud google com/artifact registry/docs/docker/authentication#json key for more information 4\ pull the license server docker image with the following command docker pull us docker pkg dev/litmus sales enablement/ls/litmus licensing server\ latest step 4 run license server to deploy the license server, enter the following docker command \# run license server docker container docker run name=lls d v lls\ /var/lib p 8443 8443 p 8445 8445 e litmus licensing api key=$apikey secret e litmus licensing server url=$server url us docker pkg dev/litmus sales enablement/ls/litmus licensing server\ latest if the docker is not in a running state, an error message will be generated the $apikey secret and $server url are the variables created in step 1 (api key) and step 2 (server ip and dns) install licenses in license server once you have set up the license server without litmus edge manager, you can start installing licenses in the license server note if you have already set up a license server through litmus edge manager, see license server management docid 5u hnnsavs e5hqjeq0o and activate an edge device docid\ odxkra2uhii7rg92cw2q to learn how to manage licenses through litmus edge manager before you begin request the activation key you will need from the litmus central portal https //central litmus io/ install a license in litmus edge to install a license in litmus edge in a web browser, log in to the license server you previously installed in the following format \[license server url] \[port number] for example 10 19 12 48 8443 if this is the first time you are logging in to the license server, enter the following default credentials username admin password password click add license the add license dialog box appears in the license key field, enter or paste the activation key you received from litmus if you will be upgrading the core license, select the upgrade core license check box click generate request click the copy icon for the activation request then, click the url ( https //litmus activate id ) to visit the licensing portal page in the activation request box, paste the activation request you copied in the previous step then, click the i'm not a robot check box click make license copy the license key that is created and return to the license server page from the add license dialog box, click next in the activation data field, paste the license key you copied in step 9 click add the license is added to the license server register license server to individual litmus edge instance if you set up a license server without litmus edge manager, you have the option of registering the license server to individual litmus edge instances note if you have already set up a license server through litmus edge manager, see license server management docid 5u hnnsavs e5hqjeq0o and activate an edge device docid\ odxkra2uhii7rg92cw2q to learn how to manage licenses through litmus edge manager to register the license server to an individual litmus edge instance from the license server page, click authorize device the authorize device dialog box appears in the device label field, enter a name for the litmus edge instance click generate configuration a configuration key is generated click copy & close the configuration key is copied and the dialog box closes in litmus edge, navigate to system > license in the license server settings section, click set server the set license server configuration dialog box appears in the configuration field, paste the configuration key you copied click save the license is added to the litmus edge instance and the instance is added to the devices section in the license server page