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 For Salt

This tutorial will go over how to set up Heist to manage ephemeral Salt Minions. The whole point of Heist is to make deployment and management of Salt easy!

Before you start please be advised that a more detailed quickstart is available in the docs for heist.

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

pip install heist

Setting up a Salt Master

Don’t worry, this is a snap! Once Heist is installed you will need a Salt Master to connect to. If you have an existing Salt Master running you can skip this section, just run heist on your Salt Master.

Download the all-in-one Salt binary for Linux or Mac (Windows coming soon!):

For Linux:

wget https://repo.saltstack.com/salt-bin/linux/salt

For Mac:

wget https://repo.saltstack.com/salt-bin/osx/salt

Now you can just run it!

chmod +x salt
sudo ./salt master

Now you have a running Salt Master to control your minions!

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 will will execute a single roster file with heist:

heist -R roster.cfg

Assuming your roster is correct, heist will now connect to the remote system, deploy a salt minion, and connect it to your running master! Now you can use the same binary that you started the master with to accept your new minion’s keys:

./salt key -A

Then give your minion a few seconds to authenticate and then run your first salt command on the newly set up minion:

./salt \* test.version

Thats it! Now that the minion is up you can run salt commands on it at breakneck speed, the full power of Salt is at your fingertips!!

Metadata

Release files for heist 2.3

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 2.3
File Size Uploaded
heist-2.3.tar.gz 13.4 kB Details

Built distribution (wheel)

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

Total release size: 40.7 kB

Release files / heist-2.3.tar.gz

Download URL heist-2.3.tar.gz
Size 13.4 kB
Tags Source
SHA-256 checksum
How to use checksums
07922ffb5cdc39a6466173bf6fdc053cffbd9d4fe01be03425f4825284eb3fe4
BLAKE2b-256 checksum
How to use checksums
77dffe2f55d833ca76da88b29e2eb7f8a7aa9cf3f1590ae353026f9eab164ae2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.8.0

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

Download URL heist-2.3-py3-none-any.whl
Size 27.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aeb2e9481f4d72f7ecd0e101fcd4314fa750898586c8e23508050ba7891d209d
BLAKE2b-256 checksum
How to use checksums
0bc066ee041856167bc17d1622b3b39870aad9478b3723c521546b86908e9032
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.8.0

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

4.0.0

2 release files

3.0

2 release files

2.4

2 release files

This release

2.3 This release

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