add note about when to use deployment rollout

rstudio · Feb 18, 2022 · 3732d18 · 3732d18
1 parent 6d8b810
commit 3732d18
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/other-charts/prepull-daemonset/README.md b/other-charts/prepull-daemonset/README.md
@@ -27,9 +27,11 @@ images:
     image: ubuntu:bionic
 ```
 
-## Upgrade
+## Pull Again
+
+To run the pre-pull again (i.e. to pull new images with the same tag, to ensure node
+caches are fresh*), there are a few options:
 
-To run the pre-pull again, there are a few options:
 ```
 # by default, every upgrade is randomized / does a rollout (`--set randomize=false` to disable this behavior)
 helm upgrade install preepull-daemonset rstudio/prepull-daemonset
@@ -38,6 +40,10 @@ helm upgrade install preepull-daemonset rstudio/prepull-daemonset
 kubectl rollout restart daemonset/prepull-daemonset
 ```
 
+> * Kubernetes Nodes (the `kubelet` service) periodically remove images from
+> the cache to free up disk space, especially if an image is not in use and has
+> not been used lately
+
 ## Values
 
 | Key | Type | Default | Description |

diff --git a/other-charts/prepull-daemonset/README.md.gotmpl b/other-charts/prepull-daemonset/README.md.gotmpl
@@ -20,9 +20,11 @@ images:
     image: ubuntu:bionic
 ```
 
-## Upgrade
+## Pull Again
+
+To run the pre-pull again (i.e. to pull new images with the same tag, to ensure node
+caches are fresh*), there are a few options:
 
-To run the pre-pull again, there are a few options:
 ```
 # by default, every upgrade is randomized / does a rollout (`--set randomize=false` to disable this behavior)
 helm upgrade install preepull-daemonset rstudio/prepull-daemonset
@@ -31,6 +33,10 @@ helm upgrade install preepull-daemonset rstudio/prepull-daemonset
 kubectl rollout restart daemonset/prepull-daemonset
 ```
 
+> * Kubernetes Nodes (the `kubelet` service) periodically remove images from
+> the cache to free up disk space, especially if an image is not in use and has
+> not been used lately
+
 {{ template "chart.valuesSection" . }}
 
 {{ template "helm-docs.versionFooter" . }}