From fdbcce3a5e56d931030f0348616424f9d440072e Mon Sep 17 00:00:00 2001 From: Kenichi Omichi <ken1ohmichi@gmail.com> Date: Mon, 14 Nov 2022 11:23:57 +0900 Subject: [PATCH] Update offline-environment.md (#9481) This makes it more readable by explaining clearly what files are necessary to be downloaded in advance from online environment. --- docs/offline-environment.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/offline-environment.md b/docs/offline-environment.md index 063ed74a3..b76134cd6 100644 --- a/docs/offline-environment.md +++ b/docs/offline-environment.md @@ -1,12 +1,25 @@ # Offline environment -In case your servers don't have access to internet (for example when deploying on premises with security constraints), you need to setup: +In case your servers don't have access to the internet directly (for example +when deploying on premises with security constraints), you need to get the +following artifacts in advance from another environment where has access to the internet. + +* Some static files (zips and binaries) +* OS packages (rpm/deb files) +* Container images used by Kubespray. Exhaustive list depends on your setup +* [Optional] Python packages used by Kubespray (only required if your OS doesn't provide all python packages/versions listed in `requirements.txt`) +* [Optional] Helm chart files (only required if `helm_enabled=true`) + +Then you need to setup the following services on your offline environment: * a HTTP reverse proxy/cache/mirror to serve some static files (zips and binaries) * an internal Yum/Deb repository for OS packages -* an internal container image registry that need to be populated with all container images used by Kubespray. Exhaustive list depends on your setup -* [Optional] an internal PyPi server for kubespray python packages (only required if your OS doesn't provide all python packages/versions listed in `requirements.txt`) -* [Optional] an internal Helm registry (only required if `helm_enabled=true`) +* an internal container image registry that need to be populated with all container images used by Kubespray +* [Optional] an internal PyPi server for python packages used by Kubespray +* [Optional] an internal Helm registry for Helm chart files + +You can get artifact lists with [generate_list.sh](contrib/offline/generate_list.sh) script. +In addition, you can find some tools for offline deployment under [contrib/offline](contrib/offline/README.md). ## Configure Inventory -- GitLab