Skip to content
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.

Sign up for GitHub

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

[WIP] 129 the quiet flag feature needs documentation to explain how to use these flags within the quickstart script #131

Closed
wants to merge 3 commits into from
Closed

[WIP] 129 the quiet flag feature needs documentation to explain how to use these flags within the quickstart script #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
baa6dac
add quiet mode to single cluster doc
ehearneRedHat Jul 25, 2024
d0b85fb
move multicluster var to multicluster setup
ehearneRedHat Jul 25, 2024
a948cd7
Add quiet mode info to multi cluster
ehearneRedHat Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/getting-started-multi-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 12 additions & 0 deletions docs/getting-started-single-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ 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` . |

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:

### AWS
Expand Down
Loading