From 0a4e683708db32e2667884a45068472b0d15f228 Mon Sep 17 00:00:00 2001 From: "R.B. Boyer" Date: Wed, 21 Aug 2019 16:23:08 -0500 Subject: [PATCH] docs: remove beta references; leave version notation (#6372) --- website/source/api/discovery-chain.html.md | 4 +++- .../config-entries/proxy-defaults.html.md | 4 ++-- .../config-entries/service-defaults.html.md | 18 ++++++++---------- .../config-entries/service-resolver.html.md | 6 ++++-- .../config-entries/service-router.html.md | 6 ++++-- .../config-entries/service-splitter.html.md | 6 ++++-- .../source/docs/agent/config_entries.html.md | 6 +++--- website/source/docs/agent/services.html.md | 2 +- .../docs/connect/l7-traffic-management.html.md | 14 ++++++++------ .../source/docs/connect/mesh_gateway.html.md | 6 ++++-- website/source/docs/connect/proxies/envoy.md | 2 +- .../registration/service-registration.html.md | 2 +- .../docs/internals/discovery-chain.html.md | 4 +++- website/source/docs/internals/index.html.md | 2 +- website/source/downloads.html.erb | 7 ------- website/source/layouts/api.erb | 2 +- website/source/layouts/docs.erb | 12 ++++++------ 17 files changed, 54 insertions(+), 49 deletions(-) diff --git a/website/source/api/discovery-chain.html.md b/website/source/api/discovery-chain.html.md index 8c4f489682..d3b9f7ef62 100644 --- a/website/source/api/discovery-chain.html.md +++ b/website/source/api/discovery-chain.html.md @@ -6,7 +6,9 @@ description: |- The /discovery-chain endpoints are for interacting with the discovery chain. --- -# Discovery Chain HTTP Endpoint beta +-> **1.6.0+:** The discovery chain API is available in Consul versions 1.6.0 and newer. + +# Discovery Chain HTTP Endpoint ~> This is a low-level API primarily targeted at developers building external [Connect proxy integrations](/docs/connect/proxies/integrate.html). Future diff --git a/website/source/docs/agent/config-entries/proxy-defaults.html.md b/website/source/docs/agent/config-entries/proxy-defaults.html.md index 2229456451..bf9b40c10e 100644 --- a/website/source/docs/agent/config-entries/proxy-defaults.html.md +++ b/website/source/docs/agent/config-entries/proxy-defaults.html.md @@ -49,9 +49,9 @@ config { * [Envoy](/docs/connect/proxies/envoy.html#bootstrap-configuration) * [Consul's built-in proxy](/docs/connect/proxies/built-in.html) -- `MeshGateway` (beta) `(MeshGatewayConfig: )` - Controls the default +- `MeshGateway` `(MeshGatewayConfig: )` - Controls the default [mesh gateway configuration](/docs/connect/mesh_gateway.html#connect-proxy-configuration) - for all proxies. + for all proxies. Added in v1.6.0. - `Mode` `(string: "")` - One of `none`, `local`, or `remote`. diff --git a/website/source/docs/agent/config-entries/service-defaults.html.md b/website/source/docs/agent/config-entries/service-defaults.html.md index c0fb09a3bc..34b782107a 100644 --- a/website/source/docs/agent/config-entries/service-defaults.html.md +++ b/website/source/docs/agent/config-entries/service-defaults.html.md @@ -29,22 +29,20 @@ Protocol = "http" - `Protocol` `(string: "tcp")` - Sets the protocol of the service. This is used by Connect proxies for things like observability features and to unlock usage - of the [`service-splitter` - (beta)](/docs/agent/config-entries/service-splitter.html) and - [`service-router` - (beta)](/docs/agent/config-entries/service-router.html) config + of the [`service-splitter`](/docs/agent/config-entries/service-splitter.html) and + [`service-router`](/docs/agent/config-entries/service-router.html) config entries for a service. -- `MeshGateway` (beta) `(MeshGatewayConfig: )` - Controls the default +- `MeshGateway` `(MeshGatewayConfig: )` - Controls the default [mesh gateway configuration](/docs/connect/mesh_gateway.html#connect-proxy-configuration) - for this service. + for this service. Added in v1.6.0. - `Mode` `(string: "")` - One of `none`, `local`, or `remote`. -- `ExternalSNI` (beta) `(string: "")` - This is an optional setting - that allows for the TLS - [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication) value to be - changed to a non-connect value when federating with an external system. +- `ExternalSNI` `(string: "")` - This is an optional setting that allows for + the TLS [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication) value to + be changed to a non-connect value when federating with an external system. + Added in v1.6.0. ## ACLs diff --git a/website/source/docs/agent/config-entries/service-resolver.html.md b/website/source/docs/agent/config-entries/service-resolver.html.md index 7c17a7caeb..95290a2ab5 100644 --- a/website/source/docs/agent/config-entries/service-resolver.html.md +++ b/website/source/docs/agent/config-entries/service-resolver.html.md @@ -1,12 +1,14 @@ --- layout: "docs" -page_title: "Configuration Entry Kind: Service Resolver (beta)" +page_title: "Configuration Entry Kind: Service Resolver" sidebar_current: "docs-agent-cfg_entries-service_resolver" description: |- The `service-resolver` config entry kind controls which service instances should satisfy Connect upstream discovery requests for a given service name. --- -# Service Resolver (beta) +-> **1.6.0+:** This config entry is available in Consul versions 1.6.0 and newer. + +# Service Resolver The `service-resolver` config entry kind controls which service instances should satisfy Connect upstream discovery requests for a given service name. diff --git a/website/source/docs/agent/config-entries/service-router.html.md b/website/source/docs/agent/config-entries/service-router.html.md index c67d5d5a53..a0ffc52898 100644 --- a/website/source/docs/agent/config-entries/service-router.html.md +++ b/website/source/docs/agent/config-entries/service-router.html.md @@ -1,12 +1,14 @@ --- layout: "docs" -page_title: "Configuration Entry Kind: Service Router (beta)" +page_title: "Configuration Entry Kind: Service Router" sidebar_current: "docs-agent-cfg_entries-service_router" description: |- The service-router config entry kind controls Connect traffic routing and manipulation at networking layer 7 (e.g. HTTP). --- -# Service Router (beta) +-> **1.6.0+:** This config entry is available in Consul versions 1.6.0 and newer. + +# Service Router The `service-router` config entry kind controls Connect traffic routing and manipulation at networking layer 7 (e.g. HTTP). diff --git a/website/source/docs/agent/config-entries/service-splitter.html.md b/website/source/docs/agent/config-entries/service-splitter.html.md index 778d24cf48..e9ba3ddf1a 100644 --- a/website/source/docs/agent/config-entries/service-splitter.html.md +++ b/website/source/docs/agent/config-entries/service-splitter.html.md @@ -1,12 +1,14 @@ --- layout: "docs" -page_title: "Configuration Entry Kind: Service Splitter (beta)" +page_title: "Configuration Entry Kind: Service Splitter" sidebar_current: "docs-agent-cfg_entries-service_splitter" description: |- The service-splitter config entry kind controls how to split incoming Connect requests across different subsets of a single service (like during staged canary rollouts), or perhaps across different services (like during a v2 rewrite or other type of codebase migration). --- -# Service Splitter (beta) +-> **1.6.0+:** This config entry is available in Consul versions 1.6.0 and newer. + +# Service Splitter The `service-splitter` config entry kind controls how to split incoming Connect requests across different subsets of a single service (like during staged diff --git a/website/source/docs/agent/config_entries.html.md b/website/source/docs/agent/config_entries.html.md index 7a6323e2ab..6caa6133df 100644 --- a/website/source/docs/agent/config_entries.html.md +++ b/website/source/docs/agent/config_entries.html.md @@ -24,13 +24,13 @@ Name = "" The supported `Kind` names for configuration entries are: -* [`service-router` (beta)](/docs/agent/config-entries/service-router.html) - defines +* [`service-router`](/docs/agent/config-entries/service-router.html) - defines where to send layer 7 traffic based on the HTTP route -* [`service-splitter` (beta)](/docs/agent/config-entries/service-splitter.html) - defines +* [`service-splitter`](/docs/agent/config-entries/service-splitter.html) - defines how to divide requests for a single HTTP route based on percentages -* [`service-resolver` (beta)](/docs/agent/config-entries/service-resolver.html) - matches +* [`service-resolver`](/docs/agent/config-entries/service-resolver.html) - matches service instances with a specific Connect upstream discovery requests * [`service-defaults`](/docs/agent/config-entries/service-defaults.html) - configures diff --git a/website/source/docs/agent/services.html.md b/website/source/docs/agent/services.html.md index 18a19ecfc2..7f55175271 100644 --- a/website/source/docs/agent/services.html.md +++ b/website/source/docs/agent/services.html.md @@ -144,7 +144,7 @@ deprecated and has been removed as of Consul 1.1. The `kind` field is used to optionally identify the service as a [Connect proxy](/docs/connect/proxies.html) instance with the value `connect-proxy` or -a [Mesh Gateway(beta)](/docs/connect/mesh_gateway.html) instance with the value `mesh-gateway`. For +a [Mesh Gateway](/docs/connect/mesh_gateway.html) instance with the value `mesh-gateway`. For typical non-proxy instances the `kind` field must be omitted. The `proxy` field is also required for Connect proxy registrations and is only valid if `kind` is `connect-proxy`. The only required `proxy` field is `destination_service_name`. diff --git a/website/source/docs/connect/l7-traffic-management.html.md b/website/source/docs/connect/l7-traffic-management.html.md index e64d828d0f..4c2d6d8c14 100644 --- a/website/source/docs/connect/l7-traffic-management.html.md +++ b/website/source/docs/connect/l7-traffic-management.html.md @@ -1,17 +1,14 @@ --- layout: "docs" -page_title: "Connect - L7 Traffic Management (beta)" +page_title: "Connect - L7 Traffic Management" sidebar_current: "docs-connect-l7_traffic_management" description: |- Layer 7 traffic management allows operators to divide L7 traffic between different subsets of service instances when using Connect. --- -# L7 Traffic Management (beta) +-> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer. --> **Note:** This feature is not compatible with the -[built-in proxy](/docs/connect/proxies/built-in.html), -[native proxies](/docs/connect/native.html), -and some [Envoy proxy escape hatches](/docs/connect/proxies/envoy.html#escape-hatch-overrides). +# L7 Traffic Management Layer 7 traffic management allows operators to divide L7 traffic between different @@ -25,6 +22,11 @@ Canary testing, A/B tests, blue/green deploys, and soft multi-tenancy carving out portions of the Consul catalog smaller than the level of a single service and configuring when that subset should receive traffic. +-> **Note:** This feature is not compatible with the +[built-in proxy](/docs/connect/proxies/built-in.html), +[native proxies](/docs/connect/native.html), +and some [Envoy proxy escape hatches](/docs/connect/proxies/envoy.html#escape-hatch-overrides). + ## Stages Connect proxy upstreams are discovered using a series of stages: routing, diff --git a/website/source/docs/connect/mesh_gateway.html.md b/website/source/docs/connect/mesh_gateway.html.md index c050f24aa4..a6eb8cf247 100644 --- a/website/source/docs/connect/mesh_gateway.html.md +++ b/website/source/docs/connect/mesh_gateway.html.md @@ -1,12 +1,14 @@ --- layout: "docs" -page_title: "Connect - Mesh Gateways (beta)" +page_title: "Connect - Mesh Gateways" sidebar_current: "docs-connect-meshgateways" description: |- A Mesh Gateway enables better routing of a Connect service's data to upstreams in other datacenters. This section details how to use Envoy and describes how you can plug in a gateway of your choice. --- -# Mesh Gateways (beta) +-> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer. + +# Mesh Gateways Mesh gateways enable routing of Connect traffic between different Consul datacenters. Those datacenters can reside in different clouds or runtime environments where general interconnectivity between all services diff --git a/website/source/docs/connect/proxies/envoy.md b/website/source/docs/connect/proxies/envoy.md index d6ec4a90f0..5b1bcbbbc0 100644 --- a/website/source/docs/connect/proxies/envoy.md +++ b/website/source/docs/connect/proxies/envoy.md @@ -252,7 +252,7 @@ definition](/docs/connect/registration/service-registration.html) or proxy upstream config will override any values defined in config entries. It is supported here for backwards compatibility with Consul versions prior to 1.6.0. -### Mesh Gateway Options (beta) +### Mesh Gateway Options These fields may also be overridden explicitly in the [proxy service definition](/docs/connect/registration/service-registration.html), or defined in diff --git a/website/source/docs/connect/registration/service-registration.html.md b/website/source/docs/connect/registration/service-registration.html.md index 377ad3d264..994c7a607f 100644 --- a/website/source/docs/connect/registration/service-registration.html.md +++ b/website/source/docs/connect/registration/service-registration.html.md @@ -187,7 +187,7 @@ followed by documentation for each attribute. for this proxy. The format is defined in the [Mesh Gateway Configuration Reference](#mesh-gateway-configuration-reference). -### Mesh Gateway Configuration Reference (beta) +### Mesh Gateway Configuration Reference The following examples show all possible mesh gateway configurations. diff --git a/website/source/docs/internals/discovery-chain.html.md b/website/source/docs/internals/discovery-chain.html.md index 53296dfed0..91193e67ec 100644 --- a/website/source/docs/internals/discovery-chain.html.md +++ b/website/source/docs/internals/discovery-chain.html.md @@ -6,7 +6,9 @@ description: |- The service discovery process can be modeled as a "discovery chain" which passes through three distinct stages: routing, splitting, and resolution. Each of these stages is controlled by a set of configuration entries. --- -# Discovery Chain beta +-> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer. + +# Discovery Chain ~> This topic is part of a [low-level API](/api/discovery-chain.html) primarily targeted at developers building external [Connect proxy diff --git a/website/source/docs/internals/index.html.md b/website/source/docs/internals/index.html.md index 9ddf171e59..208882c31e 100644 --- a/website/source/docs/internals/index.html.md +++ b/website/source/docs/internals/index.html.md @@ -20,7 +20,7 @@ Please review the following documentation to understand how Consul works. * [Sessions](/docs/internals/sessions.html) * [Anti-Entropy](/docs/internals/anti-entropy.html) * [Security Model](/docs/internals/security.html) -* [Discovery Chain beta](/docs/internals/discovery-chain.html) +* [Discovery Chain](/docs/internals/discovery-chain.html) You should also be familiar with [Jepsen testing](/docs/internals/jepsen.html), before deploying a production datacenter. diff --git a/website/source/downloads.html.erb b/website/source/downloads.html.erb index 17e3792965..6c79b43e22 100644 --- a/website/source/downloads.html.erb +++ b/website/source/downloads.html.erb @@ -8,13 +8,6 @@ description: |-

Download Consul

- - -
diff --git a/website/source/layouts/api.erb b/website/source/layouts/api.erb index 8dbec5b683..19c8732d01 100644 --- a/website/source/layouts/api.erb +++ b/website/source/layouts/api.erb @@ -82,7 +82,7 @@ Coordinates > - Discovery Chain (beta) + Discovery Chain > Events diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index d3ac8f16e5..3c376d7790 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -63,7 +63,7 @@ Jepsen Testing > - Discovery Chain beta + Discovery Chain @@ -419,13 +419,13 @@ Configuration Entries > - Mesh Gateways (beta) + Mesh Gateways > Registering Proxies