From 837fbc47bf21aeafdd2d0a975d48d9ac1712d8db Mon Sep 17 00:00:00 2001
From: Giovanni Toraldo <giovanni.toraldo@hyland.com>
Date: Wed, 24 Jan 2024 10:17:11 +0100
Subject: [PATCH 1/3] wip

---
 docs/helm/kind-deployment.md | 60 ++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 docs/helm/kind-deployment.md

diff --git a/docs/helm/kind-deployment.md b/docs/helm/kind-deployment.md
new file mode 100644
index 000000000..38635b4f0
--- /dev/null
+++ b/docs/helm/kind-deployment.md
@@ -0,0 +1,60 @@
+# Setting up Kind for Helm Chart Installation
+
+## Prerequisites
+
+- Docker installed on your machine
+- Kubernetes CLI (kubectl) installed on your machine
+- Helm CLI installed on your machine
+
+## Step 1: Install Kind
+
+## Step 2: Create a Kind Cluster
+
+1. Open a terminal window.
+2. Run the following command to create a Kind cluster:
+
+    ```shell
+    cat <<EOF | kind create cluster -n acs-testing --config=-
+    kind: Cluster
+    apiVersion: kind.x-k8s.io/v1alpha4
+    nodes:
+    - role: control-plane
+    kubeadmConfigPatches:
+    - |
+        kind: InitConfiguration
+        nodeRegistration:
+        kubeletExtraArgs:
+            node-labels: "ingress-ready=true"
+    extraPortMappings:
+    - containerPort: 80
+        hostPort: 80
+        protocol: TCP
+    - containerPort: 443
+        hostPort: 443
+        protocol: TCP
+    EOF
+    ```
+
+3. Wait for the Kind cluster to be created. This may take a few minutes.
+
+## Install ingress-nginx
+
+[install kind](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx)
+
+kubectl wait --namespace ingress-nginx \
+  --for=condition=ready pod \
+  --selector=app.kubernetes.io/component=controller \
+  --timeout=90s
+
+## Install metrics server
+
+[install metrics server](https://github.com/kubernetes-sigs/metrics-server#installation)
+
+```sh
+kubectl patch -n kube-system deployment metrics-server --type=json \
+  -p '[{"op":"add","path":"/spec/template/spec/containers/0/args/-","value":"--kubelet-insecure-tls"}]'
+```
+
+## Conclusion
+
+You have successfully set up Kind and Helm for installing Helm charts. You can now proceed with installing your desired Helm charts on the Kind cluster.

From 8d3425b32342ee262133d203473ad9d5dd545b89 Mon Sep 17 00:00:00 2001
From: Giovanni Toraldo <giovanni.toraldo@hyland.com>
Date: Wed, 24 Jan 2024 12:29:21 +0100
Subject: [PATCH 2/3] add nginx patch

---
 docs/helm/kind-deployment.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/helm/kind-deployment.md b/docs/helm/kind-deployment.md
index 38635b4f0..69fc760f0 100644
--- a/docs/helm/kind-deployment.md
+++ b/docs/helm/kind-deployment.md
@@ -41,10 +41,17 @@
 
 [install kind](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx)
 
+```sh
+kubectl -n ingress-nginx patch cm ingress-nginx-controller \
+  -p '{"data": {"allow-snippet-annotations":"true"}}'
+```
+
+```sh
 kubectl wait --namespace ingress-nginx \
   --for=condition=ready pod \
   --selector=app.kubernetes.io/component=controller \
   --timeout=90s
+```
 
 ## Install metrics server
 

From 5a15971329b939aa83a8485cd38f7aa1e7861753 Mon Sep 17 00:00:00 2001
From: Giovanni Toraldo <giovanni.toraldo@hyland.com>
Date: Mon, 29 Jan 2024 10:13:06 +0100
Subject: [PATCH 3/3] complete the docs

---
 docs/helm/README.md             |   6 +-
 docs/helm/desktop-deployment.md |   2 +-
 docs/helm/kind-deployment.md    | 103 +++++++++++++++++++++-----------
 3 files changed, 75 insertions(+), 36 deletions(-)

diff --git a/docs/helm/README.md b/docs/helm/README.md
index d080cf6eb..730798387 100644
--- a/docs/helm/README.md
+++ b/docs/helm/README.md
@@ -63,7 +63,11 @@ the installation.
 
 ## Deploy
 
-For the best results we recommend [deploying ACS to AWS EKS](./eks-deployment.md). If you have a machine with at least 16GB of memory you can also [deploy using Docker for Desktop](./docker-desktop-deployment.md).
+For the best results we recommend [deploying ACS to AWS
+EKS](./eks-deployment.md). If you have a machine with at least 16GB of memory
+you can [deploy using Docker Desktop](./desktop-deployment.md) (or similar apps
+like Rancher and Podman Desktop) or via [KinD](kind-deployment.md) which just
+requires a working Docker install on any OS.
 
 The recommended cluster resources for the Enterprise version with the components enabled by default are:
 at least 3 nodes with 12 cpu cores and 32 GB of memory in total. You can install with lower
diff --git a/docs/helm/desktop-deployment.md b/docs/helm/desktop-deployment.md
index 8fc42005d..8f7b4b30d 100644
--- a/docs/helm/desktop-deployment.md
+++ b/docs/helm/desktop-deployment.md
@@ -176,7 +176,7 @@ To deploy a previous version of ACS Enterprise follow the steps below.
 
 > NOTE: The command will wait until the deployment is ready so please be
 patient. See below for
-[troubleshooting](./docker-desktop-deployment.md#troubleshooting) tips.
+[troubleshooting](#troubleshooting) tips.
 
 ## Access
 
diff --git a/docs/helm/kind-deployment.md b/docs/helm/kind-deployment.md
index 69fc760f0..130ee2baf 100644
--- a/docs/helm/kind-deployment.md
+++ b/docs/helm/kind-deployment.md
@@ -1,51 +1,68 @@
-# Setting up Kind for Helm Chart Installation
+# Alfresco Content Services Helm Deployment on KinD cluster
+
+This page describe how to get ACS up and running on a [Kubernetes In
+Docker](https://kind.sigs.k8s.io/) (KinD) cluster.
+
+KinD is better suited to run helm workloads inside CI environments but works
+well also for local development because it just requires a working Docker
+server.
 
 ## Prerequisites
 
-- Docker installed on your machine
+- Docker installed on your machine (Docker Desktop, Rancher Desktop, Podman and similar)
 - Kubernetes CLI (kubectl) installed on your machine
 - Helm CLI installed on your machine
 
 ## Step 1: Install Kind
 
+Take a look to the [KinD
+quickstart](https://kind.sigs.k8s.io/docs/user/quick-start/) to learn how to
+install the binary cli on your machine and to learn briefly the main commands
+that you can run.
+
 ## Step 2: Create a Kind Cluster
 
-1. Open a terminal window.
-2. Run the following command to create a Kind cluster:
-
-    ```shell
-    cat <<EOF | kind create cluster -n acs-testing --config=-
-    kind: Cluster
-    apiVersion: kind.x-k8s.io/v1alpha4
-    nodes:
-    - role: control-plane
-    kubeadmConfigPatches:
-    - |
-        kind: InitConfiguration
-        nodeRegistration:
-        kubeletExtraArgs:
-            node-labels: "ingress-ready=true"
-    extraPortMappings:
-    - containerPort: 80
-        hostPort: 80
-        protocol: TCP
-    - containerPort: 443
-        hostPort: 443
-        protocol: TCP
-    EOF
-    ```
-
-3. Wait for the Kind cluster to be created. This may take a few minutes.
-
-## Install ingress-nginx
-
-[install kind](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx)
+Run the following command to create a Kind cluster:
+
+```shell
+cat <<EOF | kind create cluster -n acs-testing --config=-
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+kubeadmConfigPatches:
+- |
+    kind: InitConfiguration
+    nodeRegistration:
+    kubeletExtraArgs:
+        node-labels: "ingress-ready=true"
+extraPortMappings:
+- containerPort: 80
+    hostPort: 80
+    protocol: TCP
+- containerPort: 443
+    hostPort: 443
+    protocol: TCP
+EOF
+```
+
+Wait for the Kind cluster to be created. This may take a few minutes.
+
+## Step 3: Install patched ingress-nginx
+
+Follow the instructions for
+[deploying nginx ingress on KinD](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx).
+
+Reconfigure ingress-nginx to allow snippet annotations that are still required
+when using our search services chart:
 
 ```sh
 kubectl -n ingress-nginx patch cm ingress-nginx-controller \
   -p '{"data": {"allow-snippet-annotations":"true"}}'
 ```
 
+Wait for the ingress-nginx controller to be up again after the configuration change:
+
 ```sh
 kubectl wait --namespace ingress-nginx \
   --for=condition=ready pod \
@@ -55,13 +72,31 @@ kubectl wait --namespace ingress-nginx \
 
 ## Install metrics server
 
-[install metrics server](https://github.com/kubernetes-sigs/metrics-server#installation)
+Optionally, you can [install metrics
+server](https://github.com/kubernetes-sigs/metrics-server#installation) to
+gather metrics from node and pods.
+
+Make sure to enable insecure tls option otherwise metrics collection would not work under KinD:
 
 ```sh
 kubectl patch -n kube-system deployment metrics-server --type=json \
   -p '[{"op":"add","path":"/spec/template/spec/containers/0/args/-","value":"--kubelet-insecure-tls"}]'
 ```
 
+Wait for a few minutes and then try to run:
+
+```sh
+kubectl top node
+```
+
+Upon installing ACS, you can check current cpu and memory usage via:
+
+```sh
+kubectl top pods
+```
+
 ## Conclusion
 
-You have successfully set up Kind and Helm for installing Helm charts. You can now proceed with installing your desired Helm charts on the Kind cluster.
+Now that you have successfully set up a Kind cluster with ingress-nginx and
+metrics-server, you can now proceed with installing ACS via helm charts as per
+[Desktop deployment](desktop-deployment.md#acs).