Licence
Your VoisX Orchestrate licence is a signed file. The License Service checks its signature inside your cluster, against the VoisX licence keys built into the service. Nothing calls home, so this works on an air-gapped network.
You receive only the licence file. There is no public key to install: the License Service already holds ours, and it trusts no other.
Don't edit the licence file. Any edit makes the signature check fail.
Get your licence file
Your licence comes from the VoisX portal, separately from the software. See How you receive VoisX Orchestrate.
- Sign in to the portal and open Licences. It lists every licence of your organization, with its product, seats, features, expiry date and status (active, expired or revoked).
- Choose Download on the active VoisX Orchestrate licence. You get a
.licfile.
The licence file isn't secret, but it is issued to your organization: keep it with your install's configuration and don't share it.
Until the portal is open, your VoisX contact sends the licence file directly.
Activate the licence for your cluster
Your licence is bound to the clusters it is activated on, up to the number of installs it allows, and works only on those clusters. Activation needs no connection from your cluster: you carry a short text request out, and the activated licence back in.
-
Licence binding is on.
voisctl installturns it on, andvoisctl upgradeturns it on for an older install that never set it. If you installed with plain Helm, set it in your values file and apply the change as in Configuration:site.yamllicense:
binding:
enabled: true -
Make an activation request on the cluster. It reads your cluster's identity, creates the install's own key (kept in a Secret in the
vois-orchestratenamespace) and writes a request signed with it:./voisctl licence activation-request --licence ./<your-licence-file> \
--context <your-context> --out activation-request.txtThe request holds no secret. Carry it to a machine that can reach the portal.
-
Activate it. On the portal, open the licence's Installs page, paste the request and submit. The portal returns a licence for this install alone. If it refuses, it says why, for example that every install slot is taken.
-
Bring the activated licence in and apply it as below. The licence you downloaded first works on no cluster: always apply the one the activation returned.
Until the portal is open, send the activation request to your VoisX contact. We send the activated licence back.
The Installs page lists every install the licence is activated on, with its last check-in and version. Release frees a slot, for example when you retire a cluster; that install's licence stops working.
Connected sites check in with VoisX once a day and hold a 30-day pass. A licence that we revoke, or a slot you release, takes effect at the next check-in. After 30 days without a successful check-in the licence shows checkin_overdue for the grace period, then the install is degraded.
Air-gapped sites never check in: their licence says so (checkin: none). At renewal, make a signed usage report on the cluster and paste it on the licence's page on the portal (or send it to your VoisX contact):
./voisctl licence usage-report --context <your-context> --out usage-report.txt
Apply the licence
There are two ways. Use one of them.
Upload it in the console
- Sign in as a platform admin and open Licence.
- Paste the licence text and install it.
- The License Service checks the signature and the expiry date before it keeps anything. A licence that is forged, damaged or already expired is refused, and the licence in force stays as it was.
Uploading is open even when the current licence has lapsed, because that is when you need it. Each upload is an audit event.
Uploading needs license.storage.enabled, which is on by default. It gives the License Service a small volume of its own, so it needs a default StorageClass, like the data stores. With it off, uploading answers 409 and names the setting.
Deliver it as a Kubernetes Secret
-
Store the file in a Secret, under the key
license.txt:kubectl --context <your-context> -n vois-orchestrate create secret generic vois-orchestrate-license \
--from-file=license.txt=./<your-licence-file> -
Name the Secret in your values file, and apply the change as in Configuration:
orchestrate-values.yamllicense:
secretName: vois-orchestrate-license
The chart mounts the Secret into the License Service. A renewal is then a Secret update: the License Service reads the file again every 10 minutes (license.revalidateSeconds), with no restart.
With neither an upload nor a Secret, the install runs unlicensed.
Check the licence status
In the console, open Licence. It shows the status, the licensed features and their limits, seats used, and the expiry date. The System page shows the licence too.
Through the API, a signed-in user can read GET /license/status.
The response has these fields:
| Field | Contents |
|---|---|
status | valid, grace, expired, invalid or unlicensed. See below. |
enforcement | full, degraded or unlicensed: what the platform does about it. |
detail | Why the licence isn't valid, or how long the grace period has left. |
tenant_id | Your tenant ID, as named in the licence. |
seats, seats_used | The seats in your licence, and how many are used. |
features | The licensed features, such as realtime and channels. |
modules | Each platform module and whether the licence allows it. |
limits | Limits the licence sets, such as the number of code agents or channels. |
expires_at, days_remaining | When the licence expires, as a Unix timestamp, and the days left. |
grace_days, grace_ends_at, grace_days_remaining | The grace period after expiry. |
What each status means
| Status | Meaning | What still works |
|---|---|---|
valid | The signature checks out and the licence hasn't expired. | Everything the licence includes. |
grace | The licence has expired, but less than the grace period ago (14 days by default). | Everything. Every status read says how many days are left. |
expired | The grace period has ended. | Everything already running: agent runs and chats, voice calls, evals, reads, deletes and policy changes. Actions that grow the install are refused with 402. |
invalid | The file can't be read, isn't a licence, or fails the signature check. detail gives the reason. | The same as expired. |
unlicensed | No licence has been uploaded or configured. | Everything, with no limits. This is a development mode, and every status read says so. |
The actions that grow an install are: deploying or building a model, uploading model files, registering a cluster, creating agents, code agents, projects, folders, organizations, connectors and knowledge bases, and adding or changing members. A lapsed licence never takes your running agents offline, and never stops an admin tightening security or removing users.
Features and limits
| Feature | Unlocks |
|---|---|
realtime | Voice sessions and phone calls |
model_serving | Deploying models |
rag | Knowledge bases |
agent_runtime | Code agents: creating, building, deploying and growing them. Versions already running keep serving without it. |
usage_controls | Setting budgets, rate limits, key scopes and model prices. Limits already set are enforced without it. |
enterprise_connectors | SQL Server and Oracle connectors, and connectors that act as each user. Connectors already made keep running without it. |
channels | Microsoft Teams, Slack and WhatsApp channels |
A licence can also set limits:
| Limit | What it caps |
|---|---|
| Seats | Distinct people with a membership anywhere. Adding a person who would take the install past it is refused with 402. Giving an existing member another role or project never costs a seat. |
max_code_agents, build_minutes_per_month, max_runtime_replicas | Code agents in the install, their build minutes per month, and their running replicas. |
max_channels, messages_per_month | Channel connections, and inbound channel messages accepted per month. |
A feature that the licence leaves out is refused with 403 and a message that names it.
If the License Service can't be reached, actions that grow the install fail closed with 503 once the last good answer is 15 minutes old. Module checks keep using the last answer.
Code agent quotas
A platform admin can set per-project quotas for code agents on the Licence page: code agents, builds at once, build minutes per month, and runtime CPU, memory and GPUs. Projects without their own quota use the defaults in agents.quotas.projectDefaults. The licence's install-wide limits apply on top. See Code agents.
Renew or replace the licence
Before your licence expires, contact us to renew. The renewed licence appears on the portal's Licences list as a new licence, and the old one is withdrawn. A renewal is only a new licence file: you don't need a new release, and an online site gets a new registry credential with it.
Download the new licence (and, for a bound licence, activate it for each cluster as above). Then upload it in the console, or replace the file in the Secret:
kubectl --context <your-context> -n vois-orchestrate create secret generic vois-orchestrate-license \
--from-file=license.txt=./<your-new-licence-file> \
--dry-run=client -o yaml | kubectl --context <your-context> apply -f -
The License Service picks it up within 10 minutes. Check the status afterwards.
Back up the licence
With backups turned on, a licence uploaded in the console can be copied to your backup storage every night. A licence in a Secret is part of your own configuration: keep a copy with your values file.
For questions about seats, features or terms, contact us.