Skip to content

Update license expiry details #8409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −12
Open

Update license expiry details #8409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 47 additions & 12 deletions app/_src/gateway/licenses/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,58 @@

Licenses expire at 00:00 on the date of expiration, relative to the time zone the machine is running in.

Kong Manager displays a banner with a license expiration warning starting at 15 days before expiration.
Expiration warnings also appear in [{{site.base_gateway}} logs](#license-expiration-logs).

After the license expires, {{site.base_gateway}} behaves as follows:

* Kong Manager and its configuration are accessible and may be changed, however any [Enterprise-specific features](/gateway/{{page.release}}/kong-enterprise/) become read-only.
* The Admin API allows OSS features to continue working and configured {{site.ee_product_name}} features to continue operating in read-only mode.
* Proxy traffic, including traffic using Enterprise plugins, continues to be processed as if the license had not expired.
* Other Enterprise features are not accessible.
* There may be some Enterprise features that are still writable, but they may also change later, so do not rely on this behavior.

The behavior of the different deployment modes is as follows:
### Before Expiration

- Kong Manager displays a banner with a license expiration warning starting 15 days before expiration
- Expiration warnings also appear in [{{site.base_gateway}} logs](#license-expiration-logs)

### After Expiration (30 day grace period)

- Kong Manager displays a banner with a license expiration warning for a 30 day grace period
- Critical expiration events appear in [{{site.base_gateway}} logs](#license-expiration-logs)
- Kong Manager, its configuration and OSS features are accessible and may be changed
- [Enterprise-specific features](/gateway/{{page.release}}/kong-enterprise/) become read-only
- [Enterprise-specific features](/gateway/{{page.release}}/kong-enterprise/) may be modified using the Admin API

### After Grace Period

- Kong Manager displays a banner with a license expiration warning
- Critical expiration events appear in [{{site.base_gateway}} logs](#license-expiration-logs)
- Kong Manager, its configuration and OSS features are accessible and may be changed
- [Enterprise-specific features](/gateway/{{page.release}}/kong-enterprise/) become read-only in both {{site.base_gateway}} and the Admin API[^1]

[^1]: There may be some Enterprise features that are still writable, but they may also change later, so do not rely on this behavior.

```mermaid
timeline
title License Expiration Timeline
section Before Expiration
-90 days : `WARN` log entry once a day
-30 days : `ERR` log entry once a day
-15 days : `ERR` log entry once a day
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gateway does not print logs for 15 days before the license expires.

: Kong Manager displays a license expiration warning
section License Expires (Grace Period begins)
0 days : `CRIT` log entry once a day
: {{site.base_gateway}}, it's configuration and OSS features remain accessible
: Data plane traffic (including traffic using Enterprise plugins) will continue to processed as before
: Enterprise-specific features will become read-only in {{site.base_gateway}}
: Enterprise-specific features can be modified using the Admin API
section Grace Period Expires
+30 days : `CRIT` log entry once a day
: {{site.base_gateway}}, it's configuration and OSS features remain accessible
: Data plane traffic (including traffic using Enterprise plugins) will continue to processed as before
: Enterprise-specific features will become read-only in {{site.base_gateway}} and the Admin API
```

### Data Plane Nodes
The behaviour of Data Plane nodes at license expiry depnd on the deployment mode:

Check failure on line 105 in app/_src/gateway/licenses/index.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[kong.Spelling] Did you really mean 'depnd'?

Raw Output:
{"message": "[kong.Spelling] Did you really mean 'depnd'?", "location": {"path": "app/_src/gateway/licenses/index.md", "range": {"start": {"line": 105, "column": 53}}}, "severity": "ERROR"}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The behaviour of Data Plane nodes at license expiry depnd on the deployment mode:
The behaviour of Data Plane nodes at license expiry depend on the deployment mode:


- **Traditional:** Nodes will be able to restart/scale as needed.
- **Hybrid:** Existing data planes or new data planes **can accept** config from a control plane with an expired license.
- **DB-less and KIC:** New nodes **cannot** come up, restarts will break.

### Deploying a new license

To upload a new license, see [Deploy an Enterprise License](/gateway/{{page.release}}/licenses/deploy/).

### License expiration logs
Expand Down
Loading