CortexDB 0.12.1 — your server runs under your company's license, and renews it by itself
0.12.1 is 0.12.0 plus licenses. Nothing else changed: the data format, the routes, the request and
response shapes and the capabilities are 0.12.0's, and upgrading from 0.12.0 (or from 0.11.0, as in
RELEASE_NOTES_0.12.0.md) is a drop-in replacement.
Getting 0.12.1. From https://customer.cortexdb.ai, Releases. The install commands there now
start with your company's license (export CORTEX_LICENSE='…') and pass it to the server; run them
as they are.
Summary
- The server runs under your company's license. The install commands carry it, the server
keeps it in its data directory (
license.json) from the first start, and it renews itself fromcustomer.cortexdb.aiwhen the license is extended or the plan changes. Nothing to do on your side, and nothing to restart. - Nothing stops suddenly. Two weeks before the last day the console and the log say so. After
the last day comes a grace period (7 days for pilots, 14 for customers) in which everything
keeps working. Only after that do reads and writes answer
402 LICENSE_EXPIRED, and even then your data is untouched: health checks, the console, export (POST /v1/export) and adding a license keep working, and a renewal takes effect at once. - Offline servers keep the license they have; paste a renewed one on the console's new
License page, or set
CORTEX_LICENSEagain.CORTEX_LICENSE_URL=offstops renewal checks.
Upgrading from 0.12.0 or earlier
Add your license once: take the commands from the portal (they include it), or add
-e CORTEX_LICENSE after export CORTEX_LICENSE='<your license>' to your own docker run, or paste
the license on the console's License page after the upgrade. A server that has never had a license
keeps serving for 14 days, so an upgrade never stops you; the console and the log say how long is
left.
On a cluster, put CORTEX_LICENSE = "…" in each data node's [engine] table.
What the server sends
Renewal is one HTTPS POST to https://customer.cortexdb.ai/api/license/refresh carrying the
license, a random id for the server and its version: nothing about your data or your usage. A
few seconds after start, then every 6 hours (hourly in a license's last two weeks, every 15
minutes once it has ended). TELEMETRY.md, "License renewal", has the details.
Reference
| Setting | What it does |
|---|---|
CORTEX_LICENSE | The license (the portal's commands set it). Needed once. |
CORTEX_LICENSE_FILE | A file holding it (a mounted secret). |
CORTEX_LICENSE_URL | Where renewals come from; off stops them. |
CORTEX_LICENSE_REFRESH_SECS | Check for a renewal at least this often (not under 60). |
New error codes: 402 LICENSE_EXPIRED (the license and its grace have ended) and
402 LICENSE_REQUIRED (no license for more than 14 days). Both carry details.portal and, for an
expired license, the company, the last day and your contact.
New internal console routes: GET /internal/ui/license, POST /internal/ui/license
({"token": "…"}), POST /internal/ui/license/refresh.