Skip to content

Commit 5bb028c

Browse files
committed
Update documentation
This is mostly about clarifying which is the recommended Docker image, until automatic publishing to Docker Hub will be implemented.
1 parent 03c9d55 commit 5bb028c

File tree

4 files changed

+27
-10
lines changed

4 files changed

+27
-10
lines changed

DOCKER.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ run it interactively, perhaps to help diagnose a problem.
99

1010
Docker images are automatically published to:
1111

12-
- https://hub.docker.com/r/jpmens/mqttwarn
1312
- https://github.com/orgs/jpmens/packages/container/package/mqttwarn-standard
1413
- https://github.com/orgs/jpmens/packages/container/package/mqttwarn-full
14+
- ~~https://hub.docker.com/r/jpmens/mqttwarn~~ (not automatically updated)
1515

1616
## Choosing the Docker image
1717

1818
Choose one of those Docker images.
1919
```shell
20-
# The standard image on Docker Hub.
21-
export IMAGE=jpmens/mqttwarn
22-
2320
# The standard image on GHCR.
2421
export IMAGE=ghcr.io/jpmens/mqttwarn-standard:latest
2522

2623
# The full image on GHCR.
2724
export IMAGE=ghcr.io/jpmens/mqttwarn-full:latest
25+
26+
# The standard image on Docker Hub.
27+
export IMAGE=jpmens/mqttwarn
2828
```
2929

3030
## Interactively
@@ -157,7 +157,7 @@ images.
157157

158158
In order to use `mqttwarn` with additional Python modules not included in the
159159
baseline image, you will need to build custom Docker images based on the
160-
canonical `jpmens/mqttwarn`.
160+
canonical `ghcr.io/jpmens/mqttwarn-standard:latest`.
161161

162162
We prepared an example which outlines how this would work with the Slack SDK.
163163
By using the `Dockerfile.mqttwarn-slack`, this command will build a Docker
@@ -166,3 +166,11 @@ image called `mqttwarn-slack`, which includes the Slack SDK:
166166
```shell
167167
docker build --tag=mqttwarn-slack --file=Dockerfile.mqttwarn-slack .
168168
```
169+
170+
## The "full" image, including all dependencies
171+
172+
If you prefer not to fiddle with those details, but instead want to run a full
173+
image including dependencies for all modules, we have you covered. Alongside
174+
the standard image, there is also `ghcr.io/jpmens/mqttwarn-full:latest`.
175+
176+
The `standard` image weighs in with about 130 MB, the `full` image has 230 MB.

README.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,13 @@ Container image
111111
***************
112112

113113
For running ``mqttwarn`` on a container infrastructure like Docker or
114-
Kubernetes, there are images on Docker Hub called ``jpmens/mqttwarn``.
115-
To read more about this topic, please follow up on the `Docker handbook`_.
114+
Kubernetes, corresponding images are automatically published to the
115+
GitHub Container Registry (GHCR).
116+
117+
- ``ghcr.io/earthobservations/wetterdienst-standard:latest``
118+
- ``ghcr.io/earthobservations/wetterdienst-full:latest``
119+
120+
To learn more about this topic, please follow up reading the `Docker handbook`_.
116121

117122

118123
*************

doc/sandbox.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Invoke software tests::
1717

1818
make test
1919

20+
Invoke software tests, with coverage::
21+
22+
make test-coverage
23+
2024
Install extras::
2125

2226
source .venv/bin/activate
@@ -31,7 +35,7 @@ You can also add multiple extras, all at once::
3135
Using VSCode
3236
************
3337

34-
To install the free, non-telemetry version of Microsoft VSCode::
38+
For installing the free, non-telemetry version of Microsoft VSCode, invoke::
3539

3640
brew install --cask vscodium
3741

docker-compose.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
# 4. Define the location to the custom functions file within "mqttwarn.ini":
1313
#
1414
# functions = 'funcs.py'
15-
version: '3.7'
15+
version: '3'
1616

1717
services:
1818
mqttwarn:
19-
image: jpmens/mqttwarn
19+
image: ghcr.io/jpmens/mqttwarn-full:latest
2020
container_name: mqttwarn
2121
restart: always
2222
volumes:

0 commit comments

Comments
 (0)