imp4ct/Dell_iDRAC_fan_controller_Docker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tigerblue77 2022-04-13 15:12:41 +02:00 committed by GitHub
parent 3421ced8d1
commit bd273f7e39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 72 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@ -1,23 +1,38 @@
# Dell iDRAC fan controller Docker Image <div id="top"></div>
- `IDRAC_HOST` parameter can be set to "local" or to your distant iDRAC's IP address. Default value is "local". # Dell iDRAC fan controller Docker image
- `IDRAC_USERNAME` parameter is only necessary if you're adressing a distant iDRAC. Default value is "root".
- `IDRAC_PASSWORD` parameter is only necessary if you're adressing a distant iDRAC. Default value is "calvin".
- `FAN_SPEED` parameter can be set as a decimal (from 0 to 100%) or hexadecimal value (from 0x00 to 0x64) you want to set the fans to. Default value is 5(%).
- `CPU_TEMPERATURE_TRESHOLD` parameter is the T°junction (junction temperature) threshold beyond which the Dell fan mode defined in your BIOS will become active again (to protect the server hardware against overheat). Default value is 50(°C).
- `CHECK_INTERVAL` parameter is the time (in seconds) between each temperature check. Default value is 60(s).
To use: <!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li><a href="#container-console-log-example">Container console log example</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#parameters">Parameters</a></li>
<li><a href="#contributing">Contributing</a></li>
</ol>
</details>
## Container console log example
![image](https://user-images.githubusercontent.com/37409593/163174925-d3d20ed6-0f95-44e6-827d-368939435ba4.png)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- USAGE -->
## Usage
1. with local iDRAC: 1. with local iDRAC:
```bash ```bash
docker run -d \ docker run -d \
--name Dell_iDRAC_fan_controller \ --name Dell_iDRAC_fan_controller \
--restart unless-stopped \ --restart=unless-stopped \
-e IDRAC_HOST=local \
-e FAN_SPEED=<dec or hex fan speed> \ -e FAN_SPEED=<dec or hex fan speed> \
-e CPU_TEMPERATURE_TRESHOLD=<dec temp treshold> \ -e CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold> \
alombardo4/idrac-fan-control:latest -e CHECK_INTERVAL=<seconds between each check> \
tigerblue77/dell_idrac_fan_controller:latest
``` ```
2. with LAN iDRAC: 2. with LAN iDRAC:
@ -25,13 +40,14 @@ docker run -d \
```bash ```bash
docker run -d \ docker run -d \
--name Dell_iDRAC_fan_controller \ --name Dell_iDRAC_fan_controller \
--restart unless-stopped \ --restart=unless-stopped \
-e IDRAC_HOST=<iDRAC host IP> \ -e IDRAC_HOST=<iDRAC host IP> \
-e IDRAC_USERNAME=<iDRAC username> \ -e IDRAC_USERNAME=<iDRAC username> \
-e IDRAC_PASSWORD=<iDRAC password> \ -e IDRAC_PASSWORD=<iDRAC password> \
-e FAN_SPEED=<dec or hex fan speed> \ -e FAN_SPEED=<dec or hex fan speed> \
-e CPU_TEMPERATURE_TRESHOLD=<dec temp treshold> \ -e CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold> \
alombardo4/idrac-fan-control:latest -e CHECK_INTERVAL=<seconds between each check> \
tigerblue77/dell_idrac_fan_controller:latest
``` ```
`docker-compose.yml` examples: `docker-compose.yml` examples:
@ -43,13 +59,14 @@ version: '3'
services: services:
Dell_iDRAC_fan_controller: Dell_iDRAC_fan_controller:
image: alombardo4/idrac-fan-control image: tigerblue77/dell_idrac_fan_controller
container_name: Dell_iDRAC_fan_controller container_name: Dell_iDRAC_fan_controller
restart: unless-stopped restart: unless-stopped
environment: environment:
- IDRAC_HOST=local # can be omitted as it is the default value - IDRAC_HOST=local
- FAN_SPEED=0x05 # set to the decimal or hexadecimal value you want to set the fans to (from 0 to 100%) - FAN_SPEED=<dec or hex fan speed>
- CPU_TEMPERATURE_TRESHOLD=<dec temp treshold> - CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold>
- CHECK_INTERVAL=<seconds between each check>
devices: devices:
- /dev/ipmi0:/dev/ipmi0 - /dev/ipmi0:/dev/ipmi0
``` ```
@ -61,17 +78,46 @@ version: '3'
services: services:
Dell_iDRAC_fan_controller: Dell_iDRAC_fan_controller:
image: alombardo4/idrac-fan-control image: tigerblue77/dell_idrac_fan_controller
container_name: Dell_iDRAC_fan_controller container_name: Dell_iDRAC_fan_controller
restart: unless-stopped restart: unless-stopped
environment: environment:
- IDRAC_HOST=192.168.1.100 # override to the IP address of your IDRAC - IDRAC_HOST=<iDRAC IP address>
- IDRAC_USERNAME=root # set to your IPMI username - IDRAC_USERNAME=<iDRAC username>
- IDRAC_PASSWORD=calvin # set to your IPMI password - IDRAC_PASSWORD=<iDRAC password>
- FAN_SPEED=0x05 # set to the decimal or hexadecimal value you want to set the fans to (from 0 to 100%) - FAN_SPEED=<dec or hex fan speed>
- CPU_TEMPERATURE_TRESHOLD=<dec temp treshold> - CPU_TEMPERATURE_TRESHOLD=<dec temperature treshold>
- CHECK_INTERVAL=<seconds between each check>
``` ```
Container console log example: <p align="right">(<a href="#top">back to top</a>)</p>
![image](https://user-images.githubusercontent.com/37409593/163174925-d3d20ed6-0f95-44e6-827d-368939435ba4.png) <!-- PARAMETERS -->
## Parameters
All parameters are optional as they have default values (including default iDRAC username and password).
- `IDRAC_HOST` parameter can be set to "local" or to your distant iDRAC's IP address. **Default** value is "local".
- `IDRAC_USERNAME` parameter is only necessary if you're adressing a distant iDRAC. **Default** value is "root".
- `IDRAC_PASSWORD` parameter is only necessary if you're adressing a distant iDRAC. **Default** value is "calvin".
- `FAN_SPEED` parameter can be set as a decimal (from 0 to 100%) or hexadecimal value (from 0x00 to 0x64) you want to set the fans to. **Default** value is 5(%).
- `CPU_TEMPERATURE_TRESHOLD` parameter is the T°junction (junction temperature) threshold beyond which the Dell fan mode defined in your BIOS will become active again (to protect the server hardware against overheat). **Default** value is 50(°C).
- `CHECK_INTERVAL` parameter is the time (in seconds) between each temperature check and potential profile change. **Default** value is 60(s).
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#top">back to top</a>)</p>