[Docs] Add Kubernetes APT mirrors configuration option#9553
[Docs] Add Kubernetes APT mirrors configuration option#9553Michaelvll wants to merge 3 commits intomasterfrom
Conversation
Document the apt_mirrors field added in #9521, including the unset/empty list/non-empty list semantics and an example of per-context configuration.
|
Add docs for #9553 |
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the kubernetes.apt_mirrors configuration setting, which allows users to specify a list of hostnames to be used as fallback APT mirrors for Kubernetes pods. The review feedback suggests clarifying whether this field overrides the entire system mirror list or only the fallback mirrors injected by SkyPilot. Additionally, it is recommended to explicitly mention that URL schemes like http:// should be omitted and to clarify if custom ports are supported.
| Override the APT mirrors tried when installing packages on a pod (optional). | ||
| Hostnames only (no scheme/path); tried in order. Set to ``[]`` to disable | ||
| fallback mirrors entirely. When unset, SkyPilot uses a built-in fallback list | ||
| (``mirrors.wikimedia.org``, ``mirror.umd.edu``). |
There was a problem hiding this comment.
The documentation states that setting apt_mirrors to [] disables fallback mirrors entirely. It would be beneficial to clarify whether this field overrides the entire list of APT mirrors (including the primary ones in /etc/apt/sources.list) or only the fallback mirrors that SkyPilot injects. Based on the description, it seems to only affect the fallback list, so specifying this explicitly would avoid confusion for users with custom images that already have pre-configured mirrors.
| ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Override the APT mirrors tried when installing packages on a pod (optional). | ||
| Hostnames only (no scheme/path); tried in order. Set to ``[]`` to disable |
There was a problem hiding this comment.
The instruction 'Hostnames only (no scheme/path)' is clear, but it might be worth explicitly mentioning that this implies http:// or https:// should be omitted, as users frequently include the scheme when copying mirror URLs. Additionally, clarifying if ports are supported (e.g., my-mirror:8080) would be helpful for users with internal repository managers.
Description
This PR adds a new
kubernetes.apt_mirrorsconfiguration option that allows users to override the APT mirrors used when installing packages on Kubernetes pods.Changes
apt_mirrorsconfiguration parameter to the Kubernetes section of the config schema[]disables fallback mirrors entirelymirrors.wikimedia.org,mirror.umd.edu)context_configsExample Usage
Testing
bash format.sh/smoke-test(CI) orpytest tests/test_smoke.py(local)https://claude.ai/code/session_01BMUMi6V6LebBXsid2RuKj1