commit 602583b6247587dccc609cbe0eecf76bc521fbd7 Author: Echo Date: Tue Apr 21 21:41:46 2026 +0000 Initial commit: README and SDD base spec files diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 0000000..3fbbecf --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,48 @@ +# Linux_Patch_Manager - Architecture Document + +## Project Overview +**Title:** Linux_Patch_Manager +**Version:** 0.0.1 +**Status:** Draft + +## Architecture Decisions + + + +## System Architecture + + + +## Component Design + + + +## Data Flow + + + +## Technology Stack + + + +## Security Architecture + + + +## Deployment Architecture + + + +## Scalability + + + +## Integration Points + + + +**Upstream Dependency:** [Linux Patch API](https://gitea.moon-dragon.us/echo/linux_patch_api) + +## Monitoring and Observability + + diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4348aa --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Linux Patch Manager + +**Enterprise-class secure web-based management interface for controlling patching and updates on Linux servers and workstations.** + +## Overview + +Linux Patch Manager provides a centralized web interface to manage patching and software updates across a fleet of Linux servers and workstations. It communicates with managed devices through the [Linux Patch API](https://gitea.moon-dragon.us/echo/linux_patch_api), leveraging mTLS-secured RESTful endpoints for all operations. + +## Key Features + +- **Centralized Dashboard** — Monitor patch status across all managed hosts from a single interface +- **Multi-Distribution Support** — Manage Debian/Ubuntu, RHEL/CentOS/Fedora, Alpine, and Arch hosts +- **Secure by Design** — mTLS authentication, role-based access control, audit logging +- **Batch Operations** — Apply patches and updates across multiple hosts simultaneously +- **Scheduling** — Plan and schedule patch windows with approval workflows +- **Reporting** — Compliance reporting and patch status dashboards + +## Architecture + +Linux Patch Manager is a web application that acts as a management plane, communicating with the Linux Patch API agent running on each managed host. + +``` +┌─────────────────────┐ +│ Linux Patch Manager │ ← Web UI (this project) +│ (Management Plane) │ +└──────────┬──────────┘ + │ mTLS / REST API + ┌──────┼──────┐ + ▼ ▼ ▼ +┌──────┐┌──────┐┌──────┐ +│ Host ││ Host ││ Host │ ← Linux Patch API agents +│ A ││ B ││ C │ +└──────┘└──────┘└──────┘ +``` + +## Documentation + +| Document | Description | +|----------|-------------| +| [SPEC.md](SPEC.md) | Full project specification | +| [ARCHITECTURE.md](ARCHITECTURE.md) | Architecture and design decisions | +| [REQUIREMENTS.md](REQUIREMENTS.md) | Functional and non-functional requirements | + +## Related Projects + +- **[Linux Patch API](https://gitea.moon-dragon.us/echo/linux_patch_api)** — The API agent that runs on each managed host + +## License + +Private — All rights reserved. diff --git a/REQUIREMENTS.md b/REQUIREMENTS.md new file mode 100644 index 0000000..9b9c2f1 --- /dev/null +++ b/REQUIREMENTS.md @@ -0,0 +1,69 @@ +# Linux_Patch_Manager - Requirements Document + +## Project Overview +**Title:** Linux_Patch_Manager +**Version:** 0.0.1 +**Status:** Draft + +## Functional Requirements + + + +### FR-01: Host Management + + +### FR-02: Patch Monitoring + + +### FR-03: Patch Deployment + + +### FR-04: Scheduling + + +### FR-05: Reporting + + +### FR-06: User Management + + +## Non-Functional Requirements + + + +### NFR-01: Security + + +### NFR-02: Performance + + +### NFR-03: Scalability + + +### NFR-04: Reliability + + +### NFR-05: Usability + + +## Interface Requirements + + + +### IR-01: Web Interface + + +### IR-02: Linux Patch API Integration + + +## Data Requirements + + + +## Compliance Requirements + + + +## Constraints + + diff --git a/SPEC.md b/SPEC.md new file mode 100644 index 0000000..d97ac34 --- /dev/null +++ b/SPEC.md @@ -0,0 +1,70 @@ +# Linux_Patch_Manager - Specification Document + +## Project Overview +**Title:** Linux_Patch_Manager +**Description:** Enterprise class secure web based management interface for controlling patching and updates on Linux servers and workstations +**Version:** 0.0.1 +**Status:** Draft + +## Scope + + + +**In Scope:** + + +**Out of Scope:** + + +## Objectives + + + +**Primary Objective:** + + +**Key Goals:** + + +## Constraints + + + +**Deployment:** + + +**Technical:** + + +**Security:** + + +## Architecture Overview + + + +## API Integration + + + +**Upstream Dependency:** [Linux Patch API](https://gitea.moon-dragon.us/echo/linux_patch_api) + +## User Interface + + + +## Error Handling + + + +## Assumptions + + + +## Dependencies + + + +## Audit Logging + +