- Primary Maintainer:
- Other Contributors:
The nova.objects package abstracts versionable internal objects for use with RPC.
Rather than moving this code into the incubator, I propose that we move it directly to a new library. The code has been around long enough that the API is reasonably stable.
nova/exception.py (with cleanup to remove extraneous parts; tests not needed)
nova/tests/unit/test_utils.py (with cleanup to remove extraneous parts)
nova/safe_utils.py (with cleanup to remove extraneous parts)
nova/utils.py (with cleanup to remove extraneous parts)
These projects are already using the code:
The divergence in Ironic is minimal and their version is generally slightly behind nova, as new things are only copied over as needed.
The public API is relatively well-defined at this point. Major elements consist of:
base.VersionedObject - The base object to subclass for each implementation
base.remotable - A decorator to make an object method into an RPC-able thing
base.remotable_classmethod - A decorator to make a classmethod into an RPC-able thing
base.ObjectListBase - A mix-in to gain list-of-objects functionality
base.VersionedObjectSerializer - an oslo.messaging.NoOpSerializer that marshals VersionedObject objects over the wire
The following things are fairly nova-specific and should be left in the Nova tree (for now at least):
Things that are public now (or, too public for a library) that should be made private:
Things that need some definition that are currently rather obscure and nova-centric:
The base.VersionedObjectMetaclass.indirection_api interface is how RPC-able things are remoted. Right now, this is nova’s conductor class, but a simple base class to define the interface should be created for others to subclass. In nova, we set this rather forcibly, but in this library, we should provide methods to set/clear the indirection service.
The service and conductor code will be left out of the initial import, and the tests using it commented out. Fixing those tests will be a high priority item before we release.
Finally, there is one detail of the implementation that deserves some thought before we codify it in a library. Right now, the simple act of subclassing NovaObject will register the implementation in the registry, via the metaclass. This is convenient because the author doesn’t have to do anything in order to use their implementation immediately. However, it may be a little “too magic” or “too automatic”. If you want to subclass NovaObject but not register it, there is currently no way to do that. We could have an unregister function, but then it’s impossible to avoid the small window of being registered. The unit tests currently have some weirdness because of this, for their test objects.
The alternate proposal for registration would be a simple class decorator that you apply to objects that you wish to be registered.
Target Milestone for completion: kilo-2
Create Initial Repository
Update MAINTAINERS in incubator with status and name
Remove Oslo logging calls in incubator
Fix the output of graduate.sh
Use cookiecutter template to make a new project
Sync tools from nova
Finish moving should-be-private things to private names
Make changes to the registry according to review
Finish documenting any public interfaces lacking proper docs
Publish git repo
Oslo team review new repository
openstack-infra/project-config - gerrit/projects.yaml
openstack-infra/project-config - gerrit/acls/openstack/project-name.config
openstack-infra/project-config - jenkins/jobs/projects.yaml
openstack-infra/project-config - zuul/layout.yaml
openstack-infra/project-config - gerritbot/channels.yaml
Update Gerrit Groups and ACLs
openstack-infra/devstack-gate - devstack-vm-gate-wrap.sh
Update list of libraries on Oslo wiki page
Create Launchpad project
Create Launchpad bug tracker
Create Launchpad blueprint tracker
Change owner of Launchpad project
Make the library do something
Give openstackci Owner permissions on PyPI
Tag a release
Remove graduated code from oslo-incubator
Update oslo-incubator/update.py to not rewrite references to the library
openstack/requirements - global-requirements.txt
Document Migration Process
openstack-dev/devstack - lib/oslo
openstack-dev/devstack - stackrc
Update project list on docs.openstack.org
Fix/update tests that depend on nova’s service code
Adoption will include synchronization with changes that may be going into Nova at the same time until the point at which nova can move to using the oslo library.
Earlier patch to incubator to import this code: https://review.openstack.org/#/c/60376/
#!/bin/bash # Depends on refactored graduation scripts found # in https://review.openstack.org/#/c/151027/ set -ex (cd nova && git checkout master && git pull) new_repo=oslo.versionedobjects-$(date +%Y-%m-%d-%H%M) git clone nova $new_repo cd $new_repo tooldir=~/repos/openstack/oslo-incubator/tools FILES=" nova/exception.py nova/objects/__init__.py nova/objects/base.py nova/objects/fields.py nova/test.py nova/tests/fixtures.py nova/tests/unit/objects/__init__.py nova/tests/unit/objects/test_fields.py nova/tests/unit/objects/test_objects.py nova/tests/unit/test_utils.py nova/safe_utils.py nova/utils.py " $tooldir/filter_git_history.sh $FILES git mv nova oslo_versionedobjects git mv oslo_versionedobjects/objects/* oslo_versionedobjects/ rmdir oslo_versionedobjects/objects git mv oslo_versionedobjects/tests/unit/objects/* oslo_versionedobjects/tests/ rmdir oslo_versionedobjects/tests/unit/objects git mv oslo_versionedobjects/tests/unit/test_utils.py oslo_versionedobjects/tests/ rmdir oslo_versionedobjects/tests/unit $tooldir/apply_cookiecutter.sh versionedobjects cat - >requirements.txt <<EOF six>=1.7.0 Babel>=1.3 netaddr>=0.7.12 oslo.concurrency>=1.4.1 # Apache-2.0 oslo.context>=0.1.0 # Apache-2.0 oslo.messaging>=1.4.0,!=1.5.0 oslo.serialization>=1.2.0 # Apache-2.0 oslo.utils>=1.2.0 # Apache-2.0 iso8601>=0.1.9 EOF cat - >test-requirements.txt <<EOF hacking>=0.5.6,<0.8 oslotest>=1.2.0 # Apache-2.0 mock>=1.0 testtools>=0.9.36,!=1.2.0 # These are needed for docs generation oslosphinx>=2.2.0 # Apache-2.0 sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 EOF echo echo "Output in $(pwd)" exit $? # oslo-incubator modules: # versionutils
This work is licensed under a Creative Commons Attribution 3.0 Unported License. http://creativecommons.org/licenses/by/3.0/legalcode