Skip to content

Docs/intentions refactor docs day 2022 #16758

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.

Sign up for GitHub

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

Merged
trujillo-adam merged 26 commits into from
Mar 24, 2023
Merged

Docs/intentions refactor docs day 2022 #16758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
945c132
converted intentions conf entry to ref CT format
trujillo-adam Mar 23, 2023
4034c6f
set up intentions nav
trujillo-adam Mar 23, 2023
8c06a18
add page for intentions usage
trujillo-adam Mar 23, 2023
35757aa
final intentions usage page
trujillo-adam Mar 23, 2023
1204b41
final intentions overview page
trujillo-adam Mar 23, 2023
eb19246
Merge branch 'main' into docs/intentions-refactor-docs-day-2022
trujillo-adam Mar 23, 2023
7339de8
fixed old relative links
trujillo-adam Mar 23, 2023
8c5bd0c
Merge branch 'docs/intentions-refactor-docs-day-2022' of github.com:h…
trujillo-adam Mar 23, 2023
9b6b69f
updated diagram for overview
trujillo-adam Mar 23, 2023
7e612a5
updated links to intentions content
trujillo-adam Mar 23, 2023
22a9066
fixed typo in updated links
trujillo-adam Mar 24, 2023
ad6e940
rename intentions overview page file to index
trujillo-adam Mar 24, 2023
b345201
rollback link updates to intentions overview
trujillo-adam Mar 24, 2023
8cd42d6
fixed nav
trujillo-adam Mar 24, 2023
0a45d1e
Updated custom HTML in API and CLI pages to MD
trujillo-adam Mar 24, 2023
9c1a513
applied suggestions from review to index page
trujillo-adam Mar 24, 2023
0b9bfea
moved conf examples from usage to conf ref
trujillo-adam Mar 24, 2023
aaef49e
missed custom HTML section
trujillo-adam Mar 24, 2023
c8e8894
applied additional feedback
trujillo-adam Mar 24, 2023
4c40599
Apply suggestions from code review
trujillo-adam Mar 24, 2023
a5ff062
updated headings in usage page
trujillo-adam Mar 24, 2023
0be6ddf
renamed files and udpated nav
trujillo-adam Mar 24, 2023
8b64fea
updated links to new file names
trujillo-adam Mar 24, 2023
7acd715
added redirects and final tweaks
trujillo-adam Mar 24, 2023
2bb6e9b
typo
trujillo-adam Mar 24, 2023
64f21a8
Merge branch 'main' into docs/intentions-refactor-docs-day-2022
trujillo-adam Mar 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 10 additions & 100 deletions website/content/api-docs/connect/intentions.mdx
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#acl-requirements) for additional information.</p> |

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

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/connect/envoy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Usage: `consul connect envoy [options] [-- pass-through options]`
ACL token from `-token` or the environment and so should be handled as a secret.
This token grants the identity of any service it has `service:write` permission
for and so can be used to access any upstream service that that service is
allowed to access by [Connect intentions](/consul/docs/connect/intentions).
allowed to access by [service mesh intentions](/consul/docs/connect/intentions).

- `-envoy-version` - The version of envoy that is being started. Default is
`1.23.1`. This is required so that the correct configuration can be generated.
Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/connect/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >-
Command: `consul connect`

The `connect` command is used to interact with Consul
[Connect](/consul/docs/connect/intentions) subsystems. It exposes commands for
[service mesh](/consul/docs/connect) subsystems. It exposes commands for
running the built-in mTLS proxy and viewing/updating the Certificate Authority
(CA) configuration. This command is available in Consul 1.2 and later.

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/check.mdx
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#acl-requirements) for additional information.</p> |

## Usage

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/create.mdx
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#acl-requirements) for additional information.</p> |

## Usage

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/delete.mdx
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#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
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#acl-requirements) for additional information.</p> |

## Usage

Expand Down
7 changes: 3 additions & 4 deletions website/content/commands/intention/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ The `intention` command is used to interact with Connect
creating, updating, reading, deleting, checking, and managing intentions.
This command is available in Consul 1.2 and later.

Intentions are managed primarily via
[`service-intentions`](/consul/docs/connect/config-entries/service-intentions) config
entries after Consul 1.9. Intentions may also be managed via the [HTTP
API](/consul/api-docs/connect/intentions).
Use the
[`service-intentions`](/consul/docs/connect/config-entries/service-intentions) configuration entry or the [HTTP
API](/consul/api-docs/connect/intentions) to manage intentions.

~> **Deprecated** - This command is deprecated in Consul 1.9.0 in favor of
using the [config entry CLI command](/consul/commands/config/write). To create an
Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/list.mdx
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#acl-requirements) for additional information.</p> |

## Usage

Expand Down
11 changes: 1 addition & 10 deletions website/content/commands/intention/match.mdx
View file
Open in desktop
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#intention-management-permissions">
Intention Management Permissions
</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/create-manage-intentions#acl-requirements) for additional information.</p> |

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/connect/config-entries/service-defaults.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ Specifies the default protocol for the service. In service mesh use cases, the `
- [observability](/consul/docs/connect/observability)
- [service splitter configuration entry](/consul/docs/connect/config-entries/service-splitter)
- [service router configuration entry](/consul/docs/connect/config-entries/service-router)
- [L7 intentions](/consul/docs/connect/intentions)
- [L7 intentions](/consul/docs/connect/intentions/index#l7-traffic-intentions)

You can set the global protocol for proxies in the [`proxy-defaults`](/consul/docs/connect/config-entries/proxy-defaults#default-protocol) configuration entry, but the protocol specified in the `service-defaults` configuration entry overrides the `proxy-defaults` configuration.

Expand Down Expand Up @@ -831,7 +831,7 @@ Specifies the default protocol for the service. In service service mesh use case
- [observability](/consul/docs/connect/observability)
- [`service-splitter` configuration entry](/consul/docs/connect/config-entries/service-splitter)
- [`service-router` configuration entry](/consul/docs/connect/config-entries/service-router)
- [L7 intentions](/consul/docs/connect/intentions)
- [L7 intentions](/consul/docs/connect/intentions/index#l7-traffic-intentions)

You can set the global protocol for proxies in the [`ProxyDefaults` configuration entry](/consul/docs/connect/config-entries/proxy-defaults#default-protocol), but the protocol specified in the `ServiceDefaults` configuration entry overrides the `ProxyDefaults` configuration.

Expand Down
Loading