Docker compose revamp #2439
Docker compose revamp #2439
Conversation
Port forwarding expects the evaluator to both install mender-cli and figure out a device ID. Those are extra steps that risk confusion and preventing the reader to reach a working example for the docker compose update. I've instead just replaced that with the Remote terminal for all client shell interactions. The versioning was hardcoded and the confusions between composition version vs container version were left to the user to wrestle with. Added a section to clarify this and adjusted the snippets. For this case the benefits aren't spectacular, but that is heavy content specific. I wanted to show there is indeed an improvement and give a quick snippet for the evaluator to test it. If they have the question "Is delta beneficial for this composition I want to use?" they can easily use the same approach. Ticket: None Changelog: None Signed-off-by: Alan <[email protected]>
supported one Ticket: None Changelog: None Signed-off-by: Alan <[email protected]>
There was a problem hiding this comment.
Thanks for updating this, it's overdue. :)
Have you seen that we already have a tutorial here: https://docs.mender.io/artifact-creation/create-an-artifact/docker-compose?
I think that one is mis-placed, and we should remove it after you add yours to Get started.
There is also another one on Kubernetes I think we should remove: https://docs.mender.io/artifact-creation/create-an-artifact/kubernetes. Perhaps you can just add a note that it's possible to use Kubernetes too at the end of your tutorial instead?
| # 28M traefik-composition-v2.10.mender | ||
| ``` | ||
|
|
||
| So in this case we're seeing a ~28% decrease in size. |
There was a problem hiding this comment.
size, though the size savings of deltas vary depending on the changes between Artifact as well as parameters used and can go up to 90% in some cases.
There was a problem hiding this comment.
Will expand the text but want do go with:
So in this case we are seeing a ~28% decrease in size, though the size savings of deltas vary depending on the changes between Artifacts and can go up to 90% in some cases.
Not clear what parameters are you referring to.
If it's the delta parameters I don't know a way to customize these for this update type.
| --software-version="$VERSION" | ||
| ``` | ||
|
|
||
| !!! For Raspberry pi 3 use `DEVICE_TYPE="raspberrypi3"` |
There was a problem hiding this comment.
It's possible to supply --device-type twice to avoid this issue, it seems: https://github.com/mendersoftware/app-update-module/blob/master/gen/app-gen#L33. Mender Artifacts support a list of device types compatible.
So if --device-type raspberrypi3 --device-type raspberrypi4 is supplied this should work in both cases.
In this tutorial we can remove the DEVICE_TYPE and PLATFORM variables and have them inline in the command because we are explicitly targetting Raspberry Pi only here (otherwise supplying device-type multiple times may become difficult?).
There was a problem hiding this comment.
Good call.
If QEMU ever becomes Debian based we can revisit.
Will change and retest.
|
Sorry to expand the scope here so much, but we should also consider the Mender Hub Update Module section: In particular there is a "competing" Kubernetes implementation that we made: https://hub.mender.io/t/kubernetes/1939 The problem is that it will confuse customers if we provide multiple Update Modules for the same update type. |
|
@kjaskiewiczz FYI, ref the QA discussion. My opinion is that we need to move the app-update module to https://github.com/mendersoftware/mender-update-modules, add a Mender Hub Update Module tutorial (maybe one for Docker-Compose and another for Kubernetes). I don't understand why the app-update module was done separate? Was this a more "strategic" decision to split out the update modules we support or was it just done oneoff? |
|
Thanks for the info.
I don't know, but maybe @merlin-northern knows something about it? |
who me? let's face it my knowledge is a bit on a low level.
I can dig further. if you want to move it to the other repo we can discuss. |
|
Thanks for the review, will go through it.
I've used that one as the base and describe the high level changes in the commit messages. |
|
The app-update-module |
CE-429
Currently blocked by: https://northerntech.atlassian.net/browse/MEN-7477
After that the links need to be updated
master->1.0.1