-
Notifications
You must be signed in to change notification settings - Fork 29
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
[WIP] Add simple architecture diagram #22
base: main
Are you sure you want to change the base?
Conversation
The `diagrams` package lets us create nice, graphviz based diagrams from python.
Need to figure out where to include this in the docs |
with Diagram("JupyterHub + SSH + SFTP", show=False, outformat="png", filename=f"{IMAGES_DIR}/architecture") as diag: | ||
autohttps = Deployment("autohttps") | ||
ssh = autohttps >> Edge(label="port 22") >> Deployment("jupyterhub-ssh") | ||
sftp = autohttps >> Edge(label="port 2222") >> Deployment("jupyterhub-sftp") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The SFTP k8s service expose a port with name ssh and number 22 (Recent change by me from number 2222)
- The SFTP k8s service targets a port with the name ssh on the pod (Recent change by me from targeting port 2222 by number rather than name)
- The SFTP k8s pod expose a port with name ssh and number 2222
Services can have sensible numbers <1000, pods should stay above 1000 though to comply with pod security policies etc.
sftp = autohttps >> Edge(label="port 2222") >> Deployment("jupyterhub-sftp") | |
sftp = autohttps >> Edge(label="port 22") >> Deployment("jupyterhub-sftp") |
|
||
IMAGES_DIR = "source/_static/images" | ||
|
||
with Diagram("JupyterHub + SSH + SFTP", show=False, outformat="png", filename=f"{IMAGES_DIR}/architecture") as diag: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be good to clarify this is assuming we have deployed jupyterhub ssh alongside z2jh.
❤️ wieeee more diagrams! :D This is a very helpful diagram! Questions raised when I viewed it (here):
|
😍 Such a nice diagram! I think it would be really useful to have it somewhere super visible, like the README. |
The
diagrams
package lets us create nice, graphvizbased diagrams from python.