feat(docs): add CLI migration note (#590)

Author: mikhail-klimko

charts/cf-runtime/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 description: A Helm chart for Codefresh Runner
 name: cf-runtime
-version: 7.9.0
+version: 7.9.1
 keywords:
   - codefresh
   - runner
@@ -17,10 +17,8 @@ annotations:
   artifacthub.io/containsSecurityUpdates: "true"
   # Supported kinds: `added`, `changed`, `deprecated`, `removed`, `fixed`, `security`:
   artifacthub.io/changes: |
-    - kind: changed
-      description: "Added ability to specify .Values.runtime.engine.runtimeImages as a maps with registry, repository, tag and digest."
-    - kind: fixed
-      description: "Fixed empty lines in misc templates."
+    - kind: added
+      description: "Added documentation on migrating from CLI installation"
 dependencies:
   - name: cf-common
     repository: oci://quay.io/codefresh/charts

charts/cf-runtime/README.md

@@ -1,6 +1,6 @@
 ## Codefresh Runner
 
-![Version: 7.9.0](https://img.shields.io/badge/Version-7.9.0-informational?style=flat-square)
+![Version: 7.9.1](https://img.shields.io/badge/Version-7.9.1-informational?style=flat-square)
 
 Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/installation/codefresh-runner/) to Kubernetes.
 
@@ -32,6 +32,7 @@ Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/insta
   - [ARM](#arm)
   - [Openshift](#openshift)
   - [On-premise](#on-premise)
+- [Migrating from CLI-based installation to Helm chart](#migrating-from-cli-based-installation-to-helm-chart)
 
 ## Prerequisites
 
@@ -1087,6 +1088,46 @@ helm upgrade --install cf-runtime oci://quay.io/codefresh/cf-runtime -f values.y
 
 Go to [https://<YOUR_ONPREM_DOMAIN_HERE>/admin/runtime-environments/system](https://<YOUR_ONPREM_DOMAIN_HERE>/admin/runtime-environments/system) to see the runtime. Assign it to the required account(s).
 
+## Migrating from CLI-based installation to Helm chart
+
+If you have previously installed Codefresh Runner via CLI, you can migrate to the Helm chart by following these steps:
+
+Get Agent and Runtime from existing installation:
+
+```console
+NAMESPACE=codefresh
+AGENT_NAME=$(kubectl -n $NAMESPACE get deploy runner -o json | jq -r '.spec.template.spec.containers[].env[] | select(.name == "AGENT_ID") | .value')
+RUNTIME_NAME=$(kubectl -n $NAMESPACE get secret runnerconf -o json | jq -r '.data | to_entries | .[0].value' | base64 -d | grep 'name:' | cut -d':' -f2 | tr -d ' ')
+echo "AGENT_NAME: $AGENT_NAME"
+echo "RUNTIME_NAME: $RUNTIME_NAME"
+```
+
+Delete the legacy k8s resources created via CLI with `./scripts/delete-legacy-cli-resources.sh` script:
+
+⚠️⚠️⚠️ **DO NOT DELETE `runner` secret!** ⚠️⚠️⚠️
+
+```console
+NAMESPACE=codefresh
+./scripts/delete-legacy-cli-resources.sh $NAMESPACE
+```
+
+Fill Agent and Runtime names in the `values.yaml` file:
+
+```console
+cat << EOF > my-values.yaml
+global:
+  agentName: $AGENT_NAME
+  runtimeName: $RUNTIME_NAME
+  agentTokenSecretKeyRef:
+    name: runner
+    key: codefresh.token
+EOF
+```
+
+⚠️ Any customizations in runtime-environment spec done via CLI (like `nodeSelector`, `tolerations`, `podLabels`, etc) should be added to the `values.yaml` file as well.
+
+Install the Helm chart
+
 ## Requirements
 
 | Repository | Name | Version |

charts/cf-runtime/README.md.gotmpl

@@ -32,6 +32,7 @@ Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/insta
   - [ARM](#arm)
   - [Openshift](#openshift)
   - [On-premise](#on-premise)
+- [Migrating from CLI-based installation to Helm chart](#migrating-from-cli-based-installation-to-helm-chart)
 
 ## Prerequisites
 
@@ -1089,6 +1090,47 @@ helm upgrade --install cf-runtime oci://quay.io/codefresh/cf-runtime -f values.y
 
 Go to [https://<YOUR_ONPREM_DOMAIN_HERE>/admin/runtime-environments/system](https://<YOUR_ONPREM_DOMAIN_HERE>/admin/runtime-environments/system) to see the runtime. Assign it to the required account(s).
 
+
+## Migrating from CLI-based installation to Helm chart
+
+If you have previously installed Codefresh Runner via CLI, you can migrate to the Helm chart by following these steps:
+
+Get Agent and Runtime from existing installation:
+
+```console
+NAMESPACE=codefresh
+AGENT_NAME=$(kubectl -n $NAMESPACE get deploy runner -o json | jq -r '.spec.template.spec.containers[].env[] | select(.name == "AGENT_ID") | .value')
+RUNTIME_NAME=$(kubectl -n $NAMESPACE get secret runnerconf -o json | jq -r '.data | to_entries | .[0].value' | base64 -d | grep 'name:' | cut -d':' -f2 | tr -d ' ')
+echo "AGENT_NAME: $AGENT_NAME"
+echo "RUNTIME_NAME: $RUNTIME_NAME"
+```
+
+Delete the legacy k8s resources created via CLI with `./scripts/delete-legacy-cli-resources.sh` script:
+
+⚠️⚠️⚠️ **DO NOT DELETE `runner` secret!** ⚠️⚠️⚠️
+
+```console
+NAMESPACE=codefresh
+./scripts/delete-legacy-cli-resources.sh $NAMESPACE
+```
+
+Fill Agent and Runtime names in the `values.yaml` file:
+
+```console
+cat << EOF > my-values.yaml
+global:
+  agentName: $AGENT_NAME
+  runtimeName: $RUNTIME_NAME
+  agentTokenSecretKeyRef:
+    name: runner
+    key: codefresh.token
+EOF
+```
+
+⚠️ Any customizations in runtime-environment spec done via CLI (like `nodeSelector`, `tolerations`, `podLabels`, etc) should be added to the `values.yaml` file as well.
+
+Install the Helm chart
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}

scripts/delete-legacy-cli-resources.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+NAMESPACE=${1}
+
+if [ -z "$NAMESPACE" ]; then
+    echo "Usage: $0 <namespace>"
+    exit 1
+fi
+
+KINDS=(
+    "deployment"
+    "daemonset"
+    "configmap"
+    "secret"
+    "serviceaccount"
+    "role"
+    "rolebinding"
+    "clusterrole"
+    "clusterrolebinding"
+    "storageclass"
+)
+
+for kind in "${KINDS[@]}"; do
+    echo "Deleting $kind resources in namespace: $NAMESPACE"
+    kubectl delete "$kind" -n "$NAMESPACE" -l 'app in (runner, venona, dind-volume-provisioner, dind-lv-monitor, app-proxy)' --ignore-not-found
+done
+
+# Delete unlabeled resources
+kubectl -n $NAMESPACE delete secret $(kubectl get sa runner -o json | jq -r '.secrets.[].name')
+kubectl -n $NAMESPACE delete runnerconf
+kubectl -n $NAMESPACE delete sa runner
+kubectl -n $NAMESPACE delete role codefresh-engine runner
+kubectl -n $NAMESPACE delete rolebinding codefresh-engine runner