Merge pull request #19 from R-Lawton/update-getting-started

Kuadrant · Sep 13, 2023 · 024f683 · 024f683
2 parents 09385b7 + 5acd789
commit 024f683
Showing 1 changed file with 22 additions and 9 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,31 +1,44 @@
-## Getting started with Kuadrant locally
+## Getting Started
+
 
-We have a quickstart setup script below which will setup and install Kuadrant and its components (Authorino, Limitador and the Multicluster Gateway Controller) into some local `kind` clusters for evaluation.
 ### Prerequisites
 
 - [Docker](https://docs.docker.com/engine/install/)
 - [Kind](https://kind.sigs.k8s.io/)
 - [Kubectl](https://kubernetes.io/docs/tasks/tools/)
 - OpenSSL >= 3
-- AWS account with Route 53 enabled
+- 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)
 
 ### Config
 
-One of Kuadrant's components, the Multicluster Gateway Controller, programs DNS to provide multicluster connectivity and load balaning. As part of setting this up, you'll need to export some environment variables with the keys listed below. Fill in your own values as appropriate. Note that you will need to have created a root domain in AWS using Route 53:
+Export environment variables with the keys listed below for your desired provider. Fill in your own values as appropriate. Note that you will need to have created a root domain in AWS Route 53 or in GCP Cloud DNS:
+
+### AWS
 
 | Env Var                      | Example Value               | Description                                                    |
 |------------------------------|-----------------------------|----------------------------------------------------------------|
 | `MGC_ZONE_ROOT_DOMAIN`       | `jbloggs.hcpapps.net`       | Hostname for the root Domain                                   |
-| `MGC_AWS_DNS_PUBLIC_ZONE_ID` | `Z01234567US0IQE3YLO00`     | AWS Route 53 Zone ID for specified `MGC_ZONE_ROOT_DOMAIN`      | |
+| `MGC_AWS_DNS_PUBLIC_ZONE_ID` | `Z01234567US0IQE3YLO00`     | AWS Route 53 Zone ID for specified `MGC_ZONE_ROOT_DOMAIN`      | 
 | `MGC_AWS_ACCESS_KEY_ID`      | `AKIA1234567890000000`      | Access Key ID, with access to resources in Route 53            |
 | `MGC_AWS_SECRET_ACCESS_KEY`  | `Z01234567US0000000`        | Access Secret Access Key, with access to resources in Route 53 |
 | `MGC_AWS_REGION`             | `eu-west-1`                 | AWS Region                                                     |
-| `MGC_SUB_DOMAIN`             | `myapp.jbloggs.hcpapps.net` | AWS Region                                                     |
+| `MGC_SUB_DOMAIN`             | `myapp.jbloggs.hcpapps.net` | Desired Sub domain                                             |
+
+
+### 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                          |
 
 >Alternatively, to set defaults, add the above environment variables to your `.zshrc` or `.bash_profile`.
 
-### Set Up Clusters and Kuadrant
+### Set Up Clusters and Multicluster Gateway Controller
 
 Run the following:
 
@@ -35,5 +48,5 @@ curl https://raw.githubusercontent.com/kuadrant/multicluster-gateway-controller/
 
 ### What's Next
 
-* [Multicluster Gateways walkthrough](how-to/multicluster-gateways-walkthrough.md)
-* [Kuadrant Documentation](https://docs.kuadrant.io).
+Now that you have two Kind clusters configured with Kuadrant installed you are ready to begin [the Multicluster Gateways walkthrough.](https://docs.kuadrant.io/multicluster-gateway-controller/docs/how-to/multicluster-gateways-walkthrough/)
+