OpenStack resource provider inventory allocation service
Go to file
Chris Dent 176524643d Documentation cleanup: front page
This is the first in a series of changes to the content in
doc/source to make it more accurately reflect the current state of
placement, now that it is in its own repo.

There are small changes throughout the front page, mostly to make
it more clear and make useful stuff a bit more discoverable.

The two major changes are:

* Older (pre-stein) upgrade notes are found by linking back to
  nova's rocky documentation.
* The REST API history is moved to its own sub-page, otherwise it
  the page is overwhelming and noisy.

Close review is probably required. cdent typed this. That has
implications.

Change-Id: I66e0c7d18b253b0a5a8fdac65e30b5b3cef37db2
2018-11-23 08:44:14 +00:00
api-ref Fix aggregate members in nested alloc candidates 2018-09-21 11:44:58 +09:00
doc Documentation cleanup: front page 2018-11-23 08:44:14 +00:00
etc/placement Fix genpolicy tox job 2018-10-22 15:23:54 +01:00
gate Add trait query to placement perf check 2018-08-16 18:32:12 +01:00
placement Merge "Consider root id is None in the database case" 2018-11-21 04:17:33 +00:00
releasenotes Add placement-status upgrade check command 2018-11-20 13:53:07 -05:00
tools Added alembic environment 2018-11-14 15:26:13 +00:00
.coveragerc Use both unit and functional for coverage testing 2018-09-14 13:30:14 -06:00
.gitignore Clean up .gitignore file 2018-10-16 00:14:36 +09:00
.gitreview Set up initial .zuul.yaml 2018-08-31 14:24:59 +00:00
.stestr.conf Put stestr group_regex in .stestr.conf 2018-09-14 13:30:14 -06:00
.zuul.yaml Remove build-openstack-api-ref jobs 2018-11-14 15:46:45 +00:00
CONTRIBUTING.rst Update links in documents 2018-01-12 17:05:11 +08:00
HACKING.rst Update the HACKING.rst file 2018-09-13 16:45:23 -06:00
LICENSE initial commit 2010-05-27 23:05:26 -07:00
README.rst Update README to warn of status 2018-09-10 11:11:26 -06:00
babel.cfg Get rid of distutils.extra. 2012-02-08 19:30:39 -08:00
bindep.txt Merge "Bindep does not catch missing libpcre3-dev on Ubuntu" 2018-02-14 07:31:09 +00:00
lower-constraints.txt Add placement-status upgrade check command 2018-11-20 13:53:07 -05:00
requirements.txt Add placement-status upgrade check command 2018-11-20 13:53:07 -05:00
setup.cfg Add placement-status upgrade check command 2018-11-20 13:53:07 -05:00
setup.py Updated from global requirements 2017-03-02 11:50:48 +00:00
test-requirements.txt Update requirements and test-requirements 2018-09-05 21:30:42 +01:00
tox.ini Merge "Reduce max-complexity to 15" 2018-10-11 15:19:30 +00:00

README.rst

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: