diff options
author | Bruce Ashfield <bruce.ashfield@windriver.com> | 2013-08-25 23:47:42 -0400 |
---|---|---|
committer | Bruce Ashfield <bruce.ashfield@windriver.com> | 2013-08-28 18:42:00 -0400 |
commit | ec5aab41b280d719c14e1c5d88d09e7b38168bb3 (patch) | |
tree | 9856d6b299ed11026f0ad897e1c1534957cccead /meta-openstack | |
parent | bb21ef0e1d3ea74ab61b2289eb8de08d6fbd50ee (diff) | |
download | meta-cloud-services-ec5aab41b280d719c14e1c5d88d09e7b38168bb3.tar.gz |
docs: clarify docs names and roles
Signed-off-by: Bruce Ashfield <bruce.ashfield@windriver.com>
Diffstat (limited to 'meta-openstack')
-rw-r--r-- | meta-openstack/README | 2 | ||||
-rw-r--r-- | meta-openstack/README.setup (renamed from meta-openstack/DOC) | 76 |
2 files changed, 47 insertions, 31 deletions
diff --git a/meta-openstack/README b/meta-openstack/README index b60b3d2..ffbea6e 100644 --- a/meta-openstack/README +++ b/meta-openstack/README | |||
@@ -53,6 +53,6 @@ There are target images: openstack-image-compute, openstack-image-network, | |||
53 | openstack-image-controller. | 53 | openstack-image-controller. |
54 | 54 | ||
55 | They contain the packagegroups with the same name and can be used to create | 55 | They contain the packagegroups with the same name and can be used to create |
56 | the two types of targets. There are no extra configurations required to build | 56 | the ypes of targets. There are no extra configurations required to build |
57 | these images. | 57 | these images. |
58 | 58 | ||
diff --git a/meta-openstack/DOC b/meta-openstack/README.setup index 160e67a..2b2aeb9 100644 --- a/meta-openstack/DOC +++ b/meta-openstack/README.setup | |||
@@ -3,49 +3,56 @@ Meta-OpenStack | |||
3 | 3 | ||
4 | Description | 4 | Description |
5 | ----------- | 5 | ----------- |
6 | The meta-openstack layer provides support for building the OpenStack packages. | 6 | |
7 | It contains recipes for the nova, glance, keystone, cinder, quantum, swift and | 7 | The meta-openstack layer provides support for building the OpenStack |
8 | horizon components and their dependencies. | 8 | packages. It contains recipes for the nova, glance, keystone, cinder, |
9 | quantum, swift and horizon components and their dependencies. | ||
9 | 10 | ||
10 | Components | 11 | Components |
11 | ---------- | 12 | ---------- |
13 | |||
12 | * All the openstack packages are python packages. They can be found in the | 14 | * All the openstack packages are python packages. They can be found in the |
13 | recipes-devtools/python folder. Each component has been split into multiple | 15 | recipes-devtools/python folder. Each component has been split into multiple |
14 | packages similar to the system used by other Linux distributions. | 16 | packages similar to the system used by other Linux distributions. |
15 | 17 | ||
16 | * The configuration files for each package can be found in the files folder | 18 | * The configuration files for each package can be found in the files folder |
17 | for each package. The debug and verbose options have been enabled for capturing | 19 | for each package. The debug and verbose options have been enabled for |
18 | meaningful information in the logs. The packages have been configured | 20 | capturing meaningful information in the logs. The packages have been |
19 | following the model used by devstack. Each package has to initialize a database | 21 | configured following the model used by devstack. Each package has to |
20 | before it is used for the first time. This is done using a postinstall script | 22 | initialize a database before it is used for the first time. This is done |
21 | that is run the first time the image is booted. This is why the image boot | 23 | using a postinstall script that is run the first time the image is |
22 | time is longer the first time. | 24 | booted. This is why the image boot time is longer the first time. |
23 | 25 | ||
24 | * System-V initscripts are also provided in order to start the services at boot time. | 26 | * System-V initscripts are also provided in order to start the services at boot time. |
27 | * Systemd support is not complete. | ||
25 | 28 | ||
26 | * We used postgresql (package) for the database backend. The layer contains | 29 | * We used postgresql (package) for the database backend. The layer contains |
27 | an initscript that starts the DB server at boot time. Tests were done | 30 | an initscript that starts the DB server at boot time. Tests were done using |
28 | using sqlite3 and MySQL and there were no errors. | 31 | sqlite3 and MySQL and there were no errors. |
29 | 32 | ||
30 | * The RabbitMQ server is used for the AMQP message queues. The server starts | 33 | * The RabbitMQ server is used for the AMQP message queues. The server starts |
31 | at boot time with the default configuration. | 34 | at boot time with the default configuration. |
32 | 35 | ||
33 | * The layer also contains three packagegroups: | 36 | * The layer also contains three packagegroups: |
34 | ** packagegroup-cloud-controller - required packages for building a controller | 37 | |
35 | node. This provides all functionality except the actual hosting of the virtual | 38 | ** packagegroup-cloud-controller - required packages for building a controller |
36 | machines or network services. This includes the database server, AMQP server | 39 | node. This provides all functionality except the actual hosting of the virtual |
37 | and all the openstack services except nova-compute. | 40 | machines or network services. This includes the database server, AMQP server |
38 | ** packagegroup-cloud-compute - packages for a processing node. This node runs | 41 | and all the openstack services except nova-compute. |
39 | the compute service as well as the network service agent (in our case, the | 42 | |
40 | Open vSwitch plugin agent). This server also manages the KVM hypervisor. | 43 | ** packagegroup-cloud-compute - packages for a processing node. This node runs |
41 | ** packagegroup-cloud-network: this provides networking services like DHCP, | 44 | the compute service as well as the network service agent (in our case, the |
42 | layer 2 switching, layer 3 routing and metadata connectivity. | 45 | Open vSwitch plugin agent). This server also manages the KVM hypervisor. |
43 | 46 | ||
44 | * When creating an image, multiple packagegroups can be used to obtain a target | 47 | ** packagegroup-cloud-network: this provides networking services like DHCP, |
45 | that has the functionality of both a controller and compute node. | 48 | layer 2 switching, layer 3 routing and metadata connectivity. |
49 | |||
50 | * When creating an image, multiple packagegroups can be used to obtain a | ||
51 | target that has the functionality of both a controller and compute node. | ||
46 | 52 | ||
47 | Dependencies | 53 | Dependencies |
48 | ------------ | 54 | ------------ |
55 | |||
49 | * This layers depends on components from the poky, meta-virtualization and | 56 | * This layers depends on components from the poky, meta-virtualization and |
50 | meta-openembedded layers. You can find the exact URIs of the repos and the | 57 | meta-openembedded layers. You can find the exact URIs of the repos and the |
51 | necessary revisions in the README file. | 58 | necessary revisions in the README file. |
@@ -54,12 +61,13 @@ Building an image | |||
54 | ----------------- | 61 | ----------------- |
55 | 62 | ||
56 | * There are three new target images: openstack-image-compute, | 63 | * There are three new target images: openstack-image-compute, |
57 | openstack-image-network and openstack-image-controller that contain the | 64 | openstack-image-network and openstack-image-controller that contain the |
58 | packagegroups with the same name, that have been described in the previous | 65 | packagegroups with the same name, that have been described in the previous |
59 | section. | 66 | section. |
60 | 67 | ||
61 | * Once a buildir has been initialized you have to append the necessary layers | 68 | * Once a buildir has been initialized you have to append the necessary layers |
62 | to the bblayers.conf file: | 69 | to the bblayers.conf file: |
70 | |||
63 | /meta-virtualization \ | 71 | /meta-virtualization \ |
64 | /meta-cloud/meta-openstack \ | 72 | /meta-cloud/meta-openstack \ |
65 | /meta-openembedded/meta-oe \ | 73 | /meta-openembedded/meta-oe \ |
@@ -67,6 +75,7 @@ to the bblayers.conf file: | |||
67 | 75 | ||
68 | Package configurations | 76 | Package configurations |
69 | ---------------------- | 77 | ---------------------- |
78 | |||
70 | The identity.sh script creates the necessary users, services and endpoints | 79 | The identity.sh script creates the necessary users, services and endpoints |
71 | for the Keystone identity system. If you want to customize the usernames or | 80 | for the Keystone identity system. If you want to customize the usernames or |
72 | passwords don't forget to change the information in the configuration files | 81 | passwords don't forget to change the information in the configuration files |
@@ -74,26 +83,33 @@ for the services as well. | |||
74 | 83 | ||
75 | Running an image | 84 | Running an image |
76 | ---------------- | 85 | ---------------- |
86 | |||
77 | * Controller node * | 87 | * Controller node * |
88 | |||
78 | To test the image, you can run it using the runqemu script. In order to use | 89 | To test the image, you can run it using the runqemu script. In order to use |
79 | the command line clients (nova, keystone, glance etc) some environmental | 90 | the command line clients (nova, keystone, glance etc) some environmental |
80 | variables have to be set. These are required by the openstack services to | 91 | variables have to be set. These are required by the openstack services to |
81 | connect to the identity service and authenticate the user. These can be found | 92 | connect to the identity service and authenticate the user. These can be found |
82 | in /root/.bashrc. If you start a new bash session they are automatically | 93 | in /root/.bashrc. If you start a new bash session they are automatically |
83 | loaded. All the installed OpenStack services nova(except compute), keystone, | 94 | loaded. All the installed OpenStack services nova(except compute), keystone, |
84 | glance, cinder, quantum, swift horizon should be running after a successful boot. | 95 | glance, cinder, quantum, swift horizon should be running after a successful |
96 | boot. | ||
85 | 97 | ||
86 | The dashboard component is listening for new connections on port 8080. You can | 98 | The dashboard component is listening for new connections on port 8080. You can |
87 | connect to it using any browser. | 99 | connect to it using any browser. |
88 | 100 | ||
89 | * Compute node * | 101 | * Compute node * |
102 | |||
90 | The configuration files for the nova package are for a controller node so some | 103 | The configuration files for the nova package are for a controller node so some |
91 | options have to be changed for the compute service to properly work. You have | 104 | options have to be changed for the compute service to properly work. You have |
92 | to replace localhost to the controller node IP in the following files: | 105 | to replace localhost to the controller node IP in the following files: |
106 | |||
93 | /etc/nova/nova.conf: sql_connection; rabbit_host; | 107 | /etc/nova/nova.conf: sql_connection; rabbit_host; |
94 | /etc/nova/api-paste.ini: auth_host; | 108 | /etc/nova/api-paste.ini: auth_host; |
95 | /root/.bashrc: SERVICE_ENDPOINT, OS_AUTH_URL; | 109 | /root/.bashrc: SERVICE_ENDPOINT, OS_AUTH_URL; |
110 | |||
96 | Once the changes are done you have to restart the nova-compute service. | 111 | Once the changes are done you have to restart the nova-compute service. |
112 | |||
97 | !! Hint !! | 113 | !! Hint !! |
98 | When using a multi-node setup it is recommended that each host have a different | 114 | When using a multi-node setup it is recommended that each host have a different |
99 | hostname and that every host knows the other hosts. | 115 | hostname and that every host knows the other hosts. |