From 28596064c234333d11a33e619c72547b3a0a8367 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 26 Dec 2014 15:35:17 -0400 Subject: layout --- doc/usage.mdwn | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 6ef2e965..45015131 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,7 @@ 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 --add-key keyid 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 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 +91,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. -- cgit v1.2.3 From db882415021508ced8b0b8e1ce78f03cc5cf724a Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 1 Jan 2015 13:03:30 -0400 Subject: noticed a minor bug --- doc/todo/spin_and_ipv6_addresses.mdwn | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 doc/todo/spin_and_ipv6_addresses.mdwn (limited to 'doc') 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. + -- cgit v1.2.3 From b50f33395edc55317d95c53e34c4d810a5e49041 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 1 Jan 2015 13:57:13 -0400 Subject: update docs --- doc/usage.mdwn | 4 ++++ src/Propellor/Info.hs | 9 +++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 45015131..8cd9af21 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -49,6 +49,10 @@ and configured in haskell. uses ssh agent forwarding to make this work, and the relay host sees any privdata belonging to the target host. + 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. diff --git a/src/Propellor/Info.hs b/src/Propellor/Info.hs index a91f69c8..0437f8ec 100644 --- a/src/Propellor/Info.hs +++ b/src/Propellor/Info.hs @@ -26,8 +26,13 @@ getOS = askInfo _os -- | Indidate that a host has an A record in the DNS. -- --- TODO check at run time if the host really has this address. --- (Can't change the host's address, but as a sanity check.) +-- When propellor is used to deploy a DNS server for a domain, +-- the hosts in the domain are found by looking for these +-- and similar properites. +-- +-- When propellor --spin is used to deploy a host, it checks +-- if the host's IP Property matches the DNS. If the DNS is missing or +-- out of date, the host will instead be contacted directly by IP address. ipv4 :: String -> Property ipv4 = addDNS . Address . IPv4 -- cgit v1.2.3 From df8d8eb5328b19dcde123d46d6cd9db0e2df88e9 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sun, 4 Jan 2015 17:16:43 -0400 Subject: close --- doc/todo/ssh_hostkey_Info.mdwn | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') 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. -- cgit v1.2.3