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

Improve the imagePullSecrets documentation #981

Closed
consideRatio opened this issue Oct 17, 2018 · 3 comments · Fixed by #1794
Closed

Improve the imagePullSecrets documentation #981

consideRatio opened this issue Oct 17, 2018 · 3 comments · Fixed by #1794

Comments

@consideRatio
Copy link
Member

We are missing an example of working configuration, and could perhaps now avoid duplicating the documentation within the hub's imagePullSecret and the singleuser's imagePullSecret.

Suggested action:

  • visit schema.yaml and add an example of a working configuration
  • update the hub.imagePullSecret to reference the singleuser.imagePullSecret

The current generated documentation, based on the schema.yaml file:
https://zero-to-jupyterhub-with-kubernetes.readthedocs.io/en/latest/reference.html#singleuser-imagepullsecret

@consideRatio
Copy link
Member Author

consideRatio commented Oct 19, 2018

See @dkipping's comment as well, we should point to Azure / GKE / Amazon guides for doing this perhaps? This can be done manually by referencing the secret manually created following these guides, but no matter what, the input to the helm chart needs to follow their guides even though the helm chart can automate the creation of the secret.

#447 (comment)

@ablekh
Copy link

ablekh commented Oct 19, 2018

@consideRatio I agree with the idea of pointing to Azure (AKS) / GCP (GKE) / AWS (EKS) guides for this aspect (as well as for other platform-specific aspects). By the way, the z2jh documentation hyperlink above is incorrect; the correct one is without the "-with-kubernetes" part: https://zero-to-jupyterhub.readthedocs.io/en/latest/reference.html#singleuser-imagepullsecret.

@dkipping
Copy link

dkipping commented Oct 22, 2018

@consideRatio just referencing to this guide and mentioning that the second step (creating a kubernetes secret) will be needed to reference it in the jupyterhub's config.yaml should already help. This might e.g. be done as a note in the jupyterhub doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants