From 460d5a92b94c9997d84d34b99c337dd47f9892b8 Mon Sep 17 00:00:00 2001 From: Michael Nairn Date: Wed, 18 Sep 2024 15:40:41 +0100 Subject: [PATCH] DNS related doc updates * Remove all references to docs from the multicluster-gateway-controller repo and remove it as a source. * Remove ManagedZone docs Signed-off-by: Michael Nairn --- docs/getting-started-multi-cluster-ocm.md | 55 ----------------------- mkdocs.yml | 28 ------------ 2 files changed, 83 deletions(-) delete mode 100644 docs/getting-started-multi-cluster-ocm.md diff --git a/docs/getting-started-multi-cluster-ocm.md b/docs/getting-started-multi-cluster-ocm.md deleted file mode 100644 index c1d99bf8..00000000 --- a/docs/getting-started-multi-cluster-ocm.md +++ /dev/null @@ -1,55 +0,0 @@ -## Kuadrant Getting Started - Multi Cluster - - -### 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 or GCP with Cloud DNS enabled -- [Docker Mac Net Connect](https://github.com/chipmk/docker-mac-net-connect) (macOS users only) - -### DNS Environmental Variables - -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_ACCESS_KEY_ID` | `AKIA1234567890000000` | Access Key ID, for user with permissions to Route 53 in the account where root domain is created | -| `MGC_AWS_SECRET_ACCESS_KEY` | `Z01234567US0000000` | Access Secret Access Key, for user with permissions to Route 53 in the account where root domain is created | -| `MGC_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 | - ->Alternatively, to set defaults, add the above environment variables to your `.zshrc` or `.bash_profile`. - -### Set the release you want to use - -```bash -export MGC_BRANCH=release-0.3 -``` - -### Set Up Clusters and install Kuadrant - -Run the following: - -```bash -curl "https://raw.githubusercontent.com/kuadrant/multicluster-gateway-controller/${MGC_BRANCH}/hack/quickstart-setup.sh" | bash -``` - -### What's Next - -Now that you have two Kind clusters configured with Kuadrant installed you are ready to begin [the Multicluster Gateways walkthrough.](/multicluster-gateway-controller/docs/gateways/define-and-place-a-gateway/) diff --git a/mkdocs.yml b/mkdocs.yml index 419954c1..fe3d05b9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -91,11 +91,6 @@ plugins: imports: - /README.md - /doc/* - - name: multicluster-gateway-controller - import_url: 'https://github.com/kuadrant/multicluster-gateway-controller?edit_uri=/blob/main/&branch=main' - imports: - - /README.md - - /docs/* - name: architecture import_url: 'https://github.com/kuadrant/architecture?edit_uri=/blob/main/&branch=main' imports: @@ -131,9 +126,6 @@ nav: - 'Overview': kuadrant-operator/doc/dns.md - 'Reference': kuadrant-operator/doc/reference/dnspolicy.md - 'Gateway DNS for Cluster Operators': kuadrant-operator/doc/user-guides/gateway-dns.md - - 'ManagedZone': - - 'Overview': dns-operator/docs/managedzone.md - - 'Reference': dns-operator/docs/reference/managedzone.md - 'TLSPolicy': - 'Overview': kuadrant-operator/doc/tls.md - 'Reference': kuadrant-operator/doc/reference/tlspolicy.md @@ -149,7 +141,6 @@ nav: - 'DNS configuration and load balancing': - 'DNS Health Checks': kuadrant-operator/doc/dnshealthchecks.md - 'DNS Providers': dns-operator/docs/provider.md - - 'Advanced DNS based LoadBalancing': multicluster-gateway-controller/docs/how-to/multicluster-loadbalanced-dnspolicy.md - 'TLS configuration': - 'Gateway TLS for Cluster Operators': kuadrant-operator/doc/user-guides/gateway-tls.md - 'Authentication & Authorization': @@ -180,7 +171,6 @@ nav: - 'Setting up Kuadrant authorization service as a Validating Webhook': authorino/docs/user-guides/validating-webhook.md - 'Caching': authorino/docs/user-guides/caching.md - 'Rate Limiting': - - 'RateLimitPolicy for Application Developers': multicluster-gateway-controller/docs/how-to/simple-ratelimitpolicy-for-app-developers.md - 'RateLimitPolicy for Platform Engineers': kuadrant-operator/doc/user-guides/gateway-rl-for-cluster-operators.md - 'Authenticated Rate Limiting for Application Developers': kuadrant-operator/doc/user-guides/authenticated-rl-for-app-developers.md - kuadrant-operator/doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.md @@ -189,13 +179,6 @@ nav: - 'Dashboards and Alerts': kuadrant-operator/doc/observability/examples.md - 'Tracing': kuadrant-operator/doc/observability/tracing.md - 'Authentication and Authorization': authorino/docs/user-guides/observability.md - - 'Multicluster Gateways with OCM': - - 'Getting Started with OCM': getting-started-multi-cluster-ocm.md - - 'Distributing Gateways with OCM': multicluster-gateway-controller/docs/gateways/define-and-place-a-gateway.md - - 'Gateway Deletion': multicluster-gateway-controller/docs/gateways/gateway-deletion.md - - 'Multicluster Walkthrough': multicluster-gateway-controller/docs/how-to/multicluster-gateways-walkthrough.md - - 'Control Plane installation with Existing OCM': multicluster-gateway-controller/docs/installation/control-plane-installation.md - - 'Service Protection installation with Existing OCM': multicluster-gateway-controller/docs/installation/service-protection-installation.md - 'Experimental': - 'API Quickstart': 'api-quickstart/README.md' - 'Proposals': @@ -209,13 +192,6 @@ nav: - 'RFC 0007: Policy Sync': architecture/rfcs/0007-policy-sync-v1.md - 'RFC 0008: Kuadrant Release Process': architecture/rfcs/0008-kuadrant-release-process.md - 'RFC 0009: Defaults & Overrides': architecture/rfcs/0009-defaults-and-overrides.md - - 'Multicluster Gateway Controller': - - 'Multiple DNS Provider Support': - - 'Overview': multicluster-gateway-controller/docs/proposals/multiple-dns-provider-support.md - - 'Google DNS': multicluster-gateway-controller/docs/proposals/assets/multiple-dns-provider-support/google/google.md - - 'AWS DNS': multicluster-gateway-controller/docs/proposals/assets/multiple-dns-provider-support/aws/aws.md - - 'Azure DNS': multicluster-gateway-controller/docs/proposals/assets/multiple-dns-provider-support/azure/azure.md - - 'Aggregation of Status Conditions': multicluster-gateway-controller/docs/proposals/status-aggregation.md - 'Components': - 'Kuadrant Operator': - 'Overview': kuadrant-operator/README.md @@ -247,10 +223,6 @@ nav: - 'Rate limit headers': limitador-operator/doc/rate-limit-headers.md - "Developer's Guide": limitador-operator/doc/development.md - limitador-operator/doc/logging.md - - 'Multicluster Gateway Controller': - - 'Overview': multicluster-gateway-controller/README.md - - 'Contribution': - - 'Debugging with VSCode': multicluster-gateway-controller/docs/contribution/vscode-debugging.md - 'kuadrantctl': - 'Getting Started': kuadrantctl/README.md - 'Generating Gateway API HTTPRoutes': kuadrantctl/doc/generate-gateway-api-httproute.md