Skip to main content

Heist

Heist creates network tunnels for distributing and managing agents. While it has been originally built to deploy and manage Salt Minions, it can be used to distribute and manage other agents or plugins if extended to do so.

Using Heist is very easy, Start by downloading Heist. Just install via pip:

pip install heist

Heist Manager

In order to run Heist you will need to specify a Heist manager. By default the grains heist manager is available when installing heist. Another example of a heist manager is salt.minion but this will require a user to install the heist-salt project:

pip install heist-salt

Making Your Roster

A Roster is a file used by Heist to map login information to the systems in your environment. This file can be very simple and just needs to tell Heist where your systems are and how to log into them via ssh. Open a file called roster.cfg and add the data needed to connect to a remote system via ssh:

system_name:
  host: 192.168.4.4
  username: fred
  password: freds_password

The roster files typically all live inside of a roster directory. But to get started we will execute a single roster file with heist using the grains Heist manager:

heist grains -R roster.cfg

Assuming your roster is correct, heist will now connect to the remote system, deploy a the grains binary and return the grains data.

Tear Down

Heist is able to automatically clean up as well! Just soft kill your heist application and it will reach out to all connections, tell them to remove the deployed artifacts from the target systems and stop the service! Like a proper heist these should be no evidence left behind!

Using Heist to Deploy Salt Minions

If you want to use Heist to deploy and manage Salt, you will need to install heist-salt`.

Metadata

Release files for heist 4.0.0

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

Source distribution (sdist)

Source distribution for heist 4.0.0
File Size Uploaded
heist-4.0.0.tar.gz 14.0 kB Details

Built distribution (wheel)

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

Total release size: 37.0 kB

Release files / heist-4.0.0.tar.gz

Download URL heist-4.0.0.tar.gz
Size 14.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f7594bfe6a004069caae3b8b2f9db6cf2de9c8ede58bcb04c1c06fa87570fd37
BLAKE2b-256 checksum
How to use checksums
7320e0750f441c8c2040eefa70a52ffdf51c5cae14a590f1813046b11e8d2a34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8

Release files / heist-4.0.0-py3-none-any.whl

Download URL heist-4.0.0-py3-none-any.whl
Size 23.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
671c2e3a8cab2882bf5b7ba126b59c34a11fc21c22fde1c79200c72230377969
BLAKE2b-256 checksum
How to use checksums
a51b19d00d62bbc49ff3bf3722ad73abbe8f8b1953f916ec7bad3bd805832e78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8

Release history Release notifications | RSS feed

7.0.2

2 release files

7.0.1

2 release files

6.3.3

2 release files

6.3.1

2 release files

6.3.0

2 release files

6.2.0

2 release files

6.1.0

2 release files

6.0.1

2 release files

6.0.0

2 release files

5.0.0

2 release files

This release

4.0.0 This release

2 release files

3.0

2 release files

2.4

2 release files

2.3

2 release files

2.2.0

2 release files

2.0.0

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