Chris Dent
7b5218d8e3
This change adds a rudimentary command line tool, 'placement-manage' that can do three things: * placement-manage --version: report the current version of the software * placement-manage db sync: sync the db to the 'head' alembic version * placement-manage db version: report the current version of the db It is written following the examples set by both nova and ironic for using oslo config driven command line parsing. It is not as full featured as the nova version (with decorators for argument handling and help text etc) because we don't need that yet. There's plenty of room for improvement, but the intention here is to keep things simple until we need them to be otherwise. The provided unit tests cover that the arg parsing behaves as expected and that the right commands are connected the right args. The actual functionality of the 'db sync' command (a migration.upgrade) is tested in runs that use devstack as well as the test_migrations functional test. Errors during the migration simply raise exceptions which will output noisily to the console. At this stage this is desirable and suitable. A new doc for the cli is added, with basic information for placement-manage. Note that at this time the deployment documentation has not been updated. That will be done in a later change. Future changes may include (if we can't avoid it) tools for initiating online migrations from the command line. Needed-By: https://review.openstack.org/600162/ Change-Id: I1ff472106610150a587f5286f26a6bd7c1aa84f4
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
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: