Update README to warn of status
Update README.rst to change from nova to placement and to indicate to the reader that the repository is in flux and not currently a finished thing. Also, warn readers who are reading on GitHub[1] that they may not be in the right place. [1] https://github.com/openstack/placement Change-Id: I32cb7ff0f1a578e40f259f7e28ca9af7cef85549
This commit is contained in:
61
README.rst
61
README.rst
@@ -1,28 +1,34 @@
|
|||||||
|
|
||||||
|
**Warning: This repository is currently in a state of flux as the placement
|
||||||
|
service is extracted from nova. While that is happening this repository is
|
||||||
|
not yet fully working.**
|
||||||
|
|
||||||
|
If you are viewing this README on GitHub, please be aware that placement
|
||||||
|
development happens on `OpenStack git
|
||||||
|
<https://git.openstack.org/cgit/openstack/placement/>`_ and `OpenStack
|
||||||
|
gerrit <https://review.openstack.org>`_.
|
||||||
|
|
||||||
========================
|
========================
|
||||||
Team and repository tags
|
Team and repository tags
|
||||||
========================
|
========================
|
||||||
|
|
||||||
.. image:: https://governance.openstack.org/tc/badges/nova.svg
|
.. image:: https://governance.openstack.org/tc/badges/placement.svg
|
||||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||||
|
|
||||||
.. Change things from this point on
|
OpenStack Placement
|
||||||
|
===================
|
||||||
|
|
||||||
OpenStack Nova
|
OpenStack Placement provides an HTTP service for managing, selecting,
|
||||||
==============
|
and claiming providers of classes of inventory representing available
|
||||||
|
resources in a cloud.
|
||||||
OpenStack Nova provides a cloud computing fabric controller, supporting a wide
|
|
||||||
variety of compute technologies, including: libvirt (KVM, Xen, LXC and more),
|
|
||||||
Hyper-V, VMware, XenServer, OpenStack Ironic and PowerVM.
|
|
||||||
|
|
||||||
Use the following resources to learn more.
|
|
||||||
|
|
||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
To learn how to use Nova's API, consult the documentation available online at:
|
To learn how to use Placement's API, consult the documentation available
|
||||||
|
online at:
|
||||||
|
|
||||||
- `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`__
|
- `Placement API Reference <https://developer.openstack.org/api-ref/placement/>`__
|
||||||
- `Compute API Reference <https://developer.openstack.org/api-ref/compute/>`__
|
|
||||||
|
|
||||||
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
|
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
|
||||||
|
|
||||||
@@ -33,10 +39,10 @@ For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
|
|||||||
Operators
|
Operators
|
||||||
---------
|
---------
|
||||||
|
|
||||||
To learn how to deploy and configure OpenStack Nova, consult the documentation
|
To learn how to deploy and configure OpenStack Placement, consult the
|
||||||
available online at:
|
documentation available online at:
|
||||||
|
|
||||||
- `OpenStack Nova <https://docs.openstack.org/nova/>`__
|
- `OpenStack Placement <https://docs.openstack.org/placement/>`__
|
||||||
|
|
||||||
In the unfortunate event that bugs are discovered, they should be reported to
|
In the unfortunate event that bugs are discovered, they should be reported to
|
||||||
the appropriate bug tracker. If you obtained the software from a 3rd party
|
the appropriate bug tracker. If you obtained the software from a 3rd party
|
||||||
@@ -46,29 +52,18 @@ available at:
|
|||||||
|
|
||||||
- `Bug Tracker <https://bugs.launchpad.net/nova>`__
|
- `Bug Tracker <https://bugs.launchpad.net/nova>`__
|
||||||
|
|
||||||
|
**For the time being bugs in placement should be created in the Nova bug
|
||||||
|
tracker with a tag of ``placement``.**
|
||||||
|
|
||||||
Developers
|
Developers
|
||||||
----------
|
----------
|
||||||
|
|
||||||
For information on how to contribute to Nova, please see the contents of the
|
For information on how to contribute to Placement, please see the contents of
|
||||||
CONTRIBUTING.rst.
|
CONTRIBUTING.rst.
|
||||||
|
|
||||||
Any new code must follow the development guidelines detailed in the HACKING.rst
|
Any new code must follow the development guidelines detailed in the HACKING.rst
|
||||||
file, and pass all unit tests.
|
file, and pass all tests.
|
||||||
|
|
||||||
Further developer focused documentation is available at:
|
Further developer focused documentation is available at:
|
||||||
|
|
||||||
- `Official Nova Documentation <https://docs.openstack.org/nova/>`__
|
- `Official Placement Documentation <https://docs.openstack.org/placement/>`__
|
||||||
- `Official Client Documentation
|
|
||||||
<https://docs.openstack.org/python-novaclient/>`__
|
|
||||||
|
|
||||||
Other Information
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
During each `Summit`_ and `Project Team Gathering`_, we agree on what the whole
|
|
||||||
community wants to focus on for the upcoming release. The plans for nova can
|
|
||||||
be found at:
|
|
||||||
|
|
||||||
- `Nova Specs <http://specs.openstack.org/openstack/nova-specs/>`__
|
|
||||||
|
|
||||||
.. _Summit: https://www.openstack.org/summit/
|
|
||||||
.. _Project Team Gathering: https://www.openstack.org/ptg/
|
|
||||||
|
Reference in New Issue
Block a user