-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ACL Binding Rules CLI documentation (#15584)
- Loading branch information
1 parent
bb8d2d7
commit f452441
Showing
9 changed files
with
267 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: acl binding-rule create' | ||
description: The binding-rule create command is used to create new ACL Binding Rules. | ||
--- | ||
|
||
# Command: acl binding-rule create | ||
|
||
The `acl binding-rule create` command is used to create new ACL Binding Rules. | ||
|
||
## Usage | ||
|
||
```plaintext | ||
nomad acl binding-rule create [options] | ||
``` | ||
|
||
The `acl binding-rule create` command requires the correct setting of the create options | ||
via flags detailed below. | ||
|
||
## General Options | ||
|
||
@include 'general_options_no_namespace.mdx' | ||
|
||
## Create Options | ||
|
||
- `-description`: A free form text description of the binding-rule that must not exceed | ||
256 characters. | ||
|
||
- `-auth-method`: Specifies the name of the ACL authentication method that this | ||
binding rule is associated with. | ||
|
||
- `-selector`: Selector is an expression that matches against verified identity | ||
attributes returned from the auth method during login. | ||
|
||
- `-bind-type`: Specifies adjusts how this binding rule is applied at login time | ||
to internal Nomad objects. Valid options are `role` and `policy`. | ||
|
||
- `-bind-name`: Specifies is the target of the binding used on selector match. | ||
This can be lightly templated using HIL `${foo}` syntax. | ||
|
||
- `-json`: Output the ACL binding-rule in a JSON format. | ||
|
||
- `-t`: Format and display the ACL binding-rule using a Go template. | ||
|
||
## Examples | ||
|
||
Create a new ACL Binding Rule: | ||
|
||
```shell-session | ||
$ nomad acl binding-rule create -description "example binding rule" -auth-method "auth0" -bind-type "role" -bind-name "eng-ro" -selector "engineering in list.roles" | ||
ID = 698fdad6-dcb3-79dd-dc72-b43374057dea | ||
Description = example binding rule | ||
Auth Method = auth0 | ||
Selector = "engineering in list.roles" | ||
Bind Type = role | ||
Bind Name = eng-ro | ||
Create Time = 2022-12-20 11:15:22.582568 +0000 UTC | ||
Modify Time = 2022-12-20 11:15:22.582568 +0000 UTC | ||
Create Index = 14 | ||
Modify Index = 14 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: acl binding-rule delete' | ||
description: The binding-rule delete command is used to delete existing ACL Binding Rules. | ||
--- | ||
|
||
# Command: acl binding-rule delete | ||
|
||
The `acl binding-rule delete` command is used to delete existing ACL Binding Rules. | ||
|
||
## Usage | ||
|
||
```plaintext | ||
nomad acl binding-rule delete [options] <binding-rule_id> | ||
``` | ||
|
||
The `acl binding-rule delete` command requires an existing rule's ID. | ||
|
||
## General Options | ||
|
||
@include 'general_options_no_namespace.mdx' | ||
|
||
## Examples | ||
|
||
Delete an existing ACL Auth Method: | ||
|
||
```shell-session | ||
$ nomad acl binding-rule delete 698fdad6-dcb3-79dd-dc72-b43374057dea | ||
ACL binding rule 698fdad6-dcb3-79dd-dc72-b43374057dea successfully deleted | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: acl binding-rule info' | ||
description: | | ||
The binding-rule info command is used to fetch information about an existing | ||
ACL Binding Rule. | ||
--- | ||
|
||
# Command: acl binding-rule info | ||
|
||
The `acl binding-rule info` command is used to fetch information about an existing ACL Binding Rule. | ||
|
||
## Usage | ||
|
||
```plaintext | ||
nomad acl binding-rule info [options] <binding-rule_id> | ||
``` | ||
|
||
The `acl binding-rule info` command requires an existing rule's ID. | ||
|
||
## General Options | ||
|
||
@include 'general_options_no_namespace.mdx' | ||
|
||
## Info Options | ||
|
||
- `-json`: Output the ACL Binding Rule in a JSON format. | ||
|
||
- `-t`: Format and display the ACL Binding Rule using a Go template. | ||
|
||
## Examples | ||
|
||
Fetch information about an existing ACL Binding Rule: | ||
|
||
```shell-session | ||
$ nomad acl binding-rule info dc0e494d-0878-4e56-37d4-482e371e5bdb | ||
ID = dc0e494d-0878-4e56-37d4-482e371e5bdb | ||
Description = example binding rule | ||
Auth Method = auth0 | ||
Selector = "engineering in list.roles" | ||
Bind Type = role | ||
Bind Name = engineering-ro | ||
Create Time = 2022-12-20 11:17:40.483196 +0000 UTC | ||
Modify Time = 2022-12-20 11:17:40.483196 +0000 UTC | ||
Create Index = 17 | ||
Modify Index = 17 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: acl binding-rule list' | ||
description: The binding-rule list command is used to list existing ACL Binding Rules. | ||
--- | ||
|
||
# Command: acl binding-rule list | ||
|
||
The `acl binding-rule list` command is used to list existing ACL Binding Rules. | ||
|
||
## Usage | ||
|
||
```plaintext | ||
nomad acl binding-rule list [options] | ||
``` | ||
|
||
## General Options | ||
|
||
@include 'general_options_no_namespace.mdx' | ||
|
||
## List Options | ||
|
||
- `-json` : Output the ACL binding-rules in a JSON format. | ||
|
||
- `-t` : Format and display the ACL binding-rules using a Go template. | ||
|
||
## Examples | ||
|
||
List all ACL Binding Rules: | ||
|
||
```shell-session | ||
$ nomad acl binding-rule list | ||
ID Description Auth Method | ||
dc0e494d-0878-4e56-37d4-482e371e5bdb example binding rule auth0 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: acl binding-rule update' | ||
description: The binding-rule update command is used to update existing ACL Binding Rules. | ||
--- | ||
|
||
# Command: acl binding-rule update | ||
|
||
The `acl binding-rule update` command is used to update existing ACL Binding Rules. | ||
|
||
## Usage | ||
|
||
```plaintext | ||
nomad acl binding-rule update [options] <binding-rule_ID> | ||
``` | ||
|
||
The `acl binding-rule update` command requires an existing rule's ID. | ||
|
||
## General Options | ||
|
||
@include 'general_options_no_namespace.mdx' | ||
|
||
## Update Options | ||
|
||
- `-description`: A free form text description of the binding-rule that must not exceed | ||
256 characters. | ||
|
||
- `-selector`: Selector is an expression that matches against verified identity | ||
attributes returned from the binding rule during login. | ||
|
||
- `-bind-type`: Specifies adjusts how this binding rule is applied at login time | ||
to internal Nomad objects. Valid options are `role` and `policy`. | ||
|
||
- `-bind-name`: Specifies is the target of the binding used on selector match. | ||
This can be lightly templated using HIL `${foo}` syntax. | ||
|
||
- `-json`: Output the ACL binding-rule in a JSON format. | ||
|
||
- `-t`: Format and display the ACL binding-rule using a Go template. | ||
|
||
## Examples | ||
|
||
Update an existing ACL binding rule: | ||
|
||
```shell-session | ||
$ nomad acl binding-rule update -description "new description" dc0e494d-0878-4e56-37d4-482e371e5bdb | ||
ID = dc0e494d-0878-4e56-37d4-482e371e5bdb | ||
Description = new description | ||
Auth Method = auth0 | ||
Selector = "engineering in list.roles" | ||
Bind Type = role | ||
Bind Name = engineering-ro | ||
Create Time = 2022-12-20 11:17:40.483196 +0000 UTC | ||
Modify Time = 2022-12-20 11:23:30.355439 +0000 UTC | ||
Create Index = 17 | ||
Modify Index = 25 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters