DOC-677 Add docs for license status in redpanda resource #879
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
modules/get-started/pages/licensing/monitor-license-status.adoc
Outdated
Show resolved
Hide resolved
modules/get-started/pages/licensing/monitor-license-status.adoc
Outdated
Show resolved
Hide resolved
| - `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. |
There was a problem hiding this comment.
Just FYI, other than valid, we don't show this information in Kubernetes, and valid is just a status condition, there's no licenseStatus part of the CRD, we only publish status information under the ClusterLicenseValid condition in status.conditions.
We could add additional details if we want to, but that's not how this currently works. @david-yu thoughts about extending the status to incorporate some of these or is just publishing how to check these via execing and running rpk cluster license info enough since we publish the non-granular license status in the CRD?
There was a problem hiding this comment.
@andrewstucki It would be nice to include those fields as well. I don't know if its possible to do another release of the Operator by Tuesday that includes those fields?
There was a problem hiding this comment.
Also is this status going to be updated a lot or will only happen maybe like once an hour or so?
There was a problem hiding this comment.
It may be possible to cut something by Tuesday, but seeing as it's a long holiday weekend and the changes will need to get reviewed, it might not land.
RE the updates -- this license check would get run every reconciliation, so whenever something on the Redpanda object (including status) change, when any of its owned resources that it's set up to watch change (I know it watches the StatefulSet, and any Deployments from things like Console), or by default 10 hours defined by a cache resynchronization setting in the controller runtime.
There was a problem hiding this comment.
Ok lets see how it goes through this week. Perhaps Rafal can help review if a PR is available by tomorrow?
|
Updated the PR to document how it currently works. I can follow up if/when we change the operator to display more data like expiry and enabled features.. |
Description
Review deadline: 27 November
Page previews
https://deploy-preview-879--redpanda-docs-preview.netlify.app/24.3/get-started/licensing/monitor-license-status/#check-the-license-status-on-the-redpanda-resource-in-kubernetes
Checks