Add schema annotations to values.yaml, generate schema using helm-schema #153
Conversation
marians
changed the title
| "^[a-zA-Z0-9/-_\\.]+$": { | ||
| "$ref": "https://schema.giantswarm.io/labelvalue/v0.0.1" | ||
| } |
There was a problem hiding this comment.
This is an example where we use the $ref key to point to an external schema, to avoid repetition.
https://schema.giantswarm.io/labelvalue/v0.0.1 is a schema we created and published exactly for this purpose.
| # type: integer | ||
| # minimum: 1 | ||
| # @schema | ||
| minReplicas: 3 |
There was a problem hiding this comment.
Please do not increase this. This app is used for several tests, also with kind clusters, and this change might lead to pods not being able to be scheduled due to resource limits.
| # minimum: 1 | ||
| # @schema | ||
| # Make sure to set a value that is higher than the minReplicas value. | ||
| maxReplicas: 10 |
There was a problem hiding this comment.
Please do not decrease this. This app has also been used for load tests in the past, at least from me, and I therefore increased it to 100 at some point.
| cpu: 200m | ||
| memory: 50Mi |
There was a problem hiding this comment.
Basically the same as for the max replicas: Those values were tuned with load tests. IIRC a single hello world pod takes this amount of resources to handle 1.000 requests per second at 100 connections or something like that. So this ratio is kind of tested and memory consumption will probably never be a multiple of CPU consumption.
|
I wanted to kindly ask if you're still working on this PR or if we can also close it for now. :) |
Hi there! Thanks for the review. I'd like to keep the PR open, as Honeybadger is going to come back to this. We are using this app as a reference for how to possibly maintain values schema for apps in the future. |
Towards giantswarm/roadmap#3459
This PR serves as an example to demonstrate: What changes are needed to an unprepared
values.yamlso that it can be used with helm-schema to generate a useful values schema (values.schema.jsonfile).Details
The
values.schema.jsonfile is generated using the following command:helm-schema version was 0.11.2
For consistency, I also applied this schemalint command:
The
README.mdfile in the chart folder has been re-generated using thehelm-docscommand without any araguments.