Skip to content

Commit 8165b1c

Browse files
committed
Add why salt-sproxy section to the rtd docs
1 parent cc2c45a commit 8165b1c

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/index.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,39 @@ and your (Proxy) Minions at the same time.
1414

1515
This is NOT a SaltStack product.
1616

17+
Why ``salt-sproxy``
18+
-------------------
19+
20+
``salt-sproxy`` can be used as a standalone tool to manage your devices without
21+
having any further requirements, as well as an extension to your existing Salt
22+
environment (if you already have). In other words, if you have a Salt
23+
installation where you manage some network devices and servers, installing
24+
``salt-sproxy`` on your Master will allow you to run any Salt command as always,
25+
e.g., executing ``salt \* test.ping`` and ``salt-sproxy \* test.ping`` will have
26+
the exact same effect, and result. On top of that, using ``salt-sproxy`` allows
27+
you to manage other devices for which you don't run (Proxy) Minions for.
28+
29+
Of course, if you don't already have Salt, no problem, you can start managing
30+
your devices straight away, check out the :ref:`quick-start` steps.
31+
32+
In brief, here are some benefits you can get by using *salt-sproxy*:
33+
34+
- Say goodbye to the burden of managing hundreds of system services for the
35+
Proxy Minion processes.
36+
- You can run it locally, on your own computer.
37+
- Python programming made a breeze - might go well with the
38+
`ISalt <https://github.com/mirceaulinic/isalt>`__ package.
39+
- Integrates easily with your existing Salt environment (if you have), by
40+
installing the package on your Salt Master.
41+
- Can continue to leverage the event-driven automation and orchestration
42+
methodologies.
43+
- REST API, see also :ref:`salt-api` documentation.
44+
- By sending events to a Salt Master, you are able to implement whatever
45+
auditing you need (e.g., what command was executed by who and when, etc.).
46+
- Benefit from inheriting _all_ the native Salt features and integrations
47+
contributed by thousands of users, and tested in hundreds of different
48+
environments, over almost a decade of development.
49+
1750
Install
1851
-------
1952

0 commit comments

Comments
 (0)