ADD V1 release

[mart337i]

Summary by CodeRabbit

• New Features

  • Introduced a modular service layer for Proxmox management, including virtual machines, networking, storage, tasks, users, QEMU agent, and software operations.
  • Added new API endpoints for Proxmox resource management (VMs, nodes, storage, tasks, network, QEMU, software).
  • Added CLI commands for database creation, testing, and migration.
  • Added SQLAlchemy-based database models and session management.
  • Added dynamic versioning based on date/time and Git commit hash.
  • Introduced Bash scripts for automated Nginx proxy configuration.

• Improvements

  • Refactored Proxmox API routes to use dependency injection and centralized connection handling.
  • Enhanced authentication middleware with strict token validation.
  • Improved logging configuration using Python's logging config module.
  • Updated template styling and endpoint badge color logic for improved UI clarity.

• Bug Fixes

  • Improved error handling and validation across API endpoints and CLI commands.

• Documentation

  • Expanded README with PostgreSQL setup instructions and ORM model examples.

• Chores

  • Updated environment and compose configurations to support secure secret injection and timezone settings.

• Removals

  • Removed deprecated or redundant modules, CLI commands, and schema definitions to streamline the codebase.

[coderabbitai]

Walkthrough

This update implements a substantial refactor and modularization of the Proxmox addon and the core application, introducing a new service-oriented architecture for Proxmox management. The Proxmox addon is restructured, splitting monolithic models and CLI scripts into focused service classes for virtual machines, networking, storage, tasks, users, and QEMU agent management. FastAPI routes are refactored to use dependency-injected service instances, and new endpoints are added for network, storage, QEMU, software, and task management. The core application introduces a database layer using SQLAlchemy, with CLI commands for database setup and user management. Logging, versioning, and configuration handling are improved, and deployment scripts and environment management are updated for better security and maintainability.

Changes

File(s)	Change Summary
.github/workflows/pipeline.yaml, compose.yaml, gunicorn.sh, clicx-bin	Updated deployment and runtime configuration: added secret environment variable injection, timezone change, updated entrypoints, and log file paths.
README.md	Added PostgreSQL setup instructions, SQLAlchemy model example, and updated API timeout note.
addons/base/__init__.py, addons/proxmox/__init__.py	Added module-level metadata variables and constants for versioning and authorship.
addons/base/__manifest__.py, addons/proxmox/__maifest__.py	Removed manifest files containing addon metadata.
addons/base/controller/index.py, addons/base/templates/index.html.jinja	Updated index endpoint to accept request, dynamically list routes, and improved template styling and endpoint badge logic.
addons/base/routes/config_utils.py, addons/base/routes/templates_utils.py	Removed utility FastAPI routers for config and template listing.
addons/proxmox/cli/container.py, addons/proxmox/cli/setup.py	Removed CLI scripts for container management and token authentication testing.
addons/proxmox/cli/vm.py	Refactored VM CLI: replaced direct connection logic with service-based calls, removed extra commands, and updated imports.
addons/proxmox/configurations/proxmox.json	Cleared the value of the "token_value" field for improved secret management.
addons/proxmox/enums/auth.py, addons/proxmox/enums/proxmox.py, addons/proxmox/enums/qemu.py, addons/proxmox/enums/status.py	Added new Enum classes for authentication types, backend types, QEMU status, and status codes.
addons/proxmox/middleware/auth.py	Implemented strict token-based authentication using environment variables and proper error handling.
addons/proxmox/models/__init__.py	Changed import from proxmox to auth module.
addons/proxmox/models/auth.py, addons/proxmox/models/enums.py, addons/proxmox/models/proxmox.py	Removed old enum and monolithic Proxmox client class, facilitating modularization.
addons/proxmox/routes/container.py	Removed container-related FastAPI router.
addons/proxmox/routes/network.py, addons/proxmox/routes/node.py, addons/proxmox/routes/qemu.py, addons/proxmox/routes/software.py, addons/proxmox/routes/storage.py, addons/proxmox/routes/task.py, addons/proxmox/routes/vm.py	Introduced/refactored FastAPI routers for Proxmox services: network, node, QEMU, software, storage, task, and VM management, using dependency-injected service clients and improved error handling.
addons/proxmox/schema/__init__.py, addons/proxmox/schema/bash.py, addons/proxmox/schema/lxc.py	Removed bash and LXC schema imports and files, leaving only VM schema.
addons/proxmox/service/__init__.py, addons/proxmox/service/cluster.py, addons/proxmox/service/networking.py, addons/proxmox/service/proxmox.py, addons/proxmox/service/qemu.py, addons/proxmox/service/software.py, addons/proxmox/service/storage.py, addons/proxmox/service/task.py, addons/proxmox/service/user.py, addons/proxmox/service/vm.py	Introduced a modular service architecture for Proxmox: separate classes for cluster, networking, VM, QEMU agent, software, storage, task, and user management, with a unified Proxmox client for connection and service access.
addons/proxmox/templates/create_proxy_conf.sh, addons/proxmox/templates/simple_create_proxy_conf.sh	Added Bash scripts for automated Nginx proxy configuration.
addons/proxmox/utils/yml_parser.py	Removed YAML parser utilities.
clicx/__init__.py	Changed versioning to use a dynamic getter, moved variable assignment after imports.
clicx/_models/__init__.py, clicx/_models/users.py	Added user model import and a new SQLAlchemy User model.
clicx/cli/__init__.py, clicx/utils/__init__.py	Added imports for new database and version utility modules.
clicx/cli/command.py, clicx/cli/database.py	Added Typer CLI commands for database management: create, test connection, and migrate (stub).
clicx/cli/server.py	Enhanced CLI server command: allowed extra arguments, refactored config handling, and updated server start logic.
clicx/config.py	Refactored logging setup to use logging.config.dictConfig for centralized configuration.
clicx/database/__init__.py, clicx/database/models.py, clicx/database/sql.py	Introduced database package: SQLAlchemy base, abstract model, and connection/session management classes.
clicx/server.py	Refactored API instantiation: added configure method, new factory function, updated server start logic for uvicorn factory mode.
clicx/utils/middleware.py	Changed request logging from error to debug level.
clicx/utils/version.py	Added dynamic version and API version functions using date/time and Git commit hash.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant FastAPI_Router
    participant ProxmoxService
    participant ProxmoxerAPI

    Client->>FastAPI_Router: API Request (e.g., /proxmox/v1/vm/start)
    FastAPI_Router->>ProxmoxService: Inject Proxmox client (Depends)
    ProxmoxService->>ProxmoxerAPI: Perform requested operation (e.g., start_vm)
    ProxmoxerAPI-->>ProxmoxService: Return result/status
    ProxmoxService-->>FastAPI_Router: Return result/status
    FastAPI_Router-->>Client: API Response

Loading

sequenceDiagram
    participant CLI_User
    participant Typer_CLI
    participant DatabaseLayer
    participant DB

    CLI_User->>Typer_CLI: Run 'clicx db create'
    Typer_CLI->>DatabaseLayer: Create tables, add user
    DatabaseLayer->>DB: Execute SQLAlchemy ORM commands
    DB-->>DatabaseLayer: Commit or error
    DatabaseLayer-->>Typer_CLI: Success/Error message
    Typer_CLI-->>CLI_User: Output result

Loading

Poem

Hopping through code with a whisk of delight,
The Proxmox rabbit made modules take flight!
Services now prance in a modular warren,
With FastAPI routes that are never borin’.
The database garden is ready to grow,
With users and CLI seeds all in a row.
So raise your paws high, for this code is a treat—
Modular, secure, and ever so neat!

((\
( -.-)
o_(")(")

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 3e1545e and c0640f0.

📒 Files selected for processing (65)

• .github/workflows/pipeline.yaml (1 hunks)
• README.md (1 hunks)
• addons/base/__init__.py (1 hunks)
• addons/base/__manifest__.py (0 hunks)
• addons/base/controller/index.py (2 hunks)
• addons/base/routes/config_utils.py (0 hunks)
• addons/base/routes/templates_utils.py (0 hunks)
• addons/base/templates/index.html.jinja (2 hunks)
• addons/proxmox/__init__.py (1 hunks)
• addons/proxmox/__maifest__.py (0 hunks)
• addons/proxmox/cli/container.py (0 hunks)
• addons/proxmox/cli/setup.py (0 hunks)
• addons/proxmox/cli/vm.py (9 hunks)
• addons/proxmox/configurations/proxmox.json (0 hunks)
• addons/proxmox/enums/auth.py (1 hunks)
• addons/proxmox/enums/proxmox.py (1 hunks)
• addons/proxmox/enums/qemu.py (1 hunks)
• addons/proxmox/enums/status.py (1 hunks)
• addons/proxmox/middleware/auth.py (1 hunks)
• addons/proxmox/models/__init__.py (1 hunks)
• addons/proxmox/models/auth.py (0 hunks)
• addons/proxmox/models/enums.py (0 hunks)
• addons/proxmox/models/proxmox.py (0 hunks)
• addons/proxmox/routes/container.py (0 hunks)
• addons/proxmox/routes/network.py (1 hunks)
• addons/proxmox/routes/node.py (1 hunks)
• addons/proxmox/routes/qemu.py (1 hunks)
• addons/proxmox/routes/software.py (1 hunks)
• addons/proxmox/routes/storage.py (1 hunks)
• addons/proxmox/routes/task.py (1 hunks)
• addons/proxmox/routes/vm.py (1 hunks)
• addons/proxmox/schema/__init__.py (0 hunks)
• addons/proxmox/schema/bash.py (0 hunks)
• addons/proxmox/schema/lxc.py (0 hunks)
• addons/proxmox/service/__init__.py (1 hunks)
• addons/proxmox/service/cluster.py (1 hunks)
• addons/proxmox/service/networking.py (1 hunks)
• addons/proxmox/service/proxmox.py (1 hunks)
• addons/proxmox/service/qemu.py (1 hunks)
• addons/proxmox/service/software.py (1 hunks)
• addons/proxmox/service/storage.py (1 hunks)
• addons/proxmox/service/task.py (1 hunks)
• addons/proxmox/service/user.py (1 hunks)
• addons/proxmox/service/vm.py (1 hunks)
• addons/proxmox/templates/create_proxy_conf.sh (1 hunks)
• addons/proxmox/templates/simple_create_proxy_conf.sh (1 hunks)
• addons/proxmox/utils/yml_parser.py (0 hunks)
• clicx-bin (1 hunks)
• clicx/__init__.py (1 hunks)
• clicx/_models/__init__.py (1 hunks)
• clicx/_models/users.py (1 hunks)
• clicx/cli/__init__.py (1 hunks)
• clicx/cli/command.py (1 hunks)
• clicx/cli/database.py (1 hunks)
• clicx/cli/server.py (1 hunks)
• clicx/config.py (2 hunks)
• clicx/database/__init__.py (1 hunks)
• clicx/database/models.py (1 hunks)
• clicx/database/sql.py (1 hunks)
• clicx/server.py (2 hunks)
• clicx/utils/__init__.py (1 hunks)
• clicx/utils/middleware.py (1 hunks)
• clicx/utils/version.py (1 hunks)
• compose.yaml (1 hunks)
• gunicorn.sh (2 hunks)

💤 Files with no reviewable changes (15)

• addons/proxmox/schema/init.py
• addons/proxmox/maifest.py
• addons/proxmox/models/auth.py
• addons/base/manifest.py
• addons/proxmox/configurations/proxmox.json
• addons/proxmox/schema/lxc.py
• addons/proxmox/schema/bash.py
• addons/base/routes/config_utils.py
• addons/proxmox/models/enums.py
• addons/base/routes/templates_utils.py
• addons/proxmox/utils/yml_parser.py
• addons/proxmox/routes/container.py
• addons/proxmox/cli/setup.py
• addons/proxmox/cli/container.py
• addons/proxmox/models/proxmox.py

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.