HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Consul
Consul Home

You are viewing documentation for version v1.10.x. View latest version.

Consul ACL Translate Rules

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.

Command: consul acl translate-rules

This command translates the legacy ACL rule syntax into the new syntax.

Usage

Usage: consul acl translate-rules [options] TRANSLATE

API Options

  • -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

  • -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

  • -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

  • -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

  • -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

  • -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

  • -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

  • -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

  • -datacenter=<name> - Name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent at the HTTP address.

  • -stale - Permit any Consul server (non-leader) to respond to this request. This allows for lower latency and higher throughput, but can result in stale data. This option has no effect on non-read operations. The default value is false.

Command Options

  • 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.

  • -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.

  • -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.

Examples

Translate rules within a file:

$ consul acl translate-rules @rules.hcl

Translate rules from stdin:

$ consul acl translate-rules -

Translate rules from a string argument:

$ consul acl translate-rules 'key "" { policy = "write"}'

Translate rules for a legacy ACL token using its SecretID passed from stdin:

$ consul acl translate-rules --token-secret -

Translate rules for a legacy ACL token using its AccessorID:

$ consul acl translate-rules 429cd746-03d5-4bbb-a83a-18b164171c89