From d3894930c96a254c64ceebaa11d90c4f81127bb7 Mon Sep 17 00:00:00 2001
From: tsvetkov <tsvetkov@elina>
Date: Fri, 27 Feb 2026 09:45:34 +0000
Subject: [PATCH] add the readme

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a40b175
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+This is intended for use with the [elk-jdbc-sso](https://git.96-fromsofia.net/k8s/elk-jdbc-sso) stack.
+More information about how this project can be found there.
+
+- To run the playbook:
+```
+ansible-playbook -i inventory/hosts.yml playbooks/deploy.yml --ask-become-pass
+```
+
+- It is also possible to run individual phases:
+```
+# Regenerate certificates only
+ansible-playbook -i inventory/hosts.yml playbooks/deploy.yml --tags certs,secrets
+
+# Redeploy only Logstash
+ansible-playbook -i inventory/hosts.yml playbooks/deploy.yml --tags logstash
+
+# Redeploy Elasticsearch and re-run setup
+ansible-playbook -i inventory/hosts.yml playbooks/deploy.yml --tags elasticsearch,es-setup
+```
+
+- To remove the deployment:
+```
+# Remove all K8s resources but keep Minikube running
+ansible-playbook -i inventory/hosts.yml playbooks/teardown.yml --ask-become-pass
+
+# Remove everything including Minikube
+ansible-playbook -i inventory/hosts.yml playbooks/teardown.yml --ask-become-pass -e stop_minikube=true
+```