Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

state.apply test documentation unclear #50919

Closed
dpkirchner opened this issue Dec 19, 2018 · 2 comments

Comments

Projects
None yet
3 participants
@dpkirchner
Copy link

commented Dec 19, 2018

I'm looking into how to use state.apply, however I found the documentation unclear:

https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.state.html

The documentation describes how to apply all states and how to apply a single state, however the examples for both have the same command and suggest they do different things: salt '*' salt.apply test. In the former case, the docs say it will do a dry-run. In the latter, the docs say it will apply the state test.

@dwoz dwoz added the Question label Dec 20, 2018

@dwoz dwoz added this to the Approved milestone Dec 20, 2018

@dwoz

This comment has been minimized.

Copy link
Contributor

commented Dec 20, 2018

@dpkirchner I can see why the docs are a bit confusing. Hopefully I can explain it a bit further here.

To apply all states run state.apply without any arguments:

salt '*' state.apply

To run the states found in test.sls run state.apply with a single argument test:

salt '*' state.apply test

If you want to apply the states in test.sls as a dry-run, you'll use the keyword argument test set to true:

salt '*' state.apply test test=true

@terminalmage

This comment has been minimized.

Copy link
Contributor

commented Dec 20, 2018

Docs updated in #50940. Thanks for reporting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.