License Installation

Security Requirements and Controls

The documentation covers the process of installing and managing license keys in LogScale self-hosted environments, including methods for installation through both the Administration UI and API calls. The guide explains license updating procedures, handling expired licenses, and important considerations for maintaining license functionality, such as the 30-day expiration warning and restrictions that apply when licenses expire.

After you purchase a license for running LogScale self-hosted, you need to install your license key.

You can install a key either through the Administration page within the user interface, or through an API call. If you're running LogScale in a cluster, you only have to add the key on a single node; it will be automatically propagated to all cluster nodes.

Install a license

In the account menu, select Cluster Administration. Under Other select License. Paste in the license key. Extra line breaks and white spaces are ignored.

Update a license

To update an existing license, update the license using the UI or API with the new license key.

You do not need to restart or reboot after updating a license.

Use the API

Here is an example of updating the license key using CURL:

ini
$ LICENSE_KEY="....."
  $ TOKEN=`cat /data/humio-data/local-admin-token.txt`
  $ curl -v -X POST -H "Authorization: Bearer $TOKEN" \
    -H 'Content-Type: application/json' \
    -d "{ \"query\": \"mutation { updateLicenseKey(license: \\\"$LICENSE_KEY\\\") { expiresAt } }\" }" \
  $YOUR_LOGSCALE_URL/graphql

This will return status 200 and the date your license expires.

Applying a License

When using LogScale on self-hosted infrastructure, applying a license is dependent on the host platform. To make the process as simple as possible, LogScale has created reference architectures. Details on how to apply a license can be found in Reference Architectures.

Updating a license does not require a restart or reboot.

Expired licenses

The LogScale user interface will warn you 30 days before the license expires. The license is updated using the updateLicenseKey() GraphQL mutation. No restart is required for replacing/updating the license key.

If the LogScale Operator is used, ensure that the Kubernetes secret containing the license key is also updated otherwise anything that has been added in the UI or GraphQL will be overwritten.

If your license runs out, LogScale will continue accepting ingest data while your license is renewed — but the search interval will be restricted.

You can continue to send data, create repositories, dashboards and parsers. However the search interval is limited to 1 hour, and alerts and scheduled searches will not run.