luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Updates consul exec docs to mention ACLs. (#3308) 

* Update documentation for consul exec to mention all permissions it needs.

* Removed node write perm, not needed for consul exec

* Converts ACL note into a table like the API docs, adds ACL guide x-ref.
This commit is contained in:
James Phillips 2017-07-20 09:30:08 -07:00 committed by GitHub
parent a0867b5d49
commit 6e251d39b5
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/source/api/acl.html.md
View File

@ -8,7 +8,8 @@ description: |-
# ACL HTTP API
The `/acl` endpoints create, update, destroy, and query ACL tokens in Consul.
The `/acl` endpoints create, update, destroy, and query ACL tokens in Consul. If
you are looking for general information about ACLs, please see the [ACL Guide](/docs/guides/acl.html).
## Create ACL Token

10
website/source/docs/commands/exec.html.markdown.erb
View File

@ -29,6 +29,16 @@ through the Consul servers and the Raft consensus algorithm, so having a large
number of nodes in the cluster flow a large amount of data through the KV store
could make the cluster unavailable.
The table below shows the [required ACLs](/api/index.html#acls) in order to
execute this command.
| ACL Required | Scope |
| ------------ | ------------ |
| `agent:read` | local agent |
| `session:write` | local agent |
| `key:write` | `"_rexec"` prefix |
| `event:write` | `"_rexec"` prefix |
## Usage
Usage: `consul exec [options] [-|command...]`