Skip to content

Commit 932db4d

Browse files
docs: update existing istio gateway guide (#167)
Signed-off-by: Mathew Wicks <[email protected]>
1 parent 1100116 commit 932db4d

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

content/guides/dependencies/istio.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,14 @@ See the [version matrix](../../releases/version-matrix.md#istio) for which versi
283283
If you have an existing Istio [gateway deployment](#gateways), you can use it instead of the deployKF-managed one.
284284
You may do this even when using the deployKF-managed Istio installation.
285285

286-
??? step "Step 1 - Disable embedded Gateway Deployment"
286+
??? step "Step 1 - Use an existing Istio Installation"
287+
288+
To use an existing gateway deployment, you must configure deployKF to use your existing Istio installation.
289+
That is, you cant have deployKF manage the Istio installation.
290+
291+
Follow the steps in [Use an existing Istio Installation](#use-an-existing-istio-installation) to disable the deployKF-managed Istio installation.
292+
293+
??? step "Step 2 - Disable embedded Gateway Deployment"
287294

288295
Disable the embedded gateway deployment by setting the [`deploykf_core.deploykf_istio_gateway.charts.istioGateway.enabled`](https://github.com/deployKF/deployKF/blob/v0.1.4/generator/default_values.yaml#L696) value to `false`:
289296

@@ -297,7 +304,7 @@ You may do this even when using the deployKF-managed Istio installation.
297304
enabled: false
298305
```
299306

300-
??? step "Step 2 - Configure deployKF"
307+
??? step "Step 3 - Configure deployKF"
301308

302309
You must set the following deployKF values to match your existing gateway deployment:
303310

@@ -350,7 +357,7 @@ You may do this even when using the deployKF-managed Istio installation.
350357
# https: 443
351358
```
352359

353-
??? step "Step 3 - Expose your Gateway Deployment"
360+
??? step "Step 4 - Expose your Gateway Deployment"
354361

355362
If you havent already, you will need to create a `Service` (and possibly `Ingress`) that selects your gateway deployment to expose it to external traffic.
356363

content/guides/platform/deploykf-authentication.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -554,6 +554,11 @@ The following guides show provider-specific instructions for configuring Dex [co
554554
insecureSkipEmailVerified: true
555555
```
556556

557+
!!! warning "Use Kubernetes Secrets"
558+
559+
Consider using `configExistingSecret` instead of `config` to avoid storing secrets in your values,
560+
see the [Connector Values](#connector-values) section for more details.
561+
557562
??? steps "Keycloak"
558563

559564
###### Keycloak
@@ -599,6 +604,11 @@ The following guides show provider-specific instructions for configuring Dex [co
599604
#insecureSkipVerify: true
600605
```
601606

607+
!!! warning "Use Kubernetes Secrets"
608+
609+
Consider using `configExistingSecret` instead of `config` to avoid storing secrets in your values,
610+
see the [Connector Values](#connector-values) section for more details.
611+
602612
??? steps "Generic (OpenID Connect)"
603613

604614
###### Generic (OpenID Connect)
@@ -644,6 +654,11 @@ The following guides show provider-specific instructions for configuring Dex [co
644654
insecureSkipEmailVerified: true
645655
```
646656

657+
!!! warning "Use Kubernetes Secrets"
658+
659+
Consider using `configExistingSecret` instead of `config` to avoid storing secrets in your values,
660+
see the [Connector Values](#connector-values) section for more details.
661+
647662
---
648663

649664
## Static User/Password Combinations

0 commit comments

Comments
 (0)