Skip to content

Commit

Permalink
Updated custom HTML in API and CLI pages to MD
Browse files Browse the repository at this point in the history
  • Loading branch information
trujillo-adam committed Mar 24, 2023
1 parent 8cd42d6 commit 0a45d1e
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 150 deletions.
110 changes: 10 additions & 100 deletions website/content/api-docs/connect/intentions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------------------------ |
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `NO` | `none` | `none` | `intentions:write` <p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention create -replace`](/consul/commands/intention/create#replace).

Expand Down Expand Up @@ -149,16 +140,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------------------------ |
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `NO` | `none` | `none` | `intentions:write` <p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention create`](/consul/commands/intention/create).

Expand Down Expand Up @@ -246,16 +228,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------------------------ |
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `NO` | `none` | `none` | `intentions:write`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

This endpoint supports the same parameters as the [create an intention](#create-intention-with-id) endpoint.
Additional parameters unique to this endpoint include:
Expand Down Expand Up @@ -300,16 +273,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ----------------------------- |
| `YES` | `all` | `none` | `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `YES` | `all` | `none` | `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention get`](/consul/commands/intention/get).

Expand Down Expand Up @@ -372,16 +336,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ----------------------------- |
| `YES` | `all` | `none` | `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `YES` | `all` | `none` | `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention get`](/consul/commands/intention/get).

Expand Down Expand Up @@ -435,16 +390,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ----------------------------- |
| `YES` | `all` | `none` | `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `YES` | `all` | `none` | `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention list`](/consul/commands/intention/list).

Expand Down Expand Up @@ -522,16 +468,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------------------------ |
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `NO` | `none` | `none` | `intentions:write`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention delete`](/consul/commands/intention/delete).

Expand Down Expand Up @@ -577,16 +514,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------------------------ |
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `NO` | `none` | `none` | `intentions:write`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention delete`](/consul/commands/intention/delete).

Expand Down Expand Up @@ -633,16 +561,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ----------------------------- |
| `NO` | `none` | `none` | `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `NO` | `none` | `none` | `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention check`](/consul/commands/intention/check).

Expand Down Expand Up @@ -693,16 +612,7 @@ The table below shows this endpoint's support for

| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | -------------------- | ----------------------------- |
| `YES` | `all` | `background refresh` | `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `YES` | `all` | `background refresh` | `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

The corresponding CLI command is [`consul intention match`](/consul/commands/intention/match).

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint

| ACL Required |
| ----------------------------- |
| `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

## Usage

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint

| ACL Required |
| ------------------------------ |
| `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `intentions:write`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

## Usage

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint

| ACL Required |
| ------------------------------ |
| `intentions:write`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `intentions:write`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

-> **Deprecated** - The one argument form of this command is deprecated in
Consul 1.9.0. Intentions no longer need IDs when represented as
Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint

| ACL Required |
| ----------------------------- |
| `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `intentions:read`<p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

## Usage

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint

| ACL Required |
| ----------------------------- |
| `intentions:read`<sup>1</sup> |

<p>
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/consul/docs/connect/intentions/intentions-usage#acl-requirements">
ACL requirements for intentions
</a>{' '}
for more details.
</p>
| `intentions:read` <p> Define intention rules in the `service` policy. Refer to [ACL requirements for intentions](/consul/docs/connect/intentions/intentions-usage#acl-requirements) for additional information.</p> |

## Usage

Expand Down

0 comments on commit 0a45d1e

Please sign in to comment.