doc updates

This commit is contained in:
Joey Hess 2014-11-18 17:33:08 -04:00
parent 74e067fa76
commit eaa460c04b
3 changed files with 36 additions and 32 deletions

View File

@ -53,37 +53,9 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask
So, edit `~/.propellor/config.hs` to configure the host (maybe
start with a few simple properties), and re-run step 6.
Repeat until happy and move on to the next host. :)
8. Write some neat new properties and send patches!
## adding a central git repository
The above quick start uses propellor without any central git repository.
Instead, the git repo on a host gets updated from the repo on your laptop
whenever you run `propellor --spin $HOST`.
A central git repository allows hosts to run propellor from cron and pick
up any updates you may have pushed. This is useful when managing several
hosts with propellor.
You can add a central git repository to your existing propellor setup easily:
1. Push propellor's git repository to a central server (github or your own):
`cd ~/.propellor/; git remote add origin ssh://git.example.com/propellor.git; git push -u origin master`
2. Configure the url your hosts should use for the git repisitory, if
it differs from the url above, by setting up a remote named "deploy":
`cd ~/.propellor/; git remote add deploy git://git.example.com/propellor.git`
2. Add a property to your hosts like:
`Cron.runPropellor "30 * * * *"`
3. Let your hosts know about the changed configuration (including the url
to the central repository), by running `proellor --spin $HOST` for each
of your hosts.
Now they'll automatically update every 30 minutes, and you can
`git commit -S` and `git push` changes that affect any number of
hosts.
8. Optionally, set up a [centralized git repository](https://propellor.branchable.com/centralized_git_repository/)
so multiple hosts can be updated with a simple `git commit -S; git push`
9. Write some neat new properties and send patches!
## debugging

View File

@ -0,0 +1,31 @@
Propellor can be used without any centralized git repsitory. When
`propellor --spin $HOST` is run, propellor pushes the local git repo
directly to the host. This makes it easy to get started with propellor.
A central git repository allows hosts to run propellor from cron and pick
up any updates you may have pushed. This is useful when managing several
hosts with propellor.
You can add a central git repository to your existing propellor setup easily:
1. Push propellor's git repository to a central server (github or your own):
`cd ~/.propellor/; git remote add origin ssh://git.example.com/propellor.git; git push -u origin master`
2. Configure the url your hosts should use for the git repisitory, if
it differs from the url above, by setting up a remote named "deploy":
`cd ~/.propellor/; git remote add deploy git://git.example.com/propellor.git`
2. Add a property to your hosts like:
`Cron.runPropellor "30 * * * *"`
3. Let your hosts know about the changed configuration (including the url
to the central repository), by running `proellor --spin $HOST` for each
of your hosts.
Now the hosts will automatically update every 30 minutes, and you can
`git commit -S` and `git push` changes that affect any number of
hosts.
Note that private data, set with `propellor --set`, is gpg encrypted, and
hosts cannot decrypt it! So after updating the private data of a host,
you still need to manually run `propellor --spin $HOST`

View File

@ -1,5 +1,6 @@
Propellor's security model is that the hosts it's used to deploy are
untrusted, and that the central git repository server is untrusted too.
untrusted, and that the central git repository server, if any,
is untrusted too.
The only trusted machine is the laptop where you run `propellor --spin`
to connect to a remote host. And that one only because you have a ssh key