-
Notifications
You must be signed in to change notification settings - Fork 8
Adding procedure for SNMP traps #141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
40e4e83
Adding procedure for SNMP traps
csibbitt 12d9583
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
JoanneOFlynn2018 61bda3e
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
leifmadsen f0bc491
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
csibbitt 579e204
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
csibbitt 7304798
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
JoanneOFlynn2018 f96787e
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
JoanneOFlynn2018 94ec11b
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
JoanneOFlynn2018 d2f562f
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
JoanneOFlynn2018 0ab17c4
Update doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-…
JoanneOFlynn2018 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
59 changes: 59 additions & 0 deletions
59
doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // <List assemblies here, each on a new line> | ||
|
|
||
| // This module can be included from assemblies using the following include statement: | ||
| // include::<path>/proc_setting-up-the-dashboard-to-host-grafana.adoc[leveloffset=+1] | ||
|
|
||
| // The file name and the ID are based on the module title. For example: | ||
| // * file name: proc_doing-procedure-a.adoc | ||
| // * ID: [id='proc_doing-procedure-a_{context}'] | ||
| // * Title: = Doing procedure A | ||
| // | ||
| // The ID is used as an anchor for linking to the module. Avoid changing | ||
| // it after the module has been published to ensure existing links are not | ||
| // broken. | ||
| // | ||
| // The `context` attribute enables module reuse. Every module's ID includes | ||
| // {context}, which ensures that the module has a unique ID even if it is | ||
| // reused multiple times in a guide. | ||
| // | ||
| // Start the title with a verb, such as Creating or Create. See also | ||
| // _Wording of headings_ in _The IBM Style Guide_. | ||
| [id="configuring-snmp-traps_{context}"] | ||
| = Configuring SNMP Traps | ||
|
|
||
| You can integrate {Project} ({ProjectShort}) with an existing infrastructure monitoring platform that receives notifications via SNMP traps. To enable SNMP traps, modify the `ServiceTelemetry` object and configure the `snmpTraps` parameters. | ||
|
|
||
| For more information about configuring alerts, see xref:alerts_advanced-features[]. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Know the IP address or hostname of the SNMP trap receiver where you want to send the alerts | ||
|
|
||
| .Procedure | ||
|
|
||
| . To enable SNMP traps, modify the `ServiceTelemetry` object: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| $ oc edit stf default | ||
| ---- | ||
| . Set the `alerting.alertmanager.receivers.snmpTraps` parameters: | ||
| + | ||
|
csibbitt marked this conversation as resolved.
|
||
| [source,yaml] | ||
| ---- | ||
| apiVersion: infra.watch/v1beta1 | ||
| kind: ServiceTelemetry | ||
| ... | ||
| spec: | ||
| ... | ||
| alerting: | ||
| alertmanager: | ||
| receivers: | ||
| snmpTraps: | ||
| enabled: true | ||
| target: 10.10.10.10 | ||
| ---- | ||
|
|
||
| . Ensure that you set the value of `target` to the IP address or hostname of the SNMP trap receiver. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.