Document the Docker registry mirror setting

Signed-off-by: Todd Malsbary <todd.malsbary@intel.com>
Change-Id: I585063c18d88085465bcbe647adfa6e3fa8ce1c6

diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md
index 60c131e..6dc0011 100644 (file)
--- a/doc/troubleshooting.md
+++ b/doc/troubleshooting.md
@@ -82,6 +82,22 @@ The general procedure (shown on the jump server) is:
       | uuid                  | 93366f0a-aa12-4815-b524-b95839bfa05d |
       +-----------------------+--------------------------------------+
 
+## Pod deployment fails due to Docker rate limits
+
+If a Pod fails to start and the Pod status (`kubectl describe pod
+...`) shows that the Docker pull rate limit has been reached, it is
+possible to point ICN to a [Docker registry
+mirror](https://docs.docker.com/registry/recipes/mirror/).
+
+To enable the mirror on the jump server set `DOCKER_REGISTRY_MIRROR`
+in `user_config.sh` before installing the jump server or following the
+Docker's
+[instructions](https://docs.docker.com/registry/recipes/mirror/#configure-the-docker-daemon)
+to configure the daemon.
+
+To enable the mirror in the provisioned cluster, set the
+`dockerRegistryMirrors` value of the cluster chart.
+
 ## Helm release stuck in 'pending-install'
 
 If the HelmRelease status for a chart in the workload cluster shows

diff --git a/user_config.sh b/user_config.sh
index c172caf..50c654e 100644 (file)
--- a/user_config.sh
+++ b/user_config.sh
@@ -2,3 +2,6 @@
 
 #Ironic Metal3 settings for provisioning network
 export IRONIC_INTERFACE="enp4s0f3"
+
+#Use a registry mirror for downloading container images
+export DOCKER_REGISTRY_MIRRORS=""