Skip to content

Commit 3f786cf

Browse files
authored
Merge pull request #5295 from yuvipanda/repetitive
Remove some super repetitive inline comments
2 parents f7cf459 + 0b45491 commit 3f786cf

File tree

1 file changed

+10
-42
lines changed

1 file changed

+10
-42
lines changed

helm-charts/support/values.schema.yaml

Lines changed: 10 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
# This schema (a jsonschema in YAML format) is used to generate
22
# values.schema.json which is, when available, used by the helm CLI for client
33
# side validation by Helm of the chart's values before template rendering.
4-
#
5-
# We look to document everything we have default values for in values.yaml, but
6-
# we don't look to enforce the perfect validation logic within this file.
7-
#
8-
# ref: https://json-schema.org/learn/getting-started-step-by-step.html
9-
#
104
$schema: http://json-schema.org/draft-07/schema#
115
type: object
126
additionalProperties: false
@@ -23,40 +17,34 @@ required:
2317
- aws-ce-grafana-backend
2418
- global
2519
properties:
26-
# cluster-autoscaler is a dependent helm chart, we rely on its schema
27-
# validation for values passed to it and are not imposing restrictions on them
28-
# in this helm chart.
20+
# We don't control validation of dependent charts here
2921
cluster-autoscaler:
3022
type: object
3123
additionalProperties: true
32-
# ingress-nginx is a dependent helm chart, we rely on its schema validation
33-
# for values passed to it and are not imposing restrictions on them in this
34-
# helm chart.
3524
ingress-nginx:
3625
type: object
3726
additionalProperties: true
38-
# prometheus is a dependent helm chart, we rely on its schema validation for
39-
# values passed to it and are not imposing restrictions on them in this helm
40-
# chart.
4127
prometheus:
4228
type: object
4329
additionalProperties: true
44-
# grafana is a dependent helm chart, we rely on its schema validation for
45-
# values passed to it and are not imposing restrictions on them in this helm
46-
# chart.
4730
grafana:
4831
type: object
4932
additionalProperties: true
50-
# aws-ce-grafana-backend is a dependent helm chart, we rely on its schema
51-
# validation for values passed to it and are not imposing restrictions on them
52-
# in this helm chart.
5333
aws-ce-grafana-backend:
5434
type: object
5535
additionalProperties: true
56-
# Enables https://github.com/yuvipanda/cryptnono/ to prevent cryptomining
5736
cryptnono:
5837
type: object
5938
additionalProperties: true
39+
gcpFilestoreBackups:
40+
type: object
41+
additionalProperties: true
42+
global:
43+
type: object
44+
additionalProperties: true
45+
46+
# These provide values for objects we create, so we validate their schema
47+
# to the best of our ability.
6048
redirects:
6149
type: object
6250
additionalProperties: false
@@ -87,13 +75,6 @@ properties:
8775
Relates to the HTTP Status code to use for the redirect.
8876
8977
Specify "redirect" for 302 (default), or "permanent" for 301.
90-
91-
# nvidiaDevicePlugin is _not a dependent helm chart_. It is values directly
92-
# coupled with this helm chart and are influencing the rendering of templates
93-
# we provide as part of this helm chart.
94-
#
95-
# Due to that, we maintain a strict schema here but not elsewhere.
96-
#
9778
nvidiaDevicePlugin:
9879
type: object
9980
additionalProperties: false
@@ -111,11 +92,6 @@ properties:
11192

11293
prometheusIngressAuthSecret:
11394
type: object
114-
# prometheusIngressAuthSecret is _not a dependent helm chart_. It is values directly
115-
# coupled with this helm chart and are influencing the rendering of templates
116-
# we provide as part of this helm chart.
117-
#
118-
# Due to that, we maintain a strict schema here but not elsewhere.
11995
additionalProperties: false
12096
required:
12197
- enabled
@@ -173,11 +149,3 @@ properties:
173149
type: string
174150
description: |
175151
Name of the StorageClass to create
176-
# Enables https://github.com/2i2c-org/gcp-filestore-backups to regularly backup
177-
# GCP Filestore instances
178-
gcpFilestoreBackups:
179-
type: object
180-
additionalProperties: true
181-
global:
182-
type: object
183-
additionalProperties: true

0 commit comments

Comments
 (0)