DOC-502 License enforcement updates #813

JakeSCahill · 2024-10-15T11:43:29Z

Description

Documents the new licensing enforcement rules for Redpanda and Console in 24.3 and fixes some related issues:

Review deadline: 18 October

Consistent licensing terminology (Community Edition and Enterprise Edition) for all products was agreed with David Foley on Slack. Updates to the licenses product in GitHub repos are forthcoming.

Page previews

What's new
Licensing
Add a license for Redpanda Self-Managed (Linux/Kubernetes)
Add a license through Redpanda Console
Note for reviewers: I assumed this method does not work for Kubernetes and added a note explaining why. Please check this part in particular.
Upgrade Redpanda (also added to the list of upgrade limitation)

Checks

New feature
Content gap
Support Follow-up
Small fix (typos, links, copyedits, etc)

netlify · 2024-10-15T11:43:45Z

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	`58f14f2`
🔍 Latest deploy log	https://app.netlify.com/sites/redpanda-docs-preview/deploys/6716185be7ccf90008bea377
😎 Deploy Preview	https://deploy-preview-813--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Deflaimun · 2024-10-15T15:32:45Z

make sure to rebase with the latest from v-wip/24.3

modules/console/pages/ui/add-license.adoc

pgellert · 2024-10-16T17:09:22Z

modules/get-started/partials/enterprise-features.adoc

@@ -0,0 +1,19 @@
+// tag::self-managed[]
+* xref:manage:tiered-storage.adoc[Tiered Storage]
+* xref:manage:cluster-maintenance/continuous-data-balancing.adoc[Continuous Data Balancing]


There are also some new ones to add:

core_balancing_continuous (since 24.2) - https://docs.redpanda.com/current/manage/cluster-maintenance/cluster-balancing/

iceberg_enabled

leadership_pinning_enabled

These two new ones will get added in a separate PR.

modules/get-started/pages/licensing/overview.adoc

modules/manage/partials/troubleshooting.adoc

Co-authored-by: Gellért Peresztegi-Nagy <pereszteginagy.gellert@gmail.com>

modules/console/pages/ui/add-license.adoc

modules/get-started/pages/licensing/overview.adoc

modules/get-started/partials/enterprise-features.adoc

modules/get-started/partials/licensing/enterprise-features.adoc

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc

chrisseto · 2024-10-18T15:43:35Z

modules/console/partials/licensing/kubernetes-note.adoc

@@ -0,0 +1,3 @@
+ifndef::env-kubernetes[If you use Kubernetes to deploy Redpanda, do]
+ifdef::env-kubernetes[Do]
+not use Redpanda Console to update the license if it's already set in your Kubernetes resources. During upgrades or redeployments, license values in your Kubernetes resources will override the license set using Redpanda Console. For consistent license management, set the license using either Redpanda Console or Kubernetes resources, but not both.


👨‍🍳 💋

chrisseto · 2024-10-18T15:47:08Z

modules/manage/pages/kubernetes/troubleshooting/k-troubleshoot.adoc

 +
- Update the redpanda.yaml configuration file. You can make changes to any of the following sections in the Redpanda Helm chart to trigger an update:
-* `config.cluster`
+- Make changes to any of the following sections in the Redpanda Helm chart to trigger an update:


Could we add an example just to give users something to copy paste? Changing crash_loop_limit to any other integer would be a great option IMO as it won't really impact anything else in the cluster.

Added an example in YAML

modules/upgrade/pages/k-rolling-upgrade.adoc

modules/get-started/pages/whats-new.adoc

modules/get-started/pages/licensing/add-license-redpanda/linux.adoc

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc

Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>

asimms41

Looks great! Just a couple of very minor suggestions.

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc

Co-authored-by: Paulo Borges <paulohtb@hotmail.com> Co-authored-by: Gellért Peresztegi-Nagy <pereszteginagy.gellert@gmail.com> Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>

Deflaimun and others added 2 commits October 2, 2024 12:26

Update config for new beta

0d4081f

DOC-502 License enforcement updates

ac742ee

JakeSCahill requested a review from a team as a code owner October 15, 2024 11:43

JakeSCahill requested review from mattschumpert and pgellert October 15, 2024 11:43

Remove console page

34e0399

Deflaimun force-pushed the v-WIP/24.3 branch from 0d4081f to 0e35e26 Compare October 15, 2024 15:29

Merge branch 'v-WIP/24.3' into licensing-24.3

0df1a53

JakeSCahill requested review from RafalKorepta, chrisseto and weeco October 15, 2024 15:33

pgellert reviewed Oct 17, 2024

View reviewed changes

Apply suggestions from code review

331f70c

Co-authored-by: Gellért Peresztegi-Nagy <pereszteginagy.gellert@gmail.com>

JakeSCahill requested a review from pgellert October 17, 2024 08:00

Update monitor-license-status.adoc

d52480c

weeco reviewed Oct 17, 2024

View reviewed changes

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

JakeSCahill commented Oct 17, 2024

View reviewed changes

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

JakeSCahill commented Oct 17, 2024

View reviewed changes

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

JakeSCahill commented Oct 17, 2024

View reviewed changes

modules/console/pages/ui/add-license.adoc Show resolved Hide resolved

JakeSCahill commented Oct 17, 2024

View reviewed changes

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

cc9244b

JakeSCahill requested a review from weeco October 17, 2024 12:25

JakeSCahill and others added 5 commits October 17, 2024 14:50

Apply suggestions from code review

5ff577f

Add Console as an option to Kubernetes license guide

e15dc37

Single source license check

20f1192

cluster.config no longer works to fix crash loop backoff

d29dcc6

Add links to roll back

756fe9e

weeco approved these changes Oct 17, 2024

View reviewed changes

Apply suggestions from code review

6521a04

JakeSCahill commented Oct 18, 2024

View reviewed changes

modules/console/pages/ui/add-license.adoc Outdated Show resolved Hide resolved

JakeSCahill commented Oct 18, 2024

View reviewed changes

modules/get-started/pages/licensing/overview.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

caeef3b

JakeSCahill requested a review from asimms41 October 18, 2024 14:16

JakeSCahill commented Oct 18, 2024

View reviewed changes

modules/get-started/partials/enterprise-features.adoc Show resolved Hide resolved

JakeSCahill commented Oct 18, 2024

View reviewed changes

modules/get-started/partials/licensing/enterprise-features.adoc Show resolved Hide resolved

Apply suggestions from code review

c2ede4d

chrisseto reviewed Oct 18, 2024

View reviewed changes

asimms41 reviewed Oct 18, 2024

View reviewed changes

modules/get-started/pages/whats-new.adoc Outdated Show resolved Hide resolved

asimms41 reviewed Oct 18, 2024

View reviewed changes

modules/get-started/pages/whats-new.adoc Outdated Show resolved Hide resolved

asimms41 reviewed Oct 18, 2024

View reviewed changes

modules/get-started/pages/licensing/add-license-redpanda/linux.adoc Outdated Show resolved Hide resolved

JakeSCahill commented Oct 18, 2024

View reviewed changes

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc Outdated Show resolved Hide resolved

asimms41 reviewed Oct 18, 2024

View reviewed changes

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

33b5d86

Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>

asimms41 approved these changes Oct 18, 2024

View reviewed changes

Add example

29e26f3

JakeSCahill commented Oct 18, 2024

View reviewed changes

modules/get-started/pages/licensing/add-license-redpanda/kubernetes.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

2be494d

JakeSCahill requested a review from chrisseto October 18, 2024 16:22

Update enterprise-license.adoc

58f14f2

JakeSCahill merged commit 9e25290 into v-WIP/24.3 Oct 22, 2024

JakeSCahill deleted the licensing-24.3 branch October 22, 2024 14:58

DOC-502 License enforcement updates #813

DOC-502 License enforcement updates #813

Uh oh!

Conversation

JakeSCahill commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Page previews

Checks

Uh oh!

netlify bot commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for redpanda-docs-preview ready!

Uh oh!

Deflaimun commented Oct 15, 2024

Uh oh!

Uh oh!

pgellert Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

JakeSCahill Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisseto Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

chrisseto Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

JakeSCahill Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asimms41 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

JakeSCahill commented Oct 15, 2024 •

edited

Loading

netlify bot commented Oct 15, 2024 •

edited

Loading

JakeSCahill Oct 17, 2024 •

edited

Loading