Skip to content

Commit

Permalink
Add docs for license status in RP resource
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeSCahill committed Nov 26, 2024
1 parent 24c7ca9 commit c7d9e47
Showing 1 changed file with 37 additions and 2 deletions.
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.

== Check the license status on the Redpanda resource in Kubernetes

If you have 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` field, allowing you to query the license state, expiration, and active enterprise features with `kubectl`.

. Identify the Redpanda resource:
+
[,bash]
----
kubectl get redpanda
----
+
Example output:
+
[.no-copy]
----
NAME AGE
example-redpanda 12m
----

. Check the license status:
+
[,bash]
----
kubectl get redpanda <resource-name> -o jsonpath='{.status.licenseStatus}'
----
+
Replace <resource-name> with the name of your Redpanda resource, such as `example-redpanda`.


The `status.licenseStatus` field includes:

- `valid`: Indicates whether the license is valid (true) or not (false).
- `expiryDate`: The date the license will expire (format: YYYY-MM-DD).
- `features`: A list of enterprise features currently in use.

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

Expand Down

0 comments on commit c7d9e47

Please sign in to comment.