2017-09-19 14:47:10 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
page_title: 'Commands: sentinel apply'
|
2017-09-19 14:47:10 +00:00
|
|
|
description: >
|
2019-10-22 13:44:00 +00:00
|
|
|
The sentinel apply command is used to write a new, or update an existing,
|
|
|
|
Sentinel policy.
|
2017-09-19 14:47:10 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Command: sentinel apply
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
The `sentinel apply` command is used to write a new, or update an existing,
|
|
|
|
Sentinel policy.
|
2017-09-19 14:47:10 +00:00
|
|
|
|
2018-03-22 20:39:18 +00:00
|
|
|
~> Sentinel commands are new in Nomad 0.7 and are only available with Nomad
|
|
|
|
Enterprise.
|
|
|
|
|
2017-09-19 14:47:10 +00:00
|
|
|
## Usage
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2017-09-19 14:47:10 +00:00
|
|
|
nomad sentinel apply [options] <Policy Name> <Policy File>
|
|
|
|
```
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
The `sentinel apply` command requires two arguments, the policy name and the
|
|
|
|
policy file. The policy file can be read from stdin by specifying "-" as the
|
|
|
|
file name.
|
2017-09-19 14:47:10 +00:00
|
|
|
|
2020-11-19 21:38:08 +00:00
|
|
|
Sentinel commands are only available when ACLs are enabled. This command
|
|
|
|
requires a management token.
|
|
|
|
|
2017-09-19 14:47:10 +00:00
|
|
|
## General Options
|
|
|
|
|
2020-11-19 18:02:48 +00:00
|
|
|
@include 'general_options_no_namespace.mdx'
|
2017-09-19 14:47:10 +00:00
|
|
|
|
|
|
|
## Apply Options
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-description` : Sets a human readable description for the policy
|
2017-09-19 14:47:10 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-scope` : (default: submit-job) Sets the scope of the policy and when it
|
|
|
|
should be enforced.
|
2017-09-19 14:47:10 +00:00
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
- `-level` : (default: advisory) Sets the enforcement level of the policy. Must
|
|
|
|
be one of advisory, soft-mandatory, hard-mandatory.
|
2017-09-19 14:47:10 +00:00
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
Write a policy:
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
$ nomad sentinel write -description "My test policy" foo test.sentinel
|
2017-09-19 14:47:10 +00:00
|
|
|
Successfully wrote "foo" Sentinel policy!
|
|
|
|
```
|