From 0f58a26e6032f7eaabd6b3a2de471cce87caf3e9 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Thu, 20 Mar 2025 22:05:41 +0100 Subject: [PATCH 01/14] basic network db --- network.rec | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 network.rec diff --git a/network.rec b/network.rec new file mode 100644 index 0000000..c292809 --- /dev/null +++ b/network.rec @@ -0,0 +1,7 @@ +%rec: host +%doc: These are the real machines, most of which virtualize. + +%rec: lxc +%doc: A container, usually on a Proxmox host + + -- 2.30.2 From f08d2838e36a61f9821a560ed2401781cde002c9 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Thu, 20 Mar 2025 22:20:14 +0100 Subject: [PATCH 02/14] expand network db --- network.rec | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/network.rec b/network.rec index c292809..75dd79b 100644 --- a/network.rec +++ b/network.rec @@ -1,7 +1,67 @@ +%rec: router + + +name: ISP-router + %rec: host %doc: These are the real machines, most of which virtualize. +%type: host rec lxc + +name: Moxx %rec: lxc %doc: A container, usually on a Proxmox host +name: nginx-11 +gateway: ISP-router +host: Mox +proxies: wiki-11 +proxies: gitea-11 +proxies: forum-11 +proxies: ejabberd-11 +proxies: dmzrs +name: LDAP +host: Moxx + +name: website +host: Moxx +authqueries: LDAP +queries: postgresql-11 +service: dmzrs +service: flask accounts + +name: gitea-11 +service: gitea +host: Moxx +authqueries: LDAP +queries: postgresql-11 + +name: ejabberd-11 +service: ejabberd +host: Moxx +authqueries: LDAP +queries: postgresql-11 + +name: forum-11 +service: forum +host: Moxx +authqueries: LDAP +queries: postgresql-11 + +name: postfix-11 +service: postfix +authqueries: LDAP + +name: tor-11 +service: tor +host: Moxx + +name: postgresql-11 +service: postgresql +host: Moxx + +name: wiki-11 +service: wiki +host: Moxx +authqueries: LDAP -- 2.30.2 From 0ecdda7302f70a044e84f370e37ac3261c1e6139 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Thu, 20 Mar 2025 22:29:28 +0100 Subject: [PATCH 03/14] names and places --- network.rec | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/network.rec b/network.rec index 75dd79b..e44f4fe 100644 --- a/network.rec +++ b/network.rec @@ -2,6 +2,11 @@ name: ISP-router +location: kralizec + +name: unnamed router +location: krov + %rec: host %doc: These are the real machines, most of which virtualize. @@ -9,6 +14,9 @@ name: ISP-router name: Moxx +name: Serverko +location: krov + %rec: lxc %doc: A container, usually on a Proxmox host @@ -65,3 +73,6 @@ name: wiki-11 service: wiki host: Moxx authqueries: LDAP + +name: nginx-12 +host: Serverko -- 2.30.2 From 37b3d56676f4f8f8d3503c120864af6f32126df1 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Thu, 20 Mar 2025 22:35:49 +0100 Subject: [PATCH 04/14] rework routers --- network.rec | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/network.rec b/network.rec index e44f4fe..b72870a 100644 --- a/network.rec +++ b/network.rec @@ -1,12 +1,12 @@ %rec: router - -name: ISP-router +name: ISP Router location: kralizec +ISP: Orion -name: unnamed router +name: ISP Router location: krov - +ISP: Yettel %rec: host %doc: These are the real machines, most of which virtualize. @@ -76,3 +76,10 @@ authqueries: LDAP name: nginx-12 host: Serverko + +name: nextcloud +host: Serverko + +name: tor-12 +host: nginx + -- 2.30.2 From 9ff9633bc4d8fa75a17a2332d27de7f7f66049e0 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Thu, 20 Mar 2025 23:38:11 +0100 Subject: [PATCH 05/14] fix container and host names --- network.rec | 62 +++++++++++++++++++++++++++-------------------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/network.rec b/network.rec index b72870a..e822299 100644 --- a/network.rec +++ b/network.rec @@ -9,77 +9,79 @@ location: krov ISP: Yettel %rec: host -%doc: These are the real machines, most of which virtualize. -%type: host rec lxc +%doc: These are the real machines, most of which virtualise. +%key: name -name: Moxx +name: moxx +location: kralizec name: Serverko location: krov %rec: lxc %doc: A container, usually on a Proxmox host +%type: host rec host -name: nginx-11 +name: nginx11 gateway: ISP-router -host: Mox -proxies: wiki-11 -proxies: gitea-11 -proxies: forum-11 -proxies: ejabberd-11 +host: moxx +proxies: wiki11 +proxies: gitea11 +proxies: forum11 +proxies: ejabberd11 proxies: dmzrs name: LDAP -host: Moxx +host: moxx name: website -host: Moxx +host: moxx authqueries: LDAP -queries: postgresql-11 +queries: postgresql11 service: dmzrs service: flask accounts -name: gitea-11 +name: gitea11 service: gitea -host: Moxx +host: moxx authqueries: LDAP -queries: postgresql-11 +queries: postgresql11 -name: ejabberd-11 +name: ejabberd11 service: ejabberd -host: Moxx +host: moxx authqueries: LDAP -queries: postgresql-11 +queries: postgresql11 -name: forum-11 +name: forum11 service: forum -host: Moxx +host: moxx authqueries: LDAP -queries: postgresql-11 +queries: postgresql11 -name: postfix-11 +name: postfix11 service: postfix authqueries: LDAP -name: tor-11 +name: tor11 service: tor -host: Moxx +host: moxx -name: postgresql-11 +name: postgresql11 service: postgresql -host: Moxx +host: moxx -name: wiki-11 +name: wiki11 service: wiki -host: Moxx +host: moxx authqueries: LDAP -name: nginx-12 +name: nginx12 host: Serverko name: nextcloud host: Serverko -name: tor-12 +name: tor12 host: nginx -- 2.30.2 From 85479ec6ed57ab47e7612cec03ec79806be06c04 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Fri, 21 Mar 2025 01:51:31 +0100 Subject: [PATCH 06/14] note recutils example command --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 896948c..5b10eae 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,34 @@ These setup files provide the text-only configurations for DMZ. - Any maintenance scripts. - Configurations should reside in shadow-directories, e.g. a backup `soft-serve`'s `config.yaml` should reside in this repo under `splint.rs/soft-serve/etc/soft/config.yaml`. +# Network Database + +I have a half-baked plan to finally make use of plain-text databases, and it's already half-working. +Try these commands: + +Ask what types of _rec_ords it contains: + +```sh +recinf network.rec +``` + +```sh +recsel network.rec --type router +recsel network.rec --include-descriptors --type lxc +recsel network.rec -d -t lxc +recsel network.rec -d -t lxc --expression +recsel network.rec -t lxc --expression "name ~ 'nginx'" +recsel network.rec -t lxc --expression "name = 'nginx12'" +``` + +If you can select something, you can also set its fields with `recset`. + +Use `-f` to set the field, and `-a` to add, or `-s` to set. + + +```sh +recset network.rec -t lxc --expression "name = 'nginx12'" -f proxies --add soft-serve +recsel network.rec -t lxc --expression "name = 'nginx11'" -p proxies[0] +recset network.rec -t lxc --expression "name = 'nginx11'" -f proxies[0] -s wiki9 +``` + -- 2.30.2 From 4b9dae9b3a6fb2d9153d2639bed07a95b2eabb8f Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Fri, 21 Mar 2025 02:11:49 +0100 Subject: [PATCH 07/14] give example of inserting record --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 5b10eae..5e6fbc6 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,8 @@ recsel network.rec -t lxc --expression "name = 'nginx11'" -p proxies[0] recset network.rec -t lxc --expression "name = 'nginx11'" -f proxies[0] -s wiki9 ``` +Insert a new record with `recins`. + +```sh +recins network.rec -t lxc -r "name: bob" -r "service: bob" -r "host: moxx" +``` -- 2.30.2 From 12644b80daaaacc86a0720ad5f557cbf4a1fd869 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Sat, 22 Mar 2025 14:05:10 +0100 Subject: [PATCH 08/14] autogenerate map from network info --- Makefile | 29 +++++++++++++++++++++++------ map.ge | 39 --------------------------------------- 2 files changed, 23 insertions(+), 45 deletions(-) delete mode 100644 map.ge diff --git a/Makefile b/Makefile index 7eb64a9..d673a17 100644 --- a/Makefile +++ b/Makefile @@ -5,13 +5,29 @@ help: ## Print the help message sort | \ column -s ':' -t -map.txt: map.ge ## Making map.txt - grep -v '# unimportant' $< | graph-easy --boxart > $@ - cat $@ +########## Network Map ########## -full_map.txt: map.ge ## Generating full_map.txt with graph-easy - graph-easy --boxart < $< > $@ - cat $@ +graph_cmd = graph-easy --boxart + +queries = queries authqueries + +query_formats = $(patsubst %, .dbs/%.txt, $(queries)) + +.dbs/: + mkdir $@ + +$(query_formats): .dbs/%.txt: | .dbs/ + echo "[ {{name}} ] -- $(basename $(@F)) --> [ {{$(basename $(@F))}} ]" > $@ + +.PHONY: map +map: .dbs/network.txt ## Show a network map + $(graph_cmd) < $< + +.dbs/network.txt: network.rec $(query_formats) + $(RM) .dbs/network.txt + $(foreach relation, $(queries), \ + recsel $< -t lxc -e "$(relation) != ''" -p name,$(relation) | recfmt -f .dbs/$(relation).txt >> $@ ;\ + ) ########## Man Pages ########## @@ -56,3 +72,4 @@ pages: $(kralmans) $(krovmans) $(setupmans) $(splintmans) clean: $(RM) $(kralmans) $(krovmans) + $(RM) -r .dbs diff --git a/map.ge b/map.ge deleted file mode 100644 index a4cd284..0000000 --- a/map.ge +++ /dev/null @@ -1,39 +0,0 @@ -# Network map of Decentrala. Use with: -# graph-easy --boxart < netmap.txt - -(Mox - [ m_router ]{label: router ;} - [ wireguard ] --> [ m_nginx ]{label: nginx-11 ;} - [ wiki ] --> [ m_nginx ] - [ gitea ] --> [ m_nginx ] - [ tor11 ] --> [ m_nginx ] --> [ m_router ] - [ smtp ] -) - -(Serverko - [ s_nginx ]{label: nginx-12 ;} - [ s_router ]{label: router ;} - [ s_nginx ] --> [ nextcloud ] - [ s_nginx ] --> [ tor12 ] - [ s_nginx ] --> [ s_router ] -) - -(splint.rs # unimportant - [ soft-serve ] # unimportant - [ mail-cache ]# unimportant -) # unimportant - -[ tor12 ] <..> [ onions ] <..> [ tor11 ] -[ m_router ] <..> [ BGP ] <..> [ madness ] <..> [ s_router ] -[ smtp ] <..> [ madness ] -[ madness ] <..> [ mail-cache ]# unimportant -[ A ]{label: "" ;} -[ B ]{label: "" ;} -[ C ]{label: "" ;} -[ D ]{label: "" ;} -[ onions ] <..> [ A ] -[ onions ] <..> [ B ] -[ A ] <..> [ C ] -[ B ] <..> [ D ] - -(Sharks! [ D ]) -- 2.30.2 From 452970261edbc43e827303f63d585275dc28f1be Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Sat, 22 Mar 2025 14:23:13 +0100 Subject: [PATCH 09/14] create check target --- Makefile | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Makefile b/Makefile index d673a17..e191812 100644 --- a/Makefile +++ b/Makefile @@ -5,6 +5,13 @@ help: ## Print the help message sort | \ column -s ':' -t +.PHONY: check +check: ## Check you have all dependencies + @command -v graph-easy >/dev/null || { echo "Install perl-graph-easy" && exit 1 ;} + @command -v recsel >/dev/null || { echo "Install recutils" && exit 1 ;} + @command -v lowdown >/dev/null || { echo "Install lowdown" && exit 1 ;} + @echo "All dependencies installed" + ########## Network Map ########## graph_cmd = graph-easy --boxart -- 2.30.2 From 1d35d54af1ddb33dc4976c488b2d800bb7c7eb2d Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Tue, 25 Mar 2025 21:03:40 +0100 Subject: [PATCH 10/14] embiggen recutils examples --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 5e6fbc6..8f5a6cb 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,20 @@ Ask what types of _rec_ords it contains: recinf network.rec ``` +Select with `recsel`, then specify the type of record. + ```sh recsel network.rec --type router recsel network.rec --include-descriptors --type lxc recsel network.rec -d -t lxc recsel network.rec -d -t lxc --expression +``` + +User `-q` for a 'quick' selection, or `-e` for more precise selections. + +```sh +recsel network.rec --type lxc --quick wiki +recsel network.rec --type lxc -q nginx recsel network.rec -t lxc --expression "name ~ 'nginx'" recsel network.rec -t lxc --expression "name = 'nginx12'" ``` -- 2.30.2 From fdb9cf9514fb9432c461f61446500bb080b29b59 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Tue, 25 Mar 2025 21:13:01 +0100 Subject: [PATCH 11/14] add record info to network.rec --- network.rec | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/network.rec b/network.rec index e822299..7cd2d27 100644 --- a/network.rec +++ b/network.rec @@ -1,4 +1,5 @@ %rec: router +%doc: Routers, or possibly modems? name: ISP Router location: kralizec @@ -9,7 +10,7 @@ location: krov ISP: Yettel %rec: host -%doc: These are the real machines, most of which virtualise. +%doc: These are the real machines, most of which run VMs or containters. %key: name name: moxx @@ -19,7 +20,7 @@ name: Serverko location: krov %rec: lxc -%doc: A container, usually on a Proxmox host +%doc: A container, usually on a Proxmox host. %type: host rec host name: nginx11 -- 2.30.2 From 763748322a32755ba8e8d02912704d0362d2fe9d Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Tue, 25 Mar 2025 21:46:47 +0100 Subject: [PATCH 12/14] note recutils package required --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f5a6cb..46578a7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ These setup files provide the text-only configurations for DMZ. # Network Database I have a half-baked plan to finally make use of plain-text databases, and it's already half-working. -Try these commands: +Install `recutils` and try these commands: Ask what types of _rec_ords it contains: -- 2.30.2 From 40a4064ddbba475fdbc89a3bc6ad20dd28413b38 Mon Sep 17 00:00:00 2001 From: Malin Freeborn Date: Tue, 25 Mar 2025 22:04:21 +0100 Subject: [PATCH 13/14] add graph-easy dependency --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 46578a7..85eee94 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ These setup files provide the text-only configurations for DMZ. *It should not contain private data.* +# Dependencies + +- `recutils` +- (optional) `graph-easy` (the package may be called `perl-graph-easy`) + # Aspirations - Each service should reside in its own directory. @@ -18,7 +23,7 @@ These setup files provide the text-only configurations for DMZ. # Network Database I have a half-baked plan to finally make use of plain-text databases, and it's already half-working. -Install `recutils` and try these commands: +Try these commands: Ask what types of _rec_ords it contains: -- 2.30.2 From 64f9f6ffa32b2abb2c2ce21d04faa98cd018a53f Mon Sep 17 00:00:00 2001 From: coja Date: Tue, 25 Mar 2025 22:49:19 +0100 Subject: [PATCH 14/14] [Doc] changed readme --- README.md | 47 ++++++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 85eee94..4154c28 100644 --- a/README.md +++ b/README.md @@ -27,41 +27,54 @@ Try these commands: Ask what types of _rec_ords it contains: +## Database + ```sh recinf network.rec ``` -Select with `recsel`, then specify the type of record. +### Select queries + +Select with `recsel`, then specify the database (.rec) and type of record (like table in db). + +`--include-descriptors` or `-d` +`--type` or `-t` +`--expression` or `-e` +`--quick` or `-q` ```sh recsel network.rec --type router -recsel network.rec --include-descriptors --type lxc recsel network.rec -d -t lxc -recsel network.rec -d -t lxc --expression +recsel network.rec -d -t lxc -e ?example? ``` -User `-q` for a 'quick' selection, or `-e` for more precise selections. +User `-q` for a `--quick` selection, or `-e` for more precise selections. ```sh recsel network.rec --type lxc --quick wiki -recsel network.rec --type lxc -q nginx -recsel network.rec -t lxc --expression "name ~ 'nginx'" -recsel network.rec -t lxc --expression "name = 'nginx12'" +recsel network.rec -t lxc -q nginx +recsel network.rec -t lxc -e "name ~ 'nginx'" +recsel network.rec -t lxc -e "name = 'nginx12'" ``` -If you can select something, you can also set its fields with `recset`. - -Use `-f` to set the field, and `-a` to add, or `-s` to set. - - -```sh -recset network.rec -t lxc --expression "name = 'nginx12'" -f proxies --add soft-serve -recsel network.rec -t lxc --expression "name = 'nginx11'" -p proxies[0] -recset network.rec -t lxc --expression "name = 'nginx11'" -f proxies[0] -s wiki9 -``` +### Insert queries Insert a new record with `recins`. ```sh recins network.rec -t lxc -r "name: bob" -r "service: bob" -r "host: moxx" ``` + +### Update queries + +If you can select something, you can also set its fields with `recset`. + +Use `-f` to set the `--field`, and `-a` to `--add`, or `-s` to `--set`. + + +```sh +recset network.rec -t lxc -e "name = 'nginx12'" -f proxies -a soft-serve +recsel network.rec -t lxc -e "name = 'nginx11'" -p proxies[0] +recset network.rec -t lxc -e" name = 'nginx11'" -f proxies[0] -s wiki9 +``` + -- 2.30.2