From 6310262e97ec5582ac583d13c5d4c3240effdf5c Mon Sep 17 00:00:00 2001 From: gyptazy Date: Wed, 16 Oct 2024 08:19:16 +0200 Subject: [PATCH] fix(docs): Change docs to make bool usage in configs more clear. Fixes: #104 --- .changelogs/1.0.5/104_docs_bool_adjustment.yml | 2 ++ .changelogs/1.0.5/release_meta.yml | 1 + CONTRIBUTING.md | 4 ++-- README.md | 14 +++++++------- 4 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 .changelogs/1.0.5/104_docs_bool_adjustment.yml create mode 100644 .changelogs/1.0.5/release_meta.yml diff --git a/.changelogs/1.0.5/104_docs_bool_adjustment.yml b/.changelogs/1.0.5/104_docs_bool_adjustment.yml new file mode 100644 index 0000000..783162a --- /dev/null +++ b/.changelogs/1.0.5/104_docs_bool_adjustment.yml @@ -0,0 +1,2 @@ +changed: + - Change docs to make bool usage in configs more clear. [#104] diff --git a/.changelogs/1.0.5/release_meta.yml b/.changelogs/1.0.5/release_meta.yml new file mode 100644 index 0000000..c19765d --- /dev/null +++ b/.changelogs/1.0.5/release_meta.yml @@ -0,0 +1 @@ +date: TBD diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5192856..79ba0f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Before submitting a pull request, ensure that your changes sucessfully perform t 1. **Install pytest if you haven't already:** ```sh - pip install fake8 + pip install flake8 ``` 2. **Run the lintin:** @@ -118,4 +118,4 @@ By participating in this project, you agree to abide by our [Code of Conduct](CO If you need help or have any questions, feel free to reach out by creating an issue or by joining our [discussion forum](https://github.com/gyptazy/proxlb/discussions). You can also refer to our [documentation](https://github.com/gyptazy/ProxLB/tree/main/docs) for more information about the project or join our [chat room](https://matrix.to/#/#proxlb:gyptazy.ch) in Matrix. -Thank you for contributing to ProxLB! Together, we can enhance the efficiency and performance of Proxmox clusters. \ No newline at end of file +Thank you for contributing to ProxLB! Together, we can enhance the efficiency and performance of Proxmox clusters. diff --git a/README.md b/README.md index d07542e..a7b9316 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ The following options can be set in the `proxlb.conf` file: | `proxmox` | api_host | hypervisor01.gyptazy.com | Host or IP address (or comma separated list) of the remote Proxmox API. | | | api_user | root@pam | Username for the API. | | | api_pass | FooBar | Password for the API. | -| | verify_ssl | 1 | Validate SSL certificates (1) or ignore (0). (default: 1) | +| | verify_ssl | 1 | Validate SSL certificates (1) or ignore (0). (default: 1, type: bool) | | | timeout | 10 | Timeout for the Proxmox API in sec. (default: 10) | | `vm_balancing` | enable | 1 | Enables VM/CT balancing. | | | method | memory | Defines the balancing method (default: memory) where you can use `memory`, `disk` or `cpu`. | @@ -121,19 +121,19 @@ The following options can be set in the `proxlb.conf` file: | | mode_option | byte | Rebalance by node's resources in `bytes` or `percent`. (default: bytes) | | | type | vm | Rebalance only `vm` (virtual machines), `ct` (containers) or `all` (virtual machines & containers). (default: vm)| | | balanciness | 10 | Value of the percentage of lowest and highest resource consumption on nodes may differ before rebalancing. (default: 10) | -| | parallel_migrations | 1 | Defines if migrations should be done parallely or sequentially. (default: 1) | +| | parallel_migrations | 1 | Defines if migrations should be done parallely or sequentially. (default: 1, type: bool) | | | maintenance_nodes | dummynode03,dummynode04 | Defines a comma separated list of nodes to set them into maintenance mode and move VMs/CTs to other nodes. | | | ignore_nodes | dummynode01,dummynode02,test* | Defines a comma separated list of nodes to exclude. | | | ignore_vms | testvm01,testvm02 | Defines a comma separated list of VMs to exclude. (`*` as suffix wildcard or tags are also supported) | | `storage_balancing` | enable | 0 | Enables storage balancing. | | | balanciness | 10 | Value of the percentage of lowest and highest storage consumption may differ before rebalancing. (default: 10) | -| | parallel_migrations | 1 | Defines if migrations should be done parallely or sequentially. (default: 1) | -| `update_service` | enable | 0 | Enables the automated update service (rolling updates). | +| | parallel_migrations | 1 | Defines if migrations should be done parallely or sequentially. (default: 1, type: bool) | +| `update_service` | enable | 0 | Enables the automated update service (rolling updates). (default: 0, type: bool) | | `api` | enable | 0 | Enables the ProxLB API. | -| `service`| daemon | 1 | Run as a daemon (1) or one-shot (0). (default: 1) | +| `service`| daemon | 1 | Run as a daemon (1) or one-shot (0). (default: 1, type: bool) | | | schedule | 24 | Hours to rebalance in hours. (default: 24) | -| | master_only | 0 | Defines is this should only be performed (1) on the cluster master node or not (0). (default: 0) | -| | log_verbosity | INFO | Defines the log level (default: CRITICAL) where you can use `INFO`, `WARN` or `CRITICAL` | +| | master_only | 0 | Defines is this should only be performed (1) on the cluster master node or not (0). (default: 0, type: bool) | +| | log_verbosity | INFO | Defines the log level (default: CRITICAL) where you can use `INFO` or `CRITICAL` | | | config_version | 3 | Defines the current config version schema for ProxLB | An example of the configuration file looks like: