Skip to content
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.

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

DOC-677 Add docs for license status in redpanda resource #879

Open
wants to merge 5 commits into
base: v-WIP/24.3
Choose a base branch
from
Open
Changes from all commits
Commits
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
39 changes: 37 additions & 2 deletions modules/get-started/pages/licensing/monitor-license-status.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Check the Status of an Enterprise Edition License
:description: pass:q[Learn how to monitor the status of your Redpanda Enterprise Edition license using `rpk`, the Redpanda Console, the Admin API, and observability tools such as logs and metrics.]
:description: pass:q[Learn how to monitor the status of your Redpanda Enterprise Edition license using `rpk`, Redpanda Console, and observability tools such as logs and metrics.]

To track license expiration and ensure compliance with xref:get-started:licensing/overview.adoc[Redpanda licensing], you can monitor the status of your Enterprise Edition license using <<rpk, `rpk`>>, <<console, Redpanda Console>>, and observability tools such as <<logs, logs>> and <<metrics, metrics>>.

Expand Down Expand Up @@ -32,7 +32,7 @@ Indicates the current state of the license. Possible values include:
* `expired`: The license has expired, and restrictions may apply to enterprise features.
* `not_present`: No license is currently applied.

|License violation
|License violation
|
A boolean value that indicates whether enterprise features are being used in violation of the licensing terms:

Expand Down Expand Up @@ -147,6 +147,41 @@ Redpanda Console displays warnings in the following scenarios:

- *Redpanda Self-Managed enterprise features are in use without a valid license*: If the Redpanda cluster is using enterprise features without a valid license, Redpanda Console displays a warning specifying the features in use without proper licensing.

== Use the Redpanda Operator to check license status

If you deployed a Redpanda cluster in Kubernetes using the Redpanda Operator, you can monitor the Enterprise Edition license status from the Redpanda custom resource. The operator integrates license monitoring into the resource's `status.conditions` field, allowing you to get the license state with `kubectl`.

Identify your Redpanda resources:

[,bash]
----
kubectl get redpanda -A
----

Example output:

[.no-copy]
----
NAMESPACE NAME LICENSE READY STATUS
redpanda cluster Valid True Redpanda reconciliation succeeded
----

The `License` field indicates whether the license is valid. Possible values include:

- `Valid`: The license is valid.
- `Expired`: The license has expired.
- `Not Present`: No license is applied.

The Redpanda Operator performs a license check during reconciliation, which is triggered in the following cases:

- If changes are made to the Redpanda resource or its status.

- If changes are made to resources managed by the operator, such as the StatefulSet resources for brokers or Deployment resources for Redpanda Console.

- If no changes occur, the operator reconciles every 10 hours (default cache resync interval).

- If you force reconciliation by making a no-op change, such as adding an annotation, to the Redpanda resource.

[[logs]]
== Monitor a license in the logs

Expand Down