[Doc][Serve] Document for HTTPS #3972
Conversation
|
bump for review @Michaelvll |
There was a problem hiding this comment.
Thanks for adding the doc @cblmemo! Looks mostly good to me.
| @@ -161,6 +161,7 @@ Read the research: | |||
| ../serving/sky-serve | |||
| ../serving/user-guides | |||
| ../serving/service-yaml-spec | |||
| ../serving/https | |||
There was a problem hiding this comment.
Should we have it at the top level of the doc or in the user-guides?
There was a problem hiding this comment.
This feels more like a serving dedicated guide to me as putting it in other places is possible to left the impression that this doc is for https on a cluster with ports exposed.. wdyt?
docs/source/serving/https.rst
Outdated
| HTTPS on Load Balancer | ||
| ---------------------- | ||
|
|
||
| To enable HTTPS on the load balancer, you need to provide a certificate and a private key. Obtaining these from a trusted Certificate Authority (CA) is the most secure method. However, for development and testing purposes, you can generate a self-signed certificate and private key using the :code:`openssl` command-line tool. Here is an example of how to generate them: |
There was a problem hiding this comment.
We should have a section talking about common ways to get certificate for people who want to do it in production.
There was a problem hiding this comment.
Also, does a normal HTTPS requires periodic refresh for the token?
There was a problem hiding this comment.
Good point! Lemme investigate and try it out.
There was a problem hiding this comment.
Yes, they typically last for 3 months and up to 13 months. FastAPI doc says you cannot do that using uvicorn (see picture below). I think moving to envoy would address this problem.
https://fastapi.tiangolo.com/deployment/https/#certificate-renewal
|
@Michaelvll updated. PTAL again! |
Related to and block by #3380.
Tested (run the relevant ones):
bash format.shpytest tests/test_smoke.pypytest tests/test_smoke.py::test_fill_in_the_nameconda deactivate; bash -i tests/backward_compatibility_tests.sh