diff --git a/docs/getting-started-single-cluster.md b/docs/getting-started-single-cluster.md index c0e96a68..cd5a1ac4 100644 --- a/docs/getting-started-single-cluster.md +++ b/docs/getting-started-single-cluster.md @@ -10,6 +10,7 @@ In this quick start, we will cover: - [Docker](https://docs.docker.com/engine/install/) - [Kind](https://kind.sigs.k8s.io/) - [Kubectl](https://kubernetes.io/docs/tasks/tools/) +- [Helm](https://helm.sh/) - OpenSSL >= 3 - AWS account with Route 53 enabled or GCP with Cloud DNS enabled - [Docker Mac Net Connect](https://github.com/chipmk/docker-mac-net-connect) (macOS users only) @@ -18,31 +19,32 @@ In this quick start, we will cover: ### Environmental Variables ### General -| Env Var | Example Value | Description | -|------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------| -| `ISTIO_INSTALL_SAIL` | `true` | Whether to install istio through project sail, default `false` | +| Env Var | Example Value | Description | +|----------------------|---------------|--------------------------------------------------------------------------------------------------------------| +| `ISTIO_INSTALL_SAIL` | `false` | Whether to install istio through project sail, default `true` | +| `SAIL_VERSION` | `0.1.0` | Version of the [sail-operator](https://github.com/istio-ecosystem/sail-operator) to install, default `0.1.0` | If you want to make use of the Kuadrant `DNSPolicy` you should setup the following environmental variables depending on your DNS Provider: ### AWS -| Env Var | Example Value | Description | -|------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------| +| Env Var | Example Value | Description | +|-----------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------| | `KUADRANT_ZONE_ROOT_DOMAIN` | `jbloggs.hcpapps.net` | Hostname for the root Domain | -| `KUADRANT_AWS_DNS_PUBLIC_ZONE_ID` | `Z01234567US0IQE3YLO00` | AWS Route 53 Zone ID for specified `KUADRANT_ZONE_ROOT_DOMAIN` | +| `KUADRANT_AWS_DNS_PUBLIC_ZONE_ID` | `Z01234567US0IQE3YLO00` | AWS Route 53 Zone ID for specified `KUADRANT_ZONE_ROOT_DOMAIN` | | `KUADRANT_AWS_ACCESS_KEY_ID` | `AKIA1234567890000000` | Access Key ID, for user with permissions to Route 53 in the account where root domain is created | | `KUADRANT_AWS_SECRET_ACCESS_KEY` | `Z01234567US0000000` | Access Secret Access Key, for user with permissions to Route 53 in the account where root domain is created | | `KUADRANT_AWS_REGION` | `eu-west-1` | AWS Region | ### GCP -| Env Var | Example Value | Description | -|-------------------------|------------------------|----------------------------------------------------------------| -| `GOOGLE` | `{"client_id": "00000000-00000000000000.apps.googleusercontent.com","client_secret": "d-FL95Q00000000000000","refresh_token": "00000aaaaa00000000-AAAAAAAAAAAAKFGJFJDFKDK","type": "authorized_user"}` | This is the JSON created from either the JSON credentials created by the Google Cloud CLI or a Service account | -| `PROJECT_ID` | `my_project_id` | ID to the google project | -| `ZONE_NAME` | `jbloggs-google` | Zone name | -| `ZONE_DNS_NAME` | `jbloggs.google.hcpapps.net` | DNS name | -| `LOG_LEVEL` | `1` | Log level for the Controller | +| Env Var | Example Value | Description | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| +| `GOOGLE` | `{"client_id": "00000000-00000000000000.apps.googleusercontent.com","client_secret": "d-FL95Q00000000000000","refresh_token": "00000aaaaa00000000-AAAAAAAAAAAAKFGJFJDFKDK","type": "authorized_user"}` | This is the JSON created from either the JSON credentials created by the Google Cloud CLI or a Service account | +| `PROJECT_ID` | `my_project_id` | ID to the google project | +| `ZONE_NAME` | `jbloggs-google` | Zone name | +| `ZONE_DNS_NAME` | `jbloggs.google.hcpapps.net` | DNS name | +| `LOG_LEVEL` | `1` | Log level for the Controller | >Alternatively, to set defaults, add the above environment variables to your `.zshrc` or `.bash_profile`. @@ -50,7 +52,6 @@ If you want to make use of the Kuadrant `DNSPolicy` you should setup the followi ```bash export KUADRANT_REF=main -export ISTIO_INSTALL_SAIL=true ``` ### Set Up a kind cluster and install Kuadrant