File reference pages
This commit includes changes to the infrastructure files and a draft of the "Intro" page for the doc plus some skeletal pages for review. It also includes a README.md file with instructions for creating a new page and template files that can be copied to begin a new page. See https://blueprints.launchpad.net/fuel/+spec/config-file-reference for more information. Change-Id: I660ddc28acb4da70e62a5cfe85ec91d0e213c07d
This commit is contained in:
Meg McRoberts
parent
3dd4437b66
commit
027dfab729
|
|
@ -14,5 +14,6 @@ Documentation
|
|||
virtualbox
|
||||
reference-architecture
|
||||
terminology
|
||||
file-ref
|
||||
release-notes
|
||||
eula
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
.. include:: /pages/file-ref/0000-intro.rst
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
.. index:: User Guide
|
||||
|
||||
.. _file-ref:
|
||||
|
||||
=====================
|
||||
File Format Reference
|
||||
=====================
|
||||
|
||||
.. contents:: :local:
|
||||
|
||||
.. include:: /contents/contents-file-ref.rst
|
||||
|
|
@ -47,6 +47,11 @@ network considerations, and deployment options.
|
|||
Short articles about OpenStack terminology and technology
|
||||
with references to other documentation and other useful information.
|
||||
|
||||
:ref:`file-ref` `(pdf) <pdf/Mirantis-OpenStack-6.0-Fuel File-Format-Reference.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Reference pages for select configuration files that Fuel uses.
|
||||
|
||||
:ref:`release-notes` `(pdf) <pdf/Mirantis-OpenStack-6.0-RelNotes.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,56 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
.. _file-reference:
|
||||
|
||||
Fuel File Reference Pages
|
||||
=========================
|
||||
|
||||
This section provides reference pages
|
||||
for select configuration files that Fuel uses.
|
||||
|
||||
.. warning:: Be very careful when modifying the configuration files.
|
||||
A simple typo when editing these files
|
||||
may severely damage your environment.
|
||||
|
||||
When you modify the YAML files,
|
||||
you will receive a warning
|
||||
that some attributes were modified from the outside.
|
||||
Some features may become inaccessible
|
||||
from the UI after you do this.
|
||||
|
||||
These pages are under development;
|
||||
the information presented here has been reviewed
|
||||
but may not be complete.
|
||||
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
| File | Node | Description |
|
||||
+===============================+=============+===============================+
|
||||
| :ref:`astute-yaml-master-ref` | Fuel Master | Configuration attributes |
|
||||
| | | passed to :ref:`puppet-term` |
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
| :ref:`astute-yaml-target-ref` | Target | Configuration attributes |
|
||||
| | | passed to Puppet |
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
| :ref:`engine-yaml-ref` | Fuel Master | Provisioning engine (Cobbler) |
|
||||
| | | and basic configuration of |
|
||||
| | | target nodes |
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
| :ref:`openstack-yaml-ref` | Fuel Master | Basic configuration of target |
|
||||
| | | nodes |
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
| :ref:`settings-yaml-ref` | Fuel Master | Information from "Settings" |
|
||||
| | | tab on UI |
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
| | | |
|
||||
+-------------------------------+-------------+-------------------------------+
|
||||
|
||||
.. include:: /pages/file-ref/astute-yaml-master.rst
|
||||
.. include:: /pages/file-ref/astute-yaml-target.rst
|
||||
.. include:: /pages/file-ref/engine-yaml.rst
|
||||
.. include:: /pages/file-ref/openstack-yaml.rst
|
||||
.. include:: /pages/file-ref/settings-yaml.rst
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
This directory contains reference pages for files that
|
||||
Fuel uses to deploy an environment.
|
||||
|
||||
To add a page, copy the appropriate template file and
|
||||
modify the content:
|
||||
|
||||
- docker-template: template for files that are accessed
|
||||
using dockerctl
|
||||
|
||||
- fuel-env-template: template for files that are accessed
|
||||
using fuel --env
|
||||
|
||||
Then add an include line for the file at the bottom of the
|
||||
0000-intro.rst file.
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _astute-yaml-master-ref:
|
||||
|
||||
astute.yaml
|
||||
-----------
|
||||
|
||||
Fuel Master Node:
|
||||
**/etc/fuel/astute.yaml**
|
||||
|
||||
Fuel uses the *astute.yaml* file to pass configuration attributes
|
||||
to :ref:`puppet<puppet-term>`.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
The */etc/fuel/astute.yaml* file is installed
|
||||
on the Fuel Master node
|
||||
and must not be deleted.
|
||||
|
||||
|
||||
File Format
|
||||
~~~~~~~~~~~
|
||||
|
||||
The *xxx.yaml* file <detailed-description>
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _astute-yaml-target-ref:
|
||||
|
||||
astute.yaml
|
||||
-----------
|
||||
|
||||
Target Nodes:
|
||||
**/etc/astute.yaml**
|
||||
|
||||
Fuel uses the *astute.yaml* file to pass configuration attributes
|
||||
to :ref:`puppet<puppet-term>`.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
The */etc/fuel/astute.yaml* file is installed
|
||||
on the Fuel Master node
|
||||
and must not be deleted.
|
||||
|
||||
|
||||
File Format
|
||||
~~~~~~~~~~~
|
||||
|
||||
The *xxx.yaml* file <detailed-description>
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _xxx-ref:
|
||||
|
||||
xxx.yaml
|
||||
--------
|
||||
|
||||
Fuel Master Node:
|
||||
**/usr/lib/python2.6/site-packages/nailgun/fixtures*
|
||||
|
||||
The *xxx.yaml* file defines
|
||||
the basic configuration of the target nodes
|
||||
that Fuel deploys for the OpenStack environment.
|
||||
Initially, it contains Fuel defaults;
|
||||
these are adjusted in response to configuration choices
|
||||
the user makes through the Fuel UI
|
||||
and then fed to :ref:`Nailgun<nailgun-term>`.
|
||||
|
||||
Usage
|
||||
~~~~~
|
||||
|
||||
#. Log into the nailgun :ref:`docker-term` container:
|
||||
::
|
||||
|
||||
dockerctl shell nailgun
|
||||
|
||||
#. Edit file.
|
||||
|
||||
#. Run the following commands to Nailgun
|
||||
to reread its settings and restart:
|
||||
::
|
||||
|
||||
manage.py dropdb && manage.py syncdb && manage.py loaddefault
|
||||
killall nailgund
|
||||
|
||||
|
||||
#. Exit the Nailgun docker container:
|
||||
::
|
||||
|
||||
exit
|
||||
|
||||
File Format
|
||||
~~~~~~~~~~~
|
||||
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _engine-yaml-ref:
|
||||
|
||||
engine.yaml
|
||||
-----------
|
||||
|
||||
Fuel Master Node:
|
||||
**/root/provisioning_1**
|
||||
|
||||
The *engine.yaml* file defines
|
||||
the basic configuration of the target nodes
|
||||
that Fuel deploys for the OpenStack environment.
|
||||
Initially, it contains Fuel defaults;
|
||||
these are adjusted in response to configuration choices
|
||||
the user makes through the Fuel UI
|
||||
and then fed to :ref:`Nailgun<nailgun-term>`.
|
||||
|
||||
Usage
|
||||
~~~~~
|
||||
|
||||
#. Dump provisioning information using this
|
||||
:ref:`fuel CLI<fuel-cli-config>` command::
|
||||
|
||||
fuel --env 1 provisioning default
|
||||
|
||||
where ``--env 1`` should be set to the specific environment
|
||||
(id=1 in this example).
|
||||
|
||||
|
||||
#. Edit file.
|
||||
|
||||
|
||||
#. Upload the modified file:
|
||||
::
|
||||
|
||||
fuel --env-1 provisioning upload
|
||||
|
||||
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
The *engine.yaml* file defines the provisioning engine
|
||||
being used (:ref:`cobbler-term` by default)
|
||||
along with the password and URLs used to access it.
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _xxx-ref:
|
||||
|
||||
xxx.yaml
|
||||
--------
|
||||
|
||||
Fuel Master Node:
|
||||
**yyy**
|
||||
|
||||
The *xxx.yaml* file <brief functional description>
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
#. Dump provisioning information using this
|
||||
:ref:`fuel CLI<fuel-cli-config>` command::
|
||||
|
||||
fuel --env 1 provisioning default
|
||||
|
||||
where ``--env 1`` points to the specific environment
|
||||
(id=1 in this example).
|
||||
|
||||
|
||||
#. Edit file.
|
||||
|
||||
|
||||
#. Upload the modified file:
|
||||
::
|
||||
|
||||
fuel --env-1 provisioning upload
|
||||
|
||||
|
||||
File Format
|
||||
~~~~~~~~~~~
|
||||
|
||||
The *xxx.yaml* file <detailed-description>
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _openstack-yaml-ref:
|
||||
|
||||
openstack.yaml
|
||||
--------------
|
||||
|
||||
Fuel Master Node:
|
||||
**/usr/lib/python2.6/site-packages/nailgun/fixtures/openstack.yaml**
|
||||
|
||||
The *openstack.yaml* file defines
|
||||
the basic configuration of the target nodes
|
||||
that Fuel deploys for the OpenStack environment.
|
||||
Initially, it contains Fuel defaults;
|
||||
these are adjusted in response to configuration choices
|
||||
the user makes through the Fuel UI
|
||||
and then fed to :ref:`Nailgun<nailgun-term>`.
|
||||
|
||||
Usage
|
||||
~~~~~
|
||||
|
||||
#. Log into the nailgun :ref:`docker-term` container:
|
||||
::
|
||||
|
||||
dockerctl shell nailgun
|
||||
|
||||
#. Edit file.
|
||||
|
||||
#. Run the following commands to Nailgun
|
||||
to reread its settings and restart:
|
||||
::
|
||||
|
||||
manage.py dropdb && manage.py syncdb && manage.py loaddefault
|
||||
killall nailgund
|
||||
|
||||
|
||||
#. Exit the Nailgun docker container:
|
||||
::
|
||||
|
||||
exit
|
||||
|
||||
File Format
|
||||
+++++++++++
|
||||
|
||||
The *openstack.yaml* file contains a number of blocks,
|
||||
each of which may contain multiple parameters.
|
||||
The major ones are described here.
|
||||
|
||||
The file has two major sections:
|
||||
|
||||
- The first is for VirtualBox and other limited deployments.
|
||||
|
||||
- The second is for full bare-metal deployments.
|
||||
|
||||
modes-metadata section
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Lists each of the roles available on the
|
||||
:ref:`assign-roles-ug` screen
|
||||
with the description.
|
||||
Note that there are two `roles-metadata` sections in the file:
|
||||
|
||||
- The limited deployments section
|
||||
lists only the Controller, Compute, and Cinder LVM roles.
|
||||
|
||||
- The "full_release" section
|
||||
lists the Controller, Compute, Cinder LVM,
|
||||
Ceph-OSD, MongoDB, and Zabbix Server roles.
|
||||
|
||||
Roles that should not be deployed on the same server
|
||||
are identified with "conflicts" statements
|
||||
such as the following that prevents a Compute role
|
||||
from being installed on a Controller node:
|
||||
::
|
||||
|
||||
controller:
|
||||
name: "Controller"
|
||||
description: "The controller initiates orchestration activities..."
|
||||
conflicts:
|
||||
- compute
|
||||
|
||||
If you delete the "conflicts:" and "compute" line
|
||||
and redeploy nailgun,
|
||||
you can deploy a bare-metal deployment
|
||||
that runs on a single server.
|
||||
|
||||
.. warning:: Deploying Fuel on VirtualBox is a much better
|
||||
way to install Fuel on minimal hardware
|
||||
for demonstration purposes
|
||||
than using this procedure.
|
||||
Be extremely careful when using this "all-in-one" deployment;
|
||||
if you create too many VM instances,
|
||||
they may consume all the available CPUs,
|
||||
causing serious problems accessing the MySQL database.
|
||||
Resource-intensive services
|
||||
such as Ceilometer with MongoDB, Zabbix,
|
||||
and Ceph are also apt to cause problems
|
||||
when OpenStack is deployed on a single server.
|
||||
|
||||
networks-metadata section
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
volumes-metadata section
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak
|
||||
|
||||
|
||||
.. _settings-yaml-ref:
|
||||
|
||||
settings.yaml
|
||||
-------------
|
||||
|
||||
Fuel Master Node:
|
||||
**/root/settings_x.yaml/**
|
||||
|
||||
The *settings.yaml* file contains
|
||||
the current values for the information
|
||||
on the :ref:`Settings<settings-ug>` page of the Fuel UI.
|
||||
|
||||
Usage
|
||||
~~~~~
|
||||
|
||||
#. Dump provisioning information using this
|
||||
:ref:`fuel CLI<fuel-cli-config>` command::
|
||||
|
||||
fuel --env 1 settings default
|
||||
|
||||
where ``--env 1`` that to the specific environment
|
||||
(id=1 in this example).
|
||||
|
||||
|
||||
#. Edit file.
|
||||
|
||||
|
||||
#. Upload the modified file:
|
||||
::
|
||||
|
||||
fuel --env-1 settings upload
|
||||
|
||||
|
||||
File Format
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. warning:: You should usually modify these values using the
|
||||
:ref:`Settings<settings-ug>` tab of the Fuel UI.
|
||||
|
||||
|
|
@ -24,5 +24,6 @@ pdf_documents = [
|
|||
('pdf/pdf_virtualbox', u'Mirantis-OpenStack-6.0-Running-Mirantis-OpenStack-on-VirtualBox', u'Running Mirantis OpenStack on VirtualBox', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_reference', u'Mirantis-OpenStack-6.0-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_terminology', u'Mirantis-OpenStack-6.0-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_file-ref', u'Mirantis-OpenStack-6.0-File-Reference', u'File Reference', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_relnotes', u'Mirantis-OpenStack-6.0-RelNotes', u'Release Notes', u'2014, Mirantis Inc.', {'pdf_use_toc': False}),
|
||||
]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,31 @@
|
|||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v6.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| File Format Reference | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| | |
|
||||
| ©2014, Mirantis Inc. | Page ###Page### |
|
||||
+--------------------------+----------------------+
|
||||
|
||||
.. raw:: pdf
|
||||
|
||||
PageBreak oneColumn
|
||||
|
||||
.. toctree::
|
||||
|
||||
.. include:: /pages/preface/preface.rst
|
||||
|
||||
.. _file-ref:
|
||||
|
||||
.. include:: /contents/contents-file-ref.rst
|
||||
Loading…
Reference in New Issue