From baa6dac25e958e93c60eb70fb68025bf96332101 Mon Sep 17 00:00:00 2001 From: ehearneredhat Date: Thu, 25 Jul 2024 13:51:31 +0100 Subject: [PATCH 1/3] add quiet mode to single cluster doc Signed-off-by: ehearneredhat --- docs/getting-started-single-cluster.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/getting-started-single-cluster.md b/docs/getting-started-single-cluster.md index c0e96a68..7134f11b 100644 --- a/docs/getting-started-single-cluster.md +++ b/docs/getting-started-single-cluster.md @@ -22,6 +22,17 @@ In this quick start, we will cover: |------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------| | `ISTIO_INSTALL_SAIL` | `true` | Whether to install istio through project sail, default `false` | + +### Quiet Mode + +Quiet mode is useful for when you wish to run the script uninterrupted. Below outlines the env vars needed to use quiet mode. These flags can be set alongside other env vars listed below to take advantage of their features: + +| Env Var | Example Value | Description | +|---------|---------------|-------------| +| `KUADRANT_QUIET` | `true` | Runs uninterrupted quickstart in single cluster mode with no DNS provider if set on its own .| +| `DNS_PROVIDER` | `true` | Runs uninterrupted quickstart in single cluster mode with DNS provider if set alongside `KUADRANT_QUIET` . | +| `MULTICLUSTER` | `true` | Runs quickstart uninterrupted in multicluster mode with DNS provider if `DNS_PROVIDER` and `KUADRANT_QUIET` are set; otherwise, runs without DNS provider if only `KUADRANT_QUIET` is set. | + If you want to make use of the Kuadrant `DNSPolicy` you should setup the following environmental variables depending on your DNS Provider: ### AWS From d0b85fb89a4529e7a500b843e51b6e77ea0a8030 Mon Sep 17 00:00:00 2001 From: ehearneredhat Date: Thu, 25 Jul 2024 15:00:53 +0100 Subject: [PATCH 2/3] move multicluster var to multicluster setup Signed-off-by: ehearneredhat --- docs/getting-started-single-cluster.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting-started-single-cluster.md b/docs/getting-started-single-cluster.md index 7134f11b..fe13f889 100644 --- a/docs/getting-started-single-cluster.md +++ b/docs/getting-started-single-cluster.md @@ -31,7 +31,8 @@ Quiet mode is useful for when you wish to run the script uninterrupted. Below ou |---------|---------------|-------------| | `KUADRANT_QUIET` | `true` | Runs uninterrupted quickstart in single cluster mode with no DNS provider if set on its own .| | `DNS_PROVIDER` | `true` | Runs uninterrupted quickstart in single cluster mode with DNS provider if set alongside `KUADRANT_QUIET` . | -| `MULTICLUSTER` | `true` | Runs quickstart uninterrupted in multicluster mode with DNS provider if `DNS_PROVIDER` and `KUADRANT_QUIET` are set; otherwise, runs without DNS provider if only `KUADRANT_QUIET` is set. | + +Additional env vars for quiet mode are available in [multicluster setup](getting-started-multi-cluster.md). If you want to make use of the Kuadrant `DNSPolicy` you should setup the following environmental variables depending on your DNS Provider: From a948cd7aeb508dbc2d1cc5fb333e75c6e93099a7 Mon Sep 17 00:00:00 2001 From: ehearneredhat Date: Thu, 25 Jul 2024 15:01:29 +0100 Subject: [PATCH 3/3] Add quiet mode info to multi cluster Signed-off-by: ehearneredhat --- docs/getting-started-multi-cluster.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/getting-started-multi-cluster.md b/docs/getting-started-multi-cluster.md index ceaddd12..d618662f 100644 --- a/docs/getting-started-multi-cluster.md +++ b/docs/getting-started-multi-cluster.md @@ -13,7 +13,13 @@ It can be used for adding 1 or more clusters to your local setup. ### Environmental Variables The same environment variable requirements from the [Single-cluster Quick Start](./getting-started-single-cluster.md) apply to this document, -including the `KUADRANT_REF` variable. +including the `KUADRANT_REF` variable. Read below for additional environmental variables that can be used with multicluster setup. + +### Quiet Mode (additional) + +| Env Var | Example Value | Description | +|---------|---------------|-------------| +| `MULTICLUSTER` | `true` | Runs quickstart uninterrupted in multicluster mode with DNS provider if `DNS_PROVIDER` and `KUADRANT_QUIET` are set; otherwise, runs without DNS provider if only `KUADRANT_QUIET` is set. Refer to [single cluster](getting-started-single-cluster.md) for information on these environmental variables . | ### Set Up a kind cluster and install Kuadrant