quarkus Make Quarkus Kubernetes GitOps friendly

trafficstars

Done by not writing to target dir and removing non-idempotent annotations.

Addressing issue: https://github.com/quarkusio/quarkus/issues/26928

Jul 29 '22 15:07 Dairdevil

Thanks for your pull request!

The title of your pull request does not follow our editorial rules. Could you have a look?

title should not end up with ellipsis (make sure the title is complete)

This message is automatically generated by a bot.

Jul 29 '22 15:07 quarkus-bot[bot]

Thanks @iocanel - good suggestion on using the term "idempotent", I'll change it to that. It was a case of "I know this isn't a good label for it but I'm having a mind blank as to what would be better".

Would it be preferable to default to the current behaviour & leave the change of default behaviour to be done later?

Aug 01 '22 07:08 Dairdevil

@Dairdevil is there a reason why these properties are acessed from a static method and not from a @ConfigItem as we usually do?

Aug 04 '22 12:08 gastaldi

@gastaldi I wanted to avoid making the KubernetesProcessor class take injected configuration as this would break from the other processors. Happy to change this to @ConfigItem and remove the static methods if thats preferred?

Aug 04 '22 12:08 Dairdevil

Using a Config class with @ConfigItem is better because the build generates an Asciidoc document that can be used in the guides

Aug 04 '22 12:08 gastaldi

Thanks, I'll make that change. Just to make sure I've understood, I should make a new SomethingConfig class that has variables of my new config items injected via @ConfigItem (as opposed to putting the @ConfigItems directly into the classes they are needed in)?

Aug 04 '22 12:08 Dairdevil

@Dairdevil you need to add to https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/vanilla/deployment/src/main/java/io/quarkus/kubernetes/deployment/KubernetesConfig.java and use that in your KubernetesProcessor

Aug 04 '22 12:08 gastaldi

@gastaldi I've made the changes based on your explanation, thanks for going through that with me.

I think its as concise as it can be, and currently introduces the following new variables:

quarkus.kubernetes.idempotent Controls whether to include the non-idempotent labels on generated kubernetes resources (defaults to true);
quarkus.openshift.idempotent Controls whether to include the non-idempotent labels on generated openshift resources (defaults to true);
quarkus.knative.idempotent Controls whether to include the non-idempotent labels on generated knative resources (defaults to true);
quarkus.kubernetes.output-directory Optionally write any generated resources to a different directory relative to the module root

Current behaviour is that:

By default, all resources are generated with the non-idempotent labels removed
Each resource type (kubernetes, openshift, knative) has an independent variable to force the inclusion of the non-idempotent labels
If quarkus.kubernetes.output-directory is set, new resources are written to this directory in the module root
If any of the quarkus.*.idempotent variables are set to false then the new resources are written to the original location in the target directory
By default, all new resources will be written to a new directory .kubernetes in the module root

This slightly muddled logic has come from tying the writing of the resources to a new directory to the idempotency option. Would it make more sense to completely separate these two and continue to write to the directory under target until explicitly specified otherwise (using quarkus.kubernetes.output-directory as above) ?

Aug 08 '22 14:08 Dairdevil

Looks okay to me, but I'll let @iocanel have the final say on this 👍🏻

Aug 08 '22 15:08 gastaldi

@gsmet: The PR does change the default behavior by removing some labels / annotations from the generated resources. Not sure if this qualifies as breaking change, but it might be for a really small portion of our users. I think that we should merge anyway, but just wanted your view on that before I do.

Aug 18 '22 13:08 iocanel

I rebased the PR as somehow the CI didn't run. Let's see how it goes and merge if it's green.

Sep 13 '22 12:09 gsmet

:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.

:warning: Unable to include the stracktraces as the report was too long. See annotations below for the details. :warning: Unable to include the failure links as the report was too long. See annotations below for the details.

Failing Jobs - Building ac4d9d45e194c71f34628e55c93e9e0576867dd3

Status	Name	Step	Failures	Logs	Raw logs
✖	JVM Tests - JDK 11	`Build`	Failures	Logs	Raw logs
✖	JVM Tests - JDK 11 Windows	`Build`	Failures	Logs	Raw logs
✖	JVM Tests - JDK 17	`Build`	Failures	Logs	Raw logs
✖	JVM Tests - JDK 18	`Build`	Failures	Logs	Raw logs

Failures

:gear: JVM Tests - JDK 11 #

- Failing: integration-tests/kubernetes/maven-invoker-way integration-tests/kubernetes/quarkus-standard-way integration-tests/kubernetes/quarkus-standard-way-kafka

:package: integration-tests/kubernetes/maven-invoker-way

✖ Failed to execute goal org.apache.maven.plugins:maven-invoker-plugin:3.2.2:run (integration-tests) on project quarkus-integration-test-kubernetes-invoker: 7 builds failed. See console output above for details.

:package: integration-tests/kubernetes/quarkus-standard-way

✖ io.quarkus.it.kubernetes.BasicKubernetesTest.assertGeneratedResources line 56

✖ io.quarkus.it.kubernetes.BasicOpenshiftTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.KnativeClusterLocalTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.KnativeContainerImageTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.KnativeGlobalContainerConcurrencyTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KnativeGlobalRequestsPerSecondTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KnativeScaleBoundsTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.KnativeScaleToZeroTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KnativeTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KnativeWithApplicationPropertiesTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KnativeWithGlobalAutoscalingTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.KnativeWithHealthTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.KnativeWithImagePullSecretTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.KnativeWithRevisionAutoscalingTest.assertGeneratedResources line 38

✖ io.quarkus.it.kubernetes.KnativeWithSecretConfigTest.assertGeneratedResources line 41

✖ io.quarkus.it.kubernetes.KnativeWithSpecifiedContainerNameTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KnativeWithTrafficSplittingTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KnativeWithVolumesTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.KubernetesAndMinikubeWithApplicationPropertiesTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.KubernetesConfigWithSecretsTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.KubernetesInitContainersTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.KubernetesServiceMappingTest.assertGeneratedResources line 41

✖ io.quarkus.it.kubernetes.KubernetesWithApplicationPropertiesTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.KubernetesWithArgumentsTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KubernetesWithAutoMongoBindingTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.KubernetesWithAutoMysqlBindingTest.assertGeneratedResources line 43

✖ io.quarkus.it.kubernetes.KubernetesWithAutoPostgresBindingTest.assertGeneratedResources line 43

✖ io.quarkus.it.kubernetes.KubernetesWithCommandTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KubernetesWithConfigMapCustomModeTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KubernetesWithConfigMapTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KubernetesWithCustomResourcesTest.assertGeneratedResources line 45

✖ io.quarkus.it.kubernetes.KubernetesWithDefaultsTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithDeprecatedPropertiesTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithEmptyDirVolumesTest.assertGeneratedResources line 41

✖ io.quarkus.it.kubernetes.KubernetesWithEnvFromConfigMapTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithEnvFromFieldTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KubernetesWithEnvFromSecretTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.KubernetesWithGitlabLikeImageTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.KubernetesWithHealthAndJibTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.KubernetesWithHealthTest.assertGeneratedResources line 61

✖ io.quarkus.it.kubernetes.KubernetesWithHostAliasesTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.KubernetesWithIngressTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.KubernetesWithInitContainerResourceLimitsTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.KubernetesWithInputStatefulSetResourcesTest.assertGeneratedResources line 49

✖ io.quarkus.it.kubernetes.KubernetesWithMappingVolumeConfigMapItemsTest.ensureVolumeIsCorrectlyMappedWithItems line 36

✖ io.quarkus.it.kubernetes.KubernetesWithMappingVolumeSecretItemsTest.ensureVolumeIsCorrectlyMappedWithItems line 36

✖ io.quarkus.it.kubernetes.KubernetesWithMetricsCustomAbsoluteTest.assertGeneratedResources line 59

✖ io.quarkus.it.kubernetes.KubernetesWithMetricsCustomRelativeTest.assertGeneratedResources line 58

✖ io.quarkus.it.kubernetes.KubernetesWithMetricsNoAnnotationsTest.assertGeneratedResources line 59

✖ io.quarkus.it.kubernetes.KubernetesWithMetricsTest.assertGeneratedResources line 60

✖ io.quarkus.it.kubernetes.KubernetesWithMicrometerTest.assertGeneratedResources line 58

✖ io.quarkus.it.kubernetes.KubernetesWithMixedStyleEnvTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.KubernetesWithMultiplePortsTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.KubernetesWithNewStyleEnvTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.KubernetesWithOldStyleEnvTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.KubernetesWithPvcVolumesTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.KubernetesWithQuarkusAppNameTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.KubernetesWithRbacAndNamespaceTest.assertGeneratedResources line 45

✖ io.quarkus.it.kubernetes.KubernetesWithRemoteDebugTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithResourcesRequirementsTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithRootAndHealthTest.assertGeneratedResources line 38

✖ io.quarkus.it.kubernetes.KubernetesWithSecureIngressTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.KubernetesWithSecurityContextTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithSemiAutoPostgresBindingTest.assertGeneratedResources line 43

✖ io.quarkus.it.kubernetes.KubernetesWithServiceBindingTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.KubernetesWithSidecarAndJibTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.KubernetesWithSidecarAndProbesTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.KubernetesWithSpecifiedContainerNameTest.assertGeneratedResources line 43

✖ io.quarkus.it.kubernetes.KubernetesWithStatefulSetResourceTest.assertGeneratedResources line 41

✖ io.quarkus.it.kubernetes.KubernetesWithSysGroupTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.KubernetesWithWarningsEnvTest.ensureProperQuarkusPropertiesLogged line 39

✖ io.quarkus.it.kubernetes.MinikubeWithApplicationPropertiesTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.MinikubeWithDefaultsTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.MinikubeWithMixedStyleEnvTest.assertGeneratedResources line 38

✖ io.quarkus.it.kubernetes.OpenshiftV3Test.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.OpenshiftV4Test.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.OpenshiftWithAppConfigMapTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.OpenshiftWithApplicationPropertiesTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.OpenshiftWithAppSecretTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.OpenshiftWithArgumentsTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.OpenshiftWithCommandTest.assertGeneratedResources line 34

✖ io.quarkus.it.kubernetes.OpenshiftWithDeploymentResourceTest.assertGeneratedResources line 50

✖ io.quarkus.it.kubernetes.OpenshiftWithDeploymentWithoutSelectorsTest.assertGeneratedResources line 38

✖ io.quarkus.it.kubernetes.OpenshiftWithDockerBuildStrategyTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.OpenshiftWithHealthTest.assertGeneratedResources line 57

✖ io.quarkus.it.kubernetes.OpenshiftWithJvmAdditionalArgumentsTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.OpenshiftWithJvmArgumentsTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.OpenshiftWithLegacySidecarAndS2iTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.OpenshiftWithLocalDockerAndDeploymentResourceTest.assertGeneratedResources line 49

✖ io.quarkus.it.kubernetes.OpenshiftWithLocalDockerTest.assertGeneratedResources line 51

✖ io.quarkus.it.kubernetes.OpenshiftWithRemoteDebugTest.assertGeneratedResources line 40

✖ io.quarkus.it.kubernetes.OpenshiftWithRoutePropertiesTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.OpenshiftWithS2iTest.assertGeneratedResources line 43

✖ io.quarkus.it.kubernetes.OpenshiftWithServiceBindingTest.assertGeneratedResources line 42

✖ io.quarkus.it.kubernetes.OpenshiftWithSidecarAndS2iTest.assertGeneratedResources line 39

✖ io.quarkus.it.kubernetes.OpenshiftWithUberJarTest.assertGeneratedResources line 51

✖ io.quarkus.it.kubernetes.OpenshiftWithStatefulSetResourceTest.assertGeneratedResources line 36

✖ io.quarkus.it.kubernetes.WithKubernetesClientAndExistingResourcesTest.assertGeneratedResources line 46

✖ io.quarkus.it.kubernetes.WithKubernetesClientAndRbacDisabledTest.assertGeneratedResources line 43

✖ io.quarkus.it.kubernetes.WithKubernetesClientTest.assertGeneratedResources line 55

:package: integration-tests/kubernetes/quarkus-standard-way-kafka

✖ io.quarkus.it.kubernetes.kafka.BasicKubernetesTest.assertGeneratedResources line 35

✖ io.quarkus.it.kubernetes.kafka.BasicMinikubeTest.assertGeneratedResources line 37

✖ io.quarkus.it.kubernetes.kafka.BasicOpenshiftTest.assertGeneratedResources line 38

:gear: JVM Tests - JDK 11 Windows #

- Failing: integration-tests/kubernetes/quarkus-standard-way integration-tests/kubernetes/quarkus-standard-way-kafka