Skip to content

Licensing

A docker volume is provisioned with your license file or files. You can use the following command to manage your license file:

edgexpert license [<option>]

The options are as follows:

Option Description
install Installs the specified licenses to the license volume
uninstall Uninstall the specified license
view Lists all currently installed licenses
check Validates all installed licenses
clean Deletes the license volume

Before using Edge Xpert, you must install the license which is validated each time Edge Xpert starts.

Install a License

To install a license, do the following:

  1. Open a terminal
  2. Enter the following command:

    edgexpert license install <path>/<license file>
    

    If the license is successfully installed, the terminal displays the following:

    <license file>  Creating license volume: edgexpert_license-data
    The following license/s were installed:    <license file>
    

Read Permission for License

Please ensure that your license file has the appropriate read permissions. Other Permissions should allow containers to read the license file. You can verify this using the following command:

ls -l <path>/<license file>
The permission column of the license file should look like -rw-rw-r--. The Other permission is the three-character block to the furthest right. If this is not r--, read permissions can be granted with the following command:

chmod +r <path>/<license file>

If read permission has not been granted for your license file, Edge Xpert services will not be able to run correctly.

Validate a License

To validate a license, do the following:

  1. Open a terminal
  2. Enter the following command:

    edgexpert license check
    

    If the check is successful, the terminal displays the following:

    Edge Xpert Licensing: Validating License File <license file>
    Edge Xpert Licensing: Signature valid
    Edge Xpert Licensing: License valid
    

List Installed Licenses

To list all installed licenses, do the following:

  1. Open a terminal
  2. Enter the following command:

    edgexpert license view
    

    The terminal displays a list of all installed licenses.

Uninstall a License

To uninstall a license, do the following:

  1. Open a terminal
  2. Enter the following command:

    edgexpert license uninstall <license file>    
    

    If the license is successfully uninstalled, the terminal displays the following:

    Successfully uninstalled license: <license file>
    

Delete the License Volume

To delete the license volume, do the following:

  1. Open a terminal
  2. Enter the following command:

    edgexpert license clean
    
  3. Enter y when prompted, as illustrated below, to confirm deletion of the license-data volume and to clear all installed licenses:

    clean: delete the license-data volume and clear all installed licenses (y/n)? y
    
Back to top