build: add obsah convenience wrapper for hack/

.github/workflows/test.yaml

@@ -18,6 +18,6 @@ jobs:
 
       - run: pip install ansible
 
-      - run: ansible-playbook hack/plays/manage.yml
+      - run: ansible-playbook hack/playbooks/manage/manage.yaml
 
       - run: git diff --exit-code

.gitignore

@@ -3,3 +3,4 @@
 **/selinux/*.pp
 site/
 venv/
+.var/lib/hackctl

CONTRIBUTING.md

@@ -92,20 +92,51 @@ RaBe servers it soley regenerates README files and documentation.
 
 ### Regenerating READMEs
 
+If you have obsah installed (e.g using pip), you can use the `hack/hackctl` script
+to conveniently provide a help and store your recent args.
+
 ```bash
-ansible-playbook hack/plays/manage.yml
+pip install obsah
+
+hack/hackctl manage --help
 ```
 
-### Fetching Templates using ansible
+NOTE: your args (like the API token) are persisted to the
+`.var/lib/hackctl/parameters.yaml` file when you use hackctl.
+
+If you prefer to use `ansible-playbook`, see below.
+
+### Fetching Templates using hackctl
 
 ```bash
-ansible-playbook hack/plays/manage.yml -e ansible_zabbix_auth_key=<AUTH_KEY>
+hack/hackctl manage --ansible-zabbix-auth-key=<API_TOKEN>
 ```
 
 If you just want to fetch a single template:
 
 ```bash
-ansible-playbook hack/plays/manage.yml -e ansible_zabbix_auth_key=<AUTH_KEY> -e 'rabe_zabbix_templates=[{"template_name":"CHANGEME"}]'
+hack/hackctl manage --ansible-zabbix-auth-key=<AUTH_KEY> --rabe-zabbix-templates='[{"template_name":"CHANGEME"}]'
+```
+
+To remove the API token from `.var/lib/hackctl/parameters.yaml` and rerun without fetching RaBe sources:
+
+```bash
+hack/hackctl manage --reset-ansible-zabbix-auth-key
+```
+
+### Fetching Templates using ansible
+
+
+```bash
+ansible-playbook hack/playbooks/manage/manage.yaml
+```
+
+```bash
+ansible-playbook hack/playbooks/manage/manage.yaml -e ansible_zabbix_auth_key=<AUTH_KEY>
+```
+
+```bash
+ansible-playbook hack/playbooks/manage/manage.yaml -e ansible_zabbix_auth_key=<AUTH_KEY> -e 'rabe_zabbix_templates=[{"template_name":"CHANGEME"}]'
 ```
 
 ### Adding new templates

Templates/Network_devices/Netgear_GS_by_SNMP/7.0/Netgear_GS_by_SNMP.yaml

@@ -24,7 +24,7 @@ zabbix_export:
         - name: 'Templates/Network devices'
       items:
         - uuid: 9e2e8706b8e4496e80d15bc420401b97
-          name: 'GS Hardware serial number'
+          name: 'Netgear Fastpath: Hardware serial number'
           type: SNMP_AGENT
           # the upstream template uses the oid 1.3.6.1.4.1.4526.10.1.1.1.4.0
           # the following line is the main reason to add a GS template on top
@@ -47,8 +47,8 @@ zabbix_export:
           triggers:
             - uuid: 9b30371ec844436ab1456ba571ca74d0
               expression: 'last(/Netgear GS by SNMP/rabe.system.hw.serialnumber,#1)<>last(/Netgear GS by SNMP/rabe.system.hw.serialnumber,#2) and length(last(/Netgear GS by SNMP/rabe.system.hw.serialnumber))>0'
-              name: 'GS Device has been replaced'
-              event_name: 'GS Device has been replaced (new serial number received)'
+              name: 'RaBe: Netgear Fastpath: Device has been replaced'
+              event_name: 'RaBe: Netgear Fastpath: Device has been replaced (new serial number received)'
               priority: INFO
               description: 'Device serial number has changed. Acknowledge to close the problem manually.'
               manual_close: 'YES'

hack/hackctl

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+OBSAH_NAME=hack/hackctl
+OBSAH_BASE=$(dirname $(readlink -f $0))/..
+OBSAH_DATA=${OBSAH_BASE}/hack
+OBSAH_INVENTORY=${OBSAH_BASE}/hack/inventories
+OBSAH_STATE=${OBSAH_BASE}/.var/lib/hackctl
+OBSAH_PERSIST_PARAMS=true
+export OBSAH_NAME OBSAH_DATA OBSAH_INVENTORY OBSAH_STATE OBSAH_PERSIST_PARAMS
+
+ANSIBLE_LOG_PATH=${OBSAH_BASE}/.var/lib/hackctl/ansible.log
+export ANSIBLE_LOG_PATH
+
+exec obsah "$@"

hack/inventories/localhost

@@ -0,0 +1 @@
+localhost ansible_connection=local