Merge pull request #2 from StackStorm-Exchange/LH/metadata

updated readme, metadata

Author: LindsayHill

README.md

@@ -1,16 +1,36 @@
 # stackstorm-netbox
-Stackstorm pack for netbox integration
+
+[NetBox](https://github.com/digitalocean/netbox) is an Open Source IPAM and DCIM tool
+maintained by Digital Ocean.
+
+## Configuration
+
+Copy the example configuration in [netbox.yaml.example](./netbox.yaml.example)
+to `/opt/stackstorm/configs/netbox.yaml` and edit as required.
+
+It should look like this:
+
+```yaml
+---
+hostname: "netbox.corp.lan"
+api_token: "aaabbbccc111222333"
+use_https: true
+ssl_verify: true
+```
+
+After editing, run `sudo st2ctl reload --register-configs` to ensure your configuration
+is loaded.
 
 ## Actions
 
 ### DCIM
-- **dcim_get_devices**: Get device(s) via optional parameters
-- **dcim_get_interfaces**: Get interface(s) via optional parameters
-- **dcim_get_sites**: Get site(s) via optional parameters
+- **dcim\_get\_devices**: Get device(s) via optional parameters
+- **dcim\_get\_interfaces**: Get interface(s) via optional parameters
+- **dcim\_get\_sites**: Get site(s) via optional parameters
 
 ### IPAM
-- **ipam_get_ip_addresses**: Get IP Address(es) via optional parameters
-- **ipam_get_vlan_groups**: Get VLAN Group(s) via optional parameters
-- **ipam_get_vlans**: Get VLAN(s) via optional parameters
-- **ipam_get_vrfs**: Get VRF(s) via optional parameters
-- **ipam_get_prefixes**: Get Prefix(es) via optional parameters
+- **ipam\_get\_ip\_addresses**: Get IP Address(es) via optional parameters
+- **ipam\_get\_vlan\_groups**: Get VLAN Group(s) via optional parameters
+- **ipam\_get\_vlans**: Get VLAN(s) via optional parameters
+- **ipam\_get\_vrfs**: Get VRF(s) via optional parameters
+- **ipam\_get\_prefixes**: Get Prefix(es) via optional parameters

actions/dcim_get_devices.yaml

@@ -2,7 +2,7 @@
 name: dcim_get_devices
 pack: netbox
 runner_type: "python-script"
-description: Get device(s) from netbox
+description: Get device(s) from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:

actions/dcim_get_interfaces.yaml

@@ -2,7 +2,7 @@
 name: dcim_get_interfaces
 pack: netbox
 runner_type: "python-script"
-description: Get interface(s) from netbox
+description: Get interface(s) from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:

actions/dcim_get_sites.yaml

@@ -2,7 +2,7 @@
 name: dcim_get_sites
 pack: netbox
 runner_type: "python-script"
-description: Get site(s) from netbox
+description: Get site(s) from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:

actions/ipam_get_ip_addresses.yaml

@@ -2,7 +2,7 @@
 name: ipam_get_ip_addresses
 pack: netbox
 runner_type: "python-script"
-description: Get ip addresses from netbox
+description: Get IP addresses from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:
@@ -20,7 +20,7 @@ parameters:
     description: IP Address parent prefix
   mask_length:
     type: integer
-    description: Subnet mask length (CIRD bits)
+    description: Subnet mask length (CIDR bits)
   vrf_id:
     type: integer
     description: ID of the VRF

actions/ipam_get_prefixes.yaml

@@ -2,7 +2,7 @@
 name: ipam_get_prefixes
 pack: netbox
 runner_type: "python-script"
-description: Get prefixes from netbox
+description: Get prefixes from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:
@@ -20,7 +20,7 @@ parameters:
     description: Parent prefix
   mask_length:
     type: integer
-    description: Subnet mask length (CIRD bits)
+    description: Subnet mask length (CIDR bits)
   vrf_id:
     type: integer
     description: ID of the VRF

actions/ipam_get_vlan_groups.yaml

@@ -2,7 +2,7 @@
 name: ipam_get_vlan_groups
 pack: netbox
 runner_type: "python-script"
-description: Get VLAN Group(s) from netbox
+description: Get VLAN Group(s) from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:

actions/ipam_get_vlans.yaml

@@ -2,7 +2,7 @@
 name: ipam_get_vlans
 pack: netbox
 runner_type: "python-script"
-description: Get VLAN(s) from netbox
+description: Get VLAN(s) from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:

actions/ipam_get_vrfs.yaml

@@ -2,7 +2,7 @@
 name: ipam_get_vrfs
 pack: netbox
 runner_type: "python-script"
-description: Get VRF(s) from netbox
+description: Get VRF(s) from NetBox
 enabled: true
 entry_point: base_get_action.py
 parameters:

config.schema.yaml

@@ -1,6 +1,6 @@
 ---
 hostname:
-  description: "Hostname for the netbox server"
+  description: "Hostname for the NetBox server"
   type: "string"
   required: true