[icinga-checkins] icinga.org: icinga2-api-examples/master: Move examples into tables including language and details

git at icinga.org git at icinga.org
Tue Dec 6 13:57:46 CET 2016


Module: icinga2-api-examples
Branch: master
Commit: 662479ebc199af0b1df946662f2a185b9e9ad96c
URL:    https://git.icinga.org/?p=icinga2-api-examples.git;a=commit;h=662479ebc199af0b1df946662f2a185b9e9ad96c

Author: Michael Friedrich <michael.friedrich at icinga.com>
Date:   Tue Dec  6 13:57:22 2016 +0100

Move examples into tables including language and details

---

 README.md |   69 +++++++++++++++++++++++++++++++++++++++----------------------
 1 file changed, 44 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index dc1cd61..08cefe9 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # General
 
-These examples for the [Icinga 2 API](http://docs.icinga.org/icinga2/latest/doc/module/icinga2/chapter/icinga2-api#icinga2-api)
+These examples for the [Icinga 2 API](http://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/icinga2-api#icinga2-api)
 should help you get started with your own projects.
 
 Please read the API documentation thoroughly before looking
@@ -11,7 +11,7 @@ into the scripting details.
 These examples remain generally unsupported, you should not put them in
 production without your own review and knowledge.
 
-Discuss your questions on the [community channels](https://www.icinga.org/community/).
+Discuss your questions on the [community channels](https://www.icinga.com/community/get-involved/).
 
 # Integrations
 
@@ -19,46 +19,65 @@ If any tool or script is missing, please send a patch/PR :)
 
 ## Libraries
 
-* [python-icinga2-api](https://pypi.python.org/pypi/python-icinga2api)
-* [go-icinga2](https://github.com/xert/go-icinga2)
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+[python-icinga2-api](https://pypi.python.org/pypi/python-icinga2api)				| Python	| Python bindings for Icinga 2 interaction
+[go-icinga2](https://github.com/xert/go-icinga2)						| Golang	| Golang functions and type definitions
 
 ## Status
 
-* [Dashing](https://github.com/icinga/dashing-icinga2) (separate standalone project, integrated into the Vagrant boxes)
-* [Clippy.js](clippy.js/)
-* [BitBar for OSX](https://getbitbar.com/plugins/Dev/Icinga2/icinga2.24m.py)
-* [Icinga 2 Multistatus](https://chrome.google.com/webstore/detail/icinga-multi-status/khabbhcojgkibdeipanmiphceeoiijal/related)
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+[Dashing](https://github.com/icinga/dashing-icinga2)						| Ruby, HTML	| Dashboard for Dashing querying the REST API for current host/service/global status
+[IcingaBusyLightAgent](https://github.com/stdevel/IcingaBusylightAgent) 			| C#		| Notification Agent in Systray
+* [BitBar for OSX](https://getbitbar.com/plugins/Dev/Icinga2/icinga2.24m.py)			| Python	| macOS tray app for highlighting the host/service status
+* [Icinga 2 Multistatus](https://chrome.google.com/webstore/detail/icinga-multi-status/khabbhcojgkibdeipanmiphceeoiijal/related)	| - 	| Chrome Extension
+[Clippy.js](clippy.js/)										| PHP, JS	| Funny demo for presenting alerts in your browser
 
 ## Manage Objects
 
-* [Icinga Director](https://www.icinga.org/products/icinga-web-2-modules/)
-* [AWS/EC2](aws-ec2/)
-* [Foreman Smart Proxy Monitoring](https://github.com/theforeman/smart_proxy_monitoring)
-* [Terraform Provider](https://github.com/lrsmith/terraform-provider-icinga2)
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+[Icinga Director](https://www.icinga.org/products/icinga-web-2-modules/) 			| PHP, JS	| Icinga 2 configuration interface integrated into Icinga Web 2
+[AWS/EC2](aws-ec2/)										| Ruby		| Example script for creating and deleting AWS instances in Icinga 2
+[Foreman Smart Proxy Monitoring](https://github.com/theforeman/smart_proxy_monitoring)		| Ruby		| Smart Proxy extension for Foreman creating and deleting hosts and services in Icinga 2
+[Terraform Provider](https://github.com/lrsmith/terraform-provider-icinga2)			| Golang	| Register hosts from Terraform in Icinga 2
 
 ## Event Streams
 
-* [Request Tracker ticket integration](https://github.com/bytemine/icinga2rt)
-* [Logstash input event stream](https://github.com/bobapple/logstash-input-icinga_eventstream)
-* [Flapjack events](https://github.com/sol1/flapjack-icinga2)
-* [Stackstorm integration](https://github.com/StackStorm-Exchange/stackstorm-icinga2)
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+[Request Tracker ticket integration](https://github.com/bytemine/icinga2rt)			| Golang	| Create and update RT tickets
+[Logstash input event stream](https://github.com/bobapple/logstash-input-icinga_eventstream)	| Ruby		| Forward events as Logstash input
+[Flapjack events](https://github.com/sol1/flapjack-icinga2)					| Golang	| Dumping events into Redis for Flapjack processing
+[Stackstorm integration](https://github.com/StackStorm-Exchange/stackstorm-icinga2)		| Python	| Processing events and fetching status information
 
 ## Actions
 
-* [mqttwarn](https://github.com/jpmens/mqttwarn#icinga2), [Monitoring OpenHAB](https://community.openhab.org/t/monitoring-openhab-using-icinga2/13461)
-* [Lita handler](https://github.com/tuxmea/lita-icinga2)
-* [Sakuli forwarder](http://sakuli.readthedocs.io/en/dev/forwarder-icinga2api/)
-* [OpsGenie actions](https://www.opsgenie.com/docs/integrations/icinga2-integration)
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+[mqttwarn](https://github.com/jpmens/mqttwarn#icinga2)						| Python	| Forward check results from mqttwarn to Icinga 2
+[Lita handler](https://github.com/tuxmea/lita-icinga2)						| Ruby		| List, recheck and acknowledge through a #chatops bot called [Lita](https://github.com/litaio/lita)
+[Sakuli forwarder](http://sakuli.readthedocs.io/en/dev/forwarder-icinga2api/)			| Java		| Forward check results from tests from [Sakuli](https://github.com/ConSol/sakuli) to Icinga 2
+[OpsGenie actions](https://www.opsgenie.com/docs/integrations/icinga2-integration)		| Golang, Java	| Integrate Icinga 2 into OpsGenie
 
 
 ## REST API Clients
 
-* Browser plugins
-* [Paw for MacOS](https://paw.cloud), examples [here](paw/)
-* [Icinga Studio](http://docs.icinga.org/icinga2/latest/doc/module/icinga2/toc#!/icinga2/latest/doc/module/icinga2/chapter/icinga2-api#icinga2-api-clients-icinga-studio)
-* [icinga2 console](http://docs.icinga.org/icinga2/latest/doc/module/icinga2/toc#!/icinga2/latest/doc/module/icinga2/chapter/icinga2-api#icinga2-api-clients-cli-console)
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+Browser plugins											| -		|
+[Paw for MacOS](https://paw.cloud)								| (exported)	| Examples [here](paw/)
+[Icinga Studio](http://docs.icinga.org/icinga2/latest/doc/module/icinga2/toc#!/icinga2/latest/doc/module/icinga2/chapter/icinga2-api#icinga2-api-clients-icinga-studio)	| C++	| Application for visualizing the status information
+[icinga2 console](http://docs.icinga.org/icinga2/latest/doc/module/icinga2/toc#!/icinga2/latest/doc/module/icinga2/chapter/icinga2-api#icinga2-api-clients-cli-console)	| C++	| CLI tool for running config expressions against the API
 
 ## Misc
 
-* [Scripts](scripts/)
+Several [Scripts](scripts/).
 
+Name												| Language	| Description
+------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------
+[go-icinga2-events](go-icinga2-events/)								| Golang	| Connect to the event stream and output state changes
+[console](scripts/console/)									| -		| Examples for using the icinga2 console CLI command
+[events](scripts/events/)									| -		| Examples for event streams
+[objects](scripts/objects/)									| PHP, Python	| Examples for fetching status and managing objects



More information about the icinga-checkins mailing list