Initial commit

.gitignore

@@ -0,0 +1,65 @@
+# Byte-compiled / optimized / DLL files
+.*
+!.gitignore
+.*.sw?
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv python configuration file
+.python-version

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Gorka Eguileor <gorka@eguileor.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

CONTRIBUTING.rst

@@ -0,0 +1,114 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/akrog/alt_cinder_sch/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Alternative Cinder Scheduler Classes could always use more documentation, whether as part of the
+official Alternative Cinder Scheduler Classes docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/akrog/alt_cinder_sch/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `alt_cinder_sch` for local development.
+
+1. Fork the `alt_cinder_sch` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/alt_cinder_sch.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv alt_cinder_sch
+    $ cd alt_cinder_sch/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 alt_cinder_sch tests
+    $ python setup.py test or py.test
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
+   https://travis-ci.org/akrog/alt_cinder_sch/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+
+    $ python -m unittest tests.test_alt_cinder_sch

HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.1.0 (2017-07-02)
+------------------
+
+* First release on PyPI.

LICENSE

@@ -0,0 +1,17 @@
+
+Apache Software License 2.0
+
+Copyright (c) 2017, Gorka Eguileor
+
+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.
+

MANIFEST.in

@@ -0,0 +1,13 @@
+
+include AUTHORS.rst
+
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

Makefile

@@ -0,0 +1,92 @@
+.PHONY: clean clean-test clean-pyc clean-build docs help
+.DEFAULT_GOAL := help
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+
+lint: ## check style with flake8
+	flake8 alt_cinder_sch tests
+
+test: ## run tests quickly with the default Python
+
+		python setup.py test
+
+test-all: ## run tests on every Python version with tox
+	tox
+
+coverage: ## check code coverage quickly with the default Python
+
+		coverage run --source alt_cinder_sch setup.py test
+
+		coverage report -m
+		coverage html
+		$(BROWSER) htmlcov/index.html
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/alt_cinder_sch.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ alt_cinder_sch
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(BROWSER) docs/_build/html/index.html
+
+servedocs: docs ## compile the docs watching for changes
+	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+
+register: ## register package in pypi
+       python setup.py register
+
+release: clean ## package and upload a release
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+dist: clean ## builds source and wheel package
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+install: clean ## install the package to the active Python's site-packages
+	python setup.py install

README.rst

@@ -0,0 +1,70 @@
+Alternative Cinder Scheduler Classes
+====================================
+
+.. image:: https://img.shields.io/pypi/v/alt_cinder_sch.svg
+   :target: https://pypi.python.org/pypi/alt_cinder_sch
+
+.. image:: https://readthedocs.org/projects/alt-cinder-sch/badge/?version=latest
+   :target: https://alt-cinder-sch.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://img.shields.io/pypi/pyversions/alt_cinder_sch.svg
+   :target: https://pypi.python.org/pypi/alt_cinder_sch
+
+.. image:: https://pyup.io/repos/github/akrog/alt_cinder_sch/shield.svg
+     :target: https://pyup.io/repos/github/akrog/alt_cinder_sch/
+     :alt: Updates
+
+.. image:: https://img.shields.io/:license-apache-blue.svg
+   :target: http://www.apache.org/licenses/LICENSE-2.0
+
+
+Alternative Classes such as filters, host managers, etc. for Cinder, the
+OpenStack Block Storage service.
+
+The main purpose of this library is to illustrate the broad range of
+possibilities of the Cinder Scheduler provided by its flexible mechanisms.
+
+Currently there's only 2 interesting features, which are the possibility of
+changing the default provisioning type on volume creation for volumes that
+don't specify the type using the `provisioning:type` extra spec and an
+alternative calculation of the free space consumption.
+
+Scheduler's original approach to space consumption by new volumes is
+conservative to prevent backends from filling up due to a sudden burst of
+volume creations.
+
+The alternative approach is more aggressive and is adequate for deployments
+where the workload is well know and a lot of thin volumes could be requested
+at the same time.
+
+It's important to notice that even though the Schedulers will be able to
+understand `provisioining:type` extra spec it will depend on the backend if
+this parameter is actually used or not.
+
+* Free software: Apache Software License 2.0
+* Documentation: https://alt-cinder-sch.readthedocs.io.
+
+Features
+--------
+
+* Can default capacity calculations to thin or thick.
+* Less conservative approach to free space consumption calculations.
+
+
+Usage
+-----
+
+First we'll need to have the package installed:
+
+.. code-block:: console
+
+ # pip install alt_cinder-sch
+
+Then we'll have to configure Cinder's schedulers to use the package::
+
+    scheduler_host_manager = alt_cinder_sch.host_managers.HostManagerThin
+    scheduler_default_filters = AfailabilityZoneFilter,AltCapacityFilter,CapabilitiesFilter
+    scheduler_dirver = alt_cinder_sch.scheduler_drivers.FilterScheduler
+
+And finally restart scheduler services.