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

Jump to bottom

Update the single-cluster quickstart guide for sail changes #144

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Update the single-cluster quickstart guide for sail changes #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7524dd
Update the single-cluster quickstart guide for sail changes
adam-cattermole Nov 4, 2024
6e4b955
Table formatting
adam-cattermole Nov 4, 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
29 changes: 15 additions & 14 deletions docs/getting-started-single-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -18,39 +19,39 @@ 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`.

### Set the release you want to use

```bash
export KUADRANT_REF=main
export ISTIO_INSTALL_SAIL=true
```

### Set Up a kind cluster and install Kuadrant
Expand Down
Loading