salt-cumin

Compatibility

Salt Version Linux Windows macOS
master 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9
v3002.7 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9
v3003.3 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9
v3004 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9 3.5 3.6 3.7 3.8 3.9

Description

Cumin

Cumin contains a Python library and CLI scripts for accessing a remote salt-api instance.

cumin abstracts the HTTP calls to salt-api so existing Python projects can easily integrate with a remote Salt installation just by instantiating a class.

The cumin CLI script allows users to execute Salt commands from computers that are external to computers running the salt-master or salt-minion daemons as though they were running Salt locally. The long-term goal is to add additional CLI scripts maintain the same interface as Salt’s own CLI scripts (salt, salt-run, salt-key, etc).

Installation

pip install salt-cumin

Usage

export SALTAPI_USER=saltdev SALTAPI_PASS=saltdev SALTAPI_EAUTH=pam
cumin '*' test.ping
cumin '*' test.kwarg hello=dolly

Examples leveraging the runner client.

cumin-run reactor.list
cumin-run reactor.add event='test/provision/*' reactors='/srv/salt/state/reactor/test-provision.sls'

Configuration

You can configure cumin through the command line, using environment variables or in a configuration file $HOME/.pepperrc with the following syntax :

[main]
SALTAPI_URL=https://localhost:8000/
SALTAPI_USER=saltdev
SALTAPI_PASS=saltdev
SALTAPI_EAUTH=pam