added links to the READMEs for the cookbooks and added the 'Usage' section

This commit is contained in:
mattray 2012-06-25 12:53:23 -07:00
parent 2a52d86add
commit 901f048009
1 changed files with 38 additions and 12 deletions

View File

@ -8,17 +8,27 @@ This is a canonical source of documentation and there is additional content in t
There is a Spiceweasel (http://bit.ly/spcwsl) manifest documenting all the community cookbooks (and their versions), roles, data bags and environments required to deploy OpenStack. The intention is to only depend on publicly available community versions of cookbooks so the openstack-chef-repo will not contain any cookbooks (there may temporarily be patched versions waiting for upstream to publish). The manifest will also document a variety of deployment techniques for single-node, small and large deployments.
Usage
=====
To populate this Chef repository with the cookbooks for deploying, run the following command:
```
spiceweasel infrastructure.yml
```
This will also give you all of the commands necessary to push the roles to the Chef server. You can execute this with
```
spiceweasel infrastructure.yml | sh
```
Note that with subsequent runs of spiceweasel the commands will change once the missing cookbooks have been downloaded.
Cookbooks
=========
The cookbooks have been designed and written in such a way that they can be used to deploy individual service components on _any_ of the nodes in the infrastructure; in short they can be used for single node 'all-in-one' installs (for testing), right up to multi/many node production installs. In order to achieve this flexibility, they make use of the [chef search](http://wiki.opscode.com/display/chef/Search) functionality, and therefore require that if you are deploying anything larger than a single node deployment, you use [chef server](http://wiki.opscode.com/display/chef/Chef+Server) to host your cookbooks rather than using Chef Solo.
Each of the OpenStack services has its own cookbook and is available on the Chef Community site and on GitHub. Please refer to the `documentation` directory for more details on each.
Nova
----
http://community.opscode.com/cookbooks/nova
http://github.com/mattray/nova
Each of the OpenStack services has its own cookbook and is available on the Chef Community site and on GitHub. Please refer to the `documentation` directory for more details on the roles for deploying them.
Glance
------
@ -26,11 +36,7 @@ http://community.opscode.com/cookbooks/glance
http://github.com/mattray/glance
Keystone
--------
http://community.opscode.com/cookbooks/keystone
http://github.com/mattray/keystone
There is further documentation in the [Glance cookbook README.me](http://github.com/mattray/glance/blob/essex/README.md).
Horizon
--------
@ -38,12 +44,32 @@ http://community.opscode.com/cookbooks/horizon
http://github.com/mattray/horizon
There is further documentation in the [Horizon cookbook README.me](http://github.com/mattray/horizon/blob/essex/README.md).
Keystone
--------
http://community.opscode.com/cookbooks/keystone
http://github.com/mattray/keystone
There is further documentation in the [Keystone cookbook README.me](http://github.com/mattray/keystone/blob/essex/README.md).
Nova
----
http://community.opscode.com/cookbooks/nova
http://github.com/mattray/nova
There is further documentation in the [Nova cookbook README.me](http://github.com/mattray/nova/blob/essex/README.md).
Swift
-----
http://community.opscode.com/cookbooks/swift
http://github.com/mattray/swift
There is further documentation in the [Swift cookbook README.me](http://github.com/mattray/swift/blob/essex/README.md).
License
=======
Licensed under the Apache License, Version 2.0 (the "License");