Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow enabled config, for use by charts depending on this chart conditionally #3162

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
Expand Up @@ -217,6 +217,7 @@ def parse_schema(d, md=[], depth=0, pre=""):
"https://your-domain-name.com", # example
"https://kubernetes.io/docs/tutorials/kubernetes-basics/", # works
"https://cloud.ibm.com/kubernetes/catalog/create", # works
"https://github.com/traefik/traefik/blob/HEAD/CHANGELOG.md", # works
"https://portal.azure.com", # sign-in redirect noise
"https://console.cloud.google.com", # sign-in redirect noise
"https://console.developers.google.com", # sign-in redirect noise
Expand Down
6 changes: 6 additions & 0 deletions jupyterhub/values.schema.yaml
Expand Up @@ -27,6 +27,12 @@ required:
- rbac
- global
properties:
enabled:
type: [boolean, "null"]
description: |
`enabled` is ignored by the jupyterhub chart itself, but a chart depending
on the jupyterhub chart conditionally can make use this config option as
the condition.
fullnameOverride:
type: [string, "null"]
description: |
Expand Down
5 changes: 5 additions & 0 deletions jupyterhub/values.yaml
Expand Up @@ -3,6 +3,11 @@
fullnameOverride: ""
nameOverride:

# enabled is ignored by the jupyterhub chart itself, but a chart depending on
# the jupyterhub chart conditionally can make use this config option as the
# condition.
enabled:
Copy link
Member

Choose a reason for hiding this comment

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

What do other charts typically do? Do they leave this null, or default to true?

Copy link
Member

Choose a reason for hiding this comment

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

I suggest its made null as default here, true/false has no meaning by this chart anyhow so making it null seems less confusing, and both false/true and can be defaults for a chart depending on this - such chart should define enabled to false/true explicitly.

Copy link
Member

Choose a reason for hiding this comment

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

Most charts dont need an entry for this, but we have a strict schema.


# custom can contain anything you want to pass to the hub pod, as all passed
# Helm template values will be made available there.
custom: {}
Expand Down