Sentinel is a policy framework that is embedded in the enterprise versions of HashiCorp tools. The policies you write are deployed to these applications and enforced there.
Sentinel Simulator is a command-line interface (CLI) for local development and testing. For the getting started guide, we'll use Sentinel Simulator to learn how to write policies for Sentinel-enabled applications. The Sentinel Simulator is distributed as a binary package for all supported platforms and architectures.
To install Sentinel Simulator, find the appropriate package for your system and download it. Sentinel Simulator is packaged as a zip archive.
After downloading Sentinel, unzip the package. Sentinel Simulator runs as a single binary
sentinel. Any other files in the package can be safely removed and
Sentinel will still function.
The final step is to make sure that the
sentinel binary is available on the
See this page
for instructions on setting the PATH on Linux and Mac.
contains instructions for setting the PATH on Windows.
After installing Sentinel Simulator, verify the installation worked by opening a new
terminal session and checking that the
sentinel binary is available. By executing
sentinel, you should see help output similar to the following:
$ sentinel Usage: sentinel [--version] [--help] <command> [<args>] Available commands are: apply Execute a policy and output the result doc Show documentation for an import from a doc file fmt Format Sentinel policy to a canonical format test Test policies version Prints the Sentinel version
If you get an error that the binary could not be found, then your
variable was not setup properly. Please go back and ensure that your
variable contains the directory where Sentinel was installed.
Otherwise, Sentinel Simulator is installed and ready to go!
Now that Sentinel Simulator is installed we can start writing our first policy!