Backport of Docs/intentions refactor docs day 2022 into release/1.15.x (

#16775) * backport of commit 945c132 * backport of commit 4034c6f * backport of commit 8c06a18 * backport of commit 35757aa * backport of commit 1204b41 * Docs/intentions refactor docs day 2022 (#16758) * converted intentions conf entry to ref CT format * set up intentions nav * add page for intentions usage * final intentions usage page * final intentions overview page * fixed old relative links * updated diagram for overview * updated links to intentions content * fixed typo in updated links * rename intentions overview page file to index * rollback link updates to intentions overview * fixed nav * Updated custom HTML in API and CLI pages to MD * applied suggestions from review to index page * moved conf examples from usage to conf ref * missed custom HTML section * applied additional feedback * Apply suggestions from code review Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> * updated headings in usage page * renamed files and udpated nav * updated links to new file names * added redirects and final tweaks * typo --------- Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> * remove old files --------- Co-authored-by: trujillo-adam <ajosetru@gmail.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
hashicorp · Mar 24, 2023 · a3d05b6 · a3d05b6
1 parent dfb7f71
commit a3d05b6
Show file tree

Hide file tree

Showing 23 changed files with 1,269 additions and 972 deletions.
diff --git a/website/content/api-docs/connect/intentions.mdx b/website/content/api-docs/connect/intentions.mdx
@@ -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).
 
@@ -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).
 
@@ -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:
@@ -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).
 
@@ -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).
 
@@ -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).
 
@@ -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).
 
@@ -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).
 
@@ -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).
 
@@ -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).
 

diff --git a/website/content/commands/connect/envoy.mdx b/website/content/commands/connect/envoy.mdx
@@ -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.

diff --git a/website/content/commands/connect/index.mdx b/website/content/commands/connect/index.mdx
@@ -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.
 

diff --git a/website/content/commands/intention/check.mdx b/website/content/commands/intention/check.mdx
@@ -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
 

diff --git a/website/content/commands/intention/create.mdx b/website/content/commands/intention/create.mdx
@@ -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
 

diff --git a/website/content/commands/intention/delete.mdx b/website/content/commands/intention/delete.mdx
@@ -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

diff --git a/website/content/commands/intention/get.mdx b/website/content/commands/intention/get.mdx
@@ -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
 

diff --git a/website/content/commands/intention/index.mdx b/website/content/commands/intention/index.mdx
@@ -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

diff --git a/website/content/commands/intention/list.mdx b/website/content/commands/intention/list.mdx
@@ -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
 

diff --git a/website/content/commands/intention/match.mdx b/website/content/commands/intention/match.mdx
@@ -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
 

diff --git a/website/content/docs/connect/config-entries/service-defaults.mdx b/website/content/docs/connect/config-entries/service-defaults.mdx
@@ -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.    
 
@@ -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.