feat: generate simple generic helm chart #665

csviri · 2023-07-20T14:27:33Z

This is the MVP for helm chart generator, it is "bare minimum" that works, will add subsequent PRs to improve.

metacosm · 2023-08-16T17:37:06Z

...ent/src/main/java/io/quarkiverse/operatorsdk/deployment/helm/DisableDefaultHelmListener.java

+import io.dekorate.kubernetes.config.BaseConfigFluent;
+import io.dekorate.kubernetes.config.Configurator;
+
+public class DisableDefaultHelmListener extends Configurator<BaseConfigFluent<?>> implements WithSession {


What's the point of this class?

added comment. it is to disable default helm generator

samples/mysql-schema/src/main/resources/application.properties

metacosm · 2023-08-17T07:26:19Z

core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/HelmConfiguration.java

+    /**
+     * Can be used to disable helm chart generation.
+     */
+    @ConfigItem(defaultValue = "true")


This should be false by default, imo. We don't want to generate Helm charts on every build for sure.

IDK, I would rather generate everything, users still can opt out, if something is not needed, but they would be aware that it's there. Also would worth to measure the time difference. Will do some naive measurement

Briefly did some "naive" measurement on exposed app sample, the problem is that the build time varies even if nothing changes around ~300ms (without tests), independently from the fact that helm genertion is turned on or off. But basically comparing it with or without helm there was no significant difference.

Let's assume that there is a difference in the build, thus there is additional 100ms more if helm is enabled (while the project builds without tests in about 11s), is this worth turning it off? it's really not significant imo

This is more important in the dev mode, so at the very least, helm chart generation should be disabled in dev mode, though I still think it shouldn't be active by default, the same way we don't generate bundles by default either (which is why the support is in a different module). Since helm support is in the core module, it should be deactivated by default. Generating something all the time just to make people aware of it is a bad idea, imo. This should be addressed by documentation.

IDK, can do it for now, but my opinion is that if there is no explicit reason why not to generate it it should be there, even for dev mode, so users can see the helm chart if they add an additional dependent resource.

Why bundle generation is a separate module, I mean why it is not just a flag to not generate it?

IDK, can do it for now, but my opinion is that if there is no explicit reason why not to generate it it should be there, even for dev mode, so users can see the helm chart if they add an additional dependent resource.

The core principle is to be as efficient as possible so sure, we can always say things are "fast" enough but from my point of view, if something doesn't need to be done all the time, it shouldn't.

Why bundle generation is a separate module, I mean why it is not just a flag to not generate it?

Cleaner separation of concerns. Also allows to not bring the dependencies if not used. For that matter, we might want to extract Helm support in its own module at some later point as well.

Cleaner separation of concerns. Also allows to not bring the dependencies if not used. For that matter, we might want to extract Helm support in its own module at some later point as well.

I think this is a matter of definition, if having such a features in different package and feature flag vs different module. I personally definitely would prefer just feature flag, especially since there should be this nice unified way how we configure quarkus.

metacosm · 2023-08-17T08:33:03Z

.../deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/helm/HelmChartProcessor.java

+
+    @BuildStep
+    public void handleHelmCharts(
+            BuildProducer<ArtifactResultBuildItem> dummy,


If this is needed to ensure this steps runs after another one, please add a comment to that effect, otherwise that parameter might get removed at some point, leading to possibly difficult to diagnose issues.

Actually, this is a BuildProducer that isn't used so I don't think there's any point in keeping this.

without it it does not gets executed

maybe there is a more elegant way to do this

Sgitario

I see that you have followed the approach of using templates instead of YAML expressions which is perfectly fine and I think it fits better in your use case.

I've added a few comments about the tests, but not blockers at all.

Good job!!

Sgitario · 2023-08-17T09:04:36Z

core/deployment/src/test/java/io/quarkiverse/operatorsdk/test/HelmChartGeneratorTest.java

+                    (jar) -> jar.addClasses(SimpleReconciler.class, SimpleCR.class, SimpleSpec.class, SimpleStatus.class));
+
+    @Test
+    void generatesHelmChart() {


I think it would be good to assert that the resources are indeed generated.

yes, will take a look on this, there was an issue with the test, and though an e2e will be enough, bit will give it an other try. Thx!

added simple asserts, not sure if we should check the templates in depth in this case.

Sgitario · 2023-08-17T09:06:07Z

samples/exposedapp/src/test/java/io/halkyon/HelmDeploymentE2ETest.java

+// https://github.com/dajudge/kindcontainer/issues/235
+@Disabled
+@QuarkusTest
+class HelmDeploymentE2ETest {


A while ago, I remember having a workflow that used Kind to install the ping pong operators. It had been useful to use this workflow to verify the helm installation via CLI instead of using junit test which is prone to errors (because it needs maintainers to have installed certain tools like helm, etc).

Yeah, it is quite annoying when you need those tools, but managing such tests is quite handy from java code. Will take a look on this in next pr. An other possibility is to commit something like this script to the repo:
https://helm.sh/docs/intro/install/#from-script
And install helm during the test if not installed yet

For GitHub Actions there is a nice action that does that.

csviri · 2023-08-17T13:46:12Z

.../deployment/src/main/java/io/quarkiverse/operatorsdk/deployment/helm/HelmChartProcessor.java

+        try (InputStream file = Thread.currentThread().getContextClassLoader()
+                .getResourceAsStream(CRD_ROLE_BINDING_TEMPLATE_PATH)) {
+            if (file == null) {
+                throw new IllegalArgumentException("Template file " + CRD_ROLE_BINDING_TEMPLATE_PATH + " doesn't exist");


There is not much benefit to check for null on a static resource.

[skip ci]

csviri changed the title ~~Helm chart~~ feat: generate simple generic helm chart Jul 20, 2023

csviri force-pushed the helm-chart branch from e8a83fd to 10d6077 Compare July 24, 2023 08:47

csviri self-assigned this Jul 24, 2023

csviri linked an issue Jul 27, 2023 that may be closed by this pull request

Generate Helm Chart for an Operator (MVP) #621

Closed

csviri force-pushed the helm-chart branch from 59535a4 to b5143eb Compare August 1, 2023 15:53

csviri added 25 commits August 8, 2023 10:15

feat: generate helm chart

b456f8c

feat: generate simple generic helm chart

ed524f8

wip

556207a

wip

e88a95b

working basic helm chart

a3ce311

improvemets on sample chart

3dea2d3

generate the base helm templates

0ac61d7

helm listener fix, values model

c9914e3

progress with values generation

d63d239

reconciler related data generation skeleton

20bcbd9

simple generation of reconilers finished

a232c64

add crd-s to the helm chart

259ae34

config options

6dfcbe4

improvements, mvp implementation works

87c2dab

refactoring, partially generating templates explicitly

9b1fdba

generating role bindings for reconcilers primary

82cc4ff

fix: using qute for templating

fd741ed

passing namespace environment variable

313b7fe

roles for dependent resources

c22566b

reusing generated Deployment

bfa9ffc

helm test progress

2601ab5

started e2e test with exposed app

86bd36b

e2e progress

049106a

generate per controller namespace settings

0bc75a0

code improvements

6970d0f

csviri force-pushed the helm-chart branch from a50d733 to 7ced034 Compare August 8, 2023 08:21

csviri added 3 commits August 16, 2023 16:15

e2e test improvements

23b264f

improvements

1afdad4

Merge branch 'main' into helm-chart

2bce8a8

csviri marked this pull request as ready for review August 16, 2023 15:24

metacosm requested review from Sgitario and metacosm August 16, 2023 17:04

metacosm reviewed Aug 16, 2023

View reviewed changes

samples/mysql-schema/src/main/resources/application.properties Outdated Show resolved Hide resolved

csviri added 2 commits August 17, 2023 08:21

remove unnecessary property

9453591

comment explaining class

11c6423

metacosm reviewed Aug 17, 2023

View reviewed changes

metacosm and others added 3 commits August 17, 2023 09:34

refactor: generify

c2744a2

remove image

69c4d86

format

eff703f

metacosm reviewed Aug 17, 2023

View reviewed changes

csviri added 2 commits August 17, 2023 10:45

fixes

ff1128a

Merge branch 'main' into helm-chart

c7183e5

Sgitario approved these changes Aug 17, 2023

View reviewed changes

csviri requested a review from metacosm August 17, 2023 10:53

csviri and others added 5 commits August 17, 2023 14:02

simple test

427b885

refactor: improve file management

ad21612

refactor: add utility method to deal with generated resources

4ce5e51

refactor: unify path management

1b10041

refactor: minor

555dabd

csviri commented Aug 17, 2023

View reviewed changes

metacosm approved these changes Aug 17, 2023

View reviewed changes

docs: make comment more explicit

e388a1b

[skip ci]

metacosm merged commit 1515cb7 into main Aug 17, 2023

metacosm deleted the helm-chart branch August 17, 2023 14:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: generate simple generic helm chart #665

feat: generate simple generic helm chart #665

csviri commented Jul 20, 2023 •

edited

Loading

metacosm Aug 16, 2023

csviri Aug 17, 2023

metacosm Aug 17, 2023

csviri Aug 17, 2023

csviri Aug 17, 2023

metacosm Aug 17, 2023

csviri Aug 17, 2023

metacosm Aug 17, 2023

csviri Aug 17, 2023

metacosm Aug 17, 2023

metacosm Aug 17, 2023

csviri Aug 17, 2023

csviri Aug 17, 2023

Sgitario left a comment

Sgitario Aug 17, 2023

csviri Aug 17, 2023

csviri Aug 17, 2023

Sgitario Aug 17, 2023

csviri Aug 17, 2023

csviri Aug 17, 2023

csviri Aug 17, 2023

feat: generate simple generic helm chart #665

feat: generate simple generic helm chart #665

Conversation

csviri commented Jul 20, 2023 • edited Loading

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

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

Sgitario 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

Choose a reason for hiding this comment

csviri commented Jul 20, 2023 •

edited

Loading