Skip to content

Commit

Permalink
Added a bit of clarification about resources.xml in the getting start…
Browse files Browse the repository at this point in the history
…ed section.
  • Loading branch information
ahonor committed Dec 9, 2010
1 parent 61cb430 commit 5388bf7
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 16 deletions.
15 changes: 15 additions & 0 deletions docs/en/02-basics/02-chapter1.md
Expand Up @@ -207,6 +207,21 @@ to the output printed by the `dispatch -v` shown earlier:
editUrl="" remoteUrl=""/>
</project>

You'll notice the root node is called `project` and there is a single
node descriptor for "strongbad". The `node` tag has a number of
required and optional attributes. Additional node descriptors can be
added by defining new `node` elements inside the `project` tag.
Here's an example of a node called "homestar" with just the required
attributes:

<node name="homestar" type="Node"
hostname="192.168.1.02"
username="alexh" />

The `hostname` and `username` values are used for the SSH connection
while the `name` and `type` are used to define Node identity in the
resource model.

Chances are you maintain information about your hosts within
another tool, perhaps Chef, Puppet, Nagios, Amazon EC2, RightScale or
even an in-house database. One of these tools might be
Expand Down
34 changes: 18 additions & 16 deletions docs/en/manpages/man5/resource-v10.5.md
Expand Up @@ -38,53 +38,49 @@ The node element defines a Node resource.

*Attributes*

type

: The node type.

name

: The node name. This is a logical identifier from the node. (required)

type

: The node type, such as "Node". (required)

description

: A brief description about the node.
: A brief description about the node. (optional)

hostname

: The hostname or IP address of the remote host. (required)

osArch

: The operating system architecture.
: The operating system architecture. (optional)

osFamily

: The operating system family (e.g, unix or windows).
: The operating system family, such as unix or windows. (optional)

osName

: The operating system name (e.g., Linux or Mac OS X).
: The operating system name such as Linux or Mac OS X. (optional)

tags

: Comma separated list of filtering tags.
: Comma separated list of filtering tags. (optional)

username

: The username on the remote host to which RunDeck connects.

password

: The remote connection password.
: The username used for the remote connection. (required)

editUrl

: URL to an external resource model editor service
: URL to an external resource model editor service (optional)

remoteUrl

: URL to an external resource model service
: URL to an external resource model service. (optional)

*Nested Elements*

Expand Down Expand Up @@ -121,6 +117,12 @@ value is overloaded to include the port (192.168.1.106:4022):
hostname="192.168.1.106:4022"
username="deploy"/>

An example using just the required attributes:

<node name="centos54" type="Node"
hostname="192.168.1.106:4022"
username="deploy"/>
## setting

The setting element defines a Setting resource.
Expand Down

0 comments on commit 5388bf7

Please sign in to comment.