Skip to content

Installation

To install the license management client tool, klic, replace the username and password below with those of your KX nexus account. Then run the commands on your target machine.

NEXUS_USER=<redacted>
NEXUS_PASSWORD=<redacted>
python3 -m pip install --extra-index-url https://$NEXUS_USER:$NEXUS_PASSWORD@nexus.dl.kx.com/repository/klic/simple klic==1.0.0

This will install the klic tool to ~/.local/bin. You should add this directory to your PATH environment variable. Alternatively you may wish to install the tool globally by running it with sudo (or directly as root).

You should now be able to run klic, and see some navigable usage instructions.

$ klic
Usage: klic [OPTIONS] COMMAND [ARGS]...

Options:
    --debug  Enable debugging
    --help   Show this message and exit.

Commands:
    accounting      Accounting (usage) management
    authenticate    Authentication
    bastion         Start Bastion helper
    entitlement     Entitlement management.
    environment     Environment management
    group           Group management
    license         License management
    permission      Tenant group permissions management
    serviceaccount  Service Account management
    tenant          Tenant management

It is recommended that the commands walked through in this document are explored by yourself, to discover further options and sub-commands and gain further familiarity and understanding. This can be done by passing in --help to any command or sub-command.

Offline targets

If the target system to be licensed is offline (air-gapped), klic will need to be installed there for the environment enrollment. This is described in more detail later. The instructions below describe the process of installing klic on that system.

As before, you will need to replace your KX Nexus credentials in the commands below.

  1. Run the commands below on your workstation to download the client.

    NEXUS_USER=<redacted>
NEXUS_PASSWORD=<redacted>
python3 -m pip download -d bundle setuptools wheel https://$pip_user:$pip_password@nexus.dl.kx.com/repository/klic/packages/klic/1.0.0/klic-1.0.0.tar.gz
tar zcf bundle.tar.gz bundle

  2. Copy bundle.tar.gz to your air-gapped target and run the commands below to install it.

    tar zxf bundle.tar.gz
cd bundle
python3 -m pip install --no-index --find-links bundle klic-1.0.0.tar.gz