diff options
| author | Steven Dake <stdake@cisco.com> | 2016-03-09 00:27:24 -0500 |
|---|---|---|
| committer | Steven Dake <stdake@cisco.com> | 2016-04-11 00:22:33 -0700 |
| commit | 9119e2e360f6a72b52c8879c4b68adf0c050a727 (patch) | |
| tree | 9fc6ee2dc3f0fcc36eeb880922893759fec4a956 | |
| parent | 12735f01dae0b7ee94df980f79d48b83611cf8ac (diff) | |
| download | kolla-9119e2e360f6a72b52c8879c4b68adf0c050a727.tar.gz kolla-9119e2e360f6a72b52c8879c4b68adf0c050a727.zip | |
Add note about heat being busted for development
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
| -rw-r--r-- | doc/quickstart.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/quickstart.rst b/doc/quickstart.rst index 838596a4c..e3f2a922b 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -11,12 +11,22 @@ operating system. If developing Kolla on an OpenStack cloud environment that supports Heat, follow the :doc:`Heat developer environment guide <heat-dev-env>`. -If developing Kolla on a system that provides VirtualBox or Libvirt in addition -to Vagrant, use the Vagrant virtual environment documented in +If developing Kolla on a system that provides VirtualBox or Libvirt in +addition to Vagrant, use the Vagrant virtual environment documented in :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 -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 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 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 -Kolla.
\ No newline at end of file +Kolla. |