Add docs for opening ports on Kubernetes #2997
Conversation
…o hemil/k8s-ports-docs # Conflicts: # docs/source/reference/config.rst # docs/source/reference/kubernetes/index.rst
There was a problem hiding this comment.
Thanks @hemildesai! I've reworked the docs to focus on how to get configured quickly with direct instructions - let me know what you think!
There was a problem hiding this comment.
Thanks for adding the doc @hemildesai @romilbhardwaj! Left several minor comments.
docs/source/reference/config.rst
Outdated
| # deploying the NGINX ingress controller. In this mode, the port can be | ||
| # accessed externally using the Ingress URL plus a path prefix of the form | ||
| # /skypilot/{cluster_pod_name}/{port} | ||
| # Refer to kubernetes-ingress.yml.j2 for the exact template. |
There was a problem hiding this comment.
At the first glance, I thought I should fill out the template myself. Maybe we can say: "SkyPilot uses the config in sky/templates/kubernetes-ingress.yml.j2 to setup the ingress"
There was a problem hiding this comment.
Thanks! I think this was a little too much detail, and the user should likely not look/edit at this j2 unless they really know what they are doing. I have removed this for now.
docs/source/reference/config.rst
Outdated
| # deploying the NGINX ingress controller. In this mode, the port can be | ||
| # accessed externally using the Ingress URL plus a path prefix of the form | ||
| # /skypilot/{cluster_pod_name}/{port} | ||
| # Refer to kubernetes-ingress.yml.j2 for the exact template. |
There was a problem hiding this comment.
Thanks! I think this was a little too much detail, and the user should likely not look/edit at this j2 unless they really know what they are doing. I have removed this for now.
| To work around this issue, make sure all your ports have services running behind them. | ||
|
|
||
| .. note:: | ||
| LoadBalancer services are not supported on kind clusters created using :code:`sky local up`. |
There was a problem hiding this comment.
Just a quick thought, maybe we can do it in the future, but is it possible that we can have sky local up with the nginx ingress setup by default, so the user can directly try the open ports on the cluster that is local up'ed
There was a problem hiding this comment.
Good idea! tracking here - #3112 : )
Add docs for #2713