Compare commits
3 Commits
18.0
...
fd9b169925
| Author | SHA1 | Date | |
|---|---|---|---|
|
fd9b169925 | ||
|
|
9897d7ebe8 | ||
|
|
8558f5b79f |
@@ -1,92 +0,0 @@
|
|||||||
============================================
|
|
||||||
maintenance_create_requests_from_project_task
|
|
||||||
============================================
|
|
||||||
|
|
||||||
This module allows the bulk creation of maintenance requests directly from a
|
|
||||||
project task. It is particularly useful when a task requires maintenance
|
|
||||||
actions on multiple equipment items simultaneously.
|
|
||||||
|
|
||||||
Key features:
|
|
||||||
|
|
||||||
- **Bulk creation**: Create multiple maintenance requests at once from a task
|
|
||||||
- **Equipment filtering**: Use domain filters to select target equipment
|
|
||||||
- **Smart defaults**: Pre-fills equipment from the task's project
|
|
||||||
- **Request tracking**: View all maintenance requests linked to a task
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
Use Odoo normal module installation procedure to install
|
|
||||||
`maintenance_create_requests_from_project_task`.
|
|
||||||
|
|
||||||
This module depends on:
|
|
||||||
- `maintenance`
|
|
||||||
- `maintenance_project`
|
|
||||||
- `project`
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
No specific configuration is required.
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Creating Maintenance Requests from a Task
|
|
||||||
|
|
||||||
1. Go to Project > Tasks
|
|
||||||
2. Open a task
|
|
||||||
3. In the action menu (or via the server action), click "Create maintenance requests"
|
|
||||||
4. A wizard opens with:
|
|
||||||
- **Task**: The source task (read-only)
|
|
||||||
- **Title**: The name for all created maintenance requests
|
|
||||||
- **Equipment Domain**: Filter to select which equipment to target
|
|
||||||
- By default, shows equipment linked to the task's project
|
|
||||||
- Use the domain builder to refine the selection
|
|
||||||
- **Technician**: Assign a technician to all requests
|
|
||||||
- **Maintenance Type**: Corrective or Preventive
|
|
||||||
- **Priority**: From Very Low to High
|
|
||||||
- **Duration**: Estimated duration in hours
|
|
||||||
- **Scheduled Date**: When the maintenance should occur
|
|
||||||
- **Description**: Details about the maintenance work
|
|
||||||
5. Click "Create"
|
|
||||||
6. All matching equipment will have a maintenance request created
|
|
||||||
7. You are redirected to the list of created requests
|
|
||||||
|
|
||||||
## Viewing Linked Maintenance Requests
|
|
||||||
|
|
||||||
On the task form:
|
|
||||||
- A smart button shows the count of open (not done) maintenance requests
|
|
||||||
- Click it to view all maintenance requests linked to this task
|
|
||||||
|
|
||||||
## Equipment Domain Examples
|
|
||||||
|
|
||||||
- All equipment in the project: `[('project_id', '=', project_id)]`
|
|
||||||
- Only servers: `[('category_id.name', '=', 'Server')]`
|
|
||||||
- Equipment needing backup: `[('backup_activated', '=', True)]`
|
|
||||||
- Combine conditions: `[('project_id', '=', project_id), ('category_id.name', '=', 'Server')]`
|
|
||||||
|
|
||||||
# Known issues / Roadmap
|
|
||||||
|
|
||||||
- Add template support for common maintenance scenarios
|
|
||||||
- Add option to create a single request for multiple equipment
|
|
||||||
|
|
||||||
# Bug Tracker
|
|
||||||
|
|
||||||
Bugs are tracked on
|
|
||||||
[our issues website](https://git.elabore.coop/Elabore/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.
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
=======================
|
|
||||||
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.
|
|
||||||
@@ -1,151 +0,0 @@
|
|||||||
===================================
|
|
||||||
maintenance_service_http_monitoring
|
|
||||||
===================================
|
|
||||||
|
|
||||||
This module provides automated HTTP availability monitoring for services
|
|
||||||
defined on maintenance equipment. It periodically checks the HTTP status of
|
|
||||||
service URLs and automatically creates maintenance requests when services
|
|
||||||
are detected as unavailable.
|
|
||||||
|
|
||||||
Key features:
|
|
||||||
|
|
||||||
- **Automated HTTP checks**: Scheduled cron job checks all active services
|
|
||||||
- **Maintenance mode**: Temporarily disable monitoring during planned maintenance
|
|
||||||
- **Automatic maintenance requests**: Creates corrective maintenance requests
|
|
||||||
when services fail HTTP checks
|
|
||||||
- **Status tracking**: Records last HTTP status code and check date per service
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
Use Odoo normal module installation procedure to install
|
|
||||||
`maintenance_service_http_monitoring`.
|
|
||||||
|
|
||||||
This module depends on:
|
|
||||||
- `maintenance`
|
|
||||||
- `maintenance_server_data`
|
|
||||||
|
|
||||||
**Python dependencies**: This module requires the `requests` library.
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
## Maintenance Mode Duration
|
|
||||||
|
|
||||||
By default, maintenance mode lasts 4 hours. To change this:
|
|
||||||
|
|
||||||
1. Go to Settings > Technical > System Parameters
|
|
||||||
2. Create or edit the parameter:
|
|
||||||
- Key: `maintenance_service_http_monitoring.maintenance_mode_duration`
|
|
||||||
- Value: Duration in hours (e.g., `8`)
|
|
||||||
|
|
||||||
## Cron Jobs
|
|
||||||
|
|
||||||
Two scheduled actions are installed:
|
|
||||||
|
|
||||||
1. **HTTP Service Monitoring: check all services**
|
|
||||||
- Runs every 15 minutes
|
|
||||||
- Checks HTTP status of all active service instances with URLs
|
|
||||||
|
|
||||||
2. **HTTP Service Monitoring: deactivate expired maintenance mode**
|
|
||||||
- Runs every 15 minutes
|
|
||||||
- Automatically disables maintenance mode when the end time is reached
|
|
||||||
|
|
||||||
## Webhook Notifications
|
|
||||||
|
|
||||||
Go to **Settings > Technical > Parameters > System Parameters** and configure:
|
|
||||||
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
| Key | Description |
|
|
||||||
+========================================================+========================================+
|
|
||||||
| ``maintenance_service_http_monitoring.webhook_url`` | Webhook URL (POST endpoint) |
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
| ``maintenance_service_http_monitoring.webhook_user`` | Basic Auth username (optional) |
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
| ``maintenance_service_http_monitoring.webhook_password``| Basic Auth password (optional) |
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Monitoring Services
|
|
||||||
|
|
||||||
Services are automatically monitored if they have:
|
|
||||||
- A service URL defined
|
|
||||||
- An associated equipment
|
|
||||||
- The equipment is not in maintenance mode
|
|
||||||
- The service instance is active
|
|
||||||
|
|
||||||
The monitoring checks HTTPS availability (HTTP URLs are automatically
|
|
||||||
upgraded to HTTPS). A service is considered OK if it returns HTTP 200.
|
|
||||||
|
|
||||||
## Using Maintenance Mode
|
|
||||||
|
|
||||||
When performing planned maintenance on a server:
|
|
||||||
|
|
||||||
1. Go to Maintenance > Equipments
|
|
||||||
2. Open the equipment record
|
|
||||||
3. Click "Activer le mode maintenance" (Activate maintenance mode)
|
|
||||||
4. HTTP monitoring is suspended for this equipment
|
|
||||||
5. The mode automatically expires after the configured duration
|
|
||||||
6. Or click "Désactiver le mode maintenance" to end it manually
|
|
||||||
|
|
||||||
## Viewing HTTP Status
|
|
||||||
|
|
||||||
On service instances, you can see:
|
|
||||||
- **Last HTTP Status Code**: The last received HTTP status (200, 404, 500, etc.)
|
|
||||||
- **Last HTTP Check Date**: When the last check was performed
|
|
||||||
- **HTTP Status OK**: Quick visual indicator of service health
|
|
||||||
|
|
||||||
## Automatic Maintenance Requests
|
|
||||||
|
|
||||||
When a service fails HTTP checks:
|
|
||||||
- A corrective maintenance request is created with prefix "[HTTP KO]"
|
|
||||||
- The request is linked to the equipment
|
|
||||||
- Only one request per equipment per day is created
|
|
||||||
- The request description lists all failing services
|
|
||||||
|
|
||||||
## Webhook notifications
|
|
||||||
|
|
||||||
When a new maintenance request is created (HTTP check failure), the module can
|
|
||||||
send a webhook notification to an external service (e.g., n8n, Rocket.Chat, Slack).
|
|
||||||
|
|
||||||
The webhook sends a JSON POST with the following structure::
|
|
||||||
|
|
||||||
{
|
|
||||||
"id": 42,
|
|
||||||
"name": "[HTTP KO] Server Name",
|
|
||||||
"priority": "2",
|
|
||||||
"description": "Service KO: https://example.com",
|
|
||||||
"equipment": "Server Name",
|
|
||||||
"link": "https://odoo.example.com/web#id=42&model=maintenance.request&view_type=form"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# Known issues / Roadmap
|
|
||||||
|
|
||||||
- Add configurable alert thresholds (e.g., alert after N consecutive failures)
|
|
||||||
- Add email/notification on service failure
|
|
||||||
- Support custom HTTP check endpoints (e.g., /health)
|
|
||||||
- Add support for basic authentication
|
|
||||||
|
|
||||||
# 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.
|
|
||||||
@@ -8,7 +8,6 @@
|
|||||||
"depends": ["base", "maintenance", "maintenance_server_data"],
|
"depends": ["base", "maintenance", "maintenance_server_data"],
|
||||||
"external_dependencies": {"python": ["requests"]},
|
"external_dependencies": {"python": ["requests"]},
|
||||||
"data": [
|
"data": [
|
||||||
"data/ir_config_parameter.xml",
|
|
||||||
"data/cron.xml",
|
"data/cron.xml",
|
||||||
"views/service_instance_views.xml",
|
"views/service_instance_views.xml",
|
||||||
"views/maintenance_equipment_views.xml",
|
"views/maintenance_equipment_views.xml",
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<odoo noupdate="1">
|
|
||||||
<record id="config_param_webhook_url" model="ir.config_parameter">
|
|
||||||
<field name="key">maintenance_service_http_monitoring.webhook_url</field>
|
|
||||||
<field name="value"></field>
|
|
||||||
</record>
|
|
||||||
<record id="config_param_webhook_user" model="ir.config_parameter">
|
|
||||||
<field name="key">maintenance_service_http_monitoring.webhook_user</field>
|
|
||||||
<field name="value"></field>
|
|
||||||
</record>
|
|
||||||
<record id="config_param_webhook_password" model="ir.config_parameter">
|
|
||||||
<field name="key">maintenance_service_http_monitoring.webhook_password</field>
|
|
||||||
<field name="value"></field>
|
|
||||||
</record>
|
|
||||||
</odoo>
|
|
||||||
@@ -1,18 +1,8 @@
|
|||||||
import logging
|
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
from odoo import api, fields, models
|
from odoo import api, fields, models
|
||||||
|
|
||||||
|
|
||||||
try:
|
|
||||||
import requests as http_requests
|
|
||||||
except ImportError:
|
|
||||||
http_requests = None
|
|
||||||
|
|
||||||
_logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
WEBHOOK_TIMEOUT = 10 # seconds
|
|
||||||
|
|
||||||
class MaintenanceEquipment(models.Model):
|
class MaintenanceEquipment(models.Model):
|
||||||
_inherit = "maintenance.equipment"
|
_inherit = "maintenance.equipment"
|
||||||
|
|
||||||
@@ -113,51 +103,8 @@ class MaintenanceEquipment(models.Model):
|
|||||||
vals["maintenance_team_id"] = team.id
|
vals["maintenance_team_id"] = team.id
|
||||||
request = self.env["maintenance.request"].create(vals)
|
request = self.env["maintenance.request"].create(vals)
|
||||||
self.http_maintenance_request = request.id
|
self.http_maintenance_request = request.id
|
||||||
self._notify_webhook(request, ko_services)
|
|
||||||
return request
|
return request
|
||||||
|
|
||||||
def _notify_webhook(self, request, ko_services):
|
|
||||||
"""Send a webhook notification when a new maintenance request is created."""
|
|
||||||
ICP = self.env['ir.config_parameter'].sudo()
|
|
||||||
webhook_url = ICP.get_param(
|
|
||||||
'maintenance_service_http_monitoring.webhook_url', ''
|
|
||||||
)
|
|
||||||
if not webhook_url:
|
|
||||||
return
|
|
||||||
webhook_user = ICP.get_param(
|
|
||||||
'maintenance_service_http_monitoring.webhook_user', ''
|
|
||||||
)
|
|
||||||
webhook_password = ICP.get_param(
|
|
||||||
'maintenance_service_http_monitoring.webhook_password', ''
|
|
||||||
)
|
|
||||||
base_url = ICP.get_param('web.base.url', '')
|
|
||||||
link = (
|
|
||||||
f"{base_url}/web#id={request.id}"
|
|
||||||
f"&model=maintenance.request&view_type=form"
|
|
||||||
)
|
|
||||||
payload = {
|
|
||||||
'id': request.id,
|
|
||||||
'name': request.name,
|
|
||||||
'description': request.description or '',
|
|
||||||
'equipment': self.name,
|
|
||||||
'link': link,
|
|
||||||
}
|
|
||||||
auth = None
|
|
||||||
if webhook_user and webhook_password:
|
|
||||||
auth = (webhook_user, webhook_password)
|
|
||||||
try:
|
|
||||||
http_requests.post(
|
|
||||||
webhook_url,
|
|
||||||
json=payload,
|
|
||||||
auth=auth,
|
|
||||||
timeout=WEBHOOK_TIMEOUT,
|
|
||||||
)
|
|
||||||
except Exception as e:
|
|
||||||
_logger.warning(
|
|
||||||
"Webhook notification failed for maintenance request %s: %s",
|
|
||||||
request.id, e,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _build_ko_services_description(self, ko_services):
|
def _build_ko_services_description(self, ko_services):
|
||||||
lines = [f"Service KO: {s.service_url or s.name}" for s in ko_services]
|
lines = [f"Service KO: {s.service_url or s.name}" for s in ko_services]
|
||||||
return "\n".join(lines)
|
return "\n".join(lines)
|
||||||
|
|||||||
Reference in New Issue
Block a user