Skip to content

Commit

Permalink
Add ingress gateway deprecation notices to docs (#18102)
Browse files Browse the repository at this point in the history
### Description

This adds notices, that ingress gateway is deprecated, to several places
in the product docs where ingress gateway is the topic.

### Testing & Reproduction steps

Tested with a local copy of the website.

### Links

Deprecation of ingress gateway was announced in the Release Notes for
Consul 1.16 and Consul-K8s 1.2. See:

[https://developer.hashicorp.com/consul/docs/release-notes/consul/v1_16_x#what-s-deprecated](https://developer.hashicorp.com/consul/docs/release-notes/consul/v1_16_x#what-s-deprecated
)

[https://developer.hashicorp.com/consul/docs/release-notes/consul-k8s/v1_2_x#what-s-deprecated](https://developer.hashicorp.com/consul/docs/release-notes/consul-k8s/v1_2_x#what-s-deprecated)

### PR Checklist

* [N/A] updated test coverage
* [X] external facing docs updated
* [X] appropriate backport labels added
* [X] not a security concern

---------

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
  • Loading branch information
Jeff-Apple and trujillo-adam committed Jul 13, 2023
1 parent a2c6953 commit 68863b4
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 8 deletions.
4 changes: 2 additions & 2 deletions website/content/docs/concepts/service-mesh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ The API gateway will route the incoming requests to the respective service. The

A service mesh specializes in the network management of services and the communication between services.
The mesh is responsible for keeping track of services and their health status, IP address, and traffic routing and ensuring all traffic between services is authenticated and encrypted.
Unlike API gateways, a service mesh will track all registered services' lifecycle and ensure requests are routed to healthy instances of the service.
Unlike some API gateways, a service mesh will track all registered services' lifecycle and ensure requests are routed to healthy instances of the service.
API gateways are frequently deployed alongside a load balancer to ensure traffic is directed to healthy and available instances of the service.
The mesh reduces the load balancer footprint as routing responsibilities are handled in a decentralized manner.

API gateways can be used with a service mesh to bridge external networks (non-mesh) with a service mesh.

-> **API gateways and traffic direction:** API gateways are often used to accept north-south traffic. North-south traffic is networking traffic that either enters or exits a data center or a virtual private network (VPC).
-> **API gateways and traffic direction:** API gateways are often used to accept north-south traffic. North-south traffic is networking traffic that either enters or exits a datacenter or a virtual private network (VPC). You can connect API gateways to a service mesh and provide access to it from outside the mesh.
A service mesh is primarily used for handling east-west traffic. East-west traffic traditionally remains inside a data center or a VPC.
A service mesh can be connected to another service mesh in another data center or VPC to form a federated mesh.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ description: >-

# Ingress gateway configuration entry reference

<Note>

Ingress gateway is deprecated and will not be enhanced beyond its current capabilities. Ingress gateway is fully supported in this version but will be removed in a future release of Consul.

Consul's API gateway is the recommended alternative to ingress gateway.

</Note>

This topic provides configuration reference information for the ingress gateway configuration entry. An ingress gateway is a type of proxy you register as a service in Consul to enable network connectivity from external services to services inside of the service mesh. Refer to [Ingress gateways overview](/consul/docs/connect/gateways/ingress-gateway) for additional information.

## Configuration model
Expand Down
34 changes: 29 additions & 5 deletions website/content/docs/connect/gateways/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ This topic provides an overview of the gateway features shipped with Consul. Gat

## Mesh Gateways

-> **1.6.0+:** This feature is available in Consul versions 1.6.0 and newer.

Mesh gateways enable service mesh traffic to be routed between different Consul datacenters and admin partitions. The datacenters or partitions can reside
in different clouds or runtime environments where general interconnectivity between all services in all datacenters
isn't feasible.
Expand All @@ -35,9 +33,37 @@ Mesh gateways enable the following scenarios:

-> **Mesh gateway tutorial**: Follow the [mesh gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-gateways) to learn concepts associated with mesh gateways.

## API Gateways

API gateways enable network access, from outside a service mesh, to services running in a Consul service mesh. The
systems accessing the services in the mesh, may be within your organizational network or external to it. This type of
network traffic is commonly called _north-south_ network traffic because it refers to the flow of data into and out of
a specific environment.

API gateways solve the following primary use cases:

- **Control access at the point of entry**: Set the protocols of external connection
requests and secure inbound connections with TLS certificates from trusted
providers, such as Verisign and Let's Encrypt.
- **Simplify traffic management**: Load balance requests across services and route
traffic to the appropriate service by matching one or more criteria, such as
hostname, path, header presence or value, and HTTP method.

Refer to the following documentation for information on how to configure and deploy API gateways:
- [API Gateways on VMs](/consul/docs/connect/gateways/api-gateway/usage)
- [API Gateways for Kubernetes](/consul/docs/api-gateway).


## Ingress Gateways

-> **1.8.0+:** This feature is available in Consul versions 1.8.0 and newer.
<Note>

Ingress gateway is deprecated and will not be enhanced beyond its current capabilities. Ingress gateway is fully supported
in this version but will be removed in a future release of Consul.

Consul's API gateway is the recommended alternative to ingress gateway.

</Note>

Ingress gateways enable connectivity within your organizational network from services outside the Consul service mesh
to services in the mesh. To accept ingress traffic from the public internet, use Consul's
Expand All @@ -56,8 +82,6 @@ and the [ingress gateway tutorial](/consul/tutorials/developer-mesh/service-mesh

## Terminating Gateways

-> **1.8.0+:** This feature is available in Consul versions 1.8.0 and newer.

Terminating gateways enable connectivity within your organizational network from services in the Consul service mesh
to services outside the mesh.
Services outside the mesh do not have sidecar proxies or are not [integrated natively](/consul/docs/connect/native).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ An ingress gateway is a type of proxy that enables network connectivity from ext

![Ingress Gateway Architecture](/img/ingress-gateways.png)

<Note>

Ingress gateway is deprecated and will not be enhanced beyond its current capabilities. Ingress gateway is fully supported
in this version but will be removed in a future release of Consul.

Consul's API gateway is the recommended alternative to ingress gateway.

</Note>

## Workflow

The following stages describe how to add an ingress gateway to your service mesh:
Expand Down
9 changes: 8 additions & 1 deletion website/content/docs/k8s/connect/ingress-gateways.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ description: >-

# Configure Ingress Gateways for Consul on Kubernetes

-> 1.9.0+: This feature is available in Consul versions 1.9.0 and higher
<Note>

Ingress gateway is deprecated and will not be enhanced beyond its current capabilities. Ingress gateway is fully supported
in this version but will be removed in a future release of Consul.

Consul's API gateway is the recommended alternative to ingress gateway.

</Note>

~> This topic requires familiarity with [Ingress Gateways](/consul/docs/connect/gateways/ingress-gateway).

Expand Down

0 comments on commit 68863b4

Please sign in to comment.