From 50b238addc9edf32715691a9abc96e622442a994 Mon Sep 17 00:00:00 2001 From: boruszak Date: Fri, 23 Sep 2022 15:59:02 -0500 Subject: [PATCH] /docs/api-gateway/configuration /docs/api-gateway/ --- .../docs/api-gateway/configuration/gateway.mdx | 8 ++++---- .../docs/api-gateway/configuration/gatewayclass.mdx | 8 ++++---- .../api-gateway/configuration/gatewayclassconfig.mdx | 8 ++++---- .../content/docs/api-gateway/configuration/index.mdx | 8 ++++---- .../docs/api-gateway/configuration/meshservice.mdx | 8 ++++---- .../docs/api-gateway/configuration/routes.mdx | 12 ++++++------ website/content/docs/api-gateway/index.mdx | 4 ++-- website/content/docs/api-gateway/install.mdx | 4 ++-- website/content/docs/api-gateway/tech-specs.mdx | 4 ++-- website/content/docs/api-gateway/upgrades.mdx | 6 +++--- website/content/docs/api-gateway/usage.mdx | 9 ++++----- 11 files changed, 39 insertions(+), 40 deletions(-) diff --git a/website/content/docs/api-gateway/configuration/gateway.mdx b/website/content/docs/api-gateway/configuration/gateway.mdx index 240b19721d..5186a940b2 100644 --- a/website/content/docs/api-gateway/configuration/gateway.mdx +++ b/website/content/docs/api-gateway/configuration/gateway.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Consul API Gateway Gateway -description: >- - This topic describes how to configure the Consul API Gateway Gateway object +page_title: Gateway Resource Configuration +description: >- + Learn how to configure the `Gateway` resource to define how the Consul API Gateway handles incoming service mesh traffic with this configuration model and reference specifications. --- -# Gateway +# Gateway Resource Configuration This topic provides full details about the `Gateway` resource. diff --git a/website/content/docs/api-gateway/configuration/gatewayclass.mdx b/website/content/docs/api-gateway/configuration/gatewayclass.mdx index dc366d4c05..2ef711efdf 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclass.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclass.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Consul API Gateway GatewayClass -description: >- - Consul API Gateway GatewayClass +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. --- -# GatewayClass +# GatewayClass Resource Configuration This topic provides describes how to configure the `GatewayClass` resource, a generic Kubernetes gateway object used as a template for creating `Gateway` resources. diff --git a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx index 58f7af80d4..44f21fe918 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Consul API Gateway GatewayClassConfig -description: >- - Consul API Gateway GatewayClassConfig +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. --- -# GatewayClassConfig +# GatewayClassConfig Resource Configuration This topic provides full details about the `GatewayClassConfig` resource. diff --git a/website/content/docs/api-gateway/configuration/index.mdx b/website/content/docs/api-gateway/configuration/index.mdx index 630f26ab93..aa9b571d23 100644 --- a/website/content/docs/api-gateway/configuration/index.mdx +++ b/website/content/docs/api-gateway/configuration/index.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Consul API Gateway Configuration -description: >- - Consul API Gateway Configuration +page_title: Consul API Gateway Configuration - Overview +description: >- + Configure your Consul API Gateway to manage traffic into your service mesh. Learn about the Kubernetes Gateway Specification items you can configure and how to configure custom API Gateways. --- -# Configuration +# Consul API Gateway Configuration Overview This topic provides an overview of the configuration items that enable Consul API Gateway to manage traffic into your Consul service mesh. diff --git a/website/content/docs/api-gateway/configuration/meshservice.mdx b/website/content/docs/api-gateway/configuration/meshservice.mdx index 0307b3a4be..2dd377fb68 100644 --- a/website/content/docs/api-gateway/configuration/meshservice.mdx +++ b/website/content/docs/api-gateway/configuration/meshservice.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Consul API Gateway MeshService -description: >- - This topic describes how to configure the Consul API Gateway MeshService object +page_title: MeshService Resource Configuration +description: >- + The `MeshService` resource specifies a service running outside the Kubernetes cluster but in the same datacenter where the Consul API Gateway is deployed. Learn about its configuration model and reference specifications. --- -# MeshService +# MeshService Resource Configuration This topic provides full details about the `MeshService` resource. diff --git a/website/content/docs/api-gateway/configuration/routes.mdx b/website/content/docs/api-gateway/configuration/routes.mdx index be711b32ee..0053775cbf 100644 --- a/website/content/docs/api-gateway/configuration/routes.mdx +++ b/website/content/docs/api-gateway/configuration/routes.mdx @@ -1,11 +1,11 @@ ---- +"--- layout: docs -page_title: Consul API Gateway Routes -description: >- - Consul API Gateway Routes ---- +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. +---" -# Route +# Route Resource Configuration This topic describes how to create and configure `Route` resources. Routes are independent configuration objects that are associated with specific listeners. diff --git a/website/content/docs/api-gateway/index.mdx b/website/content/docs/api-gateway/index.mdx index 6702bbc2f3..a58cfd77bf 100644 --- a/website/content/docs/api-gateway/index.mdx +++ b/website/content/docs/api-gateway/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Consul API Gateway Overview -description: >- - Using Consul API gateway functionality +description: >- + Consul API Gateway enables external network client access to a service mesh on Kubernetes and forwards requests based on path or header information. Learn about how the k8s Gateway API specification configures Consul API Gateway so you can control access and simplify traffic management. --- # Consul API Gateway Overview diff --git a/website/content/docs/api-gateway/install.mdx b/website/content/docs/api-gateway/install.mdx index 3d1a542ee8..cae158bc8b 100644 --- a/website/content/docs/api-gateway/install.mdx +++ b/website/content/docs/api-gateway/install.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Install Consul API Gateway -description: >- - Installing 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. --- # Install Consul API Gateway diff --git a/website/content/docs/api-gateway/tech-specs.mdx b/website/content/docs/api-gateway/tech-specs.mdx index 7471d2fd85..f99abd5495 100644 --- a/website/content/docs/api-gateway/tech-specs.mdx +++ b/website/content/docs/api-gateway/tech-specs.mdx @@ -2,10 +2,10 @@ layout: docs page_title: Consul API Gateway Technical Specifications description: >- - This topic describes technical specifications for Consul API Gateway. + Consul API Gateway is a service mesh add-on for Kubernetes deployments. Learn about its requirements for system resources, ports, and component versions, its Enterprise limitations, and compatible k8s cloud environments. --- -# Technical Specifications +# Consul API Gateway Technical Specifications This topic describes the technical specifications associated with using Consul API Gateway. diff --git a/website/content/docs/api-gateway/upgrades.mdx b/website/content/docs/api-gateway/upgrades.mdx index 87a7993152..821a80dce8 100644 --- a/website/content/docs/api-gateway/upgrades.mdx +++ b/website/content/docs/api-gateway/upgrades.mdx @@ -1,11 +1,11 @@ --- layout: docs -page_title: Upgrades +page_title: Upgrade Consul API Gateway description: >- - This topic describes how to upgrade Consul API Gateway. + Upgrade Consul API Gateway to use newly supported features. Learn about the requirements, procedures, and post-configuration changes involved in standard and specific version upgrades. --- -# Upgrades +# Upgrade Consul API Gateway This topic describes how to upgrade Consul API Gateway. diff --git a/website/content/docs/api-gateway/usage.mdx b/website/content/docs/api-gateway/usage.mdx index dd71de9d2b..f5199d0c8f 100644 --- a/website/content/docs/api-gateway/usage.mdx +++ b/website/content/docs/api-gateway/usage.mdx @@ -1,12 +1,11 @@ --- layout: docs -page_title: Consul API Gateway Basic Usage -description: >- - This topic describes how to use Consul API Gateway. +page_title: Use Consul API Gateway +description: >- + Learn how to apply a configured Consul API Gateway to your Kubernetes cluster, review the required fields for rerouting HTTP requests, and troubleshoot an error message. --- - -# Usage +# Use Consul API Gateway This topic describes how to use Consul API Gateway.