salt
salt copied to clipboard
saltstack
[DOCS] Wrong link for saltext-docker
Description The changelog for 3007.0rc1 (2024-01-02) mentions that all Docker modules have been deprecated in favor of the Docker Salt Extension, but the specified link https://github.com/saltstack/saltext-docker is invalid (the destination does not exist).
Suggested Fix The link should point to the actual location of the Docker Salt Extension (which I unfortunately could not find via a Google search either).
Type of documentation
CHANGELOG.md in the Salt repo.
Location or format of documentation https://github.com/saltstack/salt/blob/v3007.0rc1/CHANGELOG.md
Additional context This issue might be related to the changes introduced with #64894.
Same for the link at the top of https://docs.saltproject.io/en/latest/ref/states/all/salt.states.docker_network.html
The change was introduced #64890, but there is no mention of the failing link there.
I suspect the repo is currently set to private, which is really unfortunate. We are currenty evaluating SaltStack for our application, but without Docker support, we cannot use it. I would love for some maintainer to confirm that Docker support is going to be available after 3007 (with the extension of course).
deprecation does not mean removed. it is just a warning at this point and will be removed in 3009.
docker will be a core extension module in the future.
I can confirm docker still works in 3007. the link is for an upcoming extension module. not one that currently exists.
I guess it is a at least a bit irritating to add a deprecation warning before the alternative is available.
In most pieces of software, a deprecation warning means: “Don’t use this in new code / projects. Use … instead.” But with no alternative being available yet, there is only the choice between using the deprecated module or not configuring Docker via Salt at all. IMO, such a deprecation warning is quite useless.
So, it is debatable whether there should be a deprecation warning at current point in time at all, but if there is supposed to be one, it should rather read: “This module will be removed from Salt in version 3009. An alternative in form of an extension module is going to be provided before the removal.”
I am in the same boat. I am looking at Salt and now I do not know if I should spend time using Docker with Salt and then how much I will have to rewrite when support moves to saltext-docker? Is this code just moving there, or will saltext-docker be a rewrite and require changes to my states?
the docker saltext will be just moving the existing code into it's own repo. it will be the same code.
So you are just changing monorepo project structure to multiple repositories? If docker extension will still stay "core". Maybe then this is not deprecation?
it is a deprecation in that it will require an install of saltext-docker in 3009 and beyond. not shipped with the core system.
it will be a core saltext not a core module after 3009. meaning that the core team will still be handling the code. and that it will start out from the code that already exists.
but with time it will also mean faster development of the saltext as well as the core system as we move things around and yes turn into a multiple repo system.
Thank you for explanation. This all sounds good and reasonable, but could be communicated much better. For example, code could be first moved out of the core into saltext-docker with core having a dependency on saltext-docker. Then after some time that dependency link could get deprecated. And then removed after few versions. Then it would be clear what is being deprecated: the dependency link, not the code/module itself.
Just wanted to pipe in that I for one appreciate the deprecation warning. If you've been with the project for a while you know 3009 is a while away so just seeing that in the "future release" made me smile and immediately ignore it.
"I'm not even mad, I'm impressed"
Love the foresight and the inclination to warn us asap!
Hope the API is similar :crossed_fingers:
