From c908af45fb305f95e7c05cc85e05cbaff7c11f6b Mon Sep 17 00:00:00 2001
From: Jason Madigan <jason@jasonmadigan.com>
Date: Wed, 23 Aug 2023 12:50:53 +0100
Subject: [PATCH] data-plane components installation guide

Data plane components installation guide
---
 .../redis/limitador/kustomization.yaml        |  2 +-
 docs/how-to/data-plane-installation.md        | 72 +++++++++++++++++++
 docs/how-to/ratelimiting-shared-redis.md      | 53 +++++++-------
 3 files changed, 100 insertions(+), 27 deletions(-)
 create mode 100644 docs/how-to/data-plane-installation.md

diff --git a/config/kuadrant/redis/limitador/kustomization.yaml b/config/kuadrant/redis/limitador/kustomization.yaml
index 35662940e..13b4107b9 100644
--- a/config/kuadrant/redis/limitador/kustomization.yaml
+++ b/config/kuadrant/redis/limitador/kustomization.yaml
@@ -6,4 +6,4 @@ secretGenerator:
     literals:
       -  URL=redis://172.31.0.3:30611
     options:
-      disableNameSuffixHash: true   
\ No newline at end of file
+      disableNameSuffixHash: true
\ No newline at end of file
diff --git a/docs/how-to/data-plane-installation.md b/docs/how-to/data-plane-installation.md
new file mode 100644
index 000000000..99db9b437
--- /dev/null
+++ b/docs/how-to/data-plane-installation.md
@@ -0,0 +1,72 @@
+# Installing Kuadrant data-plane into an existing OCM Managed Cluster
+
+## Introduction
+This walkthrough will show you how to install and setup the Kuadrant Operator into an [OCM](https://open-cluster-management.io/) [Managed Cluster](https://open-cluster-management.io/concepts/managedcluster/).
+
+## Prerequisites
+* Access to an Open Cluster Management (>= 0.6.0) Managed Cluster, which has already been bootstrapped and registered with a hub cluster
+  * See:
+    * https://open-cluster-management.io/getting-started/quick-start/
+    * https://open-cluster-management.io/concepts/managedcluster/
+* OLM will need to be installed into the ManagedCluster where you want to run the Kuadrant data-plane components
+  * See https://olm.operatorframework.io/docs/getting-started/
+* Kuadrant uses Istio as a Gateway API provider - this will need to be installed into the data plane clusters
+  * See https://istio.io/v1.16/blog/2022/getting-started-gtwapi/
+  * We recommend installing Istio 1.17.0
+
+If you'd like to quickly get started locally, without having to worry to much about the pre-requisites, take a look at [this guide](./ocm-control-plane-walkthrough.md). It will get you setup with Kind, OLM, OCM & Kuadrant in a few short steps.
+
+
+## Install the Kuadrant OCM Add-On
+
+To install the Kuadrant data-plane into a `ManagedCluster`, target your cluster and run:
+
+```bash
+kubectl apply -f - <<EOF
+apiVersion: addon.open-cluster-management.io/v1alpha1
+kind: ManagedClusterAddOn
+metadata:
+ name: kuadrant-addon
+ namespace: kind-mgc-workload-1
+spec:
+ installNamespace: open-cluster-management-agent-addon
+EOF
+```
+
+**Note:** if you've run our Quickstart Setup guide, you'll  be set to run this command as-is.
+
+The above command will install the `ManagedClusterAddOn` resource needed to install the Kuadrant addon into the `kind-mgc-workload-1` namespace, and install the Kuadrant data-plane components into the `open-cluster-management-agent-addon` namespace. 
+
+The Kuadrant addon will install:
+
+* the Kuadrant Operator
+* Limitador (and its associated operator)
+* Authorino  (and its associated operator)
+
+For more details, see the Kuadrant components installed by the (kuadrant-operator)[https://github.com/Kuadrant/kuadrant-operator#kuadrant-components]
+
+## Verify the Kuadrant addon installation
+
+To verify the Kuadrant OCM addon has installed currently, run:
+
+```bash
+kubectl get pods -n kuadrant-system
+```
+
+You should see the namespace `kuadrant-system`, and the following pods come up:
+* authorino-*value*
+* authorino-operator-*value*
+* kuadrant-operator-controller-manager-*value*
+* limitador-*value*
+* limitador-operator-controller-manager-*value*
+
+# Further Reading
+With the Kuadrant data plane components installed, here is some further reading material to help you utilise Authorino and Limitador:
+
+[Getting started with Authorino](https://docs.kuadrant.io/authorino/)
+[Getting started With Limitador](https://docs.kuadrant.io/limitador-operator/)
+
+
+
+
+
diff --git a/docs/how-to/ratelimiting-shared-redis.md b/docs/how-to/ratelimiting-shared-redis.md
index 5e11e9dbe..f8f4ba022 100644
--- a/docs/how-to/ratelimiting-shared-redis.md
+++ b/docs/how-to/ratelimiting-shared-redis.md
@@ -5,8 +5,8 @@ The following document is going to show you how to deploy Redis as storage for L
 
 ## Requirements
 * Kind
-* Kuadrant operator [Walkthrough to install Kuadrant can be found here](https://github.com/Kuadrant/multicluster-gateway-controller/docs/how-to's/kuadrant-addon-walkthrough.md)
-* Gateways setup [Walkthrough to setup gateways in you clusters can be found here](https://github.com/Kuadrant/multicluster-gateway-controller/docs/how-to's/ocm-control-plane-walkthrough.md)
+* Kuadrant operator [Walkthrough to install Kuadrant can be found here](https://github.com/Kuadrant/multicluster-gateway-controller/docs/how-to/kuadrant-addon-walkthrough.md)
+* Gateways setup [Walkthrough to setup gateways in you clusters can be found here](https://github.com/Kuadrant/multicluster-gateway-controller/docs/how-to/ocm-control-plane-walkthrough.md)
 
 
  ## Installation and Setup
@@ -27,40 +27,41 @@ Open three windows, which we'll refer to throughout this walkthrough as:
     ``` bash
     kubectl get nodes -o wide
     ```
-1. If needs be, update the URL located in `config/kuadrant/redis/limitador` to include the ip address from above step.
+1. If needs be, update the URL located in `config/kuadrant/redis/limitador/kustomization.yaml` to include the internal IP address from above step.
 1. In the clusters that have Kuadrant operator installed i.e. `T1 & T3` run the following to configure limitador to use Redis as storage rather than local cluster storage:
     ```bash
-    kustomize build config/kuadrant/limitador/ | kubectl apply -f -
+    kustomize build config/kuadrant/redis/limitador/ | kubectl apply -f -
     ```
 ## Configuring Rate Limit Policies
 1. In `T1 & T3 both spoke clusters` run the following command to create a Rate Limit Policy for the HTTP route created in the walkthrough linked above called `Open Cluster Management and Multi-Cluster gateways`. The policy is limiting the route to have 8 successful requests in 10 seconds, these values can be changed to whatever you want.
 
-    ```bash
-    kubectl apply -f - <<EOF
-    apiVersion: kuadrant.io/v1beta1
-    kind: RateLimitPolicy
-    metadata:
-    name: echo-rlp
-    spec:
-    targetRef:
-        group: gateway.networking.k8s.io
-        kind: HTTPRoute
-        name: prod-web
-    rateLimits:
-        - configurations:
+```bash
+kubectl apply -f - <<EOF
+apiVersion: kuadrant.io/v1beta1
+kind: RateLimitPolicy
+metadata:
+  name: echo-rlp
+spec:
+  targetRef:
+    group: gateway.networking.k8s.io
+    kind: HTTPRoute
+    name: prod-web
+  rateLimits:
+    - configurations:
         - actions:
             - generic_key:
                 descriptor_key: "limited"
                 descriptor_value: "1"
-        - rules:
-        - hosts: [ "replace.this" ]
-        limits:
-            - conditions:
-                - 'limited == "1"'
-            maxValue: 8
-            seconds: 10
-    EOF
-    ```
+      rules:
+        - hosts: [ "$MGC_SUB_DOMAIN" ]
+      limits:
+        - conditions:
+            - 'limited == "1"'
+          maxValue: 8
+          seconds: 10
+EOF
+```
+
 1.  In `T1 and T3` test the RLP you can run the following command:
     ```bash
     while true; do curl -k -s -o /dev/null -w "%{http_code}\n"  replace.this.with.host && sleep 1; done