Skip to content

Commit 25bebf5

Browse files
authored
Merge pull request #239 from andyxning/add_doc_about_custom_plugin
add docs about custom plugin
2 parents 515b854 + 4475a5a commit 25bebf5

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,10 @@ Kubernetes cluster to a healthy state. The following remedy systems exist:
177177
[this issue](https://github.com/kubernetes/node-problem-detector/issues/199)
178178
for an example production use case for Draino.
179179

180+
# Docs
181+
182+
* [Custom plugin monitor](docs/custom_plugin_monitor.md)
183+
180184
# Links
181185

182186
* [Design Doc](https://docs.google.com/document/d/1cs1kqLziG-Ww145yN6vvlKguPbQQ0psrSBnEqpy0pzE/edit?usp=sharing)

docs/custom_plugin_monitor.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Custom Plugin Monitor
2+
3+
## Configuration
4+
### Plugin Config
5+
* `invoke_interval`: Interval at which custom plugins will be invoked.
6+
* `timeout`: Time after which custom plugins invokation will be terminated and considered timeout.
7+
* `max_output_length`: The maximum standard output size from custom plugins that NPD will be cut and use for condition status message.
8+
* `concurrency`: The plugin worker number, i.e., how many custom plugins will be invoked concurrently.

0 commit comments

Comments
 (0)