Skip to main content

A CLI front-end to a running salt-api system

Project description

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

salt-pepper-0.7.5.tar.gz (21.7 kB view details)

Uploaded Source

Built Distributions

salt_pepper-0.7.5-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

salt_pepper-0.7.5-py2-none-any.whl (14.9 kB view details)

Uploaded Python 2

File details

Details for the file salt-pepper-0.7.5.tar.gz.

File metadata

  • Download URL: salt-pepper-0.7.5.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for salt-pepper-0.7.5.tar.gz
Algorithm Hash digest
SHA256 9ca4daebbe15c4da0ca286d74f7361444cfd30fc6abc92afdc12cdc65bf406f2
MD5 2c21cc720a9abdfde65c3a17e70b10ef
BLAKE2b-256 1b3f9213b4bab514aadc48f0a89d5bc218d9e042366c16eb75b0c0c3d7fdb134

See more details on using hashes here.

File details

Details for the file salt_pepper-0.7.5-py3-none-any.whl.

File metadata

File hashes

Hashes for salt_pepper-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 989156bfe24b23b7698c100371584ff9ac4d54233cb0f096ad47b3dac755dd7b
MD5 2880f8f9b8a97f4c06dec3f2646df664
BLAKE2b-256 b1658f57f2832fc8e16d9e4f6ccc50597893fb9c4844cd0b9d29f30c8f17eabe

See more details on using hashes here.

File details

Details for the file salt_pepper-0.7.5-py2-none-any.whl.

File metadata

File hashes

Hashes for salt_pepper-0.7.5-py2-none-any.whl
Algorithm Hash digest
SHA256 a6e9bd903e7bb6897d9ff949e28c2e7d56ed60d38bf5896c4694e5e93a389d16
MD5 c49e7d77ee3505bf02fb9e19b91ce164
BLAKE2b-256 e127df7411c22b6c5998a89861e9ba6652e78b7bd5f0d1e3cdaa57cd6522be3c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page