Documentation cleanup

Correct REPO_OS for CentOS 7. Normalization and typo cleanup.

Change-Id: I9dcd1db1b20e45d8555e279483572d451d98d1d7
This commit is contained in:
Samuel Cassiba 2015-06-02 14:06:12 -07:00
parent 700a625bbc
commit 144c9b2d38
6 changed files with 35 additions and 34 deletions

View File

@ -5,9 +5,9 @@ that you can still build a cluster from the ground up with any changes we push u
This framework also gives us an opportunity to show different Reference Architectures and a sane example on how to start with OpenStack and Chef. This framework also gives us an opportunity to show different Reference Architectures and a sane example on how to start with OpenStack and Chef.
With the `master` branch of the cookbooks, which is currently tied to the base OpenStack Kilo release, this supports deploying to Ubuntu 14 and CentOS 7 for all-in-one with nova-network. Support for all-in-one with Neutron, and multi-node support, is a work in progress. With the `master` branch of the cookbooks, which is currently tied to the base OpenStack Kilo release, this supports deploying to Ubuntu 14.04 and CentOS 7.1 for all-in-one with nova-network. Support for all-in-one with Neutron, and multi-node support, is a work in progress.
Support for CentOS 6.5 and Ubuntu 12 with Icehouse is available with the stable/icehouse branch of this project. Support for CentOS 6.5 and Ubuntu 12.04 with Icehouse is available with the stable/icehouse branch of this project.
## Prereqs ## Prereqs
@ -19,20 +19,19 @@ Support for CentOS 6.5 and Ubuntu 12 with Icehouse is available with the stable/
```shell ```shell
$ git clone https://github.com/stackforge/openstack-chef-repo.git $ git clone https://github.com/stackforge/openstack-chef-repo.git
$ cd openstack-chef-repo $ cd openstack-chef-repo
$ vi vagrant_linux.rb # change the 'vm.box' to the variant you'd like to use.
$ chef exec rake berks_vendor $ chef exec rake berks_vendor
``` ```
The StackForge OpenStack cookbooks by default use databags for configuring passwords. There are four The OpenStack cookbooks by default use databags for configuring passwords. There are four
data_bags : *user_passwords*, *db_passwords*, *service_passwords*, *secrets*. I have a already created data_bags : *user_passwords*, *db_passwords*, *service_passwords*, *secrets*. I have a already created
the `data_bags/` directory, so you shouldn't need to make them, if you do something's broken. the `data_bags/` directory, so you shouldn't need to make them, if you do something's broken.
See [Databag](#databags) section below for more details. See [Databags](#databags) section below for more details.
**NOTE**: If you are running Ubuntu 14.04 LTS and as your **base** compute machine, you should note that the shipped **NOTE**: If you are running Ubuntu 14.04 LTS and as your **base** compute machine, you should note that the shipped
kernel `3.13.0-24-generic` has networking issues, and the best way to resolve this is kernel `3.13.0-24-generic` has networking issues, and the best way to resolve this is
via: `apt-get install linux-image-generic-lts-utopic`. This will install at least `3.16.0` from the Utopic hardware enablement. via: `apt-get install linux-image-generic-lts-utopic`. This will install at least `3.16.0` from the Utopic hardware enablement.
## Supported Environments ## Supported Deployments
* All-in-One * All-in-One
* nova-network * nova-network
@ -41,12 +40,14 @@ via: `apt-get install linux-image-generic-lts-utopic`. This will install at leas
* nova-network * nova-network
* Neutron * Neutron
For each environment, there's a corresponding readme file in the doc directory. Please review that for specific details and additional setup that might be required before deploying the cloud. For each deployment model, there is a corresponding readme file in the doc/ directory. Please review that for specific details and additional setup that might be required before deploying the cloud.
## Rake Deploy Commands ## Rake Deploy Commands
These commands will spin up various OpenStack cluster configurations, the simplest being the all-in-one controller with nova-network. These commands will spin up various OpenStack cluster configurations, the simplest being the all-in-one controller with nova-network.
For CentOS, set the environment variable REPO_OS=centos7
```bash ```bash
$ chef exec rake aio_nova # All-in-one controller with nova-network $ chef exec rake aio_nova # All-in-one controller with nova-network
$ chef exec rake aio_neutron # All-in-one controller with Neutron $ chef exec rake aio_neutron # All-in-one controller with Neutron
@ -178,7 +179,7 @@ secrets
service_passwords service_passwords
user_passwords user_passwords
# Show the list of databag items # Show the list of data bag items
$ chef exec knife data bag show db_passwords -z $ chef exec knife data bag show db_passwords -z
ceilometer ceilometer
cinder cinder
@ -191,32 +192,32 @@ keystone
neutron neutron
nova nova
# Show contents of databag item # Show contents of data bag item
$ chef exec knife data bag show db_passwords ceilometer -z $ chef exec knife data bag show db_passwords ceilometer -z
Encrypted data bag detected, decrypting with provided secret. Encrypted data bag detected, decrypting with provided secret.
ceilometer: mypass ceilometer: mypass
id: ceilometer id: ceilometer
# Update contents of databag item # Update contents of data bag item
# set EDITOR env var to your editor, for powershell, I used nano # set EDITOR env var to your editor. For PowerShell, I used nano
$ chef exec knife data bag edit secrets dispersion_auth_user -z $ chef exec knife data bag edit secrets dispersion_auth_user -z
``` ```
### Databag Default Values ### Data bag default values
db_passwords are set to "mypass" db_passwords are set to "mypass"
secrets are set to "<key>_token" secrets are set to "<key>_token"
service_passwords are set to "mypass" service_passwords are set to "mypass"
user_passwords are set to "mypass" user_passwords are set to "mypass"
### Default Databag Secret ### Default encrypted data bag secret
The default secret is stored here .chef\encrypted_data_bag_secret The default secret is stored here .chef/encrypted_data_bag_secret
and referenced by .chef\knife.rb. and referenced by .chef/knife.rb.
## Known Issues and Workarounds ## Known Issues and Workarounds
### Gemfile support ### Gemfile support
The ChefDK provides all the required level of gems this testing suite needs. But there exists a Gemfile-Provisioning file that can be used as well. The ChefDK provides all the required level of gems this testing suite needs, but there exists a Gemfile-Provisioning file that can be used as well.
You will need to replace the Gemfile with the Gemfile-Provisioning before running your gem bundling. You will need to replace the Gemfile with the Gemfile-Provisioning before running your gem bundling.
Note: please ignore the Gemfile, as it is needed only to pass the existing gates with older levels of gems. Note: please ignore the Gemfile, as it is needed only to pass the existing gates with older levels of gems.
@ -229,8 +230,8 @@ When using this on a Windows platform, here are some tweaks to make this work:
## TODOs ## TODOs
- Better instructions for multi-node network setup - Better instructions for multi-node network setup
- Better support for aio_neutron and muilt node tests - Better support for aio_neutron and multi-node tests
- Support for floating ip's - Support for floating IPs
- Split out the `multi-neutron-network-node` cluster also so the network node is it's own machine - Split out the `multi-neutron-network-node` cluster also so the network node is it's own machine
- Support for swift multi node test - Support for swift multi node test
- Easier debugging. Maybe a script to pull the logs from the controller. - Easier debugging. Maybe a script to pull the logs from the controller.

View File

@ -1,3 +1,3 @@
# All in One with Neutron networking # All in One with Neutron
The defaults in the aio-neutron.rb and the environments/vagrant-aio-neutron.json should work without any changes. The defaults in the aio-neutron.rb and the environments/vagrant-aio-neutron.json should work without any changes.

View File

@ -1,5 +1,5 @@
# All in One with Nova networking # All-in-One with nova-network
The defaults in the aio-nova.rb and the environments/vagrant-aio-nova.json should work without any changes. The defaults in the aio-nova.rb and the environments/vagrant-aio-nova.json should work without any changes.
Note: Default operating system is ubuntu. If you would like centos, set env var REPO_OS=centos Note: Default operating system is Ubuntu. If you would like CentOS, set env var REPO_OS=centos7

View File

@ -10,7 +10,7 @@ secrets
service_passwords service_passwords
user_passwords user_passwords
# Show the list of databag items # Show the list of data bag items
$ chef exec knife data bag show db_passwords -z $ chef exec knife data bag show db_passwords -z
ceilometer ceilometer
cinder cinder
@ -23,23 +23,23 @@ keystone
neutron neutron
nova nova
# Show contents of databag item # Show contents of data bag item
$ chef exec knife data bag show db_passwords ceilometer -z $ chef exec knife data bag show db_passwords ceilometer -z
Encrypted data bag detected, decrypting with provided secret. Encrypted data bag detected, decrypting with provided secret.
ceilometer: mypass ceilometer: mypass
id: ceilometer id: ceilometer
# Update contents of databag item # Update contents of data bag item
# set EDITOR env var to your editor, for powershell, I used nano # set EDITOR env var to your editor. For powershell, I used nano
$ chef exec knife data bag edit secrets dispersion_auth_user -z $ chef exec knife data bag edit secrets dispersion_auth_user -z
``` ```
## Databag Default Values ## data bag default values
db_passwords are set to "mypass" db_passwords are set to "mypass"
secrets are set to "<key>_token" secrets are set to "<key>_token"
service_passwords are set to "mypass" service_passwords are set to "mypass"
user_passwords are set to "mypass" user_passwords are set to "mypass"
## Default Databag Secret ## Encrypted data bag secret
The default secret is stored here .chef\encrypted_data_bag_secret The default secret is stored here .chef/encrypted_data_bag_secret
and referenced by .chef\knife.rb. and referenced by .chef/knife.rb.

View File

@ -1,3 +1,3 @@
# Multi node with Nuetron networking # Multi-node with Neutron
todo ... todo ...

View File

@ -1,6 +1,6 @@
# Multi node with Nova networking # Multi-node with nova-network
Note: Default operating system is ubuntu. If you would like centos, set env var REPO_OS=centos Note: Default operating system is Ubuntu. If you would like CentOS, set env var REPO_OS=centos7
## Nodes ## Nodes
@ -12,8 +12,8 @@ Changes need to be made to the multi-nova.rb and the environments\vagrant-multi-
### Bridge IP Address ### Bridge IP Address
The ip address used for the bridge should on the same network as your machine connects to the internet. Change the '172.16.100.' ip address in the multi-nova.rb and the environments\vagrant-multi-nova.json files. The IP address used for the bridge should on the same network as your machine connects to the internet. Change the '172.16.100.' ip address in the multi-nova.rb and the environments\vagrant-multi-nova.json files.
For example, on my home network, my laptop as and ip of 192.168.1.xxx, so I set the bridge address to 192.168.1.60. For example, on my home network, my laptop has an IP of 192.168.1.xxx, so I set the bridge address to 192.168.1.60.
### Device interface ### Device interface