summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess2015-01-04 17:16:55 -0400
committerJoey Hess2015-01-04 17:16:55 -0400
commitacdcff5ca48aeb08cb0b06621cf9889e1c628a86 (patch)
treec57102d12541ec2be0c25bbaddeb8644a0cdeaf8 /doc
parenta9163ba3ab5e59b93dc901959b43c05e3fe6498a (diff)
parentdf8d8eb5328b19dcde123d46d6cd9db0e2df88e9 (diff)
Merge branch 'joeyconfig'
Conflicts: privdata.joey/privdata.gpg
Diffstat (limited to 'doc')
-rw-r--r--doc/todo/spin_and_ipv6_addresses.mdwn8
-rw-r--r--doc/todo/ssh_hostkey_Info.mdwn2
-rw-r--r--doc/usage.mdwn30
3 files changed, 28 insertions, 12 deletions
diff --git a/doc/todo/spin_and_ipv6_addresses.mdwn b/doc/todo/spin_and_ipv6_addresses.mdwn
new file mode 100644
index 00000000..8693f16e
--- /dev/null
+++ b/doc/todo/spin_and_ipv6_addresses.mdwn
@@ -0,0 +1,8 @@
+Currently, --spin uses Network.BSD to look up IPv4 addresses of hostnames.
+Not Ipv6.
+
+This doesn't prevent using propellor with IPv6 only hosts. But it prevents
+using short names for such hosts with --spin. And, propellor only looks at
+configured ipv4 properties of a host when deciding if the DNS hostname is
+out of date, and falling back to contacting the host by IPv6 address.
+
diff --git a/doc/todo/ssh_hostkey_Info.mdwn b/doc/todo/ssh_hostkey_Info.mdwn
index a7f8a66a..70c88339 100644
--- a/doc/todo/ssh_hostkey_Info.mdwn
+++ b/doc/todo/ssh_hostkey_Info.mdwn
@@ -5,3 +5,5 @@
the PrivData, and instead configured using the info.
Getting the ssh host key into the info will allow automatically
exporting it via DNS (SSHFP record)
+
+[[done]]; although I did not implement SSHFTP yet, it should be doable now.
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 6ef2e965..8cd9af21 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -13,11 +13,13 @@ and configured in haskell.
# MODES OF OPERATION
-* The first time you run `propellor`, without any options,
- it will set up a `~/.propellor/` repository.
- Edit `~/.propellor/config.hs` to configure it.
+* propellor
-* 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.
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
host.
-* --spin targethost [targethost ...] [--via relayhost]
+* propellor --spin targethost [targethost ...] [--via relayhost]
Causes propellor to automatically install itself on the specified target
host, or if it's already installed there, push any updates. Propellor is
@@ -47,7 +49,11 @@ and configured in haskell.
uses ssh agent forwarding to make this work, and the relay host
sees any privdata belonging to the target host.
-* --add-key keyid
+ Propellor configuration typically uses the FQDN of hosts.
+ The hostname given to --spin can be a short name, which is
+ then looked up in the DNS to find the FQDN.
+
+* propellor --add-key keyid
Adds a gpg key, which is used to encrypt the privdata.
@@ -55,25 +61,25 @@ and configured in haskell.
using this key. Propellor requires signed commits when pulling from
a central git repository.
-* --list-fields
+* propellor --list-fields
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
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.
-* --dump field context
+* propellor --dump field context
Outputs the privdata value to stdout.
-* --edit field context
+* propellor --edit field context
Opens $EDITOR on the privdata value.
-* --merge
+* propellor --merge
Combine multiple --spin commits into a single, more useful commit.
@@ -89,7 +95,7 @@ and configured in haskell.
(This will result in a trapezoid pattern in gitk.)
-* hostname
+* propellor hostname
When run with a hostname and no other options, propellor will
provision the local host with the configuration of that hostname.