cadey
/
propellor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

layout

This commit is contained in:
Joey Hess 2014-12-26 15:35:17 -04:00
parent c7aac0b35e
commit 28596064c2
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/usage.mdwn
View File

@ -13,11 +13,13 @@ and configured in haskell.
# MODES OF OPERATION # MODES OF OPERATION
* The first time you run `propellor`, without any options, * propellor
it will set up a `~/.propellor/` repository.
Edit `~/.propellor/config.hs` to configure it.
* Once propellor is configured, running it without any options will take The first time you run `propellor`, without any options,
it will set up a `~/.propellor/` repository. Edit `~/.propellor/config.hs`
to configure it.
Once propellor is configured, running it without any options will take
action as needed to satisfy the configured properties of the local host. action as needed to satisfy the configured properties of the local host.
If there's a central git repository, it will first fetch from the If there's a central git repository, it will first fetch from the
@ -28,7 +30,7 @@ and configured in haskell.
the same as running propellor --spin with the hostname of the local the same as running propellor --spin with the hostname of the local
host. host.
* --spin targethost [targethost ...] [--via relayhost] * propellor --spin targethost [targethost ...] [--via relayhost]
Causes propellor to automatically install itself on the specified target Causes propellor to automatically install itself on the specified target
host, or if it's already installed there, push any updates. Propellor is host, or if it's already installed there, push any updates. Propellor is
@ -47,7 +49,7 @@ and configured in haskell.
uses ssh agent forwarding to make this work, and the relay host uses ssh agent forwarding to make this work, and the relay host
sees any privdata belonging to the target host. sees any privdata belonging to the target host.
* --add-key keyid * propellor --add-key keyid
Adds a gpg key, which is used to encrypt the privdata. Adds a gpg key, which is used to encrypt the privdata.
@ -55,25 +57,25 @@ and configured in haskell.
using this key. Propellor requires signed commits when pulling from using this key. Propellor requires signed commits when pulling from
a central git repository. a central git repository.
* --list-fields * propellor --list-fields
Lists all privdata fields that are used by your propellor configuration. Lists all privdata fields that are used by your propellor configuration.
The first 2 columns are the field name and context, and are followed by The first 2 columns are the field name and context, and are followed by
a list of the hosts that use that privdata value. a list of the hosts that use that privdata value.
* --set field context * propellor --set field context
Sets a field of privdata. The content is read in from stdin. Sets a field of privdata. The content is read in from stdin.
* --dump field context * propellor --dump field context
Outputs the privdata value to stdout. Outputs the privdata value to stdout.
* --edit field context * propellor --edit field context
Opens $EDITOR on the privdata value. Opens $EDITOR on the privdata value.
* --merge * propellor --merge
Combine multiple --spin commits into a single, more useful commit. Combine multiple --spin commits into a single, more useful commit.
@ -89,7 +91,7 @@ and configured in haskell.
(This will result in a trapezoid pattern in gitk.) (This will result in a trapezoid pattern in gitk.)
* hostname * propellor hostname
When run with a hostname and no other options, propellor will When run with a hostname and no other options, propellor will
provision the local host with the configuration of that hostname. provision the local host with the configuration of that hostname.