luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-consul/website/pages/commands/acl/translate-rules.mdx

72 lines
1.8 KiB
Plaintext
Raw Normal View History

Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
---
docs: update structure (#8506) - moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary page
2020-09-01 15:14:13 +00:00
layout: commands
intro and api navigation converted
2020-04-07 18:55:19 +00:00
page_title: 'Commands: ACL Translate Rules'
remove 'sidebar_current' from frontmatter
2020-04-13 18:40:26 +00:00
sidebar_title: translate-rules
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
---
-> **Deprecated:** This command exists only as a convenience to make legacy ACL migration easier.
It will be removed in a future major release when support for the legacy ACL system is removed.
# Consul ACL Translate Rules
Command: `consul acl translate-rules`
This command translates the legacy ACL rule syntax into the new syntax.
### Usage
s/translate rules/translate-rules/ Just fixes a typo in the command's usage info.
2020-08-21 14:47:05 +00:00
Usage: `consul acl translate-rules [options] TRANSLATE`
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
#### API Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
docs rendering
2020-04-07 23:56:08 +00:00
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
#### Command Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
- `TRANSLATE` - The rules to translate. If `-` is used, then
the rules will be read from stdin. If `@` is prefixed to
the value then the value is considered to be a file and
the rules will be read from that file.
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
intro and api navigation converted
2020-04-07 18:55:19 +00:00
- `-token-secret` - Specifies that what the `TRANSLATE` argument
holds is not a rule set but rather the token secret ID of a
legacy ACL token that holds the rule set.
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
intro and api navigation converted
2020-04-07 18:55:19 +00:00
- `-token-accessor` - Specifies that what the `TRANSLATE` argument
holds is not a rule set but rather the token accessor ID of a
legacy ACL token that holds the rule set.
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
### Examples
intro and api navigation converted
2020-04-07 18:55:19 +00:00
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
Translate rules within a file:
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
$ consul acl translate-rules @rules.hcl
```
Translate rules from stdin:
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
$ consul acl translate-rules -
```
Translate rules from a string argument:
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
$ consul acl translate-rules 'key "" { policy = "write"}'
```
Translate rules for a legacy ACL token using its SecretID passed from stdin:
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
$ consul acl translate-rules --token-secret -
```
Translate rules for a legacy ACL token using its AccessorID:
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
Implement CLI token cloning & special ID handling (#4827) * Implement CLI token cloning & special ID handling * Update a couple CLI commands to take some alternative options. * Document the CLI. * Update the policy list and set-agent-token synopsis
2018-10-24 14:24:29 +00:00
$ consul acl translate-rules 429cd746-03d5-4bbb-a83a-18b164171c89
```