Commit graph

848 commits

Author SHA1 Message Date
James Howe
49411d1c24 Update doc/ref/states/requisites.rst
Co-authored-by: Pedro Algarvio <pedro@algarvio.me>
(cherry picked from commit fc58fa4d9d)
2023-09-25 01:51:20 +01:00
James Howe
a2c70b7239 Fix heading level of "creates"
(cherry picked from commit d38a372687)
2023-09-25 01:51:20 +01:00
Thomas Phipps
77d795c469 forgo the bold 2023-08-29 19:58:38 +00:00
Thomas Phipps
0b0b434cca fixes from @barbaricyawps 2023-08-29 19:58:38 +00:00
Thomas Phipps
b11fe4840a add doc about backup_mode options. 2023-08-29 19:58:38 +00:00
Gareth J. Greenaway
13aed44e86 requested fixes. 2023-04-11 18:24:26 +00:00
Gareth J. Greenaway
35fb908059 updating requisite documentation to include cmd_opts_exclude. 2023-04-11 18:24:26 +00:00
Pedro Algarvio
6c819439b5 Add a few more nice to have hooks
Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>
2023-02-07 07:10:13 +00:00
Barney Sowood
e512c9767a Adds documentation on fire_events to master events
Adds documentation on the fire_events state option to the
Salt Master Events doc for completeness.
2023-02-02 16:06:44 +00:00
jeanluc
49a77dbba7 Add x509_v2 modules 2022-12-22 08:00:41 -07:00
Sebastian Marsching
02a1ee476e Extend OpenVSwitch modules (closes #58986).
This adds the new openvswitch_db state module. It also  adds the new
functions bridge_to_parent, bridge_to_vlan, db_get, and db_set to the
openvswitch execution module.

Besides, it adds two new optional parameters parent and vlan to the
openvswitch_bridge.present state module function and the
openvswitch.bridge_create execution module function.
2022-12-09 19:43:03 +01:00
Erik Johnson
765a5f0808 Add umask as a global state argument
This removes the umask argument from cmd states and makes it a global
state argument.
2022-11-01 14:18:38 -06:00
James Howe
327664a375 Title underline too short 2022-10-31 13:19:25 -06:00
James Howe
ed9188f6c2 Update requisite matching
Properly document how identifier matching works.
Reorder sections to a more logical progression.
Remove duplicate section.
Remove section on high data implementation details that doesn't make anything clearer.
2022-10-31 13:19:25 -06:00
piterpunk
d1932fa3c5
Added sysfs state module to manage kernel objects 2022-10-21 13:24:12 -06:00
Shane Lee
4c3638bd14
Merge branch 'master' into doc-fixes 2022-10-20 10:44:53 -07:00
Twangboy
6050c91ff1
Add to toctree to fix docs build... hopefully 2022-10-17 17:32:35 -06:00
Twangboy
58a60ec17d
Remove 'undoc-members' 2022-10-17 17:14:00 -06:00
Twangboy
b9bfa808a5
Fix some pre-commit 2022-10-17 17:09:34 -06:00
Twangboy
898cc3130e Fix some linting errors 2022-06-02 07:21:27 -06:00
Jamie Murphy
d549038625 doc update 2022-05-20 15:21:03 -04:00
Jamie Murphy
7f81bca162 doc update 2022-05-20 15:21:03 -04:00
James Howe
38341cb2fe Minor doc correction 2022-05-10 14:57:59 -04:00
Megan Wilhite
b16ad8ea87 Remove enable_slsvars_fixes feature flag and enable behavior by default 2022-04-07 13:59:47 -04:00
Gareth J. Greenaway
fb825aa760
[merge jam] Master port 49261 - consul modules (#58101)
* add consul states and acl function present/absent

* add consul to states doc index

* refact/fix consul states

* fix doc, fix states

* fix name parameter for acl_changes

* fixing pylint errors

* small changes after review by @rallytime

* fix header count

* Update consul.py

* fix acl_exists description, fix when both id and name are missing

* Adding some tests for consul module and consul state module.  Some additional fixes in the consul module.

* Fixing tests.

* Fixing failing tests on Windows.

* Adding changelog.

* Adding some tests for consul module and consul state module.  Some additional fixes in the consul module.

* moving tests to pytest.

* manual black changes.

* One more manual black change.

* fixing formatting.  Adding versionadded for state module.

Co-authored-by: Rémi Jouannet <remi.jouannet@outscale.com>
Co-authored-by: Mike Place <mp@saltstack.com>
Co-authored-by: Daniel Wozniak <dwozniak@saltstack.com>
Co-authored-by: Wayne Werner <wwerner@vmware.com>
2022-01-20 16:19:58 -05:00
Bryce Larson
20406eabd8 fix https://github.com/saltstack/salt/issues/60969 2021-12-14 15:14:21 -05:00
Adam Mendlik
641301cc55 Fix documentation for the listen requisite 2021-10-12 15:20:50 -04:00
Elias Probst
18b60ccf85 doc/requisites: document lack of SLS support for onchanges/watch
Add note to `onchanges` and `watch` requisite docs to state, that
addressing an included SLS as requisite to be monitored by `onchanges`
or `watch` is not supported.
2021-09-22 10:23:13 -04:00
Elias Probst
9b8b822d75
doc/requisites: fix verbatim syntax 2021-05-31 09:09:11 +00:00
Elias Probst
6182ae83e8
doc/requisites: fix ref syntax 2021-05-31 09:09:11 +00:00
Elias Probst
dd0fbdf4b4
doc/requisites: state non-existence of combined _in/_any form 2021-05-31 09:09:11 +00:00
Michael "M3" Lasevich
be82b03a21 Add missing newline in doc 2021-04-27 07:24:58 -04:00
Megan Wilhite
3c7c922ff5 Remove glance state module in favor of glance_image 2021-03-18 10:42:29 -04:00
ScriptAutomate
e7eecded11 Moving includes file out of nested _incl 2021-02-23 09:13:52 +00:00
Elias Probst
a9fda57b73 doc: remove module suffix from descriptions
Until now, the listings of all kinds of modules looked quite
inconsistent like this:
- salt.states.smtp
- salt.states.snapper module
- salt.states.solrcloud module
- salt.states.splunk

The `module` suffix is redundant anyways, so let's remove it and do some
further cleanup (adjusting overline/underline usage, underline length)
using the following bash script:

```bash

sed -i 's|\s\+module$||g' doc/ref/*/all/*.*.rst

for rst in doc/ref/*/all/*.*.rst;
do
  # enforce consistent overline/underline usage, remove all overlines
  if [[ $(head -n1 "${rst}") =~ ^=+$ ]];
  then
      sed -i -e 1d "${rst}"
  fi

  # adjust the length of the underline to the length of the module name
  module_name=$(head -n1 "${rst}")
  underline=$(for i in $(seq ${#module_name}); do echo -n "="; done)
  sed -i '2s|^=\+$|'"${underline}"'|g' "${rst}"
done
```
2021-02-19 08:54:50 -05:00
Michael "M3" Lasevich
524ae365b6 Fix inconsistent name of the feature flag 2020-10-19 14:51:33 -07:00
Michael "M3" Lasevich
8515ba5faa Typos Identified in #58238 2020-10-19 14:51:33 -07:00
Pedro Algarvio
b427688048 Start checking rst files at pre-commit level with rstcheck
Additionally, fixed most of the errors reported by rstcheck.

Fixes https://github.com/saltstack/salt/issues/58668
2020-10-13 13:53:16 -07:00
mlasevich
c35b43d9f0
Cleanup calculation of template sls/tpl context (#58238)
* Cleanup calculation of template sls/tpl context

Fixes #56410

* fix string formatting

* Add unit test that works against old version (with bugs)

* Updated unit tests with non-buggy values and fix found bugs

* cleanup unit tests to test underlying function

* remove old unit test components no longer used

* Cleanup

* More Cleanup

* More cleanup. Add Mock to test.support.unit

* Add changelog entries

* Fix Mockery

* Import order fix

* Handle backslashes in sls names under *nix

* Cleanup

* Make sure we return a dictionary from jinja.load_map

* Fix scenario when sls is empty but present

* Touched another file - Cleanup to make pre-commit happy

* Adding variables to docs

* Fix expected tplpath value to be OS specific and note so in docs

* removing comments from imports as per pre-commit

* removing comments from imports as per pre-commit

* Put slsvars changes behind a feature flag

* Better documentation for enable_slsvars_fixes feature flag

* Fix test that should be skipped on windows

Co-authored-by: Michael "M3" Lasevich <Michael.Lasevich@bhnetwork.com>
Co-authored-by: Sage the Rage <36676171+sagetherage@users.noreply.github.com>
Co-authored-by: Daniel A. Wozniak <dwozniak@saltstack.com>
Co-authored-by: Shane Lee <slee@saltstack.com>
2020-10-08 07:18:08 -07:00
Tyler Johnson
f909cb5aaa States can have sub state returns 2020-10-07 13:23:32 -07:00
Jeremy Willden
2237cf2c60
Corrected a section title (#58151)
Co-authored-by: Daniel Wozniak <dwozniak@saltstack.com>
2020-10-02 02:49:37 -07:00
krionbsd
fb75bd70b4 Fix typo 2020-09-24 20:33:25 +02:00
Varjitt Jeeva
c6428ecff0 Fix Docs: Salt 3000 onlyif targeting with grains cannot have a space in function query 2020-09-08 17:51:11 -07:00
Christian McHugh
ae206709b5 allow result parsing in unless/onlyif 2020-09-08 13:25:36 -07:00
Tyler Johnson
4684a0b585 added idem exec and state modules 2020-08-12 13:55:34 -07:00
Pedro Algarvio
5e72e192f9 Blacken docs 2020-06-09 03:37:02 -07:00
Bryce Larson
4c374a8ff3 don't overwrite rst files with autodoc 2020-06-06 21:00:50 -07:00
Frode Gundersen
9536d322ac
Change Sodium reference to 3001 (#57419)
* Change Sodium reference to 3001

* Update nacl.py

Change back name to libsodium, got changed to lib3001.

Co-authored-by: Daniel Wozniak <dwozniak@saltstack.com>
2020-05-22 08:26:32 -07:00
Mathieu Parent
79c4fdad32 doc: Fix document linking in requisites.rst 2020-05-20 17:39:25 -07:00
Wesley Whetstone
1231b463f5 Revert "add plist to serializers doc index"
This reverts commit 7512218a81.
2020-05-19 10:16:07 -07:00