Browse Source

docs: v1.19 corrections (#21324)

* release notes

* Usage pages fixes
pull/21331/head
Jeff Boruszak 5 months ago committed by GitHub
parent
commit
895e7f86f3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 2
      website/content/docs/k8s/connect/terminating-gateways.mdx
  2. 4
      website/content/docs/k8s/deployment-configurations/external-service.mdx
  3. 2
      website/content/docs/release-notes/consul-k8s/v1_5_x.mdx
  4. 2
      website/content/docs/release-notes/consul/v1_19_x.mdx

2
website/content/docs/k8s/connect/terminating-gateways.mdx

@ -102,7 +102,7 @@ Registering the external services with Consul is a multi-step process:
You may register an external service with Consul using `ServiceDefaults` if
[`TransparentProxy`](/consul/docs/connect/transparent-proxy) is enabled. Otherwise,
you may register the service as a node in the Consul catalog.
you may register the service as a node in the Consul catalog using the [`Registration` CRD](/consul/docs/connect/config-entries/registration).
<Tabs>
<Tab heading="Using ServiceDefaults and TransparentProxy">

4
website/content/docs/k8s/deployment-configurations/external-service.mdx

@ -22,7 +22,9 @@ The process to register an external service in Consul on Kubernetes consists of
1. [Start Consul ESM](/consul/tutorials/connect-services/service-registration-external-services#monitor-the-external-service-with-consul-esm). You must use Consul ESM to run health checks on external services.
1. Define the external service and its health checks in a [`Registration` CRD](/consul/docs/connect/config-entries/registration).
1. Apply the CRD to your Kubernetes cluster. Internally, this action triggers an API call to Consul's [`/catalog/register` endpoint](/consul/api-docs/catalog#register-entity) to register the service.
1. When using Consul's service mesh, define [service intentions](/consul/docs/connect/intentions) between the external service and services it communicates with.
1. When using Consul's service mesh, you should also:
- Deploy a [terminating gateway](/consul/docs/k8s/connect/terminating-gateways) so that downstream services can communicate with the external service.
- Define [service intentions](/consul/docs/connect/intentions) for the external service and the downstream services that communicate with it.
## Guidance

2
website/content/docs/release-notes/consul-k8s/v1_5_x.mdx

@ -11,7 +11,7 @@ We are pleased to announce the following Consul updates.
## Release highlights
- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). The CRD removes the requirement to deploy a terminating gateway in order to register a service running on an external node in Consul on Kubernetes, but a terminating gateway is still required to make the external service available to downstream services in the service mesh. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information.
- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). This CRD changes the workflow to register a service running on an external node with the Consul catalog. A terminating gateway is still required to enable downstream services in the service mesh to communicate with external services. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information.
- **File system certificate**: A new [`file-system-certificate` configuration entry](/consul/docs/connect/config-entries/file-system-certificate) for Consul API Gateway on VMs supports specifying a filepath to the certificate and private key on the local system. Consul on Kubernetes deployments that use `consul-k8s` Helm chart v1.5.0 or later use file system certificates instead of inline certificates without additional configuration. For information about certificate configuration for Kubernetes environments, refer to [Gateway Resource Configuration](/consul/docs/connect/gateways/api-gateway/configuration/gateway).

2
website/content/docs/release-notes/consul/v1_19_x.mdx

@ -11,7 +11,7 @@ We are pleased to announce the following Consul updates.
## Release highlights
- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). The CRD removes the requirement to deploy a terminating gateway in order to register a service running on an external node in Consul on Kubernetes, but a terminating gateway is still required to make the external service available to downstream services in the service mesh. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information.
- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). This CRD changes the workflow to register a service running on an external node with the Consul catalog. A terminating gateway is still required to enable downstream services in the service mesh to communicate with external services. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information.
- **Transparent Proxy on Nomad**: Consul’s CNI plugin enables the use of transparent proxy for seamlessly redirecting traffic through the Envoy proxy without requiring application changes, or elevated network privileges for the workload. As a result, you can onboard applications without additional configuration between a service and its upstreams.

Loading…
Cancel
Save