Docker plain helm chart #1035

segfault16 · 2024-08-02T09:17:52Z

Add helm chart for docker plain

Refers to #1013

Tasks:

Updated documentation in docs/modules/... directory
Ran tests in <quickstarter>/testdata directory
Shared library adaptions

…t name and release name

…on helm notes and remove switch cases on k8s version on ingress template

… the readme

docker-plain/files/chart/values.yaml

faust2199 · 2024-11-24T13:21:07Z

Having a very strict values.schema.json is probably not going to provide good experience when using helmValues defined from the Jenkinsfile. According to https://helm.sh/docs/topics/charts/ , "the schema is applied to the final .Values object, and not just to the values.yaml file."

Let's say we have the following in the Jenkinsfile:
odsComponentStageRolloutOpenShiftDeployment(context, [ 'selector': "app.kubernetes.io/name=${context.componentId}", 'helmEnvBasedValuesFiles': ['values.env.yaml'], 'helmValues': [ 'foo': 'bar' ] ]

When the above runs on Jenkins, ods-jenkins-shared-library will add two arguments on the command line:
--set foo=bar --set global.foo=bar

Then it will be aborted because additionalProperties are not allowed in both places. Is the user really expected to add two entries in values.schema.json to fix this?

I suggest that we remove the whole values.schema.json file. If the result of rendering is bad, helm upgrade is going to fail and rollback anyway.

renedupont · 2024-11-25T08:57:05Z

Having a very strict values.schema.json is probably not going to provide good experience when using helmValues defined from the Jenkinsfile. According to https://helm.sh/docs/topics/charts/ , "the schema is applied to the final .Values object, and not just to the values.yaml file."

Let's say we have the following in the Jenkinsfile: odsComponentStageRolloutOpenShiftDeployment(context, [ 'selector': "app.kubernetes.io/name=${context.componentId}", 'helmEnvBasedValuesFiles': ['values.env.yaml'], 'helmValues': [ 'foo': 'bar' ] ]

When the above runs on Jenkins, ods-jenkins-shared-library will add two arguments on the command line: --set foo=bar --set global.foo=bar

Then it will be aborted because additionalProperties are not allowed in both places. Is the user really expected to add two entries in values.schema.json to fix this?

I suggest that we remove the whole values.schema.json file. If the result of rendering is bad, helm upgrade is going to fail and rollback anyway.

I partially agree, I think there is a middle way though. In the values.schema.json we could set "additionalProperties": false to true in the relevant parts. That way we validate everything that is set in that file and everything else will not be considered and not lead to failing the helm validation.

docker-plain/files/chart/values.yaml

….enabled

This reverts commit 167397b.

jafarre-bi

A few new comments and some conversations still open.

docker-plain/files/chart/DEVNOTES.md

docker-plain/files/docker/default.conf

jafarre-bi · 2025-02-08T12:59:37Z

docker-plain/Jenkinsfile.template

  }
-  odsComponentStageRolloutOpenShiftDeployment(context)
+  odsComponentStageRolloutOpenShiftDeployment(context, [
+    'selector': "app.kubernetes.io/name=${context.componentId}",


Why is this selector only the name? chart.selectorLables are, as they should, name + instance.

Why is this selector only the name? chart.selectorLables are, as they should, name + instance.

Do you mean https://kubernetes.io/docs/reference/labels-annotations-taints/#app-kubernetes-io-instance? How do we generate the unique postfix like in the example given "mysql-abcxyz"?

@faust2199 Unless there's something I'm missing, the deployment.yaml is using chart.selectorLabels for the selector. This is defined in _helpers.tpl to be name = chart.name and instance = .Release.Name. Whatever we use it must match the actual selectors used in deployments, services...

My questions here are:

Is the chart name always equal to the componentId?

Will the functionality of getting resources based only on the name label never return resources that shouldn't match?

Is it correct to specify this selector in the deployment mean when the actual selector used is different? (For this I would answer no)

As agreed in the meeting, we will make the helmReleaseName config parameter explicit and add it to the selector to match the actual selector used in the deployments.

docker-plain/files/README.md

jafarre-bi · 2025-02-08T13:09:26Z

docker-plain/files/chart/values.yaml

+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 3


The Release Manager doesn't support multiple replicas yet. Not sure if these values should even be configurable, or at least maxReplicas should be 1 by default, with a comment saying that higher values aren't supported.

@jafarre-bi I don't know about this limitation, there's nothing in opendevstack documentation about. Please provide the source

@segfault16 HelmDeploymentStrategy, line 198:
// TODO: Once the orchestration pipeline can deal with multiple replicas,
// update this to store multiple pod artifacts.
Even if the code could deal with it and the documentation and traceability would be correctly preserved, it's still not officially supported. We would need to validate the functionality, document it and create specific automated tests to prevent regressions.

As agreed, I will see if we are on time to add a note stating that multiple replicas are currently unsupported to the official documentation. We will add a comment to this values file referencing that to warn the users to use this at their own risk.

The default value for maxReplicas must be 1. Using (unsupported) multiple replicas must be an informed opt-in.

jafarre-bi

Adding comments to the open conversations with the outcome of the meeting we just had.

jafarre-bi · 2025-05-15T10:07:07Z

docker-plain/Jenkinsfile.template

  }
-  odsComponentStageRolloutOpenShiftDeployment(context)
+  odsComponentStageRolloutOpenShiftDeployment(context, [
+    'selector': "app.kubernetes.io/name=${context.componentId}",


As agreed in the meeting, we will make the helmReleaseName config parameter explicit and add it to the selector to match the actual selector used in the deployments.

jafarre-bi · 2025-05-15T10:09:17Z

docker-plain/files/chart/values.yaml

+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 3


As agreed, I will see if we are on time to add a note stating that multiple replicas are currently unsupported to the official documentation. We will add a comment to this values file referencing that to warn the users to use this at their own risk.

segfault16 · 2025-07-04T09:36:07Z

@jafarre-bi is the official doc updated?

jafarre-bi · 2025-10-31T13:48:12Z

@jafarre-bi is the official doc updated?

The change in the documentation has been merged into master through opendevstack/ods-jenkins-shared-library#1245

jafarre-bi · 2025-10-31T13:55:48Z

As agreed in the meeting, we will make the helmReleaseName config parameter explicit and add it to the selector to match the actual selector used in the deployments.

Has this open point been addressed?
If we can close the open points in the next few days, we aim to release the Helm quickstarter in the next EDP release, which will start mid-November.
Please, @faust2199 , @segfault16, and everyone else, we are almost there —let's work together to close this.
Thank you!

segfault16 · 2025-11-03T10:10:56Z

@jafarre-bi selectors and doc updated, please test rollout to production and merge on success

jafarre-bi

@segfault16, please see the comments to the latest changes.

jafarre-bi · 2025-11-03T11:56:02Z

docker-plain/Jenkinsfile.template

    */
    odsComponentStageBuildOpenShiftImage(context)
  }
+  def releaseName = context.componentId // can be customized as needed


It should be explicit that it must match .Release.Name. Otherwise, it will still be inconsistent with the selector used elsewhere.

@jafarre-bi we're supplying the same releaseName to helm upgrade (via helmReleaseName) as we use in the selector. .Release.Name is given by releaseName, we specify the selector. What inconsistency are you referring to?

jafarre-bi · 2025-11-03T11:57:02Z

docker-plain/files/chart/values.yaml

    memory: 16Mi
    ephemeral-storage: 1Mi

+## Before enabling check the official ODS documentation about replicate support: https://www.opendevstack.org/ods-documentation/opendevstack/latest/jenkins-shared-library/orchestration-pipeline.html#_known_limitations


Good idea to link to the official docs, but it's not enough, since many people will miss it. Please, make the warning explicit: multiple replicas aren't currently supported by the orchestration pipeline.

@jafarre-bi we agreed on this in July and I've been waiting for the official doc to reference since then. Those values will get templated and there's no way to keep this information up-to-date then. the reference will stay valid longer.

jafarre-bi · 2025-11-03T11:58:11Z

docker-plain/files/chart/values.yaml

+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 3


The default value for maxReplicas must be 1. Using (unsupported) multiple replicas must be an informed opt-in.

segfault16 and others added 15 commits May 6, 2024 15:57

feat: add initial draft for helm chart (docker-plain)

429158a

test: docker-plain chart test use AWS ECR busybox

a8df74d

test: update docker-plain golden tests with helm integration

55df77c

feat: docker-plain remove provisioning resources creation

abcd6c1

drop: comment on docker-plain chart name

8be1e7a

feat: prepare Chart.yaml for templating the componend_id

5fb6f7e

fix: remove custom app label, prefer the labels suggested by kubernetes

3dc157b

fix: remove componentId since this should be covered by the helm char…

ed3b160

…t name and release name

feat: update image section

f83dba3

update devnotes

1d7229d

fix TODO note regarding image Values values.yaml

543e5e2

feat: docker-plain ingress with default tls templating, fix imagetag …

e48a729

…on helm notes and remove switch cases on k8s version on ingress template

fix: align tabs on ingress.yaml and update devnotes todo

3c9e765

feat: docker-plain render Helm chart Chart.yaml file

0658683

update devnotes, remove dependencies in Chart.yml for now

0b541a8

segfault16 requested a review from michaelsauter as a code owner August 2, 2024 09:17

segfault16 added 2 commits August 2, 2024 09:30

Merge branch 'master' into docker-plain-helm-chart

d6d7121

update changelog

b97f813

tbugfinder requested review from BraisVQ and gerardcl August 10, 2024 11:41

gerardcl requested review from henrjk, jafarre-bi, jorge-romero, kuebler, metmajer, oalyman, renedupont, serverhorror and tbugfinder and removed request for michaelsauter August 13, 2024 07:15

gerardcl and others added 2 commits September 20, 2024 18:52

docker-plain add helm lint and helm template processing howto info in…

6bf18ed

… the readme

Update OS package by default

11871d4

renedupont reviewed Nov 18, 2024

View reviewed changes

docker-plain/files/chart/values.yaml Show resolved Hide resolved

faust2199 reviewed Nov 26, 2024

View reviewed changes

docker-plain/files/chart/values.yaml Outdated Show resolved Hide resolved

faust2199 and others added 6 commits November 27, 2024 22:22

docker-plain: add HorizontalPodAutoscaler

a4c338a

docker-plain: use nginx/nginx-unprivileged

e3e6552

docker-plain: add simpleHost to chart/values.yaml

167397b

docker-plain: allow additionalProperties; make use of .Values.service…

fe5fa7f

….enabled

Revert "docker-plain: add simpleHost to chart/values.yaml"

6c58ed7

This reverts commit 167397b.

Merge branch 'master' into docker-plain-helm-chart

5161996

serverhorror previously approved these changes Feb 7, 2025

View reviewed changes

jafarre-bi requested changes Feb 8, 2025

View reviewed changes

remove devnotes

6709b68

segfault16 dismissed serverhorror’s stale review via 6709b68 February 10, 2025 09:40

segfault16 and others added 3 commits February 10, 2025 10:44

add comments

da0af77

Set Ephemeral storage request and limit

d1f9713

Merge branch 'master' into docker-plain-helm-chart

a7b1cab

jafarre-bi reviewed May 15, 2025

View reviewed changes

serverhorror previously approved these changes Sep 2, 2025

View reviewed changes

up doc, up selectors

b9c0a1a

segfault16 dismissed serverhorror’s stale review via b9c0a1a November 3, 2025 10:05

Merge branch 'master' into docker-plain-helm-chart

2c453cc

jafarre-bi requested changes Nov 3, 2025

View reviewed changes

disable autoscaling multiple times

74046fb

Docker plain helm chart #1035

Are you sure you want to change the base?

Docker plain helm chart #1035

Uh oh!

Conversation

segfault16 commented Aug 2, 2024

Uh oh!

Uh oh!

faust2199 commented Nov 24, 2024

Uh oh!

renedupont commented Nov 25, 2024

Uh oh!

Uh oh!

jafarre-bi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jafarre-bi Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jafarre-bi Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jafarre-bi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

segfault16 commented Jul 4, 2025

Uh oh!

jafarre-bi commented Oct 31, 2025

Uh oh!

jafarre-bi commented Oct 31, 2025

Uh oh!

segfault16 commented Nov 3, 2025

Uh oh!

jafarre-bi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

jafarre-bi Feb 12, 2025 •

edited

Loading

jafarre-bi Feb 12, 2025 •

edited

Loading