openstack/placement
Code Issues Proposed changes
dc472e144a
placement/README.rst
Chris Dent 8166d1f5cf 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
2018-09-10 11:11:26 -06:00

2.2 KiB
Raw Blame History

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 and OpenStack gerrit.

Team and repository tags

image

OpenStack Placement

OpenStack Placement provides an HTTP service for managing, selecting, and claiming providers of classes of inventory representing available resources in a cloud.

API

To learn how to use Placement's API, consult the documentation available online at:

For more information on OpenStack APIs, SDKs and CLIs in general, refer to:

Operators

To learn how to deploy and configure OpenStack Placement, consult the documentation available online at:

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 operating system vendor, it is often wise to use their own bug tracker for reporting problems. In all other cases use the master OpenStack bug tracker, available at:

For the time being bugs in placement should be created in the Nova bug tracker with a tag of ``placement``.

Developers

For information on how to contribute to Placement, please see the contents of CONTRIBUTING.rst.

Any new code must follow the development guidelines detailed in the HACKING.rst file, and pass all tests.

Further developer focused documentation is available at: