Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

https://img.shields.io/pypi/v/salt-pepper.svg https://travis-ci.com/saltstack/pepper.svg?branch=develop https://img.shields.io/pypi/pyversions/salt-pepper.svg https://img.shields.io/badge/license-Apache2-blue.svg?maxAge=3600 https://codecov.io/gh/saltstack/pepper/branch/develop/graph/badge.svg

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

pepperlib 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 pepper 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).

It does not require any additional dependencies and runs on Python 2.5+ and Python 3. (Python 3 support is new, please file an issue if you encounter trouble.)

Installation

pip install salt-pepper

Usage

Basic usage is in heavy flux. You can run pepper using the script in %PYTHONHOME%/scripts/pepper (a pepper.cmd wrapper is provided for convenience to Windows users).

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

Examples leveraging the runner client.

pepper --client runner reactor.list
pepper --client runner reactor.add event='test/provision/*' reactors='/srv/salt/state/reactor/test-provision.sls'

Configuration

You can configure pepper 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

Contributing

Please feel free to get involved by sending pull requests or join us on the Salt mailing list or on IRC in #salt or #salt-devel.

This repo follows the same contributing guidelines as Salt and uses separate develop and master branches for in-progress additions and bug-fix changes respectively.

Metadata

Release files for upepper 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for upepper 0.1.7
File Size Uploaded
upepper-0.1.7.tar.gz 26.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for upepper 0.1.7
File Interpreter ABI Platform
upepper-0.1.7-py3-none-any.whl Python 3 none any Details

Total release size: 42.5 kB

Release files / upepper-0.1.7.tar.gz

Download URL upepper-0.1.7.tar.gz
Size 26.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3953e83a47a44a72411a5964f5bbfff209ba64fc3b346c82372026275985aced
BLAKE2b-256 checksum
How to use checksums
2173642a0eaa45aaa03bcda4cf4d609e9ba261b16e6fd7fbc44288cf1a33c0a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / upepper-0.1.7-py3-none-any.whl

Download URL upepper-0.1.7-py3-none-any.whl
Size 16.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
de6c8d10266fb346fab0c09d7fd2b1722eb5eaf489de900884c59295bff63e6a
BLAKE2b-256 checksum
How to use checksums
c5686c0d9d834deb46f073a2ece12ae521e47d3ab2fd512aff21c983297ef22f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page