Skip to content

Quick start

This section will walk through the process of generating a license for a local workstation. This aims to introduce the basic commands of the tools and interactions with KX.

It assumes;

  • the target system is the local machine, and is a supported OS
  • it has klic installed and is connected to the Internet
  • has a version of kdb+ Cloud Edition 4.0 (>=2022.01.31) installed at $QHOME or $HOME/q (no license is required)
  • the current directory or $QLIC is a writable location

Enrollment

Start by authenticating with KX's license server. Replace your email address in the command below:

klic authenticate login --email <EMAIL>@example.com

This will prompt you to open a URL in your browser, and use the code/link in the email you are sent to complete the authentication.

Now create a tenant using the command below, replacing My Tenant with a name of your choosing:

klic tenant create 'My Tenant' --description "klic docs tenant"

Once created, you will be provided with a UUID, referred to as TENANT-UUID; make a note of this as you will need it later. However, it can always be recovered by running the command to list the tenants:

klic tenant list

Entitlement

Send your TENANT-UUID to your account manager and licadmin@kx.com who will arrange for you to be able to issue licenses to your tenant.

Environment

Creating the environment captures an identity for the target system.

klic environment create <TENANT-UUID> 'My Environment' --description "klic docs environment"

Once created you will be provided with a UUID (referred to as ENVIRONMENT-UUID) that you will need to make a note of. You may recover it by listing the environments available to you with:

klic environment list <TENANT-UUID>

License Creation

Now you have enrolled your environment, you may issue licenses for it by running:

klic license create <ENVIRONMENT-UUID> 'My License' --description "klic docs license"

Once created you will be provided with a UUID (referred to as LICENSE-UUID) that you will need to make a note of. You may recover it by listing the licenses issued to you with:

klic license list ENVIRONMENT-UUID

Tip

The LICENSE-UUID is included in the banner when you start q

When you create a license, the process will write out a kx.lic file to the directory pointed to by your $QLIC variable or $PWD if not not set.

Then run kdb+/Insights Core against with this license. You should now be presented with a functioning instance.