From 74f08b966709ab78511f6a7461dba9c4ab575b86 Mon Sep 17 00:00:00 2001 From: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Date: Tue, 11 Oct 2022 09:34:17 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com> Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> --- .../content/docs/api-gateway/configuration/gatewayclass.mdx | 2 +- .../docs/api-gateway/configuration/gatewayclassconfig.mdx | 2 +- website/content/docs/api-gateway/configuration/routes.mdx | 2 +- website/content/docs/api-gateway/install.mdx | 2 +- website/content/docs/ecs/configuration-reference.mdx | 2 +- website/content/docs/ecs/manual/acl-controller.mdx | 2 +- website/content/docs/ecs/manual/install.mdx | 2 +- website/content/docs/ecs/requirements.mdx | 4 ++-- website/content/docs/ecs/task-resource-usage.mdx | 2 +- website/content/docs/ecs/terraform/install.mdx | 4 ++-- .../deployment-configurations/clients-outside-kubernetes.mdx | 2 +- website/content/docs/lambda/index.mdx | 2 +- website/content/docs/security/acl/auth-methods/index.mdx | 2 +- website/content/docs/security/acl/auth-methods/jwt.mdx | 2 +- website/content/docs/security/acl/auth-methods/kubernetes.mdx | 2 +- 15 files changed, 17 insertions(+), 17 deletions(-) diff --git a/website/content/docs/api-gateway/configuration/gatewayclass.mdx b/website/content/docs/api-gateway/configuration/gatewayclass.mdx index 2ef711efdf..8150860bec 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclass.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclass.mdx @@ -2,7 +2,7 @@ layout: docs page_title: GatewayClass Resource Configuration description: >- - A `GatewayClass` resource specifies a controller name, controller parameters, and global `Gateway` options for Consul API Gateway. Learn about its configuration model and reference specifications, and review an example config. + A `GatewayClass` resource specifies a controller name, controller parameters, and global `Gateway` options for Consul API Gateway. Learn about its configuration model and reference specifications, and review an example configuration. --- # GatewayClass Resource Configuration diff --git a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx index 44f21fe918..15ae326b8f 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx @@ -2,7 +2,7 @@ layout: docs page_title: GatewayClassConfig Resource Configuration description: >- - The `GatewayClassConfig` resource specifies connection information and settings that Consul API Gateway uses to connect to Consul. Learn about its configuration model and reference specifications, and review an example config. + The `GatewayClassConfig` resource specifies connection information and settings that Consul API Gateway uses to connect to Consul. Learn about its configuration model and reference specifications, and review an example configuration. --- # GatewayClassConfig Resource Configuration diff --git a/website/content/docs/api-gateway/configuration/routes.mdx b/website/content/docs/api-gateway/configuration/routes.mdx index 0053775cbf..57c4d8fdd1 100644 --- a/website/content/docs/api-gateway/configuration/routes.mdx +++ b/website/content/docs/api-gateway/configuration/routes.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Route Resource Configuration description: >- - The `HTTPRoute` and `TCPRoute` resources define Consul API Gateway routing behavior for traffic into the service mesh according to rules. Learn about its configuration model and reference specifications, and review an example config. + The `HTTPRoute` and `TCPRoute` resources define Consul API Gateway routing behavior for traffic into the service mesh according to rules. Learn about its configuration model and reference specifications, and review an example configuration. ---" # Route Resource Configuration diff --git a/website/content/docs/api-gateway/install.mdx b/website/content/docs/api-gateway/install.mdx index cae158bc8b..ac6e36ab6c 100644 --- a/website/content/docs/api-gateway/install.mdx +++ b/website/content/docs/api-gateway/install.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Install Consul API Gateway description: >- - Learn how to install Custom Resource Definitions (CRDs) and configure the Helm chart so that you can run Consul API Gateway on your Kubernetes deployment. + Learn how to install custom resource definitions (CRDs) and configure the Helm chart so that you can run Consul API Gateway on your Kubernetes deployment. --- # Install Consul API Gateway diff --git a/website/content/docs/ecs/configuration-reference.mdx b/website/content/docs/ecs/configuration-reference.mdx index 3077d8da9f..bb98056928 100644 --- a/website/content/docs/ecs/configuration-reference.mdx +++ b/website/content/docs/ecs/configuration-reference.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Consul on AWS Elastic Container Service (ECS) Configuration Reference description: >- - Use the `consul-ecs` reference guide to manually configure Consul for deployment on Amazon Web Services ECS. Learn how the config values correspond to Terraform module input variables and review JSON configuration models for `consulLogin`, `gateway`, `proxy`, and `service` fields. + Use the `consul-ecs` reference guide to manually configure Consul for deployment on Amazon Web Services ECS. Learn how the configuration values correspond to Terraform module input variables and review JSON configuration models for `consulLogin`, `gateway`, `proxy`, and `service` fields. --- # Consul on AWS Elastic Container Service (ECS) Configuration Reference diff --git a/website/content/docs/ecs/manual/acl-controller.mdx b/website/content/docs/ecs/manual/acl-controller.mdx index 0ec242386d..38aff74bd6 100644 --- a/website/content/docs/ecs/manual/acl-controller.mdx +++ b/website/content/docs/ecs/manual/acl-controller.mdx @@ -5,7 +5,7 @@ description: >- An ACL Controller is required to configure the AWS IAM auth method on Amazon Web Services ECS. Learn how to manually install ACL controllers by defining a task and a service and then configuring role policies. --- -# Manual Installatio of ACL Controller for Consul on AWS Elastic Container Service (ECS) +# Manual Installation of ACL Controller for Consul on AWS Elastic Container Service (ECS) This topic describes how to manually deploy the ACL controller, which will automatically configure the [AWS IAM Auth Method](/docs/security/acl/auth-methods/aws-iam). If you are using Terraform, refer to the [Terraform Secure Configuration](/docs/ecs/terraform/secure-configuration) page to deploy the ACL controller. diff --git a/website/content/docs/ecs/manual/install.mdx b/website/content/docs/ecs/manual/install.mdx index 164653e453..ffc4111fa2 100644 --- a/website/content/docs/ecs/manual/install.mdx +++ b/website/content/docs/ecs/manual/install.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Install Manually - Consul on AWS Elastic Container Service (ECS) description: >- - Manually install Consul on Amazon Web Services ECS by using the Docker `consul-ecs` image to create task definitions that include required containers. Learn how to configure task definitions with example configs. + Manually install Consul on Amazon Web Services ECS by using the Docker `consul-ecs` image to create task definitions that include required containers. Learn how to configure task definitions with example configurations. --- # Manual Installation of Consul on AWS Elastic Container Service (ECS) diff --git a/website/content/docs/ecs/requirements.mdx b/website/content/docs/ecs/requirements.mdx index 3713aa105b..4e7cca5c6c 100644 --- a/website/content/docs/ecs/requirements.mdx +++ b/website/content/docs/ecs/requirements.mdx @@ -1,9 +1,9 @@ -"--- +--- layout: docs page_title: Requirements - Consul on AWS Elastic Container Service (ECS) description: >- Consul has requirements to install and run on Amazon Web Services ECS. Learn about Consul's requirements for Fargate and EC2, including network mode and subnet information, as well as server, routing, and ACL controller considerations to keep in mind. ----" +--- # Requirements for Consul on AWS Elastic Container Service (ECS) diff --git a/website/content/docs/ecs/task-resource-usage.mdx b/website/content/docs/ecs/task-resource-usage.mdx index 232fe77ea1..30c334b2f3 100644 --- a/website/content/docs/ecs/task-resource-usage.mdx +++ b/website/content/docs/ecs/task-resource-usage.mdx @@ -1,4 +1,4 @@ -"--- +--- layout: docs page_title: Resource Usage - Consul on AWS Elastic Container Service (ECS) description: >- diff --git a/website/content/docs/ecs/terraform/install.mdx b/website/content/docs/ecs/terraform/install.mdx index ae7b189dd9..cfb3e41d0f 100644 --- a/website/content/docs/ecs/terraform/install.mdx +++ b/website/content/docs/ecs/terraform/install.mdx @@ -1,8 +1,8 @@ -"--- +--- layout: docs page_title: Install with Terraform - Consul on AWS Elastic Container Service (ECS) description: >- - When you install Consul on Amazon Web Services ECS, you can use Terraform modules to simplify the process. Learn how to create task definitions, schedule tasks for your service mesh, and configure routes with example configs. + When you install Consul on Amazon Web Services ECS, you can use Terraform modules to simplify the process. Learn how to create task definitions, schedule tasks for your service mesh, and configure routes with example configurations. --- # Install Consul on AWS Elastic Container Service (ECS) with Terraform diff --git a/website/content/docs/k8s/deployment-configurations/clients-outside-kubernetes.mdx b/website/content/docs/k8s/deployment-configurations/clients-outside-kubernetes.mdx index 1e879e2d0f..c978da82e8 100644 --- a/website/content/docs/k8s/deployment-configurations/clients-outside-kubernetes.mdx +++ b/website/content/docs/k8s/deployment-configurations/clients-outside-kubernetes.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Join External Clients to Consul on Kubernetes description: >- - Client agents running on VMs that are not part of a Kubernetes cluster can join a service mesh that has agents running on k8s pods. Configure client agents to accept gRPC communication to join VMs to Kubernetes pods. + Client agents running on VMs can join a Consul datacenter running on Kubernetes. Configure the Kubernetes installation to accept communication from external clients. --- # Join External Clients to Consul on Kubernetes diff --git a/website/content/docs/lambda/index.mdx b/website/content/docs/lambda/index.mdx index fd7ca7becb..8177c73efe 100644 --- a/website/content/docs/lambda/index.mdx +++ b/website/content/docs/lambda/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Consul and AWS Lambda Overview description: >- - Consul supports Amazon Web Services Lambda functions, which are event-driven programs and scripts that return a response. Learn about Consul's requirements for registering and invoking AWS Lambda functions in your service mesh. + Consul supports Amazon Web Services Lambda functions, which are event-driven programs and scripts. Learn about Consul's requirements for registering and invoking AWS Lambda functions in your service mesh. --- # Consul and AWS Lambda Overview diff --git a/website/content/docs/security/acl/auth-methods/index.mdx b/website/content/docs/security/acl/auth-methods/index.mdx index dea864f046..fab5d30190 100644 --- a/website/content/docs/security/acl/auth-methods/index.mdx +++ b/website/content/docs/security/acl/auth-methods/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Auth Methods Overview description: >- - An auth method enables Consul to authenticate an application's identity and then automatically assign it ACL tokens associated with specific policies. Learn how the overall login process works and how auth methods and binding rules can help you secure your service mesh with minimal operator intervention. + An auth method enables Consul to authenticate the identity of a user or application and then automatically provision an ACL token with privileges based on identity attributes. Learn how the overall login process works and how auth methods and binding rules can help you secure your service mesh with minimal operator intervention. --- # Auth Methods Overview diff --git a/website/content/docs/security/acl/auth-methods/jwt.mdx b/website/content/docs/security/acl/auth-methods/jwt.mdx index adf685e3ef..c60a63b57d 100644 --- a/website/content/docs/security/acl/auth-methods/jwt.mdx +++ b/website/content/docs/security/acl/auth-methods/jwt.mdx @@ -2,7 +2,7 @@ layout: docs page_title: JSON Web Token (JWT) Auth Method description: >- - Use the JWT auth method to authenticate to Consul with a JSON web token. Learn how to configure the auth method parameters using this reference page and example configuration. + Use the JWT auth method to authenticate to Consul with a JSON web token and receive an ACL token with privileges based on JWT identity attributes. Learn how to configure the auth method parameters using this reference page and example configuration. --- # JSON Web Token (JWT) Auth Method diff --git a/website/content/docs/security/acl/auth-methods/kubernetes.mdx b/website/content/docs/security/acl/auth-methods/kubernetes.mdx index bdddc50146..a842d92cbe 100644 --- a/website/content/docs/security/acl/auth-methods/kubernetes.mdx +++ b/website/content/docs/security/acl/auth-methods/kubernetes.mdx @@ -2,7 +2,7 @@ layout: docs page_title: Kubernetes Auth Method description: >- - Use the Kubernetes auth method type to authenticate to Consul with a Kubernetes service account token. Learn how to configure auth method parameters using this reference page and example configuration. + Use the Kubernetes auth method type to authenticate to Consul with a Kubernetes service account token and receive an ACL token with privileges based on JWT identity attributes. Learn how to configure auth method parameters using this reference page and example configuration. --- # Kubernetes Auth Method