Cleanup

Add suppoty for github.io, obfuscate passwords, modify README

README.md

@@ -1,12 +1,12 @@
-## PureStorage Puppet Module
+## Pure Storage Puppet Module
 
 #### Table of Contents
 
   1. [Disclaimer](#disclaimer)
   2. [Overview](#overview)
   3. [Description](#description)
   4. [Setup](#setup)
-    * [Connecting to a PureStorage Array](#connecting-to-a-purestorage-array)
+    * [Connecting to a Pure Storage Array](#connecting-to-a-purestorage-array)
   5. [Usage](#usage)
     * [Puppet Device](#puppet-device)
     * [Puppet Agent](#puppet-agent)
@@ -23,7 +23,7 @@ questions about this module before running or modifying.
 
 ## Overview
 
-The PureStorage provider allows you to provision volumes on a PureStorage array
+The Pure Storage provider allows you to provision volumes on a Pure Storage array
 from either a puppet client or a puppet device proxy host. The provider has
 been developed against CentOS 7.2 using Puppet-4.8.1. At this stage testing
 is completely manual.
@@ -32,16 +32,16 @@ is completely manual.
 
 Using the `volume`, `hostconfig` and `connection` types, one
 can quickly provision remote storage and attach it via iSCSI from a
-PureStorage array to a client.
+Pure Storage array to a client.
 
-The provider utilizes the robust REST API (V1.6) available on the PureStorage
+The provider utilizes the robust REST API (V1.6) available on the Pure Storage
 array to remotely provision the necessary resources.
 
 ## Setup
 
-### Connecting to a PureStorage Array
+### Connecting to a Pure Storage Array
 
-A connection to a PureStorage array is via the storage array IP address 
+A connection to a Pure Storage array is via the storage array IP address 
 or FQDN name of the storage array and through use of a Admin account. 
 A connection string is needed to inform the providers how to connect. 
 The providers can get the connection string from various locations 
@@ -56,7 +56,7 @@ in the following order:
 
   1. Any existing connection.
   2. A Facter-supplied URL.
-  3. A user-supplied URL (in device.conf or site.pp file).
+  3. A user-supplied URL (in `device.conf` or `site.pp` file).
 
 ## Usage
 
@@ -72,15 +72,15 @@ resources). It will then apply this catalog to the said device by translating
 the resources to orders the network device understands. Puppet device will
 then report back to the master for any changes and failures as a standard node.
 
-The PureStorage providers are designed to work with the puppet device concept and
+The Pure Storage providers are designed to work with the puppet device concept and
 in this case will retrieve their connection information from the `url` given
 in Puppet's `device.conf` file. An example is shown below:
 
      [array1.puretec.purestorage.com]
       type pure
       url https://<admin>:<password>@puretec.purestorage.com
 
-In the case of Puppet Device connection to the PureStorage is from the machine
+In the case of Puppet Device connection to the Pure Storage is from the machine
 running 'device' only.
 
 command : "puppet device"
@@ -93,16 +93,16 @@ the manifest supplied to the agent from the master or it could be included
 in a custom fact passed to the client. The connection string must be supplied
 as a URL. See the example manifests (complete_create.pp) for details.
 
-In the case of Puppet Agent, connections to the PureStorage array will be
-initiated from every machine which utilizes the PureStorage puppet module this
+In the case of Puppet Agent, connections to the Pure Storage array will be
+initiated from every machine which utilizes the Pure Storage puppet module this
 way. This may be of security concern for some folks.
 
 Command: "puppet agent -t"
 
 ### Puppet Apply
 
 Puppet apply is the client only application of a local manifest. Puppet apply
-is supported similar to puppet agent by the PureStorage providers. 
+is supported similar to puppet agent by the Pure Storage providers. 
 The connection string must be supplied as a URL. See the example 
 manifests (complete_create.pp) for details.
 
@@ -120,9 +120,9 @@ Command: "puppet apply <manifest_file_path>"
 
 ## Limitations
 
-Today pure puppet module supports create, update, delete of 
-volume ,host and direct connection (between the two). 
-Today, it supports IQN ids for iSCSI only.
+Today the Pure Storage puppet module supports create, update, delete of 
+volume, host and direct connection (between the two). 
+Currently it only supports iSCSI connections and IQN ids.
 
 ## Development
 

examples/complete_create.pp

@@ -26,7 +26,7 @@
 #Example of Puppet Agent
 node 'calsoft-puppet-agent.puretec.purestorage.com'{ #--> This is Agent vm name
     #Note : device_url is MANDATORY here.	
-    $device_url = 'https://pureuser:pureuser@cloud-dev-405-a12-02.puretec.purestorage.com'
+    $device_url = 'https://pureuser:******@cloud-dev-405-a12-02.puretec.purestorage.com'
 
      volume{ "pure_storage_volume":
                 #ensure either "present" or "absent"
@@ -56,7 +56,7 @@
 #Example of Puppet Apply
 node 'puppet.puretec.purestorage.com'{ #--> This is master vm name
     #Note: device_url is MANDATORY here. 		
-    $device_url = 'https://pureuser:pureuser@cloud-dev-405-a12-02.puretec.purestorage.com'
+    $device_url = 'https://pureuser:******@cloud-dev-405-a12-02.puretec.purestorage.com'
 
      volume{ "pure_storage_volume":
                 #ensure either "present" or "absent"

support.json

@@ -0,0 +1,7 @@
+{
+    "id": "pure-puppet",
+    "filter": "devops",
+    "image": "http://code.purestorage.com/images/18_puppet.png",
+    "featured": 1,
+    "priority": 2
+}