RETIRED, Disk image elements for deployment images of OpenStack
Go to file
Andreas Jaeger 6e7d0123ec Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I5aedf5a96bc39825dac6b0ddd0005c9e8e0b1619
2020-06-03 20:37:04 +02:00
doc/source Switch to newer openstackdocstheme and reno versions 2020-06-03 20:37:04 +02:00
elements Removing debug output of 51-hosts 2020-04-13 15:23:08 -04:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-06-03 20:37:04 +02:00
tests Fix unit tests in python3 2018-08-24 10:59:06 -04:00
tools tox: Keeping going with docs 2019-11-03 02:46:54 +08:00
zuul.d Add Python3 victoria unit tests 2020-05-26 17:15:58 +00:00
.gitignore Add reno support 2017-01-29 14:40:35 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:10 +00:00
.testr.conf Add a .testr.conf configuration and ignore .testrepository. 2012-12-14 20:17:39 +13:00
HACKING.rst Optimizing the safety of the http link site in HACKING.rst 2018-11-16 09:50:05 +08:00
LICENSE Fix copyrights for HP work. 2012-11-15 16:20:32 +13:00
MANIFEST.in Package with pbr 2013-08-06 12:50:39 +12:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-05-28 14:40:51 +08:00
babel.cfg Make it possible for openstack-CI to run tests 2013-02-04 22:26:17 -08:00
requirements.txt Update pbr version to match global requirements 2015-07-02 16:53:06 +01:00
run-flake8 PEP8 on the doc and elements files 2014-08-19 10:02:00 +02:00
setup.cfg [ussuri][goal] Updates for python 2.7 drop 2020-04-25 19:44:01 -05:00
setup.py Align build files and requirements 2013-09-28 23:18:29 -04:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-06-03 20:37:04 +02:00
tox.ini remove py27 in tox.ini from tripleo-image-elements 2020-04-01 21:28:33 -06:00

README.rst

Team and repository tags

image

Image building rules for OpenStack images

These elements are used to build disk images for deploying OpenStack via Heat. They are built as part of the TripleO umbrella project.

Instructions

Checkout this source tree and also the diskimage builder, export an ELEMENTS_PATH to add elements from this tree, and build any disk images you need:

virtualenv .
source bin/activate
pip install dib-utils pyyaml
git clone https://opendev.org/openstack/diskimage-builder.git
git clone https://opendev.org/openstack/tripleo-image-elements.git
export ELEMENTS_PATH=tripleo-image-elements/elements
diskimage-builder/bin/disk-image-create -u base vm bootstrap local-config stackuser heat-cfntools -a i386 -o bootstrap

Common element combinations

Always include heat-cfntools in images that you intend to boot via heat : if that is not done, then the user ssh keys are not reliably pulled down from the metadata server due to interactions with cloud-init.

Architecture

OpenStack images are intended to be deployed and maintained using Nova + Heat.

As such they should strive to be stateless, maintained entirely via automation.

Configuration

In a running OpenStack there are several categories of config.

  • per user - e.g. ssh key registration with nova: we repeat this sort of config every time we add a user.
  • local node - e.g. nova.conf or ovs-vsctl add-br br-ex : settings that apply individually to machines
  • inter-node - e.g. credentials on rabbitmq for a given nova compute node
  • application state - e.g. 'neutron net-create ...' : settings that apply to the whole cluster not on a per-user / per-tenant basis
We have five places we can do configuration in TripleO:
  • image build time
  • in-instance heat-driven (ORC scripts)
  • from outside via APIs
  • orchestrated by Heat

Our current heuristic for deciding where to do any particular configuration step:

  • per user config should be done from the outside via APIs, even for users like 'admin' that we know we'll have. Note that service accounts are different - they are a form of inter-node configuration.
  • local node configuration should be done via ORC driven by Heat and/or configuration management system metadata.
  • inter-node configuration should be done by working through Heat. For instance, creating a rabbit account for a nova compute node is something that Heat should arrange, though the act of creating is probably done by a script on the rabbit server - triggered by Heat - and applying the config is done on the compute node by the local node script - again triggered by Heat.
  • application state changes should be done from outside via APIs

Copyright 2012,2013 Hewlett-Packard Development Company, L.P. Copyright (c) 2012 NTT DOCOMO, INC.

All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Release notes for the project can be found at:

https://docs.openstack.org/releasenotes/tripleo-image-elements