From fa942e53381708c8c77850b14b194ac8e5cc8a19 Mon Sep 17 00:00:00 2001 From: Steve Lacey Date: Tue, 3 Jun 2014 14:18:28 +0100 Subject: [PATCH] Updated README, added caveat of username + api key --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 653e269..88d61df 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -Install, configure, and launch the [Rackspace Cloud Monitoring Agent] +Puppet Cloud Monitoring +======================= + +A Puppet module to install, configure, and launch the [Rackspace Cloud Monitoring Agent] (http://www.rackspace.com/knowledge_center/article/install-the-cloud-monitoring-agent) to enable [Rackspace monitoring](http://www.rackspace.com/cloud/monitoring/). @@ -6,22 +9,24 @@ to enable For Debian/Ubuntu, this module depends on [puppetlabs-apt](https://github.com/puppetlabs/puppetlabs-apt). -You can create a monitoring instance in one of two ways: either by -providing a -[service agent monitoring token](http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/service-agent-tokens.html#service-agent-token-create-token) -like this: + +Usage +----- + +You can create a monitoring instance in one of two ways: + +### Providing a [service agent monitoring token](http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/service-agent-tokens.html#service-agent-token-create-token) class { 'cloudmonitoring': monitoring_token => 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff.000000' } -...or by providing your username and -[API key](http://www.rackspace.com/knowledge_center/article/rackspace-cloud-essentials-1-generating-your-api-key) -to authenticate to Rackspace (via -[raxmon](https://github.com/racker/rackspace-monitoring-cli)) like -this: +### Providing your username and [API key](http://www.rackspace.com/knowledge_center/article/rackspace-cloud-essentials-1-generating-your-api-key) to authenticate to Rackspace (via [raxmon](https://github.com/racker/rackspace-monitoring-cli)) class { 'cloudmonitoring': username => "myRackspaceUsername", apikey => "myApiKey", } + + +**Note:** If you choose this method, [raxmon](https://github.com/racker/rackspace-monitoring-cli) will be installed using Pip, and all of the nodes you wish to monitor will need to be labelled in the Rackspace dashboard with a label that matches their FQDN, otherwise, tokens will not be mapped correctly and your catalog runs will fail.