Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DO NOT MERGE: Docs Refresh preview #22041

Open
wants to merge 81 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
3a56024
migration
boruszak Nov 18, 2024
93344d3
nav fixes
boruszak Nov 18, 2024
ee3f186
nav
boruszak Nov 18, 2024
dcfe344
Missing top-level pages
boruszak Nov 18, 2024
cbe593e
nav/content alignment
boruszak Nov 18, 2024
89c4d4f
partial path update
boruszak Nov 18, 2024
baa2a10
Partial fixes
boruszak Nov 18, 2024
70afea4
Partial updates
boruszak Nov 19, 2024
d4d8d10
partial paths
boruszak Nov 19, 2024
55e981d
erroneous replacement fix
boruszak Nov 19, 2024
801ab53
Merge pull request #3 from boruszak/docs/CE-757-move-latest-version-o…
boruszak Nov 20, 2024
98d5753
3 page migration (test)
boruszak Nov 20, 2024
583bb7c
/agent migration
boruszak Nov 20, 2024
7c68a4d
CA, cluster peering, & config entries
boruszak Nov 21, 2024
d0496c3
connect -> Gateways
boruszak Nov 21, 2024
f617d9d
connect
boruszak Nov 22, 2024
e6962f3
connect
boruszak Nov 22, 2024
b52158e
nav
boruszak Nov 22, 2024
7a2c619
Dynamic app config
boruszak Nov 22, 2024
2358019
ecs
boruszak Nov 24, 2024
64decee
Tutorials -> docs
boruszak Nov 25, 2024
b74d204
Tutorials moved
boruszak Nov 25, 2024
45e3638
Updated nav with tutorials in docs
boruszak Nov 25, 2024
0798ef2
enterprise, install, and k8s through k8s/connect
boruszak Nov 25, 2024
f10f1cf
k8s deployment
boruszak Nov 25, 2024
47244c8
finished k8s migration
boruszak Nov 26, 2024
6284d22
lambda, nia, nomad
boruszak Nov 26, 2024
f124b31
nav fixes
boruszak Nov 27, 2024
1ea3875
security and discovery
boruszak Nov 27, 2024
16fde0e
service & upgrade
boruszak Nov 27, 2024
e0ba4cd
final page migrations
boruszak Nov 27, 2024
8e73d8c
Nav update
boruszak Nov 28, 2024
a3a3a61
Merge pull request #4 from boruszak/docs/CE-758-account-for-all-existing
boruszak Nov 28, 2024
0934235
Change navigation and page placement
Dec 5, 2024
be39342
Revert "Change navigation and page placement"
danielehc Dec 5, 2024
4b1e780
Change navigation and page placement
danielehc Dec 5, 2024
e840113
Fixed broken include.
tunzor Dec 9, 2024
1ef03ba
Updated sync consul service catalog with aws cloud map page.
tunzor Dec 9, 2024
f86905b
Update to match page use of cloud map - AWS separates the two words.
tunzor Dec 9, 2024
74564b0
Updated register services into a namespace docs page.
tunzor Dec 9, 2024
aabff94
Updated explore the consul ui page.
tunzor Dec 12, 2024
0d2f696
Refactor HAProxy tutorial into usage doc
danielehc Dec 12, 2024
c3b9bae
re-org
boruszak Dec 16, 2024
36bc4ef
architecture and fundamentals
boruszak Dec 18, 2024
560bfe9
duplicate page deleted
boruszak Dec 18, 2024
a194cd9
Apply suggestions from code review
tunzor Dec 18, 2024
68491f1
Moved consul-aws cli reference to its own page.
tunzor Dec 18, 2024
d3ab31d
Merge pull request #6 from tunzor/main
tunzor Dec 18, 2024
aee19ab
partial fix
boruszak Dec 18, 2024
558c9a2
Merge branch 'main' into introduction-content
boruszak Dec 18, 2024
92ebabe
Fix links and next steps
danielehc Dec 19, 2024
b5304a6
install and dev mode pages
boruszak Dec 19, 2024
a677383
CodeBlocks
boruszak Dec 19, 2024
f0ab205
env var page
boruszak Dec 20, 2024
282e5e3
title changes
boruszak Dec 20, 2024
710c765
Aligning with tracker
boruszak Dec 26, 2024
ed44b35
nav fixes
boruszak Dec 26, 2024
2487f07
tracking alignment
boruszak Dec 27, 2024
ecc4098
Nav fixes
boruszak Dec 27, 2024
ec06a4a
Merge pull request #8 from boruszak/introduction-content
boruszak Dec 28, 2024
90b194e
content checker fixed
boruszak Dec 30, 2024
87a1872
Partial path fixes
boruszak Dec 30, 2024
372ee59
more partial fixes
boruszak Dec 30, 2024
01bf18b
remove v2 reference
boruszak Dec 30, 2024
430aa56
nav/title adjustments
boruszak Dec 30, 2024
449b423
Merge pull request #5 from danielehc/dc/encryption
boruszak Jan 2, 2025
027fb6c
Merge pull request #7 from danielehc/dc/haproxy
boruszak Jan 2, 2025
0baa4c0
first 64 find and replaces
boruszak Jan 2, 2025
c407600
/connect and /consul-vs-other
boruszak Jan 2, 2025
6a22dea
through /nia
boruszak Jan 2, 2025
8bc05bd
finish docs paths
boruszak Jan 2, 2025
2f1922e
tutorial link paths
boruszak Jan 3, 2025
b9cd2cd
Redirects
boruszak Jan 3, 2025
5650a40
Redirect updates
boruszak Jan 6, 2025
5a28d14
another tutorials redirect fix
boruszak Jan 6, 2025
1e42bbc
link path updates
boruszak Jan 6, 2025
07b1c3d
Merge pull request #10 from boruszak/link-text-plus-redirects
boruszak Jan 6, 2025
fd63f3b
Fixes to redirect tests
boruszak Jan 14, 2025
bb022d3
Redirects
boruszak Jan 14, 2025
955eaee
More redirect fixes
boruszak Jan 14, 2025
599eeb3
Updated link path replacements
boruszak Jan 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,4 @@ terraform.rc

# Avoid accidental commits of consul-k8s submodule used by some dev environments
consul-k8s/
.vercel
1 change: 1 addition & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ out
.env*.local

website-preview
.vercel
18 changes: 9 additions & 9 deletions website/content/api-docs/acl/auth-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ACL auth methods in Consul.

For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [Access control list (ACL) overview](/consul/docs/secure/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Create an Auth Method
Expand Down Expand Up @@ -51,7 +51,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma

- `Type` `(string: <required>)` - The type of auth method being configured.
This field is immutable. For allowed values see the [auth method
documentation](/consul/docs/security/acl/auth-methods).
documentation](/consul/docs/secure/acl/auth-method).

- `Description` `(string: "")` - Free form human readable description of the
auth method.
Expand All @@ -76,7 +76,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma
- `Config` `(map[string]string: <required>)` - The raw configuration to use for
the chosen auth method. Contents will vary depending upon the type chosen.
For more information on configuring specific auth method types, see the [auth
method documentation](/consul/docs/security/acl/auth-methods).
method documentation](/consul/docs/secure/acl/auth-method).

- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the auth method you create. This field takes precedence over the `ns` query parameter,
Expand Down Expand Up @@ -107,7 +107,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma
prefixed-${serviceaccount.name}
```

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -180,7 +180,7 @@ The corresponding CLI command is [`consul acl auth-method read`](/consul/command
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you look up.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -267,7 +267,7 @@ The corresponding CLI command is [`consul acl auth-method update`](/consul/comma
- `Config` `(map[string]string: <required>)` - The raw configuration to use for
the chosen auth method. Contents will vary depending upon the type chosen.
For more information on configuring specific auth method types, see the [auth
method documentation](/consul/docs/security/acl/auth-methods).
method documentation](/consul/docs/secure/acl/auth-method).

- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the auth method you update. This field takes precedence over the `ns` query parameter,
Expand Down Expand Up @@ -298,7 +298,7 @@ The corresponding CLI command is [`consul acl auth-method update`](/consul/comma
prefixed-${serviceaccount.name}
```

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -375,7 +375,7 @@ The corresponding CLI command is [`consul acl auth-method delete`](/consul/comma
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -418,7 +418,7 @@ The corresponding CLI command is [`consul acl auth-method list`](/consul/command

The namespace may be specified as '\*' and then results are returned for all namespaces.

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

## Sample Request

Expand Down
12 changes: 6 additions & 6 deletions website/content/api-docs/acl/binding-rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ rules in Consul.

For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [Access control list (ACL) overview](/consul/docs/secure/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Create a Binding Rule
Expand Down Expand Up @@ -172,7 +172,7 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -240,7 +240,7 @@ The corresponding CLI command is [`consul acl binding-rule read`](/consul/comman
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -427,7 +427,7 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -495,7 +495,7 @@ The corresponding CLI command is [`consul acl binding-rule delete`](/consul/comm
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -539,7 +539,7 @@ The corresponding CLI command is [`consul acl binding-rule list`](/consul/comman
The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down
20 changes: 10 additions & 10 deletions website/content/api-docs/acl/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ The `/acl` endpoints are used to manage ACL tokens and policies in Consul, [boot

For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [Access control list (ACL) overview](/consul/docs/secure/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Bootstrap ACLs

This endpoint does a special one-time bootstrap of the ACL system, making the first
management token if the [`acl.tokens.initial_management`](/consul/docs/agent/config/config-files#acl_tokens_initial_management)
management token if the [`acl.tokens.initial_management`](/consul/docs/reference/agent/configuration-file#acl_tokens_initial_management)
configuration entry is not specified in the Consul server configuration and if the
cluster has not been bootstrapped previously. An operator created token can be provided in the body of the request to
bootstrap the cluster if required. The provided token should be presented in a UUID format.
Expand Down Expand Up @@ -155,7 +155,7 @@ $ curl \

- `SourceDatacenter` - The authoritative ACL datacenter that ACLs are being
replicated from and will match the
[`primary_datacenter`](/consul/docs/agent/config/config-files#primary_datacenter) configuration.
[`primary_datacenter`](/consul/docs/reference/agent/configuration-file#primary_datacenter) configuration.

- `ReplicationType` - The type of replication that is currently in use.

Expand Down Expand Up @@ -195,7 +195,7 @@ $ curl \
## Login to Auth Method

This endpoint was added in Consul 1.5.0 and is used to exchange an [auth
method](/consul/docs/security/acl/auth-methods) bearer token for a newly-created
method](/consul/docs/secure/acl/auth-method) bearer token for a newly-created
Consul ACL token.

| Method | Path | Produces |
Expand All @@ -214,7 +214,7 @@ The table below shows this endpoint's support for

-> **Note** - To use the login process to create tokens in any connected
secondary datacenter, [ACL
replication](/consul/docs/agent/config/config-files#acl_enable_token_replication) must be
replication](/consul/docs/reference/agent/configuration-file#acl_enable_token_replication) must be
enabled. Login requires the ability to create local tokens which is restricted
to the primary datacenter and any secondary datacenters with ACL token
replication enabled.
Expand Down Expand Up @@ -329,7 +329,7 @@ $ curl \
</EnterpriseAlert>

This endpoint was added in Consul 1.8.0 and is used to obtain an authorization
URL from Consul to start an [OIDC login flow](/consul/docs/security/acl/auth-methods/oidc).
URL from Consul to start an [OIDC login flow](/consul/docs/secure/acl/auth-method/oidc).

| Method | Path | Produces |
| ------ | -------------------- | ------------------ |
Expand All @@ -347,7 +347,7 @@ The table below shows this endpoint's support for

-> **Note** - To use the login process to create tokens in any connected
secondary datacenter, [ACL
replication](/consul/docs/agent/config/config-files#acl_enable_token_replication) must be
replication](/consul/docs/reference/agent/configuration-file#acl_enable_token_replication) must be
enabled. Login requires the ability to create local tokens which is restricted
to the primary datacenter and any secondary datacenters with ACL token
replication enabled.
Expand All @@ -360,7 +360,7 @@ replication enabled.
### JSON Request Body Schema

- `AuthMethod` `(string: <required>)` - The name of the auth method to use for
login. This must be of type [`oidc`](/consul/docs/security/acl/auth-methods/oidc).
login. This must be of type [`oidc`](/consul/docs/secure/acl/auth-method/oidc).

- `RedirectURI` `(string: <required>)` - See [Redirect
URIs](/consul/docs/security/acl/auth-methods/oidc#redirect-uris) for more information.
Expand Down Expand Up @@ -430,7 +430,7 @@ The table below shows this endpoint's support for

-> **Note** - To use the login process to create tokens in any connected
secondary datacenter, [ACL
replication](/consul/docs/agent/config/config-files#acl_enable_token_replication) must be
replication](/consul/docs/reference/agent/configuration-file#acl_enable_token_replication) must be
enabled. Login requires the ability to create local tokens which is restricted
to the primary datacenter and any secondary datacenters with ACL token
replication enabled.
Expand All @@ -443,7 +443,7 @@ replication enabled.
### JSON Request Body Schema

- `AuthMethod` `(string: <required>)` - The name of the auth method to use for
login. This must be of type [`oidc`](/consul/docs/security/acl/auth-methods/oidc).
login. This must be of type [`oidc`](/consul/docs/secure/acl/auth-method/oidc).

- `State` `(string: <required>)` - Opaque state ID that is part of the
Authorization URL and will be included in the redirect following
Expand Down
14 changes: 7 additions & 7 deletions website/content/api-docs/acl/policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The corresponding CLI command is [`consul acl policy create`](/consul/commands/a
- `Description` `(string: "")` - Free form human readable description of the policy.

- `Rules` `(string: "")` - Specifies rules for the ACL policy. The format of the
`Rules` property is detailed in the [ACL Rules documentation](/consul/docs/security/acl/acl-rules).
`Rules` property is detailed in the [ACL Rules documentation](/consul/docs/reference/acl/rule).

- `Datacenters` `(array<string>)` - Specifies the datacenters the policy is valid within.
When no datacenters are provided the policy is valid in all datacenters including
Expand All @@ -57,7 +57,7 @@ The corresponding CLI command is [`consul acl policy create`](/consul/commands/a
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -172,7 +172,7 @@ The corresponding CLI command is [`consul acl policy read -name=<string>`](/cons
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -236,7 +236,7 @@ The corresponding CLI command is [`consul acl policy update`](/consul/commands/a
- `Description` `(string: "")` - Free form human readable description of this policy.

- `Rules` `(string: "")` - Specifies rules for this ACL policy. The format of the
`Rules` property is detailed in the [ACL Rules documentation](/consul/docs/security/acl/acl-rules).
`Rules` property is detailed in the [ACL Rules documentation](/consul/docs/reference/acl/rule).

- `Datacenters` `(array<string>)` - Specifies the datacenters this policy is valid within.
When no datacenters are provided the policy is valid in all datacenters including
Expand All @@ -246,7 +246,7 @@ The corresponding CLI command is [`consul acl policy update`](/consul/commands/a
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -313,7 +313,7 @@ The corresponding CLI command is [`consul acl policy delete`](/consul/commands/a
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -354,7 +354,7 @@ The corresponding CLI command is [`consul acl policy list`](/consul/commands/acl
The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down
14 changes: 7 additions & 7 deletions website/content/api-docs/acl/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `/acl/role` endpoints [create](#create-a-role), [read](#read-a-role),

For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [Access control list (ACL) overview](/consul/docs/secure/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Create a Role
Expand Down Expand Up @@ -95,7 +95,7 @@ The corresponding CLI command is [`consul acl role create`](/consul/commands/acl
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -225,7 +225,7 @@ The corresponding CLI command is [`consul acl role read`](/consul/commands/acl/r
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -310,7 +310,7 @@ The corresponding CLI command is [`consul acl role read -name=<string>`](/consul
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -424,7 +424,7 @@ The corresponding CLI command is [`consul acl role update`](/consul/commands/acl
This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace).

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample Payload

Expand Down Expand Up @@ -531,7 +531,7 @@ The corresponding CLI command is [`consul acl role delete`](/consul/commands/acl
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

### Sample Request

Expand Down Expand Up @@ -575,7 +575,7 @@ The corresponding CLI command is [`consul acl role list`](/consul/commands/acl/r
The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'
@include 'legacy/http-api-query-parms-partition.mdx'

## Sample Request

Expand Down
4 changes: 2 additions & 2 deletions website/content/api-docs/acl/templated-policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `/acl/templated-policy` endpoints [read](#read-a-templated-policy-by-name),

For more information on how to setup ACLs, refer to the following resources:

- [Access control list (ACL) overview](/consul/docs/security/acl)
- [Access control list (ACL) overview](/consul/docs/secure/acl)
- [ACL tutorial](/consul/tutorials/security/access-control-setup-production)

## Read a templated policy by name
Expand Down Expand Up @@ -87,7 +87,7 @@ The corresponding CLI command is [`consul acl templated-policy preview`](/consul

- `Name` `(string: <optional>)` - Specifies the value of the `name` variable in the templated policy variables.

@include 'http-api-body-options-partition.mdx'
@include 'legacy/http-api-body-options-partition.mdx'

### Sample payload

Expand Down
Loading