-
Notifications
You must be signed in to change notification settings - Fork 465
DOC-994 Istio ingress configuration #1734
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
40b6490
created istio file
kaitlynmichael 7827214
step 1-2
kaitlynmichael 699492c
namespace note, DNS code examples
kaitlynmichael 0ea5c72
adding yaml examples
kaitlynmichael 39c819f
add rest of content and edits
kaitlynmichael 7c338e2
wording edits
kaitlynmichael b233ab0
review feedback
kaitlynmichael 4ad7132
Apply suggestions from code review
kaitlynmichael File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
155 changes: 155 additions & 0 deletions
155
content/kubernetes/re-databases/ingress_routing_with_istio.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
--- | ||
Title: Configure Istio for external routing | ||
linkTitle: Istio ingress routing | ||
description: Configure Istio as an ingress controller for access to your Redis Enterprise databases from outside the Kubernetes cluster. | ||
weight: 25 | ||
alwaysOpen: false | ||
categories: ["Platforms"] | ||
aliases: [ | ||
/kubernetes/re-databases/ingress_routing_with_istio.md, | ||
/kubernetes/re-databases/ingress_routing_with_istio/, | ||
] | ||
--- | ||
|
||
Redis Enterprise for Kubernetes version `6.2.8-tbd` introduces the ability to use an Istio ingress gateway as an alternative to NGINX or HaProxy ingress controllers. | ||
|
||
Istio can also understand ingress resources, but using that mechanism takes away the advantages and options that the native Istio resources provide. Istio offers its own configuration methods using custom resources. | ||
|
||
To configure Istio to work with the Redis Kubernetes operator, we will use two custom resources: a `Gateway` and a `VirtualService`. Then you'll be able to establish external access to your database. | ||
|
||
## Install and configure Istio for Redis Enterprise | ||
|
||
1. [Download](https://istio.io/latest/docs/setup/getting-started/) and [install](https://istio.io/latest/docs/setup/getting-started/) Istio (see instructions from Istio's [Getting Started](https://istio.io/latest/docs/setup/getting-started/) guide). | ||
|
||
Once the installation is complete, all the deployments, pods, and services will be deployed in a namespace called `istio-system`. This namespace contains a `LoadBalancer` type service called `service/istio-ingressgateway` that exposes the external IP address. | ||
|
||
1. Find the `EXTERNAL-IP` for the `istio-ingressgateway` service. | ||
|
||
```sh | ||
kubectl get svc istio-ingressgateway -n istio-system | ||
|
||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE | ||
istio-ingressgateway LoadBalancer 10.34.67.89 10.145.78.91 15021:12345/TCP,80:67891/TCP,443:23456/TCP,31400:78901/TCP,15443:10112/TCP 3h8m | ||
``` | ||
|
||
1. Create a DNS entry that resolves your chosen database hostname (or a wildcard `*` followed by your domain) to the Istio `EXTERNAL-IP`. Use this hostname to access your database from outside the cluster. | ||
|
||
In this example, any hostname that ends with `.istio.k8s.my.redisdemo.com` will resolve to the Istio LoadBalancer's external IP of `12.345.678.910`. Substitute your own values accordingly. | ||
|
||
1. Verify the record was created successfully. | ||
|
||
```sh | ||
dig api.istio.k8s.my.redisdemo.com | ||
``` | ||
|
||
Look in the `ANSWER SECTION` for the record you just created. | ||
|
||
```sh | ||
;; ANSWER SECTION: | ||
api.istio.k8s.my.redisdemo.com. 0 IN A 12.345.678.910 | ||
``` | ||
|
||
## Create custom resources | ||
|
||
### `Gateway` custom resource | ||
|
||
1. On a different namespace from `istio-system`, create a `Gateway` custom resource file (`redis-gateway.yaml`). | ||
|
||
```yaml | ||
apiVersion: networking.istio.io/v1beta1 | ||
kind: Gateway | ||
metadata: | ||
name: redis-gateway | ||
spec: | ||
selector: | ||
istio: ingressgateway | ||
servers: | ||
- hosts: | ||
- '*.istio.k8s.my.redisdemo.com' | ||
port: | ||
name: https | ||
number: 443 | ||
protocol: HTTPS | ||
tls: | ||
mode: PASSTHROUGH | ||
``` | ||
|
||
- Replace `.istio.k8s.my.redisdemo.com` with the domain that matches your DNS record. | ||
- TLS passthrough mode is required to allow secure access to the database. | ||
|
||
1. Apply `gateway.yaml` to create the ingress gateway. | ||
|
||
```sh | ||
kubectl apply -f gateway.yaml | ||
``` | ||
|
||
1. Verify the gateway was created successfully. | ||
|
||
```sh | ||
kubectl get gateway | ||
|
||
NAME AGE | ||
redis-gateway 3h33m | ||
``` | ||
|
||
### `VirtualService` custom resource | ||
|
||
1. On a different namespace than `istio-system`, create the `VirtualService` custom resource file (`redis-vs.yaml`). | ||
|
||
```yaml | ||
apiVersion: networking.istio.io/v1beta1 | ||
kind: VirtualService | ||
metadata: | ||
name: redis-vs | ||
spec: | ||
gateways: | ||
- redis-gateway | ||
hosts: | ||
- "*.istio.k8s.my.redisdemo.com" | ||
tls: | ||
- match: | ||
- port: 443 | ||
sniHosts: | ||
- api.istio.k8s.my.redisdemo.com | ||
route: | ||
- destination: | ||
host: rec | ||
port: | ||
number: 9443 | ||
- match: | ||
- port: 443 | ||
sniHosts: | ||
- db1.istio.k8s..my.redisdemo.com | ||
route: | ||
- destination: | ||
host: db1 | ||
``` | ||
|
||
This creates both a route to contact the API server and a route to contact one of the databases (`db1` in this example). | ||
|
||
- Replace `.istio.k8s.my.redisdemo.com` with the domain that matches your DNS record. | ||
- The gateway's metadata name must be similar to the gateway's spec name (`redis-gateway` in this example). | ||
|
||
1. Apply `redis-vs.yaml` to create the virtual service. | ||
|
||
```sh | ||
kubectl apply -f redis-vs.yaml | ||
``` | ||
|
||
1. Verify the virtual service was created successfully. | ||
|
||
```sh | ||
kubectl get vs | ||
|
||
NAME GATEWAYS HOSTS AGE | ||
redis-vs ["redis-gateway"] ["*.istio.k8s.my.redisdemo.com"] 3h33m | ||
``` | ||
|
||
1. [Deploy the operator]({{<relref "/kubernetes/deployment/quick-start.md">}}), Redis Enterprise Cluster (REC), and Redis Enterprise Database (REDB) on the same namespace as the gateway and virtual service. | ||
|
||
## Test your external access to the database | ||
|
||
To [test your external access]({{<relref "/kubernetes/re-databases/set-up-ingress-controller.md">}}) to the database, you need a client that supports [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) and [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). | ||
|
||
See [Test your access with Openssl]({{<relref "/kubernetes/re-databases/set-up-ingress-controller#test-your-access-with-openssl">}}) or [Test your access with Python]({{<relref "/kubernetes/re-databases/set-up-ingress-controller#test-your-access-with-python">}}) for more info. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.