Skip to content

DOC-546 Document the new useFlux flag #859

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

Jump to bottom
Merged
JakeSCahill merged 23 commits into from
Nov 22, 2024
Merged

DOC-546 Document the new useFlux flag #859

JakeSCahill merged 23 commits into from
Nov 22, 2024

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Nov 14, 2024 •
edited
Loading

Description

Review deadline: 15 November

Page previews

Checks

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

Deflaimun and others added 15 commits October 30, 2024 16:22
@Deflaimun
Update config for new beta
2caf0c6
@Deflaimun @Feediver1
update with rpk 24.3.1-rc1 (#819)
c3ffdd4 
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@JakeSCahill @Deflaimun
@pgellert @asimms41
DOC-502 License enforcement updates (#813)
58e0bff 
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 @Feediver1
Properties 24 3 (#822)
121d5f4 
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@JakeSCahill @Deflaimun @Feediver1
Add User resource docs (#773)
19c0ec1 
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@kbatuigas @asimms41
@Feediver1 @Deflaimun
Leader pinning (#809)
fce336b 
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
@kbatuigas @asimms41 @Feediver1
DOC-287 Mountable TS topics (#725)
3e93983 
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@Deflaimun
Update with latest rpk commands from v0.0.0-20241104git4a0f859 (#835)
03d3e60
@micheleRP @kbatuigas
@JakeSCahill @Deflaimun @pgellert @asimms41
what's new in 24.3 beta (#811)
41bfe40 
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
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
Force-update fallback 24.3-rc2
afba214
@micheleRP
Michele rp patch 1 (#837)
488c9f6
@JakeSCahill @kbatuigas
DOC-470 Debug bundle in Redpanda Console (#825)
67c90f5 
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
@Deflaimun
add Tombstone property (#847)
16e9cda
@kbatuigas @Feediver1
Tombstone retention (#829)
58ded83 
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@JakeSCahill
Document the new useFlux flag
0ce69bb
@JakeSCahill JakeSCahill requested a review from a team as a code owner November 14, 2024 09:57
@netlify
Copy link

netlify bot commented Nov 14, 2024 •
edited
Loading

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit d1bae7a
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/6740e94770fa380008d1166d
😎 Deploy Preview https://deploy-preview-859--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@chrisseto
Copy link
Contributor

chrisseto commented Nov 19, 2024

Thanks for the update Jake! We're still waiting/trying to cut a release. We've had to immediately unpublish a release twice already. Let's wait a day or two after the release before merging this just to be on the safe side?

Feediver1
Feediver1 approved these changes Nov 19, 2024
View reviewed changes
Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

LGTM

@david-yu
Copy link
Contributor

david-yu commented Nov 19, 2024

@JakeSCahill Could you mention that useFlux is set to true by default so opt out is possible by the user?

chrisseto
chrisseto approved these changes Nov 22, 2024
View reviewed changes
Copy link
Contributor

@chrisseto chrisseto left a comment

Choose a reason for hiding this comment

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

LGTM! The release is officially out the door too https://github.com/redpanda-data/redpanda-operator/releases/tag/v2.3.0-24.3.1

modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc

The recommended option for deploying Redpanda in Kubernetes is a combination of <<Helm>> and the Redpanda Operator. While the Helm chart facilitates the deployment of Redpanda, the Redpanda Operator manages the lifecycle of Redpanda clusters. The operator uses https://fluxcd.io/flux/concepts/[Flux^] to automate the deployment of the Redpanda Helm chart through the HelmRelease resource.
- *Flux-managed mode (`useFlux: true`)*:
When `useFlux` is set to `true` (default), the Redpanda Operator delegates reconciliation to https://fluxcd.io/flux/concepts/[Flux^] controllers. The workflow is as follows:
Copy link
Contributor

@chrisseto chrisseto Nov 22, 2024

Choose a reason for hiding this comment

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

I'm not sure how to best phrase this but useFlux is an optional boolean. Meaning there are 3 states: true, false, null.

If useFlux is explicitly set to true or false it will be interpreted as that value.

If useFlux is null either explicitly or not set[^1], it will be interpreted as the value of a CLI flag (Let's call it--use-flux-default but the name is TBD) that Rafal is in the process of adding. The flag will default to true, meaning that useFlux: null will be interpreted as true for "standard" installations of the operator.

We can omit documenting the CLI flag for now but I wanted to make sure that you're aware of it.

The weird dance of value interpretation is so we can avoid impacting the experience of existing users at the initial release and later switch the default to false followed be the official removal of this flag and flux in its entirety.

Copy link
Contributor Author

@JakeSCahill JakeSCahill Nov 22, 2024

Choose a reason for hiding this comment

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

Thanks, Chris. I'll keep this in mind when we come to doc the new CLI flag.

modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc
- *Redpanda-managed mode (`useFlux: false`)*:
When `useFlux` is set to `false`, the Redpanda Operator manages and reconciles Redpanda resources directly, without involving Flux. This mode works as follows:
+
. The Redpanda Operator creates both `HelmRelease` and `HelmRepository` resources but suspends them, keeping Flux inactive.
Copy link
Contributor

@chrisseto chrisseto Nov 22, 2024

Choose a reason for hiding this comment

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

It might be worth calling out that despite the existence of this flag, the operator still requires the Flux CRDs to be installed. Phrased in a way that indicates we intend to change that soon :)

@JakeSCahill JakeSCahill merged commit 4f3a993 into v-WIP/24.3 Nov 22, 2024
5 checks passed
@JakeSCahill JakeSCahill deleted the DOC-546 branch November 22, 2024 20:33
Deflaimun added a commit that referenced this pull request Dec 2, 2024
@JakeSCahill @Deflaimun
@Feediver1 @pgellert @asimms41 @kbatuigas @micheleRP
DOC-546 Document the new useFlux flag (#859)
66facab 
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Gellért Peresztegi-Nagy <pereszteginagy.gellert@gmail.com>
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chrisseto chrisseto chrisseto approved these changes

@Feediver1 Feediver1 Feediver1 approved these changes

+1 more reviewer

@david-yu david-yu david-yu approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@JakeSCahill @chrisseto @david-yu @Feediver1 @Deflaimun @kbatuigas @micheleRP