KernelCare Activation Keys

Navigation:  Dashboard > Products >

KernelCare Activation Keys

Previous pageReturn to chapter overviewNext page

Click KernelCare at the top menu to go to KernelCare Activation Keys page. Here you can see server licenses (used/limits).

 

KCActivationKeyPage

 

There are two types of KernelCare licenses available: IP-based and key-based. IP-based license can only be used by IP address it is issued to, while key-based licenses can be migrated to another server within the IP range defined for the key.

 

Key-based licenses

 

Every KernelCare customer gets a default activation key upon license purchase. You can have multiple activation key in your account, however the overall number of licensed servers cannot exceed the number of purchased licenses.

 

The following actions are available:

 

Copy a Default Activation Key. Click a key to copy it to a clipboard.

Generate a new Activation Key. Click Generate new activation key. In an opened popup specify Server quantity limit, IP range limit, Sticky tag , and add some Notes, if any, and click Save Changes to confirm the action or Cancel to close the popup.

 KCEditpng

Manage servers.

Add server licenses.

Remove unused server licenses. Click Remove unused server licenses to delete all server licenses that are not used to activate a server. Do it to reduce your monthly bill as a customer pays per each server license and NOT per an activated server. Confirm your action in the opened popup by clicking Remove or click Cancel to close the popup.

Go to Activation Key Details page. To do so, click a specific activation key in the table.

The table with a list of of all KernelCare Activation Keys contains the following columns:

 

Activation key — an activation key string. Click an activation key to go to Activation Key Details page.

IP range — a range of IP addresses for a particular activation key;

Note — any information you've added to a particular activation key;

Servers (used/limits) — shows how many servers have already been activated with this key (used) and a total number of servers that can be activated with this key (limits).

The following actions are available:

 

filter keys by server limits — click Server Limits and choose a desired number or unlimited;

search for an activation key — type a search query and the table will filter a list of keys;

delete one or several activation keys — tick one or several activation keys or the checkbox in the table header (to select all) and click Bin icon. In the popup, click Remove to confirm the action or Cancel to close popup. Note that Default Activation Key cannot be deleted.

 

KernelCare Activation Key Details Page

 

On the KernelCare Activation Keys page click an activation key in the table to go to KernelCare Activation Key Details page.

 

KernelCareActivationKeyDetails

 

This page contains the following information:

 

An activation key itself is displayed on the blue background; to copy it to a clipboard just click it;

Servers (used/limits) — number of servers that have already been activated with this key (used) and a total number of servers that can be registered with this particular key (limits);

Note — any information you’ve added to this activation key.

Sticky tag — when the Sticky Tag feature is enabled for particular servers, all such servers will get patches only released before the date specified in the Sticky tag field.

The following actions are available:

 

Edit key. Click Edit Key button. In the opened popup you can change a number of servers that can be activated with this key, change IP range limit, manage sticky tags (see Patch management with CLN portal (Sticky Tag)), and enter some notes. To apply changes click Save Changes or Cancel to close the popup.

Remove key. Click Remove Activation Key button to  remove an activation key with all the associated servers. In the opened popup click Remove to apply changes or Cancel to close the popup. Note that you cannot delete a default activation key.

KCRemoveKey

 

Below, there is a table with all servers activated with this activation key. The table contains the following columns:

 

Server name — a hostname of the server.

IP — an IP address of the activated server.

Registered — a date when a server was activated. A server sends this information to CLN.

Effective Kernel —  a version of kernel used.

Last check-in — the date of last successful server check-in.

The following actions are available:

 

Filter servers list by date of registration. Click Registered Date and select a date or a period to show servers registered within selected period or date.

Search in the list by a specific query. Type a search query in the search field to show specific servers.

Remove a server from this activation key. In this case, a server will not be able to use KernelCare anymore. To do so, tick server(s) and click Bin icon above the table.

 

Patch management with CLN portal (Sticky Tag)

 

The best way to handle QA and Production environments is to use Sticky Tag feature of KernelCare activation keys issued from CloudLinux Network (CLN) portal.

To use this tag, go to CLN portal → KernelCare tab → click a key to edit → click Edit Key.

You should provide a separate key for each environment and set them to a particular sticky tag which is actually the date to which all the servers in an environment have to be patched.

 

KCStickyTag

 

The date in Sticky tag field can be any date from May 28, 2018 up to one day before today.

 

To use Sticky Tag feature on the servers to be patched, run:

 

$ /usr/bin/kcarectl --set-sticky-patch=KEY

 

Alternatively, you can do the same by adding STICKY_PATCH=KEY to /etc/sysconfig/kcare/kcare.conf file.

Warning! Do not replace the KEY word with the actual KernelCare license key used to register the server.

 

When the Sticky Tag feature is enabled for particular servers, all such servers will get patches only released before the date specified in the Sticky tag field.

 

This way, you can add new patches to all the servers in some environment (i.e. registered with the same KernelCare license key) by updating only a single field in the CLN portal.

 

KernelCare Monitoring

 

Built-in monitoring

 

Systems protected by KernelCare can be monitored by means of CloudLinux Network (CLN) portal available at https://cln.cloudlinux.com. Click KernelCare activation key to see the list of servers activated with it. Servers marked with exclamation mark do not have the latest KernelCare patches installed.

 

KCKeyMonit

 

KernelCare monitoring API

 

It is possible to integrate KernelCare status monitoring with any third-party monitoring system that supports REST API.

 

The query syntax for key-based licenses is: https://cln.cloudlinux.com/api/kcare/nagios/{key_id}

The query syntax for IP-based licenses (resellers) is: https://cln.cloudlinux.com/api/kcare/nagios-res/{login}/{token}

 

The latest CloudLinux REST API description is available at https://cln.cloudlinux.com/clweb/downloads/cloudlinux-rest-api.pdf