Skip to main content

Ephemeral software tunneling and delivery system

Project description

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:

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 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!!

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

heist-3.0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

heist-3.0-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file heist-3.0.tar.gz.

File metadata

  • Download URL: heist-3.0.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.6

File hashes

Hashes for heist-3.0.tar.gz
Algorithm Hash digest
SHA256 6baf18dc96fb2ca3a5bff71df807b189be1f9afe3121e399a96f893e1150c171
MD5 d1c033c9ab058f26eed3b4a9ecf8dbf3
BLAKE2b-256 16f96971c0481444ee9ab8ce30b1752e91d2037aeba3f508c511900a579ddd04

See more details on using hashes here.

File details

Details for the file heist-3.0-py3-none-any.whl.

File metadata

  • Download URL: heist-3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.6

File hashes

Hashes for heist-3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 684e188307d652ee95968e6f546cbf50df1515da04b1dd0948b63b49558d8e09
MD5 935bcba278b147bc62e20242c17f9404
BLAKE2b-256 a5b4070bade8daf409cacc6354aac0a593ebabe2c90f46c69f2c3df149f1ff4c

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