documentation; add to existing commands

This commit is contained in:
Chelsea Holland Komlo
2017-09-17 13:36:54 +00:00
parent c651ca45b5
commit 94c12630b5
3 changed files with 50 additions and 0 deletions

View File

@@ -46,6 +46,11 @@ func Commands(metaPtr *command.Meta) map[string]cli.CommandFactory {
Meta: meta,
}, nil
},
"acl policy info": func() (cli.Command, error) {
return &command.ACLPolicyInfoCommand{
Meta: meta,
}, nil
},
"acl token": func() (cli.Command, error) {
return &command.ACLTokenCommand{
Meta: meta,

View File

@@ -22,12 +22,14 @@ subcommands are available:
* [`acl bootstrap`][bootstrap] - Bootstrap the initial ACL token
* [`acl policy apply`][policyapply] - Create or update ACL policies
* [`acl policy delete`][policydelete] - Delete an existing ACL policies
* [`acl policy info`][policyinfo] - Fetch information on an existing ACL policy
* [`acl token create`][tokencreate] - Create new ACL token
* [`acl token delete`][tokendelete] - Delete an existing ACL token
[bootstrap]: /docs/commands/acl/bootstrap.html
[policyapply]: /docs/commands/acl/policy-apply.html
[policydelete]: /docs/commands/acl/policy-delete.html
[policyinfo]: /docs/commands/acl/policy-info.html
[tokencreate]: /docs/commands/acl/token-create.html
[tokendelete]: /docs/commands/acl/token-delete.html

View File

@@ -0,0 +1,43 @@
---
layout: "docs"
page_title: "Commands: acl policy info"
sidebar_current: "docs-commands-acl-policy-info"
description: >
The policy info command is used to fetch information on an existing ACL
policy.
---
# Command: acl policy info
The `acl policy info` command is used to fetch information on an existing ACL
policy.
## Usage
```
nomad acl policy info <name>
```
The `acl policy info` command requires the policy name.
## General Options
<%= partial "docs/commands/_general_options" %>
## Examples
Fetch information on an existing ACL Policy:
```
$ nomad acl policy info my-policy
Name = my-name
Description = <none>
Rules = {
"Name": "my-policy",
"Description": "This is a great policy",
"Rules": ""
}
CreateIndex = %!s(uint64=749)
ModifyIndex = %!s(uint64=758)
```