Skip to content

Commit a439905

Browse files
committed
docs/Updates: improve clarity
1 parent 0dd11be commit a439905

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

docs/Updates/index.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Updating the project
22

3-
There are two different sources: the IOTstack project (github.com) and
4-
the Docker Hub (hub.docker.com). Both the initial stack creation and updates
5-
come from these. To illustrate the steps and artifacts of the *update* process:
3+
There are two different update sources: the IOTstack project (github.com) and
4+
Docker image registries (e.g. hub.docker.com). Both the initial stack creation
5+
and updates use both of these. Initial creation is a bit simpler, as the
6+
intermediate steps are done automatically. For a full update they need to be
7+
performed explicitly. To illustrate the steps and artifacts of the *update*
8+
process:
69

710
``` mermaid
811
flowchart TD
@@ -21,7 +24,7 @@ flowchart TD
2124
PULL --> CACHE[local Docker image cache]
2225
CACHE --- UP
2326
24-
UP --> CONTAINER[running Docker containers based on the latest cached images]
27+
UP --> CONTAINER[recreated Docker containers based on the latest cached images]
2528
2629
classDef command fill:#9996,stroke-width:0px
2730
class GITPULL,MENU,UP,PULL command
@@ -57,11 +60,12 @@ fetch the latest images, but it's not unheard of that the latest image may
5760
break [something](
5861
https://github.com/node-red/node-red/issues/3461#issuecomment-1076348639).
5962

60-
Thus to *guarantee* a successful rollback, you have to shutdown your RPi and
61-
save a complete disk image backup of its storage using another machine.
63+
Thus to *guarantee* a successful rollback to the pre-update state, you have to
64+
shutdown your RPi and save a complete disk image backup of its storage using
65+
another machine.
6266

63-
For a hobby project, not having perfect rollback may be a risk you're willing
64-
to take. Usually container image problems have fixes/workarounds within a day.
67+
For a hobby project, not having a perfect rollback may be a risk you're willing
68+
to take. Usually image problems will have fixes/workarounds within a day.
6569

6670
## Update Raspberry Pi OS
6771

@@ -77,10 +81,12 @@ $ sudo apt upgrade -y
7781
## Recommended: Update only Docker images
7882

7983
When you built the stack using the menu, it created the Docker Compose file
80-
`docker-compose.yml`. This file or its linked `Dockerfile`s, use image name and
81-
tag references (a missing tag defaults to `:latest`) to get the images from
82-
hub.docker.com. Likewise, when Docker is told to pull updated images, it will
83-
download the newest image for the tags into its local cache.
84+
`docker-compose.yml`. This file and any used build instructions
85+
(`Dockerfile`s), use image name and tag references to images on hub.docker.com
86+
or other registries. An undefined tag defaults to `:latest`. When Docker is
87+
told to pull updated images, it will download the images into the local
88+
cache, based upon what is currently stored at the registry for the used names
89+
and tags.
8490

8591
Updating the IOTstack project templates and recreating your
8692
`docker-compose.yml` isn't usually necessary. Doing so isn't likely to provide
@@ -176,7 +182,7 @@ Full update steps:
176182
* Go to the [IOTstack Discord](https://discord.gg/ZpKHnks) and describe your
177183
problem. We're happy to help.
178184

179-
## Details, partly outdated
185+
## Old-menu
180186

181187
!!! warning
182188
If you ran `git checkout -- 'git ls-files -m'` as suggested in the old wiki entry then please check your duck.sh because it removed your domain and token

0 commit comments

Comments
 (0)