Readme.md in stacksondeck-1.0.1 vs Readme.md in stacksondeck-1.0.2
- old
+ new
@@ -7,21 +7,24 @@
Chef server using the provided knife credentials (`--config`); results are cached
for a configurable amount of time (`--refresh`). SOD is [crash-only software](https://www.usenix.org/legacy/events/hotos03/tech/full_papers/candea/candea.pdf);
application state is backed up to disk (`--database`). You may also wish to
override the Rundeck user name to suit your environment (`--username`).
+**N.B.** SOD merges a Chef node's environments, roles, and tags into Rundeck
+tags. This behavior is not currently configurable.
+
## Usage
$ sod help
Commands:
sod art # View the application art
sod help [COMMAND] # Describe available commands or one specific command
sod server # Start application web server
sod version # Echo the application version
-You're most likely inteterested in `server`:
+You're most likely inteterested in the `server` command:
$ sod help server
Usage:
sod server
@@ -48,10 +51,25 @@
## API
### Node Resources `GET /`
-Renders Chef nodes as a Rundeck Resource Model in YAML format.
+Renders Chef nodes as a Rundeck Resource Model in YAML format. Sample response:
+
+ ---
+ example-node:
+ hostname: example-node
+ description: example-node.example.com
+ osArch: x86_64
+ osVersion: '12.04'
+ osFamily: debian
+ osName: ubuntu
+ username: "${job.username}"
+ remoteUrl: http://chef-server.example.com/nodes/example-node
+ editUrl: http://chef-server.example.com/nodes/example-node/edit
+ tags:
+ - example-node
+ - example
## Changelog
#### v1.0.0
\ No newline at end of file