Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/stackable-operator/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.

## [Unreleased]

### Changed

- BREAKING: `PodSecurityContextBuilder::new` was removed in favor of `PodSecurityContextBuilder::with_stackable_defaults` ([#XXXX]).
This function already sets up some defaults we want to use across the platform.
Currently this is `runAsNonRoot: true`, which might cause product Pods to crash and require changes.
- BREAKING: `PodSecurityContextBuilder::run_as_non_root` now takes a `bool` instead of assuming consumers always want to set it to `true` ([#XXXX]).
This is needed to allow users setting it to `false` in case the new `with_stackable_defaults` functions set's it to `true`.

[#XXXX]: https://github.com/stackabletech/operator-rs/pull/XXXX
Comment thread
sbernauer marked this conversation as resolved.
Outdated

## [0.113.0] - 2026-06-22

### Added
Expand Down
39 changes: 32 additions & 7 deletions crates/stackable-operator/src/builder/pod/security.rs
Original file line number Diff line number Diff line change
Expand Up @@ -144,14 +144,39 @@ impl SecurityContextBuilder {
}
}

#[derive(Clone, Default)]
/// A builder to construct a [`PodSecurityContext`].
///
/// # Basic usage
///
/// ```
/// use stackable_operator::builder::pod::security::PodSecurityContextBuilder;
///
/// let _ = PodSecurityContextBuilder::with_stackable_defaults()
/// // Configure any arbitrary fields
/// .run_as_user(1234)
/// .build();
/// ```
#[derive(Clone, Debug)]
pub struct PodSecurityContextBuilder {
pod_security_context: PodSecurityContext,
}

impl PodSecurityContextBuilder {
Comment thread
siegfriedweber marked this conversation as resolved.
pub fn new() -> Self {
Self::default()
/// Construct a new [`PodSecurityContextBuilder`] that is pre-filled with Stackable's defaults.
///
/// Currently the defaults are:
///
/// * `runAsNonRoot: true`
pub fn with_stackable_defaults() -> Self {
Comment thread
siegfriedweber marked this conversation as resolved.
// We are using the builder functions to ensure that builder functions exist to override these settings.
let mut builder = Self {
pod_security_context: PodSecurityContext::default(),
};

// Reason: Running as root is bad
builder.run_as_non_root(true);

builder
}

pub fn build(&self) -> PodSecurityContext {
Expand All @@ -173,8 +198,8 @@ impl PodSecurityContextBuilder {
self
}

pub fn run_as_non_root(&mut self) -> &mut Self {
self.pod_security_context.run_as_non_root = Some(true);
pub fn run_as_non_root(&mut self, non_root: bool) -> &mut Self {
self.pod_security_context.run_as_non_root = Some(non_root);
self
}

Expand Down Expand Up @@ -381,13 +406,13 @@ mod tests {

#[test]
fn security_context_builder() {
let mut builder = PodSecurityContextBuilder::new();
let mut builder = PodSecurityContextBuilder::with_stackable_defaults();
let context = builder
.fs_group(1000)
.fs_group_change_policy("policy")
.run_as_user(1001)
.run_as_group(1001)
.run_as_non_root()
.run_as_non_root(true)
.supplemental_groups(&[1002, 1003])
.se_linux_level("level")
.se_linux_role("role")
Expand Down
Loading