Fixes #12734: Add documentation for the Centreon plugin #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peckpeck
requested changes
Jun 6, 2018
centreon/README.md
Outdated
| This project is part of Rudder - IT automation and compliance made easy. | ||
| See: http://rudder-project.org for more information. | ||
|
|
||
| This project is also part of iTop - CMDB and ITSM open source software. |
centreon/README.md
Outdated
|
|
||
| - The Rudder server must have Python installed. | ||
|
|
||
| - Generate the Rudder package : make |
There was a problem hiding this comment.
we are not in the root directory, say where we should run make
centreon/README.md
Outdated
|
|
||
| - The Rudder server must have Python installed. | ||
|
|
||
| - Generate the Rudder package : make |
There was a problem hiding this comment.
We should probably add that the rpkg file is available somewhere
centreon/README.md
Outdated
|
|
||
| - Install the package on the Rudder server : /opt/rudder/bin/rudderpkg install-file <plugin>.rpkg | ||
|
|
||
| - Edit the configuration file /opt/rudder/etc/centreon.conf |
There was a problem hiding this comment.
what interesting values in this file what do they mean ?
centreon/README.md
Outdated
| - Install the package on the Rudder server : /opt/rudder/bin/rudderpkg install-file <plugin>.rpkg | ||
|
|
||
| - Edit the configuration file /opt/rudder/etc/centreon.conf | ||
|
|
There was a problem hiding this comment.
what happens next ?
what sould i do to check if the plugin is working ?
|
Commit modified |
victorqrt
force-pushed
the
ust_12734/add_documentation_for_the_centreon_plugin
branch
from
646d1db
to
440a72c
Compare
peckpeck
requested changes
Jun 6, 2018
centreon/README.md
Outdated
|
|
||
| - The Rudder server must have Python installed. | ||
|
|
||
| - Generate the Rudder package : cd into the centreon directory, then make. The .rpkg package file |
There was a problem hiding this comment.
if you don't have the binary rpkg file ...
centreon/README.md
Outdated
| - Generate the Rudder package : cd into the centreon directory, then make. The .rpkg package file | ||
| will be generated in the current directory. | ||
|
|
||
| - Install the package on the Rudder server : /opt/rudder/bin/rudderpkg install-file <plugin>.rpkg |
There was a problem hiding this comment.
isn't there a markdown syntax for commands ?
centreon/README.md
Outdated
| - Edit the configuration file /opt/rudder/etc/centreon.conf. This config file has to contain your Centreon | ||
| server's webservice API URL, the credentials to access it, and the name of the Centreon poller used to | ||
| monitor Rudder nodes (Central by default). You also need to provide the Rudder API URL, and a token to access | ||
| it, which you can issue from the Rudder server webapp or CLI. |
There was a problem hiding this comment.
" from the Rudder server webapp or CLI" this is too generic, either say how to get it or don't say anything.
The best would be a pointer to a Rudder documentation url that already has the information.
centreon/README.md
Outdated
|
|
||
| Centreon comes with the possiblity to add monitoring templates to its hosts. You can create templates in | ||
| Centreon or check for available ones. Once you know the name of a template suitable for a Rudder node/nodegroup, | ||
| you can add it using the "Monitoring template" generic method from the technique editor. |
There was a problem hiding this comment.
How long to i need to wait to make sure the template is applied ?
There was a problem hiding this comment.
a word about the cron/daemon that process those templates and how it works ?
centreon/README.md
Outdated
| ----- | ||
|
|
||
| Now that the plugin is installed, you can check if it is working by adding new Rudder nodes. They will be added | ||
| to you list of Centreon hosts (and removed on deletion of the Rudder node). |
There was a problem hiding this comment.
Add a sentence to briefly describe how it works : post-hook, api call from rudder server ...
|
Commit modified |
victorqrt
force-pushed
the
ust_12734/add_documentation_for_the_centreon_plugin
branch
from
440a72c
to
086f3ef
Compare
peckpeck
reviewed
Jun 11, 2018
centreon/README.md
Outdated
| ----- | ||
|
|
||
| Now that the plugin is installed, you can check if it is working by adding new Rudder nodes. They will be added | ||
| to you list of Centreon hosts (and removed on deletion of the Rudder node). |
peckpeck
reviewed
Jun 11, 2018
centreon/README.md
Outdated
| Usage | ||
| ----- | ||
|
|
||
| Now that the plugin is installed, you can check if it is working by adding new Rudder nodes. They will be added |
peckpeck
reviewed
Jun 11, 2018
centreon/README.md
Outdated
| options on such events. | ||
|
|
||
| Centreon comes with the possiblity to add monitoring templates to its hosts. You can create templates in | ||
| Centreon or check for available ones. Once you know the name of a template suitable for a Rudder node/nodegroup, |
peckpeck
reviewed
Jun 11, 2018
| hosts. The "Monitoring parameter" generic method achieves this. | ||
|
|
||
| The data will be sent hourly to the Centreon server. This can be changed by editing the /etc/cron.d/centreon-rudder file. | ||
| This operation can be manually executed by running |
|
Commit modified |
victorqrt
force-pushed
the
ust_12734/add_documentation_for_the_centreon_plugin
branch
from
086f3ef
to
39ff55e
Compare
peckpeck
approved these changes
Jun 15, 2018
|
OK, merging this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://www.rudder-project.org/redmine/issues/12734