From f67b8edf9fd82c0914e0478abac9709ee6c86994 Mon Sep 17 00:00:00 2001
From: Gabriel Viganotti <gabrielviganotti@gmail.com>
Date: Sun, 12 Jan 2025 12:56:29 -0300
Subject: [PATCH] docs: add readme with instruction to generate kube yaml file

---
 deploy/local/k8s/README.md          | 51 +++++++++++++++++++++++++++++
 deploy/local/k8s/formicaio-pod.yaml | 16 ++++-----
 2 files changed, 59 insertions(+), 8 deletions(-)
 create mode 100644 deploy/local/k8s/README.md

diff --git a/deploy/local/k8s/README.md b/deploy/local/k8s/README.md
new file mode 100644
index 0000000..12050d3
--- /dev/null
+++ b/deploy/local/k8s/README.md
@@ -0,0 +1,51 @@
+# Running Formicaio with Podman and generate Kubernetes YAML file
+
+## Install Podman
+Formicaio can be deployed and run using [Podman](https://podman.io/) instead of Docker on Linux, Windows, or macOS. To get started, you'll need to install Podman by following the instructions available at https://podman.io/docs/installation.
+You can choose to install either Podman Desktop or just the command-line interface (CLI), depending on your preference and the installation options available for your platform.
+Be sure to follow the installation guide specific to your operating system, which will include executing the following two commands to initialize and start the Podman machine:
+```
+$ podman machine init
+```
+...and this second command (which may or may not be necessary):
+```
+$ podman machine start
+```
+
+## Run pod from the Kubernetes YAML file
+Now you can simply use the Kubernetes `formicaio-pod.yaml` file found on this folder to launch the pod and Formicaio app:
+```
+$ podman play kube formicaio-pod.yaml
+```
+
+If you need to regenerate the `formicaio-pod.yaml` file, you can follow the steps below.
+
+## Create a pod
+First create an empty pod with network mode set to host so its container can share the network with the host:
+```
+$ podman pod create -p 52100:52100 --name formicaio-pod
+```
+
+## Add Docker container to the pod
+Add a container which runs Docker-in-Docker (DIND) so that the Formicaio app/container can use its local socket file to communicate with its API (this allows Formicaio and the pod to run on any platform without needing to adapt to different platforms):
+```
+$ podman run --name docker -dt --privileged -v pod_volume_formicaio:/var/run -v pod_volume_formicaio:/data -v pod_volume_formicaio:/var/lib/docker --pod formicaio-pod docker:27.4.1-dind@sha256:3c8fb358b82767a38189e54a89a2ba8d71109f0a17efa87fd009ef8283c46df6 --data-root /data/docker --exec-root /data/docker/exec --host unix:///var/run/docker.sock --pidfile /data/docker/docker.pid
+```
+
+## Add Formicaio container to the pod
+Add the Formicaio container to the pod:
+```
+$ podman run --name formicaio -dt -v pod_volume_formicaio:/var/run -v pod_volume_formicaio:/data -e DB_PATH=/data -e DOCKER_SOCKET_PATH=/var/run/docker.sock -e NODE_CONTAINER_IMAGE_TAG=latest -e HOME_NETWORK_ONLY=true --pod formicaio-pod docker.io/bochaco/formicaio:latest
+```
+
+## Generate Kubernetes YAML file
+```
+$ podman generate kube formicaio-pod > formicaio-pod.yaml
+```
+
+## Remove pod and files
+If you want to remove to leave no trace of the files stored by the pod and/or Formicaio app, you can remove the pod and volume with the following commands:
+```
+$ podman pod rm formicaio-pod -f
+$ podman volume rm pod_volume_formicaio
+```
\ No newline at end of file
diff --git a/deploy/local/k8s/formicaio-pod.yaml b/deploy/local/k8s/formicaio-pod.yaml
index 37579b1..bfdf33a 100644
--- a/deploy/local/k8s/formicaio-pod.yaml
+++ b/deploy/local/k8s/formicaio-pod.yaml
@@ -5,7 +5,7 @@
 apiVersion: v1
 kind: Pod
 metadata:
-  creationTimestamp: "2024-12-12T20:22:42Z"
+  creationTimestamp: "2025-01-12T15:54:36Z"
   labels:
     app: formicaio-pod
   name: formicaio-pod
@@ -31,21 +31,21 @@ spec:
       privileged: true
     tty: true
     volumeMounts:
-    - mountPath: /data
-      name: pod_volume_formicaio-pvc
     - mountPath: /var/lib/docker
       name: pod_volume_formicaio-pvc
     - mountPath: /var/run
       name: pod_volume_formicaio-pvc
+    - mountPath: /data
+      name: pod_volume_formicaio-pvc
   - env:
-    - name: DOCKER_SOCKET_PATH
-      value: /var/run/docker.sock
     - name: NODE_CONTAINER_IMAGE_TAG
       value: latest
     - name: DB_PATH
       value: /data
+    - name: DOCKER_SOCKET_PATH
+      value: /var/run/docker.sock
     - name: HOME_NETWORK_ONLY
-      value: true
+      value: "true"
     image: docker.io/bochaco/formicaio:latest
     name: formicaio
     resources: {}
@@ -57,10 +57,10 @@ spec:
         - CAP_AUDIT_WRITE
     tty: true
     volumeMounts:
-    - mountPath: /data
-      name: pod_volume_formicaio-pvc
     - mountPath: /var/run
       name: pod_volume_formicaio-pvc
+    - mountPath: /data
+      name: pod_volume_formicaio-pvc
   enableServiceLinks: false
   hostname: formicaio-pod
   restartPolicy: Never