Files
maintenance-tools/maintenance_server_data/README.md
2026-03-29 23:44:25 +02:00

90 lines
2.7 KiB
Markdown

=======================
maintenance_server_data
=======================
This module extends the maintenance equipment model to store detailed server
information, enabling comprehensive server infrastructure management within Odoo.
It adds several new models and fields to track:
- **Server specifications**: IP address, CPU cores, RAM, disk storage
- **Operating system**: Distribution name and version
- **Services**: Track services running on each server with their versions and URLs
- **Backup information**: Backup server, activation status, and health
# Installation
Use Odoo normal module installation procedure to install
`maintenance_server_data`.
This module depends on `maintenance`.
# Configuration
No specific configuration is required. After installation, new fields will be
available on the maintenance equipment form.
# Usage
## Managing Server Equipment
1. Go to Maintenance > Equipments
2. Create or edit an equipment record
3. Fill in the server-specific fields:
- **Server IP Address**: The server's IP address
- **Distribution**: Select or create an OS distribution
- **Hosting City**: Physical location of the server
- **Nb Cores**: Number of CPU cores
- **RAM (Go)**: Amount of RAM in gigabytes
- **Disk Storage (Go)**: Disk capacity in gigabytes
- **Backup Activated**: Whether backups are enabled
- **Backup Server**: The backup destination server
- **Backup OK**: Current backup health status
## Managing OS Distributions
1. Go to Maintenance > Configuration > OS Distributions
2. Create distributions with name and version (e.g., "Ubuntu", "22.04")
3. The display name is automatically computed from name + version
## Managing Services
1. Go to Maintenance > Configuration > Services
2. Create service definitions (e.g., "PostgreSQL", "Nginx", "Odoo")
3. Create service versions for each service
4. Mark the latest version with "Is Last Version?"
## Managing Service Instances
1. Go to Maintenance > Configuration > Service Instances
2. Link services to equipment with their specific version and URL
3. Service instances are automatically archived when their equipment is archived
# Known issues / Roadmap
- Add monitoring integration for automated backup status checks
- Add service version upgrade tracking
# Bug Tracker
Bugs are tracked on
[our issues website](https://github.com/elabore-coop/maintenance-tools/issues). In
case of trouble, please check there if your issue has already been reported. If you
spotted it first, help us smashing it by providing a detailed and welcomed feedback.
# Credits
## Contributors
- Stéphan Sainléger
## Funders
The development of this module has been financially supported by:
- Elabore (https://elabore.coop)
## Maintainer
This module is maintained by Elabore.