Skip to content

feat(helm): Improve docs, add schema#12984

Merged
mtesauro merged 2 commits intoDefectDojo:devfrom
kiblik:helm_docs_valid
Sep 16, 2025
Merged

feat(helm): Improve docs, add schema#12984
mtesauro merged 2 commits intoDefectDojo:devfrom
kiblik:helm_docs_valid

Conversation

@kiblik
Copy link
Copy Markdown
Contributor

@kiblik kiblik commented Aug 13, 2025

  • README in the form of a symlink was dropped. It was generating some ugly warnings until now
  • readme-docs/KUBERNETES.md was replaced with a simple description where the information can be found
  • No content from README.md/KUBERNETES.md was removed, only
    • moved to another location (README.md.gotmpl)
    • extended by autogenerated help (list of available variables)
  • add hint for string/nil values
  • add values.schema.json - this is useful for values validation before manifests are sent to the k8s API
  • add native linter
  • add generator/validator of documentation (if you updated values.yaml but did not mention it in the documentation, GHA will fail)

There is still a huge place for improvement (render comments from values.yaml to descriptions, add $ref for better validation of k8s resources, mention all available variables, add no-additional-properties, ...). Still, it is a good second step (the first was definitely #12691) for improving the helm chart.

@kiblik kiblik marked this pull request as draft August 13, 2025 16:42
@kiblik kiblik force-pushed the helm_docs_valid branch 2 times, most recently from 6583e5c to f1d0fec Compare August 13, 2025 17:21
@kiblik kiblik force-pushed the helm_docs_valid branch 4 times, most recently from 45a7e4a to 76c5147 Compare August 18, 2025 14:28
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 2, 2025

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 3, 2025

Conflicts have been resolved. A maintainer will review the pull request shortly.

@kiblik kiblik force-pushed the helm_docs_valid branch 4 times, most recently from 5be90c1 to 36363b5 Compare September 6, 2025 11:18
@kiblik
Copy link
Copy Markdown
Contributor Author

kiblik commented Sep 6, 2025

@fernandezcuesta, I was planning to autogenerate values.schema.json + documentation using

However, I bumped into the following issue:

- at '/postgresServer': got null, want string
- at '/imagePullSecrets': got null, want string
- at '/redisServer': got null, want string

I know that I would be able to forcefully patch related places with type: [null, string], but it does not look/sound good.
Do you have any recommendations for a better way to generate schema and docs automatically? I wasn't able to fix it with any helper/annotation in the values.yaml file using the mentioned tools.

@fernandezcuesta
Copy link
Copy Markdown
Contributor

Hi, I guess it's gonna be easier to set those 3 to an empty string rather than nil also to be consistent with the rest of default values.
On the other hand, it's weird that annotations aren't doing the job (it should be pretty much the same as this example)

@kiblik
Copy link
Copy Markdown
Contributor Author

kiblik commented Sep 8, 2025

Hi, I guess it's gonna be easier to set those 3 to an empty string rather than nil also to be consistent with the rest of default values. On the other hand, it's weird that annotations aren't doing the job (it should be pretty much the same as this example)

Ok, it looks like I made so silly typo when I was testing it before because now it works perfectly.

@kiblik kiblik force-pushed the helm_docs_valid branch 2 times, most recently from 7b109ed to 564c3d1 Compare September 8, 2025 09:38
@kiblik kiblik marked this pull request as ready for review September 8, 2025 09:39
@github-actions
Copy link
Copy Markdown
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions
Copy link
Copy Markdown
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

Copy link
Copy Markdown
Contributor

@mtesauro mtesauro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@mtesauro mtesauro merged commit fa958b8 into DefectDojo:dev Sep 16, 2025
87 of 88 checks passed
@kiblik kiblik deleted the helm_docs_valid branch September 16, 2025 14:58
Maffooch pushed a commit to valentijnscholten/django-DefectDojo that referenced this pull request Feb 16, 2026
* feat(helm): Improve docs, add schema

* Swap helm/defectdojo/README.md & readme-docs/KUBERNETES.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants