diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index fdc07fcdd0..d54b0bd8f2 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -23,5 +23,4 @@ Getting Started Guides on_fedora on_ubuntu on_other - jeos_building standalone diff --git a/doc/source/getting_started/jeos_building.rst b/doc/source/getting_started/jeos_building.rst deleted file mode 100644 index bf54b2c6ba..0000000000 --- a/doc/source/getting_started/jeos_building.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. - 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. - -Building JEOS images for use with Heat -====================================== -Heat's full functionality can only be used when launching cloud images that have -the heat-cfntools_ package installed. -This document describes some options for creating a heat-cfntools enabled image -for yourself. - -.. _heat-cfntools: https://opendev.org/openstack/heat-cfntools - -Building an image with diskimage-builder -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -diskimage-builder_ is a tool for customizing cloud images. -tripleo-image-elements_ is a collection of diskimage-builder elements related -to the TripleO_ project. It includes an element for heat-cfntools which can be -used to create heat-enabled images. - -.. _diskimage-builder: https://opendev.org/openstack/diskimage-builder -.. _tripleo-image-elements: https://opendev.org/openstack/tripleo-image-elements -.. _TripleO: https://wiki.openstack.org/wiki/TripleO - -Install the tool (preferably in a virtualenv) and fetch the elements:: - - pip install git+https://opendev.org/openstack/diskimage-builder - git clone https://opendev.org/openstack/tripleo-image-elements - -To create a heat-cfntools enabled image with the current release of Fedora x86_64:: - - export ELEMENTS_PATH=tripleo-image-elements/elements - disk-image-create vm fedora heat-cfntools -a amd64 -o fedora-heat-cfntools - -The image may then be pushed to glance, e.g:: - - source ~/.openstack/keystonerc - openstack image create fedora-heat-cfntools --public --disk-format qcow2 --container-format bare < fedora-heat-cfntools.qcow2 - -To create a heat-cfntools enabled image with the current release of Ubuntu i386:: - - export ELEMENTS_PATH=tripleo-image-elements/elements - disk-image-create vm ubuntu heat-cfntools -a i386 -o ubuntu-heat-cfntools - -If you are creating your own images you should consider creating golden images -which contain all the packages required for the stacks that you launch. You can do -this by writing your own diskimage-builder elements and invoking those elements -in the call to disk-image-create. - -This means that the resulting heat templates only need to modify configuration -files. This will speed stack launch time and reduce the risk of a transient -package download failure causing the stack launch to fail. - -To create an image that contains hooks needed for SoftwareConfig and SoftwareDeployment, -you can follow the steps below to build a fedora based image:: - - pip install git+https://opendev.org/openstack/diskimage-builder - git clone https://opendev.org/openstack/tripleo-image-elements - git clone https://opendev.org/openstack/heat-agents - export ELEMENTS_PATH=tripleo-image-elements/elements:heat-agents - disk-image-create vm \ - fedora selinux-permissive \ - heat-config \ - os-collect-config \ - os-refresh-config \ - os-apply-config \ - heat-config-cfn-init \ - heat-config-puppet \ - heat-config-script \ - -o fedora-software-config.qcow2 - -The image may then be pushed to glance, e.g:: - - source ~/.openstack/keystonerc - openstack image create fedora-software-config --public --disk-format=qcow2 --container-format=bare < fedora-software-config.qcow2