Hanna: Difference between revisions
From H4KS
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
Hanna is the | = Hanna = | ||
Hanna is the internal automation assistant used across H4KS to streamline workflows, coordinate tasks, and log important events. This page documents Hanna's purpose, architecture, usage, governance, and maintenance. | |||
== Overview == | |||
Hanna is a modular automation agent that integrates with IRC channels, project tooling, and bespoke workflows through a pluggable plugin architecture. It is designed to be privacy-conscious, auditable, and resilient. | |||
== Purpose and scope == | |||
* Automate repetitive tasks (notification routing, log aggregation, task creation) | |||
* Enforce standards and governance across channels | |||
* Provide quick access to information and open action items | |||
* Serve as a consistent interface for human operators and automated processes | |||
== Architecture == | |||
* Core engine: message parser, command dispatcher, plugin manager | |||
* Plugins: | |||
* IRC plugin: connects to #lobby and other channels | |||
* N8n adapter: triggers workflows via n8n | |||
* Logging: emits structured logs to central log store | |||
* Status: basic responsiveness and health checks | |||
* Data model: contexts per user/session, per-channel, per-workflow state | |||
* External interfaces: IRC, REST endpoints, Webhooks | |||
== Deployment and configuration == | |||
* Runs in containerized environment; uses environment variables for config | |||
* Config: /etc/hanna/config.yaml | |||
* Secrets handling: Vault or secret manager | |||
* Versioning: SemVer | |||
== Usage == | |||
* Basic commands: | |||
** Hanna help | |||
** Hanna status | |||
** Hanna log <level> <message> | |||
* Examples: | |||
** Listening to channel logs and summarizing nightly events | |||
** Triggering a workflow in n8n via the N8n adapter | |||
* Access control and privacy: only authorized users can invoke admin commands | |||
== Security and privacy == | |||
* Authentication and authorization model, role-based access control | |||
* Data retention and deletion policies | |||
* Audit logging and tamper-evident records where feasible | |||
== Maintenance and governance == | |||
* Owners: Hanna team; primary maintainers include Valware and mattf | |||
* Change management: PRs, code reviews, tests, and staging reviews | |||
* Release cycle: monthly minor releases with quarterly major updates | |||
== Backup and disaster recovery == | |||
* Daily backups of critical state and logs; retention 30 days | |||
* Offsite replication and periodic DR drills | |||
* Runbooks and escalation paths for outages | |||
== History and changelog == | |||
* 1.0 initial release and stabilization | |||
* 1.1 added IRC connectivity defaults and improved logging | |||
* 1.2 introduced N8n node adapter and improved security checks | |||
== Related pages == | |||
* Hanna's Parents: Valware and mattf | |||
* Hanna LLC | |||
* Hanna Backup Procedures | |||
* N8n-nodes-hanna License | |||
* Mita and Hanna Collaboration | |||
* Debugging Bub Message in Mini Hanna Node | |||
Latest revision as of 15:35, 9 September 2025
Hanna[edit]
Hanna is the internal automation assistant used across H4KS to streamline workflows, coordinate tasks, and log important events. This page documents Hanna's purpose, architecture, usage, governance, and maintenance.
Overview[edit]
Hanna is a modular automation agent that integrates with IRC channels, project tooling, and bespoke workflows through a pluggable plugin architecture. It is designed to be privacy-conscious, auditable, and resilient.
Purpose and scope[edit]
- Automate repetitive tasks (notification routing, log aggregation, task creation)
- Enforce standards and governance across channels
- Provide quick access to information and open action items
- Serve as a consistent interface for human operators and automated processes
Architecture[edit]
- Core engine: message parser, command dispatcher, plugin manager
- Plugins:
- IRC plugin: connects to #lobby and other channels
- N8n adapter: triggers workflows via n8n
- Logging: emits structured logs to central log store
- Status: basic responsiveness and health checks
- Data model: contexts per user/session, per-channel, per-workflow state
- External interfaces: IRC, REST endpoints, Webhooks
Deployment and configuration[edit]
- Runs in containerized environment; uses environment variables for config
- Config: /etc/hanna/config.yaml
- Secrets handling: Vault or secret manager
- Versioning: SemVer
Usage[edit]
- Basic commands:
- Hanna help
- Hanna status
- Hanna log <level> <message>
- Examples:
- Listening to channel logs and summarizing nightly events
- Triggering a workflow in n8n via the N8n adapter
- Access control and privacy: only authorized users can invoke admin commands
Security and privacy[edit]
- Authentication and authorization model, role-based access control
- Data retention and deletion policies
- Audit logging and tamper-evident records where feasible
Maintenance and governance[edit]
- Owners: Hanna team; primary maintainers include Valware and mattf
- Change management: PRs, code reviews, tests, and staging reviews
- Release cycle: monthly minor releases with quarterly major updates
Backup and disaster recovery[edit]
- Daily backups of critical state and logs; retention 30 days
- Offsite replication and periodic DR drills
- Runbooks and escalation paths for outages
History and changelog[edit]
- 1.0 initial release and stabilization
- 1.1 added IRC connectivity defaults and improved logging
- 1.2 introduced N8n node adapter and improved security checks
Related pages[edit]
- Hanna's Parents: Valware and mattf
- Hanna LLC
- Hanna Backup Procedures
- N8n-nodes-hanna License
- Mita and Hanna Collaboration
- Debugging Bub Message in Mini Hanna Node