From a6015664299d5ff4f482f34c6312d043d6fc172e Mon Sep 17 00:00:00 2001
From: anima <p.schreiner@4nima.de>
Date: Sun, 2 Feb 2025 18:48:04 +0100
Subject: [PATCH] inital version

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..78d2e3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# Icinga2 Satellite
+
+## Requirements
+* need a running icinga2 master instance
+* ticket & zone config in master instance
+  * see: [Icinga: Master Setup](https://icinga.com/docs/icinga-2/latest/doc/06-distributed-monitoring/#master-setup)
+
+ATTENTION: primary designed for:
+* [AO-IT: icinga-stack](https://git.ao-it.net/docker/icinga-stack)
+* [AO-IT: icinga2](https://git.ao-it.net/docker/icinga2)
+* [AO-IT: icingaweb2](https://git.ao-it.net/docker/icinga-satellite)
+
+Maybe you need more setup setps if you use other base!
+
+## usage
+### master instance
+## example zone.conf
+* [Icinga: Zones](https://icinga.com/docs/icinga-2/latest/doc/06-distributed-monitoring/#zones)  
+* [Icinga: Endpoints](https://icinga.com/docs/icinga-2/latest/doc/06-distributed-monitoring/#endpoints)
+
+> DO NOT copy&paste this config !  
+> Replace first all $VARS
+
+```
+object Endpoint "master.example.com" {
+}
+object Zone "master" {
+        endpoints = [ "master.example.com" ]
+}
+
+// your new config to do:
+object Endpoint "$ICINGA_SATELLITE_CN" {
+        host = "1.2.3.4"                // ip or
+        host = "$ICINGA_SATELLITE_CN"   // hostname
+}
+object Zone "$ICINGA_SATELLITE_ZONE" {
+        parent = "$ICINGA_PARENT_CN"
+        endpoints = [ "$ICINGA_SATELLITE_CN" ]
+}
+// end: new config to do
+
+object Zone "global-templates" {
+        global = true
+}
+
+object Zone "director-global" {
+        global = true
+}
+
+```
+
+create new zone on master
+```
+mkdir zones.d/$ICINGA_SATELLITE_ZONE
+nano zones.d/$ICINGA_SATELLITE_ZONE/hosts.conf 
+```
+
+### satellite node
+```
+git clone https://git.ao-it.net/docker/icinga-satellite
+cp env.sample .env
+nano .env # set your env
+docker compose up
+```
+