Skip to content

Commit 953fec0

Browse files
author
Paul Glass
committed
Fix doc headers
1 parent 71269da commit 953fec0

File tree

6 files changed

+35
-35
lines changed

6 files changed

+35
-35
lines changed

‎website/content/docs/security/acl/tokens/create/create-a-mesh-gateway-token.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
layout: docs
33
page_title: Create a token for mesh gateway registration
4-
Description: >-
4+
description: >-
55
Learn how to create ACL tokens that your mesh gateway can present to Consul servers so that they can register with the Consul catalog.
66
---
77

88
# Create a mesh gateway token
99

10-
This topic describes how to create a token to enable a mesh gateway to register.
10+
This topic describes how to create a token to enable a mesh gateway to register.
1111

1212
## Introduction
1313

@@ -27,15 +27,15 @@ To create a token for the mesh gateway, you must define a policy, register the p
2727

2828
### Define a custom policy
2929

30-
You can send custom policy definitions as command line or API arguments or define them in an external HCL or JSON file. The following example policies are externally defined policies. Refer to [ACL Rules](/consul/docs/security/acl/acl-rules) for details about all of the rules you can use in your policies.
30+
You can send custom policy definitions as command line or API arguments or define them in an external HCL or JSON file. The following example policies are externally defined policies. Refer to [ACL Rules](/consul/docs/security/acl/acl-rules) for details about all of the rules you can use in your policies.
3131

3232
#### Consul OSS
3333

3434
The following example policy grants the mesh gateway the appropriate permissions for the mesh gateway to register as a service named `mesh-gateway`.
3535

3636
<CodeTabs>
3737

38-
```hcl
38+
```hcl
3939
mesh = "write"
4040
peering = "read"
4141
service "mesh-gateway" {
@@ -246,7 +246,7 @@ You can specify an admin partition when creating policies in Consul Enterprise.
246246
consul acl policy create \
247247
-name mgw-register -rules @mgw-register.hcl \
248248
-description "Mesh gateway policy" \
249-
-partition ptn1
249+
-partition ptn1
250250
```
251251

252252
Refer to [Consul ACL Policy Create](/consul/commands/acl/policy/create) for details about the `consul acl policy create` command.
@@ -295,7 +295,7 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
295295
}'
296296
```
297297

298-
Refer to [ACL Policy HTTP API](/consul/api-docs/acl/policies) for additional information about using the API endpoint.
298+
Refer to [ACL Policy HTTP API](/consul/api-docs/acl/policies) for additional information about using the API endpoint.
299299

300300
### Link the policy to a token
301301

@@ -307,7 +307,7 @@ Run the `consul acl token create` command and specify the policy name or ID to c
307307

308308
##### Consul OSS
309309

310-
The following command creates the ACL token linked to the policy `mgw-register`.
310+
The following command creates the ACL token linked to the policy `mgw-register`.
311311

312312
```shell-session
313313
$ consul acl token create \
@@ -338,10 +338,10 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
338338
--data '{
339339
"Policies": [
340340
{
341-
"Name": "mgw-register"
341+
"Name": "mgw-register"
342342
}
343343
]
344-
}'
344+
}'
345345
```
346346

347347
##### Consul Enterprise
@@ -354,11 +354,11 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
354354
--data '{
355355
"Policies": [
356356
{
357-
"Name": "mgw-register"
357+
"Name": "mgw-register"
358358
}
359359
],
360360
"Partition": "ptn1"
361-
}'
361+
}'
362362
```
363363

364364
@include 'create-token-auth-methods.mdx'

‎website/content/docs/security/acl/tokens/create/create-a-service-token.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
page_title: Create tokens for service registration
4-
Description: >-
4+
description: >-
55
Learn how to create ACL tokens that your services can present to Consul servers so that they can register with the Consul catalog.
66
---
77

@@ -297,7 +297,7 @@ The following commands create the ACL token linked to the policy `svc1-register`
297297
```shell-session
298298
$ consul acl token create -partition "ptn1" -namespace "ns1" \
299299
-description "Service token for svc1" \
300-
-policy-name "svc1-register"
300+
-policy-name "svc1-register"
301301
```
302302

303303
#### API

‎website/content/docs/security/acl/tokens/create/create-a-terminating-gateway-token.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
page_title: Create a token for terminating gateway registration
4-
Description: >-
4+
description: >-
55
Learn how to create ACL tokens that your terminating gateway can present to Consul servers so that they can register with the Consul catalog.
66
---
77

‎website/content/docs/security/acl/tokens/create/create-a-ui-token.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
page_title: Create tokens for agent registration
4-
Description: >-
4+
description: >-
55
Learn how to create ACL tokens that your Consul agents can present to Consul servers so that they can join the Consul cluster.
66
---
77

‎website/content/docs/security/acl/tokens/create/create-an-agent-token.mdx‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
page_title: Create tokens for agent registration
4-
Description: >-
4+
description: >-
55
Learn how to create ACL tokens that your Consul agents can present to Consul servers so that they can join the Consul cluster.
66
---
77

@@ -60,9 +60,9 @@ $ consul acl token create -partition "ptn1" \
6060

6161
### API
6262

63-
Send a PUT request to the `/acl/token` endpoint and specify a node identity in the request body to create a token linked to the node identity. An ACL token linked to a policy with permissions to use the API endpoint is required. Refer to [ACL Token HTTP API](/consul/api-docs/acl/tokens) for additional information about using the API endpoint.
63+
Send a PUT request to the `/acl/token` endpoint and specify a node identity in the request body to create a token linked to the node identity. An ACL token linked to a policy with permissions to use the API endpoint is required. Refer to [ACL Token HTTP API](/consul/api-docs/acl/tokens) for additional information about using the API endpoint.
6464

65-
The following example creates a token linked to a node identity named `node1`:
65+
The following example creates a token linked to a node identity named `node1`:
6666

6767
#### Consul OSS
6868

@@ -72,8 +72,8 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
7272
--data '{
7373
"NodeIdentities": [
7474
{
75-
"NodeName": "node1",
76-
"Datacenter": "dc1"
75+
"NodeName": "node1",
76+
"Datacenter": "dc1"
7777
}
7878
]
7979
}'
@@ -89,8 +89,8 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
8989
--data '{
9090
"NodeIdentities": [
9191
{
92-
"NodeName": "node1",
93-
"Datacenter": "dc1"
92+
"NodeName": "node1",
93+
"Datacenter": "dc1"
9494
}
9595
],
9696
"Partition": "ptn1"
@@ -113,7 +113,7 @@ The following example policy grants the agent node `write` permission for node `
113113

114114
<CodeTabs>
115115

116-
```hcl
116+
```hcl
117117
node "node1" {
118118
policy = "write"
119119
}
@@ -185,7 +185,7 @@ partition "ptn1" {
185185

186186
### Register policies with Consul
187187

188-
After defining the custom policies, you can register them with Consul using the command line or API endpoint.
188+
After defining the custom policies, you can register them with Consul using the command line or API endpoint.
189189

190190
#### CLI
191191

@@ -238,7 +238,7 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
238238
}'
239239
```
240240

241-
Refer to [ACL Policy HTTP API](/consul/api-docs/acl/policies) for additional information about using the API endpoint.
241+
Refer to [ACL Policy HTTP API](/consul/api-docs/acl/policies) for additional information about using the API endpoint.
242242

243243
### Link custom policies to tokens
244244

@@ -250,7 +250,7 @@ Run the `consul acl token create` command and specify the policy name or ID to c
250250

251251
##### Consul OSS
252252

253-
The following command creates the ACL token linked to the policy `node1-register`.
253+
The following command creates the ACL token linked to the policy `node1-register`.
254254

255255
```shell-session
256256
$ consul acl token create \
@@ -272,18 +272,18 @@ Send a PUT request to the `/acl/token` endpoint and specify the policy name or I
272272

273273
##### Consul OSS
274274

275-
The following example creates an ACL token that the agent can use to register as node `node1` in the catalog:
275+
The following example creates an ACL token that the agent can use to register as node `node1` in the catalog:
276276

277277
```shell-session
278278
$ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
279279
--header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
280280
--data '{
281281
"Policies": [
282282
{
283-
"Name": "node1-register"
283+
"Name": "node1-register"
284284
}
285285
]
286-
}'
286+
}'
287287
```
288288

289289
##### Consul Enterprise
@@ -296,24 +296,24 @@ $ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
296296
--data '{
297297
"Policies": [
298298
{
299-
"Name": "node1-register"
299+
"Name": "node1-register"
300300
}
301301
],
302302
"Partition": "ptn1"
303-
}'
303+
}'
304304
```
305305

306306
@include 'create-token-auth-methods.mdx'
307307

308-
## Apply the token
308+
## Apply the token
309309

310310
Configure the Consul agent to present the token by either specifying the token in the agent configuration file or by using the `consul set-agent-token` command.
311311

312312
### Apply the token in a file
313313

314-
Specify the token in the [`acl.token.agent`](/consul/docs/agent/config/config-files#acl_tokens_agent) field of the agent configuration file so that the agent can present it and register into the catalog on startup.
314+
Specify the token in the [`acl.token.agent`](/consul/docs/agent/config/config-files#acl_tokens_agent) field of the agent configuration file so that the agent can present it and register into the catalog on startup.
315315

316-
```hcl
316+
```hcl
317317
acl = {
318318
enabled = true
319319
tokens = {

‎website/content/docs/security/acl/tokens/create/create-an-ingress-gateway-token.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
page_title: Create a token for ingress gateway registration
4-
Description: >-
4+
description: >-
55
Learn how to create ACL tokens that your ingress gateway can present to Consul servers so that they can register with the Consul catalog.
66
---
77

0 commit comments

Comments
 (0)