Skip to content

feat!: Add labels to listener volume builder #799

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

Merged
merged 9 commits into from
Jun 3, 2024
Merged

feat!: Add labels to listener volume builder #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4295b97
feat: add recommended labels to ephemeral volumes
razvan May 28, 2024
bb25659
set labels to volume
razvan May 28, 2024
7e7f6a2
update changelog
razvan May 28, 2024
006b8c5
wip: refactor
razvan May 28, 2024
7fe5671
Fix (doc)tests
razvan May 29, 2024
d71fed7
Reduce doctests to bare minimum.
razvan May 29, 2024
803162b
Remove unused error variant.
razvan May 29, 2024
cb1d7d8
Replace ObjectLabels with plain Labels to get rid of the managed-by l…
razvan May 30, 2024
7002e56
argo fmt
razvan May 30, 2024
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
2 changes: 2 additions & 0 deletions crates/stackable-operator/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ All notable changes to this project will be documented in this file.
### Added

- Add functionality to convert LogLevel to an OPA log level ([#798]).
- Add labels to listener volume builder ([#799]).

[#798]: https://github.com/stackabletech/operator-rs/pull/798
[#799]: https://github.com/stackabletech/operator-rs/pull/799

## [0.68.0] - 2024-05-22

Expand Down
89 changes: 43 additions & 46 deletions crates/stackable-operator/src/builder/pod/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use k8s_openapi::{
use snafu::{OptionExt, ResultExt, Snafu};
use tracing::warn;

use crate::kvp::Labels;
use crate::{
builder::meta::ObjectMetaBuilder,
commons::{
Expand Down Expand Up @@ -285,29 +286,27 @@ impl PodBuilder {
/// ```
/// # use stackable_operator::builder::pod::PodBuilder;
/// # use stackable_operator::builder::pod::container::ContainerBuilder;
/// # use stackable_operator::builder::pod::resources::ResourceRequirementsBuilder;
/// # use stackable_operator::kvp::Labels;
/// # use k8s_openapi::{
/// api::core::v1::ResourceRequirements,
/// apimachinery::pkg::api::resource::Quantity
/// };
/// # apimachinery::pkg::apis::meta::v1::ObjectMeta,
/// # };
/// # use std::collections::BTreeMap;
///
/// let resources = ResourceRequirementsBuilder::new()
/// .with_cpu_request("1")
/// .with_cpu_limit("1")
/// .with_memory_request("128Mi")
/// .with_memory_limit("128Mi")
/// .build();
/// let labels: Labels = Labels::try_from(
/// BTreeMap::from([("app.kubernetes.io/component", "test-role"),
/// ("app.kubernetes.io/instance", "test"),
/// ("app.kubernetes.io/name", "test")]))
/// .unwrap();
///
/// let pod = PodBuilder::new()
/// .metadata_default()
/// .add_container(
/// ContainerBuilder::new("container")
/// .unwrap()
/// .add_volume_mount("listener", "/path/to/volume")
/// .resources(resources)
/// .build(),
/// )
/// .add_listener_volume_by_listener_class("listener", "nodeport")
/// .add_listener_volume_by_listener_class("listener", "nodeport", &labels)
/// .unwrap()
/// .build()
/// .unwrap();
Expand All @@ -320,13 +319,6 @@ impl PodBuilder {
/// affinity: {}
/// containers:
/// - name: container
/// resources:
/// limits:
/// cpu: '1'
/// memory: 128Mi
/// requests:
/// cpu: '1'
/// memory: 128Mi
/// volumeMounts:
/// - mountPath: /path/to/volume
/// name: listener
Expand All @@ -337,6 +329,10 @@ impl PodBuilder {
/// metadata:
/// annotations:
/// listeners.stackable.tech/listener-class: nodeport
/// labels:
/// app.kubernetes.io/component: test-role
/// app.kubernetes.io/instance: test
/// app.kubernetes.io/name: test
/// spec:
/// accessModes:
/// - ReadWriteMany
Expand All @@ -351,9 +347,11 @@ impl PodBuilder {
&mut self,
volume_name: &str,
listener_class: &str,
labels: &Labels,
) -> Result<&mut Self> {
let listener_reference = ListenerReference::ListenerClass(listener_class.to_string());
let volume = ListenerOperatorVolumeSourceBuilder::new(&listener_reference)
let volume = ListenerOperatorVolumeSourceBuilder::new(&listener_reference, labels)
.context(ListenerVolumeSnafu { name: volume_name })?
.build_ephemeral()
.context(ListenerVolumeSnafu { name: volume_name })?;

Expand All @@ -374,29 +372,27 @@ impl PodBuilder {
/// ```
/// # use stackable_operator::builder::pod::PodBuilder;
/// # use stackable_operator::builder::pod::container::ContainerBuilder;
/// # use stackable_operator::builder::pod::resources::ResourceRequirementsBuilder;
/// # use stackable_operator::kvp::Labels;
/// # use k8s_openapi::{
/// api::core::v1::ResourceRequirements,
/// apimachinery::pkg::api::resource::Quantity
/// };
/// # apimachinery::pkg::apis::meta::v1::ObjectMeta,
/// # };
/// # use std::collections::BTreeMap;
///
/// let resources = ResourceRequirementsBuilder::new()
/// .with_cpu_request("1")
/// .with_cpu_limit("1")
/// .with_memory_request("128Mi")
/// .with_memory_limit("128Mi")
/// .build();
/// let labels: Labels = Labels::try_from(
/// BTreeMap::from([("app.kubernetes.io/component", "test-role"),
/// ("app.kubernetes.io/instance", "test"),
/// ("app.kubernetes.io/name", "test")]))
/// .unwrap();
///
/// let pod = PodBuilder::new()
/// .metadata_default()
/// .add_container(
/// ContainerBuilder::new("container")
/// .unwrap()
/// .add_volume_mount("listener", "/path/to/volume")
/// .resources(resources)
/// .build(),
/// )
/// .add_listener_volume_by_listener_name("listener", "preprovisioned-listener")
/// .add_listener_volume_by_listener_name("listener", "preprovisioned-listener", &labels)
/// .unwrap()
/// .build()
/// .unwrap();
Expand All @@ -409,13 +405,6 @@ impl PodBuilder {
/// affinity: {}
/// containers:
/// - name: container
/// resources:
/// limits:
/// cpu: '1'
/// memory: 128Mi
/// requests:
/// cpu: '1'
/// memory: 128Mi
/// volumeMounts:
/// - mountPath: /path/to/volume
/// name: listener
Expand All @@ -426,6 +415,10 @@ impl PodBuilder {
/// metadata:
/// annotations:
/// listeners.stackable.tech/listener-name: preprovisioned-listener
/// labels:
/// app.kubernetes.io/component: test-role
/// app.kubernetes.io/instance: test
/// app.kubernetes.io/name: test
/// spec:
/// accessModes:
/// - ReadWriteMany
Expand All @@ -440,9 +433,11 @@ impl PodBuilder {
&mut self,
volume_name: &str,
listener_name: &str,
labels: &Labels,
) -> Result<&mut Self> {
let listener_reference = ListenerReference::ListenerName(listener_name.to_string());
let volume = ListenerOperatorVolumeSourceBuilder::new(&listener_reference)
let volume = ListenerOperatorVolumeSourceBuilder::new(&listener_reference, labels)
.context(ListenerVolumeSnafu { name: volume_name })?
.build_ephemeral()
.context(ListenerVolumeSnafu { name: volume_name })?;

Expand Down Expand Up @@ -579,19 +574,21 @@ impl PodBuilder {

#[cfg(test)]
mod tests {
use super::*;
use k8s_openapi::{
api::core::v1::{LocalObjectReference, PodAffinity, PodAffinityTerm},
apimachinery::pkg::apis::meta::v1::{LabelSelector, LabelSelectorRequirement},
};
use rstest::*;

use crate::builder::{
meta::ObjectMetaBuilder,
pod::{
container::ContainerBuilder, resources::ResourceRequirementsBuilder,
volume::VolumeBuilder,
},
};
use k8s_openapi::{
api::core::v1::{LocalObjectReference, PodAffinity, PodAffinityTerm},
apimachinery::pkg::apis::meta::v1::{LabelSelector, LabelSelectorRequirement},
};
use rstest::*;

use super::*;

// A simple [`Container`] with a name and image.
#[fixture]
Expand Down
44 changes: 34 additions & 10 deletions crates/stackable-operator/src/builder/pod/volume.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ use k8s_openapi::{
},
apimachinery::pkg::api::resource::Quantity,
};

use snafu::{ResultExt, Snafu};
use tracing::warn;

use crate::{
builder::meta::ObjectMetaBuilder,
kvp::{Annotation, AnnotationError, Annotations},
kvp::{Annotation, AnnotationError, Annotations, LabelError, Labels},
};

/// A builder to build [`Volume`] objects. May only contain one `volume_source`
Expand Down Expand Up @@ -422,6 +423,8 @@ impl ListenerReference {
pub enum ListenerOperatorVolumeSourceBuilderError {
#[snafu(display("failed to convert listener reference into Kubernetes annotation"))]
ListenerReferenceAnnotation { source: AnnotationError },
#[snafu(display("invalid recommended labels"))]
RecommendedLabels { source: LabelError },
}

/// Builder for an [`EphemeralVolumeSource`] containing the listener configuration
Expand All @@ -433,13 +436,22 @@ pub enum ListenerOperatorVolumeSourceBuilderError {
/// # use stackable_operator::builder::pod::volume::ListenerReference;
/// # use stackable_operator::builder::pod::volume::ListenerOperatorVolumeSourceBuilder;
/// # use stackable_operator::builder::pod::PodBuilder;
/// # use stackable_operator::kvp::Labels;
/// # use k8s_openapi::{
/// # apimachinery::pkg::apis::meta::v1::ObjectMeta,
/// # };
/// # use std::collections::BTreeMap;
/// let mut pod_builder = PodBuilder::new();
///
/// let labels: Labels = Labels::try_from(BTreeMap::<String, String>::new()).unwrap();
///
/// let volume_source =
/// ListenerOperatorVolumeSourceBuilder::new(
/// &ListenerReference::ListenerClass("nodeport".into()),
/// &labels,
/// )
/// .build()
/// .unwrap()
/// .build_ephemeral()
/// .unwrap();
///
/// pod_builder
Expand All @@ -451,19 +463,24 @@ pub enum ListenerOperatorVolumeSourceBuilderError {
///
/// // There is also a shortcut for the code above:
/// pod_builder
/// .add_listener_volume_by_listener_class("listener", "nodeport");
/// .add_listener_volume_by_listener_class("listener", "nodeport", &labels);
/// ```
#[derive(Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug)]
pub struct ListenerOperatorVolumeSourceBuilder {
listener_reference: ListenerReference,
labels: Labels,
}

impl ListenerOperatorVolumeSourceBuilder {
/// Create a builder for the given listener class or listener name
pub fn new(listener_reference: &ListenerReference) -> Self {
Self {
pub fn new(
listener_reference: &ListenerReference,
labels: &Labels,
) -> Result<ListenerOperatorVolumeSourceBuilder, ListenerOperatorVolumeSourceBuilderError> {
Ok(Self {
listener_reference: listener_reference.to_owned(),
}
labels: labels.to_owned(),
})
}

fn build_spec(&self) -> PersistentVolumeClaimSpec {
Expand Down Expand Up @@ -497,6 +514,7 @@ impl ListenerOperatorVolumeSourceBuilder {
metadata: Some(
ObjectMetaBuilder::new()
.with_annotation(listener_reference_annotation)
.with_labels(self.labels.clone())
.build(),
),
spec: self.build_spec(),
Expand All @@ -518,6 +536,7 @@ impl ListenerOperatorVolumeSourceBuilder {
metadata: ObjectMetaBuilder::new()
.name(name)
.with_annotation(listener_reference_annotation)
.with_labels(self.labels.clone())
.build(),
spec: Some(self.build_spec()),
..Default::default()
Expand All @@ -529,6 +548,7 @@ impl ListenerOperatorVolumeSourceBuilder {
mod tests {
use super::*;
use k8s_openapi::apimachinery::pkg::api::resource::Quantity;
use std::collections::BTreeMap;

#[test]
fn test_volume_builder() {
Expand Down Expand Up @@ -588,9 +608,13 @@ mod tests {

#[test]
fn test_listener_operator_volume_source_builder() {
let builder = ListenerOperatorVolumeSourceBuilder::new(&ListenerReference::ListenerClass(
"public".into(),
));
let labels: Labels = Labels::try_from(BTreeMap::<String, String>::new()).unwrap();

let builder = ListenerOperatorVolumeSourceBuilder::new(
&ListenerReference::ListenerClass("public".into()),
&labels,
)
.unwrap();

let volume_source = builder.build_ephemeral().unwrap();

Expand Down