OpenStack resource provider inventory allocation service
Go to file
Chris Dent c62ed6ccba Package db migration scripts in placement pypi dist
Having the db migration scripts within the openstack-placement pypi
distribution is desirable for deployment tools, such as
openstack-ansible. It provides a known good location for the script,
available with a pip install.

There are several ways to distribute files with a python package. The
method used here was chosen because it works both with tarballs and
wheels (the files are already in the tarball, as a result of the way pbr
works, but not in the wheel).

Here's what's done:

* The db migrate scripts are put in their own direcory,
  placement_db_tools, so that only they are packaged, not the other
  tools.
* To preserve how grenade interacts with these files as well as not
  disrupt the docs, symlinks from tools to placement_db_tools have been
  created.
* placement_db_tools is added to the list of packages included in the
  openstack-placement distro. This means that when 'pip install
  openstack-placement' happens, the python environment will then include
  placement and placement_db_tools directories.

The end result is that the true path to the script can be found with:

  pkg_resources.resource_filename('placement_db_tools', 'mysql-migrate-db.sh')

This has been noted in the to-stein.rst document.

A different package was chosen to not muddy the waters of what is
"actually placement".

Similarly, the 'data_files' functionality provided by pbr was not used,
because that requires the file be written to a location on the local
filesystem, relative to the install prefix. Dirtying the filesystem
outside the python lib with this sort of thing is inappropriate.

Change-Id: Ie326ce8a2a0692d20793bc18be606e034fa94a44
Story: 2005535
Task: 30671
2019-05-07 00:08:39 +00:00
api-ref api-ref: fix formatting in member_of param for 1.21 2019-04-12 12:07:22 -04:00
doc Package db migration scripts in placement pypi dist 2019-05-07 00:08:39 +00:00
etc/placement Add oslo.log to genconfig 2019-03-19 09:47:14 -05:00
gate Add a perfload job. 2018-11-30 14:59:47 +00:00
placement Merge "Remove dead code" 2019-04-05 13:58:59 +00:00
placement_db_tools Package db migration scripts in placement pypi dist 2019-05-07 00:08:39 +00:00
playbooks OpenDev Migration Patch 2019-04-19 19:41:22 +00:00
releasenotes FUP on negative-aggregate-membership series 2019-04-02 12:22:42 +00:00
tools Package db migration scripts in placement pypi dist 2019-05-07 00:08:39 +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 OpenDev Migration Patch 2019-04-19 19:41:22 +00:00
.stestr.conf Put stestr group_regex in .stestr.conf 2018-09-14 13:30:14 -06:00
.zuul.yaml Dropping the py35 testing 2019-04-22 23:12:02 +00: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
CONTRIBUTING.rst Update CONTRIBUTING and HACKING 2019-03-11 18:28:36 +00:00
LICENSE initial commit 2010-05-27 23:05:26 -07:00
lower-constraints.txt Don't use OVO with ResourceProvider and ResourceProviderList 2019-02-25 23:48:33 +00:00
README.rst Update CONTRIBUTING and HACKING 2019-03-11 18:28:36 +00:00
requirements.txt Remove use of oslo.i18n and translation 2019-03-25 16:59:21 +00:00
setup.cfg Package db migration scripts in placement pypi dist 2019-05-07 00:08:39 +00:00
setup.py Updated from global requirements 2017-03-02 11:50:48 +00:00
test-requirements.txt Correct lower-constraints.txt and the related tox job 2018-11-27 17:41:02 +00:00
tox.ini Dropping the py35 testing 2019-04-22 23:12:02 +00:00

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:

Developers

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

Further developer focused documentation is available at: