saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Adjust dockerng docstrings

Browse source 
This adds a similar documentation section to the top of the state module
to match the one in the execution module. It also updates the expected
release date of the Carbon release to reflect the new release cadence.
This commit is contained in:
Erik Johnson 2015-09-23 09:17:32 -05:00
parent a789303d75
commit ed5ae75180
2 changed files with 24 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
salt/modules/dockerng.py
View file

@ -5,8 +5,8 @@ Management of Docker Containers
.. versionadded:: 2015.8.0
Why Make a Second Docker Module?
--------------------------------
Why Make a Second Docker Execution Module?
------------------------------------------
We have received a lot of feedback on our Docker support. In the process of
implementing recommended improvements, it became obvious that major changes
@ -19,7 +19,7 @@ option. This will give users a couple release cycles to modify their scripts,
SLS files, etc. to use the new functionality, rather than forcing users to
change everything immediately.
In the **Carbon** release of Salt (due early 2016), this execution module will
In the **Carbon** release of Salt (due in 2016), this execution module will
take the place of the default Docker execution module, and backwards-compatible
naming will be maintained for a couple releases after that to allow users time
to replace references to ``dockerng`` with ``docker``.

21
salt/states/dockerng.py
View file

@ -8,6 +8,27 @@ Management of Docker containers
This is the state module to accompany the :mod:`dockerng
<salt.modules.dockerng>` execution module.
Why Make a Second Docker State Module?
--------------------------------------
We have received a lot of feedback on our Docker support. In the process of
implementing recommended improvements, it became obvious that major changes
needed to be made to the functions and return data. In the end, a complete
rewrite was done.
The changes being too significant, it was decided that making a separate
execution module and state module (called ``dockerng``) would be the best
option. This will give users a couple release cycles to modify their scripts,
SLS files, etc. to use the new functionality, rather than forcing users to
change everything immediately.
In the **Carbon** release of Salt (due in 2016), this execution module will
take the place of the default Docker execution module, and backwards-compatible
naming will be maintained for a couple releases after that to allow users time
to replace references to ``dockerng`` with ``docker``.
.. note::
To pull from a Docker registry, authentication must be configured. See