Package: chaostoolkit-saltstack
Chaos Toolkit Extension for SaltStackThis project is a collection ofactionsandprobes, gathered as an
extension to theChaos Toolkit.GenerallySaltStackruns minion agents in machine level, and minions are under management of one or more SaltMaster machines.
On the SaltMaster or via API, SaltMaster can run bulk commands or scripts or other actions on any connected minion.
The biggest advantage of SaltSatck is adapting cross cloud solutions on VM level chaos experiments.
If you are working on hybrid cloud and have network tunnelled, one SaltMaster could control all VMs across multiple clouds, e.g. Azure, AWS, etc.InstallThis package requires Python 3.5+To be used from your experiment, this package must be installed in the Python
environment wherechaostoolkitalready lives.$ pip install -U chaostoolkit-saltstackUsageTo use the probes and actions from this package, add the following to your
experiment file:{"type":"action","name":"burn_cpu","provider":{"type":"python","module":"chaossaltstack.machines.actions","func":"burn_cpu","secrets":["saltstack"],"arguments":{"parameters":{"execution_duration":"300"}}}}That's it!Please explore the code to see existing probes and actions.ConfigurationCredentials0. Salt Master URL
    * SALTMASTER_HOST

1. Useranme & Password.
   -d username='salt' -d password='abcd1234' -d eauth='pam'
   Then a token in obrained via <salt_url>/login

2. Token
   A token directly, same with the backend of 1.

3. Key, only from Salt Master
    * SALTMASTER_HOST: Salt Master API address

    You can authenticate with user / password via:
    * SALTMASTER_USER: the user name
    * SALTMASTER_PASSWORD: the password

    Or via a token:
    * SALTMASTER_TOKENThere are two ways of doing this:you can either pass the name of the environment variables to the experiment definition as follows (recommended):{"saltstack":{"SALTMASTER_HOST":{"type":"env","key":"SALTMASTER_HOST"},"SALTMASTER_USER":{"type":"env","key":"SALTMASTER_USER"},"SALTMASTER_PASSWORD":{"type":"env","key":"SALTMASTER_PASSWORD"}}}{"saltstack":{"SALTMASTER_HOST":{"type":"env","key":"SALTMASTER_HOST"},"SALTMASTER_TOKEN":{"type":"env","key":"SALTMASTER_TOKEN"}}}or you inject the secrets explicitly to the experiment definition:{"saltstack":{"SALTMASTER_HOST":"https://172.10.20.666","SALTMASTER_USER":"username","SALTMASTER_PASSWORD":"password"}}{"saltstack":{"SALTMASTER_HOST":"https://172.10.20.666","SALTMASTER_TOKEN":"abcd1234abcd1234abcd1234"}}Additionally you may directly use if you are on the SaltMasterPutting it all togetherHere is a full example:{"version":"1.0.0","title":"...","description":"...","tags":["azure","kubernetes","aks","node"],"configuration":{"saltstack":{"environment":"azure"}},"secrets":{"saltstack":{"SALTMASTER_HOST":"https://172.20.1.172:8000","SALTMASTER_USER":"saltuser","SALTMASTER_PASSWORD":"asfasfasdfa"}},"steady-state-hypothesis":{"title":"Services are all available and healthy","probes":[{"type":"probe","name":"check_minions_online","provider":{"type":"python","module":"chaossaltstack.machine.probes","func":"is_minion_online","arguments":{"instance_ids":["PABCDEFGS0016","PABCDEFGS0666"]},"secrets":["saltstack"]}}]},"method":[{"type":"action","name":"stress_cpu","provider":{"type":"python","module":"chaossaltstack.machine.probes","module":"saltstack.machine.actions","func":"stress_cpu","arguments":{"execution_duration":"300","instance_ids":["PABCDEFGS0016","PABCDEFGS0666"]},"secrets":["saltstack"]}}],"rollbacks":[]}ContributeIf you wish to contribute more functions to this package, you are more than
welcome to do so. Please, fork this project, make your changes following the
usualPEP 8code style, sprinkling with tests and submit a PR for
review.The Chaos Toolkit projects require all contributors must sign aDeveloper Certificate of Originon each commit they would like to merge
into the master branch of the repository. Please, make sure you can abide by
the rules of the DCO before submitting a PR.DevelopIf you wish to develop on this project, make sure to install the development
dependencies. But first,create a virtual environmentand then install
those dependencies.$pipinstall-rrequirements-dev.txt-rrequirements.txtThen, point your environment to this directory:$pipinstall-e.Now, you can edit the files and they will be automatically be seen by your
environment, even when running from thechaoscommand locally.TestTo run the tests for the project execute the following:$ pytest