Support of additional volumes in pod #10099

cthtrifork · 2024-05-13T12:58:30Z

Type of change

Enhancement / new feature

Description

This is a solution design for an upcoming proposal (strimzi/proposals#120) supporting #3693
It will need testcoverage and more. Right now it is blocked by an seemingly unrelated compile issue:
CrdGenerator: error: class io.fabric8.kubernetes.api.model.Quantity is missing @JsonInclude

Checklist

Please go through this checklist and make sure all applicable tasks have been done

Write tests
Make sure all tests pass
Update documentation
Check RBAC rights for Kubernetes / OpenShift roles
Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
Reference relevant issue(s) and close them after merging
Update CHANGELOG.md
Supply screenshots for visual changes, such as Grafana dashboards

MichaelMorrisEst · 2024-06-06T12:33:41Z

I've pushed a commit that moves the implementation some way along to where I think we want to go based on the proposal. I haven't tested it yet, but hope to in next day or so

api/src/main/java/io/strimzi/api/kafka/model/common/template/PodTemplate.java

api/src/main/java/io/strimzi/api/kafka/model/common/template/Volume.java

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/TemplateUtils.java

cthtrifork · 2024-06-10T06:21:51Z

@MichaelMorrisEst Great work. So besides getting an approval on the proposal, what do you think is missing?

Unit tests
Integration tests?
Documentation
Validation

MichaelMorrisEst · 2024-06-10T14:27:45Z

@MichaelMorrisEst Great work. So besides getting an approval on the proposal, what do you think is missing?

Unit tests

Integration tests?

Documentation

Validation

Thanks.
Yes, and in additional to those items you list, we are also missing in the implementation the impacts for the other components (only kafka and zookeeper pods there at the moment). I can continue with implementing those.
There is also an open question on using the Quantity class which is referenced from EmptyDirVolumeSource. I have added a comment in the proposal PR (strimzi/proposals#120 (comment)) to get peoples thoughts on how to resolve

Signed-off-by: Casper Thygesen <cth@trifork.com> Signed-off-by: KastTrifork <kast@trifork.com>

Signed-off-by: KastTrifork <kast@trifork.com>

…nd added handling for zookeeper Also fixed checkstyle issues and implemented workaround in CRD generator to allow compilation Signed-off-by: MichaelMorris <michael.morris@est.tech> Signed-off-by: KastTrifork <kast@trifork.com>

Signed-off-by: MichaelMorris <michael.morris@est.tech> Signed-off-by: KastTrifork <kast@trifork.com>

Existing tests now passing as well Signed-off-by: MichaelMorris <michael.morris@est.tech>

Signed-off-by: MichaelMorris <michael.morris@est.tech>

Signed-off-by: Casper Thygesen <cth@trifork.com>

…umes Signed-off-by: Casper Thygesen <cth@trifork.com>

Signed-off-by: Casper Thygesen <cth@trifork.com>

cthtrifork · 2024-06-27T10:25:55Z

crd-generator/src/main/java/io/strimzi/crdgenerator/CrdGenerator.java

@@ -656,7 +656,7 @@ private void checkClass(Class<?> crdClass) {

    private void checkJsonInclude(Class<?> crdClass) {
        if (!crdClass.isAnnotationPresent(JsonInclude.class)) {
-            err(crdClass + " is missing @JsonInclude");
+            warn(crdClass + " is missing @JsonInclude");          // Changed temporarily to allow compilation of io.fabric8.kubernetes.api.model.Quantity


@MichaelMorrisEst Will you help fix this

I gave it a go, please review 😄

cthtrifork · 2024-07-01T19:20:24Z

@tombentley @scholzj I think this PR is ready for feedback. We need to adjust a modified testcase change as discussed in the community call, and we need to validate the changes on our own cluster. The PR should be mature enough to get feedback.

Signed-off-by: KastTrifork <kast@trifork.com>

cthtrifork · 2024-07-02T07:32:54Z

./.azure/scripts/release_files_check.sh
ERROR checksum of ./helm-charts does not match expected
expected f029e1dd81b5391a8684a6f555a48f7bef12033e  -
found e713b7265baf9c3108d5db3a0902bd64a0629dc7  -
if your changes are not related to a release please check your changes into
./packaging/helm-charts
instead of ./helm-charts

if this is part of a release instead update the checksum i.e.
HELM_CHART_CHECKSUM="f029e1dd81b5391a8684a6f555a48f7bef12033e  -"
->
HELM_CHART_CHECKSUM="e713b7265baf9c3108d5db3a0902bd64a0629dc7  -"
checksum of ./install/ matches expected checksum => OK
checksum of ./examples/ matches expected checksum => OK
make: *** [Makefile:138: release_files_check] Error 1

This needs to be solved.

Signed-off-by: Casper Thygesen <cth@trifork.com>

Signed-off-by: KastTrifork <kast@trifork.com>

Signed-off-by: pegtrifork <peg@trifork.com>

scholzj · 2024-07-22T13:14:17Z

/azp run regression

azure-pipelines · 2024-07-22T13:14:29Z

Azure Pipelines successfully started running 1 pipeline(s).

scholzj

I think the code looks good. We just need get a bit more consistency to the actual code and its formatting.

scholzj · 2024-07-22T13:14:50Z

CHANGELOG.md

 * Additional OAuth configuration options have been added for 'oauth' authentication on the listener and the client. 
  On the listener `serverBearerTokenLocation` and `userNamePrefix` have been added. 
  On the client `accessTokenLocation`, `clientAssertion`, `clientAssertionLocation`, `clientAssertionType`, and `saslExtensions` have been added.

+


Nit, but I think this line is not needed.

scholzj · 2024-07-22T13:15:24Z

api/src/main/java/io/strimzi/api/kafka/model/common/template/PodTemplate.java

@@ -195,6 +196,17 @@ public void setTmpDirSizeLimit(String tmpDirSizeLimit) {
        this.tmpDirSizeLimit = tmpDirSizeLimit;
    }

+    @Description("Additional volumes that can be mounted to the pod.")
+    @JsonProperty("volumes")


This should be removed? @JsonProperty("volumes")

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/EntityOperator.java

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/KafkaBridgeCluster.java

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/KafkaCluster.java

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/ZookeeperCluster.java

scholzj · 2024-07-22T13:28:08Z

cluster-operator/src/test/java/io/strimzi/operator/cluster/model/KafkaBridgeClusterTest.java

@@ -545,6 +575,14 @@ public void testTemplate() {
        assertThat(sa.getMetadata().getLabels().entrySet().containsAll(saLabels.entrySet()), is(true));
        assertThat(sa.getMetadata().getAnnotations().entrySet().containsAll(saAnots.entrySet()), is(true));
    }
+
+    private static Volume getVolume(Deployment dep, String volumeName) {


I'm fine with the utility method. But can we keep it up top with the other utility methods and not in the middle of the tests?

scholzj · 2024-07-22T13:35:33Z

cluster-operator/src/test/java/io/strimzi/operator/cluster/model/KafkaExporterTest.java

+    private static Volume getVolume(PodSpec podSpec, String volumeName) {
+        return podSpec.getVolumes().stream().filter(volume -> volumeName.equals(volume.getName())).iterator().next();
+    }
+
+    private static VolumeMount getVolumeMount(Container container, String volumeName) {
+        return container.getVolumeMounts().stream().filter(volumeMount -> volumeName.equals(volumeMount.getName())).iterator().next();
+    }


Again, fine with the utility methods. But can we keep them up tom with the other ones and not in the middle of the tests?

scholzj · 2024-07-22T13:35:50Z

...r-operator/src/test/java/io/strimzi/operator/cluster/model/KafkaMirrorMaker2ClusterTest.java

+    private static Volume getVolume(Pod pod, String volumeName) {
+        return pod.getSpec().getVolumes().stream().filter(volume -> volumeName.equals(volume.getName())).iterator().next();
+    }
+
+    private static VolumeMount getVolumeMount(Container container, String volumeName) {
+        return container.getVolumeMounts().stream().filter(volumeMount -> volumeName.equals(volumeMount.getName())).iterator().next();
+    }


Same as above.

scholzj · 2024-07-22T13:36:18Z

...r-operator/src/test/java/io/strimzi/operator/cluster/model/KafkaMirrorMaker2ClusterTest.java

@@ -1886,7 +1939,7 @@ public void testPodSetWithOAuthWithMissingClientSecret() {
                    .build();
            KafkaMirrorMaker2 resource = new KafkaMirrorMaker2Builder(this.resource)
                    .editSpec()
-                        .withClusters(targetClusterWithOAuthWithMissingClientSecret)  
+                    .withClusters(targetClusterWithOAuthWithMissingClientSecret)


Whit is intentionally indented for better readability.

Co-authored-by: Jakub Scholz <www@scholzj.com> Signed-off-by: Peter Kiib Egede <100785536+pegtrifork@users.noreply.github.com>

Signed-off-by: pegtrifork <peg@trifork.com>

scholzj · 2024-07-23T09:59:19Z

/azp run regression

azure-pipelines · 2024-07-23T09:59:32Z

Azure Pipelines successfully started running 1 pipeline(s).

scholzj

LGTM. Thanks.

tombentley

Thanks @cthtrifork, @MichaelMorrisEst and @KastTrifork!

ppatierno

LGTM.
Just a nit but no need to change if you want to stay with this. I would make calls to addAdditionalVolumeMounts and addAdditionalVolumes explicit with the TemplateUtils instead of importing them. So, i.e. using TemplateUtils.addAdditionalVolumeMounts. I think we do this way most of the code in the repository.

Signed-off-by: MichaelMorris <michael.morris@est.tech>

MichaelMorrisEst · 2024-07-26T10:45:18Z

LGTM. Just a nit but no need to change if you want to stay with this. I would make calls to addAdditionalVolumeMounts and addAdditionalVolumes explicit with the TemplateUtils instead of importing them. So, i.e. using TemplateUtils.addAdditionalVolumeMounts. I think we do this way most of the code in the repository.

Done

scholzj · 2024-07-26T11:48:57Z

/azp run build

azure-pipelines · 2024-07-26T11:49:03Z

Pull request contains merge conflicts.

scholzj · 2024-07-26T11:50:30Z

It seems that the branch has some conflicts. Can you try to look into it and rebase it if needed?

scholzj · 2024-08-01T19:52:09Z

Any chance you can rebase this? So that we can get it merged and included in the next release?

Signed-off-by: Kasper Storgaard <116632810+KastTrifork@users.noreply.github.com>

scholzj · 2024-08-01T23:38:44Z

cluster-operator/src/test/java/io/strimzi/operator/cluster/model/EntityOperatorTest.java

@@ -321,6 +321,7 @@ public void testTemplate() {
        assertThat(dep.getSpec().getTemplate().getSpec().getSchedulerName(), is("my-scheduler"));
        assertThat(dep.getSpec().getTemplate().getSpec().getTopologySpreadConstraints(), containsInAnyOrder(tsc1, tsc2));
        assertThat(dep.getSpec().getTemplate().getSpec().getEnableServiceLinks(), is(false));
+        assertThat(dep.getSpec().getTemplate().getSpec().getTolerations(), is(singletonList(toleration)));


I think this is wrong and is causing the test failure?

Thanks for pointing this out

The line mentioned is from the main branch. I noticed that there is another line using the variable assertToleration which was missing, and therefore test failure. I've added the assertToleration variable now, and the test should pass

I don't think you handled it well - or maybe I misled you. If you compare it with the main branch, this is the correct line:

strimzi-kafka-operator/cluster-operator/src/test/java/io/strimzi/operator/cluster/model/EntityOperatorTest.java

Line 297 in ff128d8

assertThat(dep.getSpec().getTemplate().getSpec().getTolerations(), is(singletonList(toleration)));

... you are restoring the removed behavior, so it will likely fail when running the tests. (also, please just delete the wrong line, not comment it out)

Sorry, my bad. I got confused by your comment and the error message in the pipeline. I will correct it to the right line, the one you are referring to, and remove the old behavior.

Thanks for your patience :-)

Signed-off-by: Kasper Storgaard <116632810+KastTrifork@users.noreply.github.com>

scholzj · 2024-08-02T21:20:59Z

/azp run regression

azure-pipelines · 2024-08-02T21:21:11Z

Azure Pipelines successfully started running 1 pipeline(s).

scholzj · 2024-08-03T14:57:12Z

Thanks for the PR!

cthtrifork mentioned this pull request Jun 6, 2024

proposal: support of additional volumes in pod strimzi/proposals#120

Merged

cthtrifork commented Jun 7, 2024

View reviewed changes

api/src/main/java/io/strimzi/api/kafka/model/common/template/PodTemplate.java Outdated Show resolved Hide resolved

cthtrifork commented Jun 7, 2024

View reviewed changes

api/src/main/java/io/strimzi/api/kafka/model/common/template/Volume.java Outdated Show resolved Hide resolved

cthtrifork commented Jun 7, 2024

View reviewed changes

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/TemplateUtils.java Show resolved Hide resolved

cthtrifork commented Jun 7, 2024

View reviewed changes

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/TemplateUtils.java Outdated Show resolved Hide resolved

cthtrifork and others added 4 commits June 12, 2024 15:02

Initial design of additionalVolumes support

da3af5c

Signed-off-by: Casper Thygesen <cth@trifork.com> Signed-off-by: KastTrifork <kast@trifork.com>

Initial work for implementation of additional volumes

a97329e

Signed-off-by: KastTrifork <kast@trifork.com>

Fix some issues found in testing and review comments

0ca3cc2

Signed-off-by: MichaelMorris <michael.morris@est.tech> Signed-off-by: KastTrifork <kast@trifork.com>

KastTrifork force-pushed the feature/additionalVolumes branch from b4c4502 to 0ca3cc2 Compare June 12, 2024 13:03

MichaelMorrisEst and others added 8 commits June 13, 2024 17:00

Added implmentation for other components

32f0777

Existing tests now passing as well Signed-off-by: MichaelMorris <michael.morris@est.tech>

Adding tests

e5782d0

Signed-off-by: MichaelMorris <michael.morris@est.tech>

update gitignore with systemtest/bin

09bc97b

Signed-off-by: Casper Thygesen <cth@trifork.com>

Update gitignore with more systemtest bins

5523212

Signed-off-by: Casper Thygesen <cth@trifork.com>

Replace CSI with PersistentVolumeClaims

a506979

Signed-off-by: Casper Thygesen <cth@trifork.com>

Merge remote-tracking branch 'origin/main' into feature/additionalVol…

51a162c

…umes Signed-off-by: Casper Thygesen <cth@trifork.com>

update docs

9dfacaf

Signed-off-by: Casper Thygesen <cth@trifork.com>

isForbiddenPath

bdfc674

Signed-off-by: Casper Thygesen <cth@trifork.com>

cthtrifork commented Jun 27, 2024

View reviewed changes

cthtrifork changed the title ~~Initial design of additionalVolumes support~~ Support of additional volumes in pod Jun 30, 2024

Merge branch 'strimzi:main' into feature/additionalVolumes

d7a6944

cthtrifork marked this pull request as ready for review July 1, 2024 19:20

Fixed test

4a367f3

Signed-off-by: KastTrifork <kast@trifork.com>

KastTrifork force-pushed the feature/additionalVolumes branch from c66d697 to 4a367f3 Compare July 1, 2024 19:46

make crd_install

f375c3c

Signed-off-by: Casper Thygesen <cth@trifork.com>

KastTrifork and others added 4 commits July 19, 2024 14:05

Merge main into branch

a3cd0c8

Signed-off-by: KastTrifork <kast@trifork.com>

Fix checkstyle error

45ed5e1

Signed-off-by: pegtrifork <peg@trifork.com>

Finish refactor of check for null

84aa5f7

Signed-off-by: pegtrifork <peg@trifork.com>

Fix checkstyle

89933ee

Signed-off-by: pegtrifork <peg@trifork.com>

scholzj reviewed Jul 22, 2024

View reviewed changes

pegtrifork and others added 2 commits July 23, 2024 09:24

Apply suggestions from code review

e009277

Co-authored-by: Jakub Scholz <www@scholzj.com> Signed-off-by: Peter Kiib Egede <100785536+pegtrifork@users.noreply.github.com>

Apply suggestions from code review

ca9eb61

Signed-off-by: pegtrifork <peg@trifork.com>

scholzj approved these changes Jul 23, 2024

View reviewed changes

tombentley approved these changes Jul 24, 2024

View reviewed changes

ppatierno approved these changes Jul 24, 2024

View reviewed changes

Removed static method imports as per review comment

3640dbe

Signed-off-by: MichaelMorris <michael.morris@est.tech>

Merge branch 'main' into feature/additionalVolumes

9e0915c

Signed-off-by: Kasper Storgaard <116632810+KastTrifork@users.noreply.github.com>

scholzj reviewed Aug 1, 2024

View reviewed changes

KastTrifork added 2 commits August 1, 2024 18:57

Added variable assertToleration

20199b7

Signed-off-by: Kasper Storgaard <116632810+KastTrifork@users.noreply.github.com>

Revert last commit to match main branch

c5bb07a

Signed-off-by: Kasper Storgaard <116632810+KastTrifork@users.noreply.github.com>

scholzj merged commit 27db9cf into strimzi:main Aug 3, 2024
21 checks passed

see-quick mentioned this pull request Aug 7, 2024

[system test] Add Support for Mounting Additional Volumes in Kafka, C… #10428

Merged

2 tasks

kyrsideris mentioned this pull request Sep 11, 2024

Add ability in KafkaConnect to use secrets provided by Secrets Store CSI Driver #5277

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support of additional volumes in pod #10099

Support of additional volumes in pod #10099

cthtrifork commented May 13, 2024 •

edited

Loading

MichaelMorrisEst commented Jun 6, 2024

cthtrifork commented Jun 10, 2024 •

edited

Loading

MichaelMorrisEst commented Jun 10, 2024

cthtrifork Jun 27, 2024

cthtrifork Jul 2, 2024

cthtrifork commented Jul 1, 2024

cthtrifork commented Jul 2, 2024

scholzj commented Jul 22, 2024

azure-pipelines bot commented Jul 22, 2024

scholzj left a comment

scholzj Jul 22, 2024

scholzj Jul 22, 2024

scholzj Jul 22, 2024

scholzj Jul 22, 2024

scholzj Jul 22, 2024

scholzj Jul 22, 2024

scholzj commented Jul 23, 2024

azure-pipelines bot commented Jul 23, 2024

scholzj left a comment

tombentley left a comment

ppatierno left a comment

MichaelMorrisEst commented Jul 26, 2024

scholzj commented Jul 26, 2024

azure-pipelines bot commented Jul 26, 2024

scholzj commented Jul 26, 2024

scholzj commented Aug 1, 2024

scholzj Aug 1, 2024

KastTrifork Aug 1, 2024

scholzj Aug 2, 2024

KastTrifork Aug 2, 2024

scholzj commented Aug 2, 2024

azure-pipelines bot commented Aug 2, 2024

scholzj commented Aug 3, 2024

Support of additional volumes in pod #10099

Support of additional volumes in pod #10099

Conversation

cthtrifork commented May 13, 2024 • edited Loading

Type of change

Description

Checklist

MichaelMorrisEst commented Jun 6, 2024

cthtrifork commented Jun 10, 2024 • edited Loading

MichaelMorrisEst commented Jun 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cthtrifork commented Jul 1, 2024

cthtrifork commented Jul 2, 2024

scholzj commented Jul 22, 2024

azure-pipelines bot commented Jul 22, 2024

scholzj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scholzj commented Jul 23, 2024

azure-pipelines bot commented Jul 23, 2024

scholzj left a comment

Choose a reason for hiding this comment

tombentley left a comment

Choose a reason for hiding this comment

ppatierno left a comment

Choose a reason for hiding this comment

MichaelMorrisEst commented Jul 26, 2024

scholzj commented Jul 26, 2024

azure-pipelines bot commented Jul 26, 2024

scholzj commented Jul 26, 2024

scholzj commented Aug 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scholzj commented Aug 2, 2024

azure-pipelines bot commented Aug 2, 2024

scholzj commented Aug 3, 2024

cthtrifork commented May 13, 2024 •

edited

Loading

cthtrifork commented Jun 10, 2024 •

edited

Loading