os-resource-classes-1.0.0/0000775000175000017500000000000013640201277015435 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/tox.ini0000664000175000017500000000264313640201232016744 0ustar zuulzuul00000000000000[tox] minversion = 3.2 envlist = py37,pep8 ignore_basepython_conflict = True [testenv] basepython = python3 usedevelop = True setenv = OS_STDOUT_CAPTURE=1 OS_STDERR_CAPTURE=1 OS_TEST_TIMEOUT=60 deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} -r{toxinidir}/test-requirements.txt commands = stestr run {posargs} [testenv:pep8] commands = flake8 {posargs} [testenv:venv] commands = {posargs} [testenv:cover] setenv = PYTHON=coverage run --source os_resource_classes --parallel-mode commands = stestr run {posargs} coverage combine coverage html -d cover coverage xml -o cover/coverage.xml [testenv:docs] deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -b html doc/source doc/build/html [testenv:pdf-docs] basepython = python3 deps = {[testenv:docs]deps} whitelist_externals = make commands = sphinx-build -W -b latex doc/source doc/build/pdf make -C doc/build/pdf [testenv:releasenotes] deps = {[testenv:docs]deps} commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [testenv:debug] commands = oslo_debug_helper {posargs} [flake8] # E123, E125 skipped as they are invalid PEP-8. show-source = True ignore = E123,E125 builtins = _ exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build os-resource-classes-1.0.0/os_resource_classes.egg-info/0000775000175000017500000000000013640201277023174 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/os_resource_classes.egg-info/PKG-INFO0000664000175000017500000000414113640201277024271 0ustar zuulzuul00000000000000Metadata-Version: 1.2 Name: os-resource-classes Version: 1.0.0 Summary: Resource Classes for OpenStack Home-page: https://docs.openstack.org/os-resource-classes/latest/ Author: OpenStack Author-email: openstack-discuss@lists.openstack.org License: UNKNOWN Description: =================== os-resource-classes =================== A list of standardized resource classes for OpenStack. A resource class is a distinct type of inventory that exists in a cloud environment, for example ``VCPU``, ``DISK_GB``. They are upper case with underscores. They often include a unit in their name. This package provides a collection of symbols representing those standard resource classes which are expected to be available in any OpenStack deployment. There also exists a concept of custom resource classes. These are countable types that are custom to a particular environment. The OpenStack `placement API`_ provides a way to create these. A custom resource class always begins with a ``CUSTOM_`` prefix. * Free software: Apache license * Documentation: https://docs.openstack.org/os-resource-classes/latest * Source: https://opendev.org/openstack/os-resource-classes * Bugs: https://storyboard.openstack.org/#!/project/openstack/os-resource-classes .. _placement API: https://docs.openstack.org/api-ref/placement/ Platform: UNKNOWN Classifier: Environment :: OpenStack Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: POSIX :: Linux Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: Implementation :: CPython Requires-Python: >=3.6 os-resource-classes-1.0.0/os_resource_classes.egg-info/SOURCES.txt0000664000175000017500000000205613640201277025063 0ustar zuulzuul00000000000000.coveragerc .stestr.conf .zuul.yaml AUTHORS CONTRIBUTING.rst ChangeLog HACKING.rst LICENSE README.rst requirements.txt setup.cfg setup.py test-requirements.txt tox.ini doc/requirements.txt doc/source/conf.py doc/source/index.rst doc/source/contributor/index.rst doc/source/install/index.rst doc/source/user/index.rst os_resource_classes/__init__.py os_resource_classes.egg-info/PKG-INFO os_resource_classes.egg-info/SOURCES.txt os_resource_classes.egg-info/dependency_links.txt os_resource_classes.egg-info/not-zip-safe os_resource_classes.egg-info/pbr.json os_resource_classes.egg-info/requires.txt os_resource_classes.egg-info/top_level.txt os_resource_classes/tests/__init__.py os_resource_classes/tests/base.py os_resource_classes/tests/test_os_resource_classes.py releasenotes/notes/.placeholder releasenotes/notes/drop-python2-support-84918a8b2635e32a.yaml releasenotes/source/conf.py releasenotes/source/index.rst releasenotes/source/stein.rst releasenotes/source/unreleased.rst releasenotes/source/_static/.placeholder releasenotes/source/_templates/.placeholderos-resource-classes-1.0.0/os_resource_classes.egg-info/top_level.txt0000664000175000017500000000002413640201277025722 0ustar zuulzuul00000000000000os_resource_classes os-resource-classes-1.0.0/os_resource_classes.egg-info/pbr.json0000664000175000017500000000005613640201277024653 0ustar zuulzuul00000000000000{"git_version": "3dd3506", "is_release": true}os-resource-classes-1.0.0/os_resource_classes.egg-info/not-zip-safe0000664000175000017500000000000113640201277025422 0ustar zuulzuul00000000000000 os-resource-classes-1.0.0/os_resource_classes.egg-info/dependency_links.txt0000664000175000017500000000000113640201277027242 0ustar zuulzuul00000000000000 os-resource-classes-1.0.0/os_resource_classes.egg-info/requires.txt0000664000175000017500000000001113640201277025564 0ustar zuulzuul00000000000000pbr>=2.0 os-resource-classes-1.0.0/doc/0000775000175000017500000000000013640201277016202 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/doc/source/0000775000175000017500000000000013640201277017502 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/doc/source/conf.py0000775000175000017500000000506313640201232020777 0ustar zuulzuul00000000000000# -*- coding: utf-8 -*- # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. # See the License for the specific language governing permissions and # limitations under the License. import os import sys sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', 'openstackdocstheme', #'sphinx.ext.intersphinx', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable # The suffix of source filenames. source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = u'os-resource-classes' copyright = u'2017, OpenStack Developers' # openstackdocstheme options repository_name = 'openstack/os-resource-classes' use_storyboard = True # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). add_module_names = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', 'doc-%s.tex' % project, u'%s Documentation' % project, u'OpenStack Developers', 'manual'), ] # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} os-resource-classes-1.0.0/doc/source/install/0000775000175000017500000000000013640201277021150 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/doc/source/install/index.rst0000664000175000017500000000052213640201232022777 0ustar zuulzuul00000000000000================== Installation Guide ================== ``os-resource-classes`` is availabe on `PyPI`_ and may be installed using `pip`_:: pip install os-resource-classes See :doc:`/user/index` for how to use it once it is installed. .. _PyPI: https://pypi.org/project/os-resource-classes/ .. _pip: https://pypi.org/project/pip/ os-resource-classes-1.0.0/doc/source/index.rst0000664000175000017500000000064413640201232021336 0ustar zuulzuul00000000000000.. os-resource-classes documentation master file, created by sphinx-quickstart on Tue Jul 9 22:26:36 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. =================== os-resource-classes =================== .. include:: ../../README.rst .. toctree:: install/index user/index contributor/index Search ====== * :ref:`search` os-resource-classes-1.0.0/doc/source/user/0000775000175000017500000000000013640201277020460 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/doc/source/user/index.rst0000664000175000017500000000022513640201232022307 0ustar zuulzuul00000000000000 ===== Usage ===== To use ``os-resource-classes`` in a project: .. code-block:: python import os_resource_classes as orc vcpu = orc.VPCU os-resource-classes-1.0.0/doc/source/contributor/0000775000175000017500000000000013640201277022054 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/doc/source/contributor/index.rst0000664000175000017500000000011613640201232023702 0ustar zuulzuul00000000000000============ Contributing ============ .. include:: ../../../CONTRIBUTING.rst os-resource-classes-1.0.0/doc/requirements.txt0000664000175000017500000000032413640201232021454 0ustar zuulzuul00000000000000sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD openstackdocstheme>=1.20.0 # Apache-2.0 # releasenotes reno>=2.5.0 # Apache-2.0 os-resource-classes-1.0.0/PKG-INFO0000664000175000017500000000414113640201277016532 0ustar zuulzuul00000000000000Metadata-Version: 1.2 Name: os-resource-classes Version: 1.0.0 Summary: Resource Classes for OpenStack Home-page: https://docs.openstack.org/os-resource-classes/latest/ Author: OpenStack Author-email: openstack-discuss@lists.openstack.org License: UNKNOWN Description: =================== os-resource-classes =================== A list of standardized resource classes for OpenStack. A resource class is a distinct type of inventory that exists in a cloud environment, for example ``VCPU``, ``DISK_GB``. They are upper case with underscores. They often include a unit in their name. This package provides a collection of symbols representing those standard resource classes which are expected to be available in any OpenStack deployment. There also exists a concept of custom resource classes. These are countable types that are custom to a particular environment. The OpenStack `placement API`_ provides a way to create these. A custom resource class always begins with a ``CUSTOM_`` prefix. * Free software: Apache license * Documentation: https://docs.openstack.org/os-resource-classes/latest * Source: https://opendev.org/openstack/os-resource-classes * Bugs: https://storyboard.openstack.org/#!/project/openstack/os-resource-classes .. _placement API: https://docs.openstack.org/api-ref/placement/ Platform: UNKNOWN Classifier: Environment :: OpenStack Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: System Administrators Classifier: License :: OSI Approved :: Apache Software License Classifier: Operating System :: POSIX :: Linux Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: Implementation :: CPython Requires-Python: >=3.6 os-resource-classes-1.0.0/LICENSE0000664000175000017500000002363713640201232016444 0ustar zuulzuul00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. os-resource-classes-1.0.0/.stestr.conf0000664000175000017500000000007313640201232017675 0ustar zuulzuul00000000000000[DEFAULT] test_path=./os_resource_classes/tests top_dir=./ os-resource-classes-1.0.0/.coveragerc0000664000175000017500000000016313640201232017545 0ustar zuulzuul00000000000000[run] branch = True source = os_resource_classes omit = os_resource_classes/tests/* [report] ignore_errors = True os-resource-classes-1.0.0/CONTRIBUTING.rst0000664000175000017500000000143013640201232020063 0ustar zuulzuul00000000000000If you would like to contribute to the development of OpenStack, you must follow the steps in this page: http://docs.openstack.org/infra/manual/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: http://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on StoryBoard: https://storyboard.openstack.org/#!/project/openstack/os-resource-classes Developers of os-resource-classes can be found in the ``#openstack-placement`` IRC channel on the ``chat.freenode.net``. os-resource-classes-1.0.0/README.rst0000664000175000017500000000202013640201232017105 0ustar zuulzuul00000000000000=================== os-resource-classes =================== A list of standardized resource classes for OpenStack. A resource class is a distinct type of inventory that exists in a cloud environment, for example ``VCPU``, ``DISK_GB``. They are upper case with underscores. They often include a unit in their name. This package provides a collection of symbols representing those standard resource classes which are expected to be available in any OpenStack deployment. There also exists a concept of custom resource classes. These are countable types that are custom to a particular environment. The OpenStack `placement API`_ provides a way to create these. A custom resource class always begins with a ``CUSTOM_`` prefix. * Free software: Apache license * Documentation: https://docs.openstack.org/os-resource-classes/latest * Source: https://opendev.org/openstack/os-resource-classes * Bugs: https://storyboard.openstack.org/#!/project/openstack/os-resource-classes .. _placement API: https://docs.openstack.org/api-ref/placement/ os-resource-classes-1.0.0/os_resource_classes/0000775000175000017500000000000013640201277021502 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/os_resource_classes/__init__.py0000664000175000017500000001016513640201232023605 0ustar zuulzuul00000000000000# Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. """Static symbols for resources classes used by OpenStack. A resource class is a type of countable thing that exists in a cloud environment, for example VCPU, DISK_GB. They are upper case with underscores. They often include a unit in their name. This package provides a collection of standard resource classes which are expected to be available in any OpenStack deployment. There also exists a concept of custom resource classes. These are countable types that are custom to a particular environment. The OpenStack placement API provides a way to create these. A custom resource class always begins with a "CUSTOM_" prefix. """ import re import sys # NOTE(cdent): We don't expect there to be thousands of resource # classes and we don't desire to track their history in any # particular way so we maintain them as a list of strings ordered by # by the time they were added to the list. From that we automatically # create symbols in the same package. Ordering is important because # it reflects database ids that have been used for resource classes # prior to this package existing. # Extend this list, if required, by adding **to the end of it**. STANDARDS = [ # Virtual CPUs 'VCPU', # Memory Megabytes 'MEMORY_MB', # Disk Gigabytes 'DISK_GB', 'PCI_DEVICE', 'SRIOV_NET_VF', 'NUMA_SOCKET', 'NUMA_CORE', 'NUMA_THREAD', 'NUMA_MEMORY_MB', 'IPV4_ADDRESS', 'VGPU', 'VGPU_DISPLAY_HEAD', # Standard resource class for network bandwidth egress measured in # kilobits per second. 'NET_BW_EGR_KILOBIT_PER_SEC', # Standard resource class for network bandwidth ingress measured in # kilobits per second. 'NET_BW_IGR_KILOBIT_PER_SEC', # Resource class representing an amount of dedicated CPUs for a single # guest. A dedicated CPU is a physical processor that has been marked # to be used for a single guest only 'PCPU', # Resource class representing the number of guests a compute node can # host with memory encrypted at the hardware level. See # http://specs.openstack.org/openstack/nova-specs/specs/train/approved/amd-sev-libvirt-support.html 'MEM_ENCRYPTION_CONTEXT', # An accelerator (the "VF" that can be attached to the guest) from an FPGA. 'FPGA', # A physical GPU for compute offload. 'PGPU', ] # Namespace used for custom resource classes CUSTOM_NAMESPACE = 'CUSTOM_' def is_custom(resource_class): return resource_class.startswith(CUSTOM_NAMESPACE) # Set symbols that match resource class name strings. package = sys.modules[__name__] for resource_class in STANDARDS: setattr(package, resource_class, resource_class) # NOTE(efried): This method was introduced in nova in commit # c6231539a7d39dccf3e859eda54e9336bc164c9f and copied from nova in its current # form as of 5a4863aa152f58f6de426b3908a75c2cc1b2efca def normalize_name(name): """Converts an input string to a legal* custom resource class name. Legal custom resource class names are prefixed with CUSTOM_ and contain only the characters A-Z, 0-9, and _ (underscore). .. note:: Does not attempt to detect an existing ``CUSTOM_`` prefix, so results starting with ``CUSTOM_CUSTOM_`` (etc.) are possible. *Does not attempt to handle length restrictions. :param name: A string to be converted. :return: A legal* custom resource class name. """ if name is None: return None # Replace non-alphanumeric characters with underscores norm_name = re.sub('[^0-9A-Za-z]+', '_', name) # Bug #1762789: Do .upper after replacing non alphanumerics. return CUSTOM_NAMESPACE + norm_name.upper() os-resource-classes-1.0.0/os_resource_classes/tests/0000775000175000017500000000000013640201277022644 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/os_resource_classes/tests/__init__.py0000664000175000017500000000000013640201232024732 0ustar zuulzuul00000000000000os-resource-classes-1.0.0/os_resource_classes/tests/test_os_resource_classes.py0000664000175000017500000000523213640201232030313 0ustar zuulzuul00000000000000# Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. """ test_os_resource_classes ---------------------------------- Tests for `os_resource_classes` module. """ import os_resource_classes as rc from os_resource_classes.tests import base class TestOs_resource_classes(base.TestCase): def test_id_mapping_strings(self): self.assertEqual('VCPU', rc.STANDARDS[0]) self.assertEqual('DISK_GB', rc.STANDARDS[2]) def test_id_mapping_symbols(self): self.assertEqual(rc.VCPU, rc.STANDARDS[0]) self.assertEqual(rc.DISK_GB, rc.STANDARDS[2]) def test_standards_tail(self): """A sanity check that developers are paying attention. When one or more standard classes are added, change the expected last class to the last one added and the length to the new length of rc.STANDARDS. If you arrive here because you've run the tests and they've failed it's possible you've added some standard classes and not thought about their order. You _must_ add new standard classs at the end of the STANDARDS list, otherwise database ids will get confused in the placement service. """ expected_last_class = rc.PGPU expected_length = 18 self.assertEqual(expected_last_class, rc.STANDARDS[-1]) self.assertEqual(expected_length, len(rc.STANDARDS)) def test_normalize_name(self): values = [ ("foo", "CUSTOM_FOO"), ("VCPU", "CUSTOM_VCPU"), ("CUSTOM_BOB", "CUSTOM_CUSTOM_BOB"), ("CUSTM_BOB", "CUSTOM_CUSTM_BOB"), # Bug #1762789: The upper() builtin treats sharp S (\xdf) # differently in py2 vs py3. Make sure normalize_name handles it # properly. (u"Fu\xdfball", u"CUSTOM_FU_BALL"), ("abc-123", "CUSTOM_ABC_123"), ("Hello, world! This is a test ^_^", "CUSTOM_HELLO_WORLD_THIS_IS_A_TEST_"), (" leading and trailing spaces ", "CUSTOM__LEADING_AND_TRAILING_SPACES_"), ] for test_value, expected in values: result = rc.normalize_name(test_value) self.assertEqual(expected, result) os-resource-classes-1.0.0/os_resource_classes/tests/base.py0000664000175000017500000000143213640201232024117 0ustar zuulzuul00000000000000# -*- coding: utf-8 -*- # Copyright 2010-2011 OpenStack Foundation # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. from oslotest import base class TestCase(base.BaseTestCase): """Test case base class for all unit tests.""" os-resource-classes-1.0.0/setup.cfg0000664000175000017500000000147113640201277017261 0ustar zuulzuul00000000000000[metadata] name = os-resource-classes summary = Resource Classes for OpenStack description-file = README.rst author = OpenStack author-email = openstack-discuss@lists.openstack.org home-page = https://docs.openstack.org/os-resource-classes/latest/ python-requires = >=3.6 classifier = Environment :: OpenStack Intended Audience :: Information Technology Intended Audience :: System Administrators License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3 :: Only Programming Language :: Python :: Implementation :: CPython [files] packages = os_resource_classes [egg_info] tag_build = tag_date = 0 os-resource-classes-1.0.0/setup.py0000664000175000017500000000177713640201232017152 0ustar zuulzuul00000000000000# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. # See the License for the specific language governing permissions and # limitations under the License. # THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT import setuptools # In python < 2.7.4, a lazy loading of package `pbr` will break # setuptools if some other modules registered functions in `atexit`. # solution from: http://bugs.python.org/issue15881#msg170215 try: import multiprocessing # noqa except ImportError: pass setuptools.setup( setup_requires=['pbr'], pbr=True) os-resource-classes-1.0.0/ChangeLog0000664000175000017500000000245613640201277017216 0ustar zuulzuul00000000000000CHANGES ======= 1.0.0 ----- * Switch to hacking 2.x * setup.cfg: Configure 'python-requires' * Stop testing with py2 * Switch to Ussuri jobs * Bump the openstackdocstheme extension to 1.20 * Update the constraints url * Build pdf docs * Update bug link in docs to point to storyboard * Update api-ref link to canonical location * Sync Sphinx requirement * Update api-ref location 0.5.0 ----- * Propose FPGA and PGPU resource classes * Add Python 3 Train unit tests 0.4.0 ----- * Replace git.openstack.org URLs with opendev.org URLs * Add MEM\_ENCRYPTION\_CONTEXT resource class * Add missing upper-constraints.txt to deps in docs testenv * Use py3 for all\* tox targets * Dropping the py35 testing * OpenDev Migration Patch * Update master for stable/stein * Update bug links for storyboard 0.3.0 ----- * Add normalize\_name utility 0.2.0 ----- * Add PCPU standard resource class * Update author-email in setup.cfg * Don't use upper-constraints when installing package 0.1.0 ----- * Tune up documentation to be more useful * Sync STANDARDS with placement/nova rc\_fields * Rename ORDERED\_CLASSES to STANDARDS * Initial automated testing for os-resource-classes * fix formatting in README * Set some real tests for the ids in ORDERED\_CLASSES * Initial tuning from cookiecutter start * Initial Cookiecutter Commit os-resource-classes-1.0.0/AUTHORS0000664000175000017500000000075613640201277016515 0ustar zuulzuul00000000000000Adam Spiers Andreas Jaeger Chris Dent Chris Dent Corey Bryant Eric Fried Ghanshyam Mann OpenStack Release Bot Stephen Finucane Takashi NATSUME bhagyashris gujin pengyuesheng os-resource-classes-1.0.0/.zuul.yaml0000664000175000017500000000027613640201232017372 0ustar zuulzuul00000000000000- project: templates: - check-requirements - openstack-cover-jobs - openstack-python3-ussuri-jobs - publish-openstack-docs-pti - release-notes-jobs-python3 os-resource-classes-1.0.0/requirements.txt0000664000175000017500000000035113640201232020707 0ustar zuulzuul00000000000000# The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. pbr>=2.0 # Apache-2.0 os-resource-classes-1.0.0/HACKING.rst0000664000175000017500000000024013640201232017216 0ustar zuulzuul00000000000000os-resource-classes Style Commandments ====================================== Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ os-resource-classes-1.0.0/test-requirements.txt0000664000175000017500000000054713640201232021673 0ustar zuulzuul00000000000000# The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. hacking>=2.0.0,<2.1.0 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 testtools>=1.4.0 # MIT os-resource-classes-1.0.0/releasenotes/0000775000175000017500000000000013640201277020126 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/source/0000775000175000017500000000000013640201277021426 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/source/_static/0000775000175000017500000000000013640201277023054 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/source/_static/.placeholder0000664000175000017500000000000013640201232025314 0ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/source/conf.py0000664000175000017500000002127413640201232022722 0ustar zuulzuul00000000000000# -*- coding: utf-8 -*- # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. # See the License for the specific language governing permissions and # limitations under the License. # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'openstackdocstheme', 'reno.sphinxext', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. copyright = u'2017, OpenStack Developers' # openstackdocstheme options repository_name = 'openstack/os-resource-classes' bug_project = 'nova' bug_tag = '' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. # The full version, including alpha/beta/rc tags. release = '' # The short X.Y version. version = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. # html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # html_additional_pages = {} # If false, no module index is generated. # html_domain_indices = True # If false, no index is generated. # html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False # If true, links to the reST sources are added to the pages. # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'os_resource_classesReleaseNotesdoc' # -- Options for LaTeX output --------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'os_resource_classesReleaseNotes.tex', u'os_resource_classes Release Notes Documentation', u'OpenStack Foundation', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # latex_use_parts = False # If true, show page references after internal links. # latex_show_pagerefs = False # If true, show URL addresses after external links. # latex_show_urls = False # Documents to append as an appendix to all manuals. # latex_appendices = [] # If false, no module index is generated. # latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'os_resource_classesrereleasenotes', u'os_resource_classes Release Notes Documentation', [u'OpenStack Foundation'], 1) ] # If true, show URL addresses after external links. # man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'os_resource_classes ReleaseNotes', u'os_resource_classes Release Notes Documentation', u'OpenStack Foundation', 'os_resource_classesReleaseNotes', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] os-resource-classes-1.0.0/releasenotes/source/index.rst0000664000175000017500000000026313640201232023257 0ustar zuulzuul00000000000000============================================ os_resource_classes Release Notes ============================================ .. toctree:: :maxdepth: 1 unreleased stein os-resource-classes-1.0.0/releasenotes/source/stein.rst0000664000175000017500000000022113640201232023264 0ustar zuulzuul00000000000000=================================== Stein Series Release Notes =================================== .. release-notes:: :branch: stable/stein os-resource-classes-1.0.0/releasenotes/source/_templates/0000775000175000017500000000000013640201277023563 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/source/_templates/.placeholder0000664000175000017500000000000013640201232026023 0ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/source/unreleased.rst0000664000175000017500000000016013640201232024273 0ustar zuulzuul00000000000000============================== Current Series Release Notes ============================== .. release-notes:: os-resource-classes-1.0.0/releasenotes/notes/0000775000175000017500000000000013640201277021256 5ustar zuulzuul00000000000000os-resource-classes-1.0.0/releasenotes/notes/drop-python2-support-84918a8b2635e32a.yaml0000664000175000017500000000011613640201232030267 0ustar zuulzuul00000000000000--- upgrade: - | Python 2 is no longer supported. Python 3 is required. os-resource-classes-1.0.0/releasenotes/notes/.placeholder0000664000175000017500000000000013640201232023516 0ustar zuulzuul00000000000000