Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swetoast/raid-status-endpoint
This is a Flask app that provides an endpoint to monitor RAID volumes on a server. It fetches RAID status using `mdadm --detail`, parses the output, and returns it in JSON format. The app's settings are read from a `raid_endpoint.conf` file. It supports HTTPS if configured.
https://github.com/swetoast/raid-status-endpoint
automation homeassistant monitoring openhab
Last synced: 30 days ago
JSON representation
This is a Flask app that provides an endpoint to monitor RAID volumes on a server. It fetches RAID status using `mdadm --detail`, parses the output, and returns it in JSON format. The app's settings are read from a `raid_endpoint.conf` file. It supports HTTPS if configured.
- Host: GitHub
- URL: https://github.com/swetoast/raid-status-endpoint
- Owner: swetoast
- License: unlicense
- Created: 2024-01-16T08:44:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-16T12:17:49.000Z (6 months ago)
- Last Synced: 2024-06-16T13:27:16.234Z (6 months ago)
- Topics: automation, homeassistant, monitoring, openhab
- Language: Python
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RAID Status Endpoint
This is a Flask application that provides an API endpoint to get the status of RAID volumes.
## Features
- **RAID Detail Retrieval**: Retrieves RAID details including resync status, state, active disks, failed disks, used space, and resync speed.
- **API Endpoint**: Provides routes `/raid_status/` and `/raid_status` to get the status of a specific RAID volume or all RAID volumes, respectively.
## Installation
1. Clone this repository.
2. Install the required Python packages: Flask, re, configparser, subprocess, os.
## Configuration
Configure the application by modifying the `raid_endpoint.conf` file in the same directory as the script. The configuration includes the host, port, whether to use HTTPS, and paths to the certificate and key files if HTTPS is used.
## Usage
Run the script to start the Flask application.
## API Endpoints
- `GET /raid_status/`: Returns a JSON object with the status of the specified RAID volume. The status includes resync status, state, active disks, failed disks, used space, and resync speed.
- `GET /raid_status`: Returns a JSON object with the status of all RAID volumes.
## Home Assistant Integration
This application can be integrated with Home Assistant using the REST sensor. Here's an example configuration:
```yaml
sensor:
- platform: rest
resource: http://IP_ADDRESS:PORT/raid_status/VOLUME_NAME
name: RAID Status
value_template: '{{ value_json.state }}'
json_attributes_path: "$.attributes"
json_attributes:
- resync_status
- active_disks
- failed_disks
- used_space
- resync_speed
```
## Importing a Blueprint in Home Assistant
Follow these steps to import a blueprint in Home Assistant:
1. Navigate to `Configuration` → `Automations & Scenes` → `Blueprints`.
2. Click on the `Import Blueprint` button located at the bottom right.
3. A dialog will pop-up asking for the URL of the blueprint. Enter the URL of your blueprint. For example: `https://raw.githubusercontent.com/swetoast/RAID-Status-Endpoint/main/blueprint_raid_status.yaml`
4. Click on `Preview Blueprint`. This will load the blueprint and show a preview in the import dialog.
5. You can change the name of the blueprint if you wish, and then click `Import Blueprint`.
The blueprint can now be used for creating automations. If the blueprint goes through revisions, you may need to re-import it to get the changes.
Please note that these instructions are based on the Home Assistant user interface as of the time of writing and may vary with future updates.