values schema #811

wkloucek · 2024-11-22T10:27:03Z

Description

Maintain a schema file to find misconfigurations.
There were already some misconfigurations found in the deployment examples (see the diff).

Related Issue

Fixes Add values schema #138

Motivation and Context

How Has This Been Tested?

tested in CI against CI values and deployment examples
tested against well known deployments outside of this Chart repo
- the "B" project, see issue backref on this ticket
- the "E" project, I ran a command like this helm lint charts/ocis -f ~/Projects/gitlab.xxx/exxx/ocis-infra/common/ocis/values.yaml -f ~/Projects/gitlab.xxx/exxx/ocis-infra/prod/apps/ocis/values.yaml

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Technical debt
Tests only (no source changes)

Checklist:

wkloucek · 2024-11-25T14:24:07Z

@d7oc could you skim those changes to check if you agree with the principle of this change?

Most interesting from my side:

the effect on the values.yaml changes in the future (one needs to maintain the schema annotations)
the schema helps devs to put configuration in the right place and avoid configuration that does nothing (includes config that was removed)
the deployment examples stay up to date because their configuration is now linted, too
the schema forces us to have sane defaults / configuration methods

If we can agree on the schema beeing a good thing, I'll gonna do some polishing on this PR, especially on the configuration documentation that received a small fallout.

wkloucek · 2024-12-06T08:15:46Z

@d7oc I'd like to get this into the chart soonish or agree on a timeframe when this change does fits our risk analysis / schedule / ...

This week I had another occurence where this schema feature would have saved a college and my like 2 hours each because we had fine looking configuration on a wrong indention level.

d7oc

Submitting first feedback. Check until line 800 in values.yaml

d7oc · 2024-12-06T16:22:21Z

charts/ocis/values.yaml

+  sha:
+  # @schema
+  # type: [string, null]
+  # required: true
+  # @schema


We should somehow limit the allowed strings here, as per Kubernetes API this can only be Always, Never or IfNotPresent.

Suggested change

sha:

# @schema

# type: [string, null]

# required: true

# @schema

sha:

# @schema

# enum: ["Always", "Never", "IfNotPresent", null]

# required: true

# @schema

adding null to to the enum field does actually not end up in the final schema.

This would be no blocker for .Values.image.pullPolicy, because it is never null.

But .Values.services.<service>.image.pullPolicy needs to be nullable to fallback to .Values.image.pullPolicy

With your changes, liniting fails:

DEBU[2024-12-09T08:01:38+01:00] Using template files [charts/ocis/docs/templates/values-desc-table.adoc.gotmpl] for chart charts/ocis /home/wkloucek/go/bin/gomplate-v3.11.8 --file=charts/ocis/docs/templates/values.adoc.yaml.gotmpl --out=charts/ocis/docs/values.adoc.yaml /home/wkloucek/go/bin/helm-v3.16.2 lint charts/ocis -f 'charts/ocis/ci/absolute-minimum-values.yaml' ==> Linting charts/ocis [INFO] Chart.yaml: icon is recommended [ERROR] values.yaml: - services.activitylog.image.pullPolicy: services.activitylog.image.pullPolicy must be one of the following: "Always", "Never", "IfNotPresent"

As said, this is because the schema doesn't inherit the null:

"pullPolicy": { "default": "", "description": "Image pull policy", + "enum": [ + "Always", + "Never", + "IfNotPresent" + ], "required": [], - "title": "pullPolicy", - "type": [ - "string", - "null" - ] + "title": "pullPolicy" },

After some further reading I guess we need to set type and enum. With type set to string and null as before and enum with the allowed string values. This should do the trick.

charts/ocis/values.yaml

d7oc · 2024-12-06T17:01:23Z

I'm missing the command here to generate the schema from the values.yaml or is there some magic I've overlooked?

d7oc

Finished review.

d7oc · 2025-01-17T15:32:53Z

charts/ocis/values.yaml

+    # @schema
+    # type: [string, null]
+    # required: false
+    # @schema
+    # -- UUID of the initial admin user.
    # If the given value matches a user's value from `features.externalUserManagement.oidc.userIDClaim`, the admin role will be assigned.


We could used format: "uuid" here

d7oc · 2025-01-17T15:34:12Z

charts/ocis/values.yaml

+      # @schema
+      # type: string
+      # required: true
+      # @schema


We could use format: "email" here

d7oc · 2025-01-17T15:35:19Z

charts/ocis/values.yaml

+      # @schema
+      # type: [string, null]
+      # required: false
+      # @schema


We could use format: "uri" here

d7oc · 2025-01-17T15:37:49Z

charts/ocis/values.yaml

+      # @schema
+      # type: [string, null]
+      # required: false
+      # @schema


We could use format: "uri" here

d7oc · 2025-01-17T15:40:34Z

charts/ocis/values.yaml

        # -- The object class to use for users in the default user search filter like `inetOrgPerson`.
        objectClass: inetOrgPerson


Was this skipped intentionally?

d7oc · 2025-01-17T16:44:08Z

charts/ocis/values.yaml

+        # @schema
+        # type: [string, null]
+        # required: false
+        # @schema


We could use format: "uri" here.

d7oc · 2025-01-17T16:45:44Z

charts/ocis/values.yaml

      # -- Configure the {"styles": []} section in the Web config.json.
      styles:
        []
        # - href: /theme/foo.css
+      # @schema
+      # additionalProperties: true
+      # @schema
      # -- Configure the {"styles": []} section in the Web config.json.


Seems to me that this description of the setting is wrong.

d7oc · 2025-01-17T16:47:25Z

charts/ocis/values.yaml

+        postLogoutRedirectURI:
+        # @schema
+        # type: [string, null]
+        # required: false
+        # @schema


We could add format: "uri" here.

d7oc · 2025-01-17T16:48:19Z

charts/ocis/values.yaml

+        # @schema
+        # type: [string, null]
+        # required: false
+        # @schema


We could add format: "uri" here.

d7oc · 2025-01-17T16:49:43Z

charts/ocis/values.yaml

+        # @schema
+        # type: [string, null]
+        # required: false
+        # @schema


We could add format: "uri" here.

wkloucek added 2 commits November 22, 2024 09:58

bootstrap tooling

f3db247

adapt more schema fields

4d607e9

wkloucek marked this pull request as draft November 22, 2024 10:27

wkloucek added 2 commits November 22, 2024 11:42

include schema in docs

8a95c80

progress with schema

dbb9125

wkloucek mentioned this pull request Nov 25, 2024

remove unused config options at features.appsIntegration.wopiIntegration #814

Merged

11 tasks

wkloucek added 2 commits November 25, 2024 08:50

add additonal linting

f6587f3

progress with the schema

55934f9

wkloucek added the QA label Nov 25, 2024

wkloucek added 8 commits November 25, 2024 11:19

progress with schema

a029a71

do more linting

c7e0dff

make helmfile use bingo managed helm

fbca19e

fix api linting

6f36c16

enhance schema

24f506b

add schema to all values

2f6ec4e

fix some schema bugs

3f0ef58

Merge branch 'main' into values-schema

9b62934

wkloucek requested a review from d7oc November 25, 2024 14:23

This was referenced Nov 25, 2024

remove per service store settings #815

Merged

clarify embed mode configuration #812

Merged

revert namespace repositioning

06f3d2b

wkloucek force-pushed the values-schema branch from 34c49fa to 06f3d2b Compare November 25, 2024 14:31

wkloucek added 6 commits November 25, 2024 15:34

remove references to the gone appprovider

40f3f09

Merge branch 'main' into values-schema

281ea9d

work on documentation

c677849

Merge branch 'main' into values-schema

dbfe052

update docs

5da90ed

Merge branch 'main' into values-schema

7b3d3da

wkloucek marked this pull request as ready for review December 6, 2024 08:14

d7oc reviewed Dec 6, 2024

View reviewed changes

wkloucek added 9 commits December 9, 2024 08:12

add schema to frameSrc

446c26e

allow integer or string for properties of rollingUpdate

f793e61

remove superfluous quotes around strings

26845bc

enhance hostAliases schema validation

cfdef00

fix hostname format

567eec1

make smtp host setting of format hostname

11d4e12

improve wopi schema

48be379

update helm-schema

f9fe500

Merge branch 'main' into values-schema

07bfe0a

wkloucek requested a review from d7oc December 17, 2024 13:58

update helm schema

2900d59

d7oc reviewed Jan 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

values schema #811

values schema #811

wkloucek commented Nov 22, 2024 •

edited by d7oc

Loading

wkloucek commented Nov 25, 2024 •

edited

Loading

wkloucek commented Dec 6, 2024 •

edited

Loading

d7oc left a comment

d7oc Dec 6, 2024

wkloucek Dec 9, 2024 •

edited

Loading

d7oc Jan 17, 2025

d7oc commented Dec 6, 2024 •

edited

Loading

d7oc left a comment

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

d7oc Jan 17, 2025

		# -- The object class to use for users in the default user search filter like `inetOrgPerson`.
		objectClass: inetOrgPerson

values schema #811

Are you sure you want to change the base?

values schema #811

Conversation

wkloucek commented Nov 22, 2024 • edited by d7oc Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

wkloucek commented Nov 25, 2024 • edited Loading

wkloucek commented Dec 6, 2024 • edited Loading

d7oc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wkloucek Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d7oc commented Dec 6, 2024 • edited Loading

d7oc 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wkloucek commented Nov 22, 2024 •

edited by d7oc

Loading

wkloucek commented Nov 25, 2024 •

edited

Loading

wkloucek commented Dec 6, 2024 •

edited

Loading

wkloucek Dec 9, 2024 •

edited

Loading

d7oc commented Dec 6, 2024 •

edited

Loading