openstack/kolla
Code Issues Proposed changes

Add note about heat being busted for development

Browse Source 
Heat development environments don't work at all.

As such document this so folks avoid them unless they want to
work on making them better.

Change-Id: Ibe3296660d30ccc24213c272ef379e6d3e2c21f2
This commit is contained in:
Steven Dake 2016-03-09 00:27:24 -05:00
parent 12735f01da
commit 9119e2e360
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/quickstart.rst
View File

@ -11,12 +11,22 @@ operating system.
If developing Kolla on an OpenStack cloud environment that supports Heat, If developing Kolla on an OpenStack cloud environment that supports Heat,
follow the :doc:`Heat developer environment guide <heat-dev-env>`. follow the :doc:`Heat developer environment guide <heat-dev-env>`.
If developing Kolla on a system that provides VirtualBox or Libvirt in addition If developing Kolla on a system that provides VirtualBox or Libvirt in
to Vagrant, use the Vagrant virtual environment documented in addition to Vagrant, use the Vagrant virtual environment documented in
:doc:`Vagrant developer environment guide <vagrant-dev-env>`. :doc:`Vagrant developer environment guide <vagrant-dev-env>`.
Currently the Heat development environment is entirely non-functional.
The Kolla core reviewers have debated removing it from the repository
but have resisted to provide an opportunity for contributors to make Heat
usable for Kolla development. THe Kolla core reviewers believe Heat
would offer a great way to develop Kolla in addition to Vagrant,
bare metal, or a manually setup virtual machine.
For more information refer to
`_bug 1562334 <https://bugs.launchpad.net/kolla/+bug/1562334>`__.
If evaluating Kolla, the community strongly recommends using bare metal or a If evaluating Kolla, the community strongly recommends using bare metal or a
virtual machine during the evaluation period. Follow the instructions in this virtual machine during the evaluation period. Follow the instructions in this
document to get started with deploying OpenStack on bare metal or a virtual document to get started with deploying OpenStack on bare metal or a virtual
machine with Kolla. machine with Kolla.
@ -664,4 +674,4 @@ values are overridden, in ``/etc/kolla/globals.yml``. The value of
Note: When you log in to Kibana web interface for the first time, you are Note: When you log in to Kibana web interface for the first time, you are
prompted to create an index. Please create an index using the name ``log-*``. prompted to create an index. Please create an index using the name ``log-*``.
This step is necessary until the default Kibana dashboard is implemented in This step is necessary until the default Kibana dashboard is implemented in
Kolla. Kolla.