Discuss indentation of configuration files in debugging docs #847
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Discuss how most unexpected behaviour from BinderHub occurs from mis-indented keys in values.yaml. Explain different types of nested charts. Include some tools to check indentation, helm diff and linting scripts.
This was referenced May 13, 2019
|
This is excellent! |
minrk
approved these changes
May 13, 2019
|
Thank you, I had excellent source material to work from! |
consideRatio
approved these changes
May 13, 2019
| If you think something should change but the diff is empty, that's probably a good clue something is misplaced! | ||
|
|
||
| An automated script to check linting may also be of appeal. | ||
| The Jupyter Team have a `lint script <https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/eaf87a217fca1834e299a0567a1ef87d813369b7/tools/templates/lint-and-validate.py>`_ to check the validity of the JupyterHub chart. |
There was a problem hiding this comment.
Oh hmmmmm, never thought about using this before!
Hmmmm, could this be extracted from the repo, perhaps as a python package, to allow users install this python package and invoke a test on their own deployment?
Hmmm... @sgibson91 ❤️ for processing these things!
|
|
||
| An automated script to check linting may also be of appeal. | ||
| The Jupyter Team have a `lint script <https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/eaf87a217fca1834e299a0567a1ef87d813369b7/tools/templates/lint-and-validate.py>`_ to check the validity of the JupyterHub chart. | ||
| It runs ``yamllint``, ``helm lint`` and ``kubeval``. |
There was a problem hiding this comment.
BTW: It also first runs helm template to generate rendered kubernetes files based on provided values before yamllint is run to validate the output from the templates. If I recall correctly, but this is a technical aspect. No change requested.
| The Jupyter Team have a `lint script <https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/eaf87a217fca1834e299a0567a1ef87d813369b7/tools/templates/lint-and-validate.py>`_ to check the validity of the JupyterHub chart. | ||
| It runs ``yamllint``, ``helm lint`` and ``kubeval``. | ||
|
|
||
| For further discussion on this topic or to join the conversation, you can visit `this Discourse thread <https://discourse.jupyter.org/t/nesting-levels-in-config-yml-file/1037>`_ or `this GitHub issue <https://github.com/jupyterhub/binderhub/issues/845>`_. |
yuvipanda
pushed a commit
to jupyterhub/helm-chart
that referenced
this pull request
May 14, 2019
yuvipanda
pushed a commit
to jupyterhub/helm-chart
that referenced
this pull request
May 20, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While building my BinderHub, most of my problems came from not indenting keys correctly in
config.yamlandsecret.yaml. I've updated the Debugging BinderHub docs to discuss different types of nested charts and suggest some tools to help with this issue based on discussions in #845 and this Discourse thread.