Skip to content

feat!: Add working conversion webhook with cert rotation #1066

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

Open
wants to merge 67 commits into
base: main
Choose a base branch
from

Conversation

sbernauer
Copy link
Member

@sbernauer sbernauer commented Jun 30, 2025

Description

Part of stackabletech/issues#642

An working example usage can be found in stackabletech/zookeeper-operator#958 (mainly look at rust/operator-binary/src/main.rs)

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

  • Changes are OpenShift compatible
  • CRD changes approved
  • CRD documentation for all fields, following the style guide.
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added

@sbernauer sbernauer changed the title feat(webhook): Add functioning conversion webhook with cert rotation feat(webhook): Add working conversion webhook with cert rotation Jul 2, 2025
Comment on lines +29 to +31
pub const WEBHOOK_CA_LIFETIME: Duration = Duration::from_minutes_unchecked(3);
pub const WEBHOOK_CERTIFICATE_LIFETIME: Duration = Duration::from_minutes_unchecked(2);
pub const WEBHOOK_CERTIFICATE_ROTATION_INTERVAL: Duration = Duration::from_minutes_unchecked(1);
Copy link
Member Author

Choose a reason for hiding this comment

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

reminder to bump these before merging. Currently they are so low for easy testing

@sbernauer sbernauer moved this to Development: In Progress in Stackable Engineering Jul 2, 2025
@sbernauer sbernauer moved this from Development: In Progress to Development: In Review in Stackable Engineering Jul 2, 2025
@sbernauer sbernauer moved this from Development: In Review to Development: Waiting for Review in Stackable Engineering Jul 2, 2025
@Techassi Techassi self-requested a review July 3, 2025 06:43
@Techassi Techassi moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Jul 3, 2025
Copy link
Member

@Techassi Techassi left a comment

Choose a reason for hiding this comment

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

Partial review, I didn't look at the CertificateResolver yet.

@Techassi Techassi changed the title feat(webhook): Add working conversion webhook with cert rotation feat!: Add working conversion webhook with cert rotation Jul 3, 2025
Copy link
Member

@Techassi Techassi left a comment

Choose a reason for hiding this comment

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

We are mostly there, just some small things left.

Comment on lines 73 to 75
/// The environment the operator is running in, notably the namespace and service name it is
/// reachable at.
pub operator_environment: OperatorEnvironmentOptions,
Copy link
Member

Choose a reason for hiding this comment

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

note: Let's avoid pulling in a type from stackable_operator here. Instead, split it into two separate fields.

Suggested change
/// The environment the operator is running in, notably the namespace and service name it is
/// reachable at.
pub operator_environment: OperatorEnvironmentOptions,
pub namespace: String,
pub service_name: String,

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, I intentionally sticked with the struct that describes the k8s env. I understand your concerns, but I also really don't like too many function arguments when there is a perfectly fine struct for what we want as "information about the environment of the operator".
Maybe tomorrow we need the k8s version or if we are on OpenShift or whatnot

Copy link
Member

@Techassi Techassi Aug 15, 2025

Choose a reason for hiding this comment

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

The comment of the field perfectly sums this up:

The environment the operator is running in, notably the namespace and service name it is reachable at.

Currently, we only need the namespace and the service name. That's it. Why are we optimizing for something which might or might not come in the future? Regarding how the crates are currently structured, I would like to avoid more entanglement between those.

As discussed multiple times already, this needs better structure in the long run, which I can hopefully pick up soon.

I also really don't like too many function arguments

There is only a single parameter: ConversionWebhookOptions. Everything is contained in there. And having two fields instead of one, doesn't really justify mixing even more types between crates (which are not designed for that currently).

Copy link
Member Author

Choose a reason for hiding this comment

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

Switched to separate namespace and service_name in 568cda7

@@ -2,4 +2,5 @@
//! purposes.
mod conversion;

pub use conversion::*;
pub use conversion::{ConversionWebhookError, ConversionWebhookOptions, ConversionWebhookServer};
pub use kube::core::conversion::ConversionReview;
Copy link
Member

Choose a reason for hiding this comment

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

note: This is already re-exported via stackable_webhook::servers::conversion::ConversionReview. As such, please remove it from here again.

Copy link
Member Author

Choose a reason for hiding this comment

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

Correct, removed in 8dc1235

Comment on lines 74 to 81
let (cert, certified_key) = Self::generate_new_cert(subject_alterative_dns_names.clone())
.await
.context(GenerateNewCertificateSnafu)?;

cert_tx
.send(cert)
.await
.map_err(|_err| CertificateResolverError::SendCertificateToChannel)?;
Copy link
Member

Choose a reason for hiding this comment

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

note: I feel like this can be moved into its own function, because we repeat the exact same code below.

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Any reason why you didn't include the certificate generation in that function as well? That's basically also the same code across two functions.

Copy link
Member Author

Choose a reason for hiding this comment

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

Pls have a look at 39fe001

@sbernauer sbernauer requested a review from Techassi August 15, 2025 10:53
@sbernauer sbernauer requested review from Techassi and removed request for Techassi August 18, 2025 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Development: In Review
Development

Successfully merging this pull request may close these issues.

3 participants