From f4c487bd960ae86b8d2b484848f7261d800b305f Mon Sep 17 00:00:00 2001 From: Rachel Lawton Date: Fri, 20 Dec 2024 12:49:07 +0000 Subject: [PATCH] remove old install k8s doc (#1091) * remove old install k8s doc Signed-off-by: R-Lawton * fix 404 links Signed-off-by: R-Lawton --------- Signed-off-by: R-Lawton --- doc/install/install-kubernetes.md | 209 ------------------ doc/install/install-make.md | 3 - doc/install/mtls-configuration.md | 4 +- ...uth-for-app-devs-and-platform-engineers.md | 3 +- doc/user-guides/dns/gateway-dns.md | 2 +- .../secure-protect-connect.md | 3 +- .../authenticated-rl-for-app-developers.md | 5 +- ...uthenticated-rl-with-jwt-and-k8s-authnz.md | 4 +- .../gateway-rl-for-cluster-operators.md | 6 +- .../multi-auth-rlp-diff-section.md | 8 +- .../multi-auth-rlp-same-section.md | 7 +- .../simple-rl-for-app-developers.md | 5 +- 12 files changed, 22 insertions(+), 237 deletions(-) delete mode 100644 doc/install/install-kubernetes.md diff --git a/doc/install/install-kubernetes.md b/doc/install/install-kubernetes.md deleted file mode 100644 index 52c66d6ed..000000000 --- a/doc/install/install-kubernetes.md +++ /dev/null @@ -1,209 +0,0 @@ -# Install Kuadrant on a Kubernetes cluster - -!!! note - You must perform these steps on each Kubernetes cluster where you want to use Kuadrant. - -!!! warning - - Kuadrant uses a number of labels to search and filter resources on the cluster. - All required labels are formatted as `kuadrant.io/*`. - Removal of any labels with the prefix may cause unexpected behaviour and degradation of the product. - - -## Prerequisites - -- Access to a Kubernetes cluster, with `kubeadmin` or an account with similar permissions -- `cert-manager` [installed](https://cert-manager.io/docs/installation/) - -## Procedure - -This guide will show you how to install Kuadrant onto a bare Kubernetes cluster. - -Alternatively, if you are looking instead for a way to set up Kuadrant locally to evaluate or develop, consider running the kind & Kubernetes [quickstart script](https://docs.kuadrant.io/latest/getting-started-single-cluster/). - -### Install Gateway API - -```bash -kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.1.0/standard-install.yaml -``` - -### Install [OLM](https://olm.operatorframework.io/) - -!!! note - Currently, we recommend installing our operator via OLM. We plan to support Helm soon. - -```bash -curl -sL https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.28.0/install.sh | bash -s v0.28.0 -``` - -### (Optional) Install Istio as a Gateway API provider - -!!! note - Skip this step if planing to use [Envoy Gateway](https://gateway.envoyproxy.io/) as Gateway API provider - - -There are several ways to install Istio (via `istioctl`, Helm chart or Operator) - this is just an example for starting from a bare Kubernetes cluster. - -```bash -curl -L https://istio.io/downloadIstio | ISTIO_VERSION=1.22.5 sh - -./istio-1.22.5/bin/istioctl install --set profile=minimal -./istio-1.22.5/bin/istioctl operator init -kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/main/config/dependencies/istio/istio-operator.yaml -``` - -### (Optional) Install Envoy Gateway as a Gateway API provider - -!!! note - Skip this step if planing to use [Istio](https://istio.io/) as Gateway API provider - -There are several ways to install Envoy Gateway (via `egctl`, Helm chart or Kubernetes yaml) - this is just an example for starting from a bare Kubernetes cluster. - -```bash -helm install eg oci://docker.io/envoyproxy/gateway-helm --version v1.1.0 -n envoy-gateway-system --create-namespace -``` - -Kuadrant relies on the Envoy Gateway patch policy feature to function correctly - enable the *EnvoyPatchPolicy* feature like so: - -```bash -TMP=$(mktemp -d) -kubectl get configmap -n envoy-gateway-system envoy-gateway-config -o jsonpath='{.data.envoy-gateway\.yaml}' > ${TMP}/envoy-gateway.yaml -yq e '.extensionApis.enableEnvoyPatchPolicy = true' -i ${TMP}/envoy-gateway.yaml -kubectl create configmap -n envoy-gateway-system envoy-gateway-config --from-file=envoy-gateway.yaml=${TMP}/envoy-gateway.yaml -o yaml --dry-run=client | kubectl replace -f - -kubectl rollout restart deployment envoy-gateway -n envoy-gateway-system -``` - -Wait for Envoy Gateway to become available: - -```bash -kubectl wait --timeout=5m -n envoy-gateway-system deployment/envoy-gateway --for=condition=Available -``` - -### Install Kuadrant - -```bash -kubectl create -f https://operatorhub.io/install/kuadrant-operator.yaml -kubectl get crd --watch | grep -m 1 "kuadrants.kuadrant.io" -``` - -### Request a Kuadrant instance - -```bash -kubectl create namespace kuadrant-system -kubectl -n kuadrant-system apply -f - < **Note:** In production environment, these steps are usually performed by a cluster operator with administrator privileges over the Kubernetes cluster. diff --git a/doc/install/mtls-configuration.md b/doc/install/mtls-configuration.md index cad4b59de..556f83fbc 100644 --- a/doc/install/mtls-configuration.md +++ b/doc/install/mtls-configuration.md @@ -12,8 +12,8 @@ At the time of writing there is [an RFC](https://github.com/Kuadrant/architectur ## Prerequisites -You have installed Kuadrant in a [Kubernetes](https://docs.kuadrant.io/latest/kuadrant-operator/doc/install/install-kubernetes/) or [OpenShift](https://docs.kuadrant.io/latest/kuadrant-operator/doc/install/install-openshift/) cluster. -Additionally, you have at least 1 AuthPolicy or RateLimitPolicy attached to your Gateway or HTTPRoute. +- You have installed Kuadrant in a Kubernetes cluster. +- Additionally, you have at least 1 AuthPolicy or RateLimitPolicy attached to your Gateway or HTTPRoute. ## Enabling mTLS diff --git a/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md b/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md index 04c0d22db..8345e933f 100644 --- a/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md +++ b/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md @@ -37,8 +37,7 @@ Topology: ## Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. - +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toy Store sample application (Persona: _App developer_) diff --git a/doc/user-guides/dns/gateway-dns.md b/doc/user-guides/dns/gateway-dns.md index 804862359..2c1b99cd2 100644 --- a/doc/user-guides/dns/gateway-dns.md +++ b/doc/user-guides/dns/gateway-dns.md @@ -9,7 +9,7 @@ This user guide walks you through an example of how to configure DNS for all rou ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. Create a namespace: diff --git a/doc/user-guides/full-walkthrough/secure-protect-connect.md b/doc/user-guides/full-walkthrough/secure-protect-connect.md index 57b856524..f598a49b9 100644 --- a/doc/user-guides/full-walkthrough/secure-protect-connect.md +++ b/doc/user-guides/full-walkthrough/secure-protect-connect.md @@ -6,8 +6,7 @@ This guide walks you through using Kuadrant to secure, protect, and connect an A ## Prerequisites -- Have a cluster with Kuadrant operator installed. - - Either [Kubernetes installation guide](../../install/install-kubernetes.md) or [Openshift installation guide](../../install/install-openshift.md) +- Kubernetes cluster with Kuadrant operator installed. - [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) command line tool. - AWS/Azure or GCP with DNS capabilities. diff --git a/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md b/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md index 8aeb82e18..028aa7fcb 100644 --- a/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md +++ b/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md @@ -1,5 +1,6 @@ # Authenticated Rate Limiting for Application developers -For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) + +For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) This user guide walks you through an example of how to configure authenticated rate limiting for an application using Kuadrant. @@ -20,7 +21,7 @@ We will define 2 users of the API, which can send requests to the API at differe ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toy Store API diff --git a/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md b/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md index d566227e2..f08445928 100644 --- a/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md +++ b/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md @@ -25,7 +25,7 @@ Each user will be entitled to a maximum of 5rp10s (5 requests every 10 seconds). ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toystore example API: @@ -274,7 +274,7 @@ curl -H "Authorization: Bearer $SA_TOKEN" -H 'Host: api.toystore.com' -X POST ht # HTTP/1.1 403 Forbidden ``` -### Enforce rate limiting on requests to the Toy Store API +### Enforce rate limiting on requests to the Toy Store API Create a Kuadrant `RateLimitPolicy` to configure rate limiting: diff --git a/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md b/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md index 3619317d6..f0c551758 100644 --- a/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md +++ b/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md @@ -1,13 +1,12 @@ # Gateway Rate Limiting for Cluster Operators -For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) +For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas) This user guide walks you through an example of how to configure rate limiting for all routes attached to a specific ingress gateway. - ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toystore example API: @@ -15,6 +14,7 @@ Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/ kubectl apply -f examples/toystore/toystore.yaml ``` + ### Create the ingress gateways ```sh diff --git a/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md b/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md index 5ab10a97b..feffc70fc 100644 --- a/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md +++ b/doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md @@ -4,7 +4,7 @@ This user guide walks you through an example of how to configure multiple rate l ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the sample API: @@ -80,7 +80,7 @@ spec: name: environment sectionName: external defaults: - strategy: merge + strategy: merge limits: "external": rates: @@ -104,7 +104,7 @@ spec: name: environment sectionName: local defaults: - strategy: merge + strategy: merge limits: "local": rates: @@ -115,8 +115,6 @@ EOF > **Note:** It may take a couple of minutes for the RateLimitPolicy to be applied depending on your cluster. - - ### Verify the rate limiting works by sending requests in a loop Expose the gateways, respectively at the port numbers `9081` and `9082` of the local host: diff --git a/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md b/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md index ef972f227..e53712cd1 100644 --- a/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md +++ b/doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md @@ -19,7 +19,7 @@ We will define 2 users of the API, which can send requests to the API at differe ### Setup the environment -Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc. +Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc. ### Deploy the Toy Store API @@ -55,7 +55,7 @@ spec: method: GET backendRefs: - name: toystore - port: 80 + port: 80 EOF ``` @@ -168,9 +168,10 @@ EOF ### Enforce authenticated rate limiting on requests to the Toy Store API -Create Kuadrant `RateLimitPolicy's` to configure rate limiting for Bob and Alice: +Create Kuadrant `RateLimitPolicy's` to configure rate limiting for Bob and Alice: ### Bob + ```sh kubectl apply -f - <