From 5a08791b540b868ce8ea56f7e51d06388cdaf9b9 Mon Sep 17 00:00:00 2001
From: Jason Madigan <jason@jasonmadigan.com>
Date: Thu, 20 Jun 2024 13:15:21 +0100
Subject: [PATCH] Bare Kubernetes install guide

Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
---
 doc/install/install-kubernetes.md | 137 ++++++++++++++++++++++++++++++
 doc/install/install-openshift.md  |   5 +-
 2 files changed, 140 insertions(+), 2 deletions(-)
 create mode 100644 doc/install/install-kubernetes.md

diff --git a/doc/install/install-kubernetes.md b/doc/install/install-kubernetes.md
new file mode 100644
index 000000000..b8eda28c6
--- /dev/null
+++ b/doc/install/install-kubernetes.md
@@ -0,0 +1,137 @@
+# Install Kuadrant on a Kubernetes cluster
+
+!!! note
+
+    You must perform these steps on each Kubernetes cluster where you want to use Kuadrant.
+
+## 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
+```
+
+### Install Istio as a Gateway API provider
+
+!!! note
+
+    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.21.4 sh -
+./istio-1.21.4/bin/istioctl install --set profile=minimal
+./istio-1.21.4/bin/istioctl operator init
+kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/main/config/dependencies/istio/istio-operator.yaml
+```
+
+### 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 - <<EOF
+apiVersion: kuadrant.io/v1beta1
+kind: Kuadrant
+metadata:
+  name: kuadrant
+spec: {}
+EOF
+```
+
+Kuadrant should now install. You can check the operator's install status with:
+
+```bash
+kubectl wait --for=jsonpath='{.status.state}'=AtLatestKnown subscription/my-kuadrant-operator -n operators --timeout=600s
+```
+
+Kuadrant is now ready to use.
+
+
+### (Optional) `DNSPolicy` setup
+
+If you plan to use `DNSPolicy`, you will need an AWS Account with access to Route 53 (more providers coming soon), and a hosted zone.
+
+Export the following environment variables for setup:
+
+```bash
+export AWS_ACCESS_KEY_ID=xxxxxxx # Key ID from AWS with Route 53 access
+export AWS_SECRET_ACCESS_KEY=xxxxxxx # Access key from AWS with Route 53 access
+```
+
+Create an AWS credentials secret:
+
+```bash
+kubectl -n kuadrant-system create secret generic aws-credentials \
+  --type=kuadrant.io/aws \
+  --from-literal=AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
+  --from-literal=AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY
+```
+
+### (Optional) Multi-cluster `RateLimitPolicy`
+
+To enable `RateLimitPolicy` to use shared, multi-cluster counters for Kuadrant's Limitador component, you need to configure Kuadrant with a Redis cluster URL. Redis URIs can be either `redis://` for standard connections or `rediss://` for secure connections.
+
+Follow these steps to create the necessary secret:
+
+1. Replace `some-redis.com:6379` with the URL of your accessible Redis cluster. Ensure you include the appropriate URI scheme (`redis://` or `rediss://`).
+
+2. Execute the following commands:
+
+    ```bash
+    # Replace this with an accessible Redis cluster URL
+    export REDIS_URL=redis://user:xxxxxx@some-redis.com:6379
+    
+    kubectl -n kuadrant-system create secret generic redis-config \
+      --from-literal=URL=$REDIS_URL
+    ```
+
+This will create a secret named `redis-config` in the `kuadrant-system` namespace containing your Redis cluster URL, which Kuadrant will use for multi-cluster rate limiting.
+
+
+You'll also need to update your earlier created `Kuadrant` instance to reconfigure Kuadrant to use Redis:
+
+```bash
+kubectl apply -f - <<EOF
+apiVersion: kuadrant.io/v1beta1
+kind: Kuadrant
+metadata:
+  name: kuadrant
+  namespace: kuadrant-system
+spec:
+  limitador:
+    storage:
+      redis-cached:
+        configSecretRef:
+          name: redis-config 
+EOF
+```
+
+## Next Steps
+
+- [Secure, protect, and connect APIs with Kuadrant on Kubernetes](../user-guides/secure-protect-connect.md)
diff --git a/doc/install/install-openshift.md b/doc/install/install-openshift.md
index a29486354..966870546 100644
--- a/doc/install/install-openshift.md
+++ b/doc/install/install-openshift.md
@@ -1,6 +1,8 @@
 # Install Kuadrant on an OpenShift cluster
 
-NOTE: You must perform these steps on each OpenShift cluster that you want to use Kuadrant on.
+!!! note
+
+    You must perform these steps on each OpenShift cluster that you want to use Kuadrant on.
 
 ## Prerequisites
 
@@ -8,7 +10,6 @@ NOTE: You must perform these steps on each OpenShift cluster that you want to us
 - AWS account with Route 53 and zone.
 - Accessible Redis instance.
 
-
 ## Procedure
 
 ### Step 1 - Set up your environment