RETIRED, Windows / Hyper-V library for OpenStack projects.
Go to file
Lucian Petrut e27e1831f9 Add config sample to os-win docs
This change adds an automatically generated config sample to the
os-win docs.

The config sample is generated each time the docs are built, using
the oslo.config sphinxconfiggen extension.

Related-Bug: #1709648

Change-Id: I01f44bf02c92ecfced6d5266caa40683a0a9248e
2017-11-13 17:53:39 +00:00
doc/source Add config sample to os-win docs 2017-11-13 17:53:39 +00:00
etc Add config sample to os-win docs 2017-11-13 17:53:39 +00:00
os_win Add oslo.config entry point 2017-11-10 15:59:49 +02:00
releasenotes Merge "FC: add support for retrieving FC LUN UIDs" 2017-08-08 07:22:31 +00:00
tools Add Constraints support 2016-12-21 12:42:13 +11:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:42:06 +00:00
.gitignore Add config sample to os-win docs 2017-11-13 17:53:39 +00:00
.gitreview Rename project to os-win 2015-09-17 05:21:49 -07:00
.mailmap Adds oslo cookiecutter template 2015-08-05 19:48:23 +03:00
.testr.conf Renames project to os-windows 2015-08-25 13:35:09 +03:00
babel.cfg Adds oslo cookiecutter template 2015-08-05 19:48:23 +03:00
CONTRIBUTING.rst Rename project to os-win 2015-09-17 05:21:49 -07:00
HACKING.rst Update the documentation link for doc migration 2017-07-24 17:27:49 +08:00
LICENSE Initial commit 2015-08-05 19:34:43 +03:00
MANIFEST.in Adds oslo cookiecutter template 2015-08-05 19:48:23 +03:00
README.rst Optimize the link address 2017-04-10 12:15:09 +05:30
requirements.txt Updated from global requirements 2017-10-04 13:43:06 +00:00
setup.cfg Add oslo.config entry point 2017-11-10 15:59:49 +02:00
setup.py Updated from global requirements 2017-03-02 17:50:41 +00:00
test-requirements.txt Add config sample to os-win docs 2017-11-13 17:53:39 +00:00
tox.ini Merge "Update log translation hacking rule" 2017-07-21 11:35:57 +00:00

Team and repository tags

image

os-win

Windows / Hyper-V library for OpenStack projects.

This library contains Windows / Hyper-V specific code commonly used in OpenStack projects. The library can be used in any other OpenStack projects where it is needed.

How to Install

os-win is released on Pypi, meaning that it can be installed and upgraded via pip. To install os-win, run the following command:

pip install os-win

To upgrade os-win, run the following command:

pip install -U os-win

Note that the first OpenStack release to use os-win is Mitaka. Previous releases do not benefit from this library.

Tests

You will have to install the test dependencies first to be able to run the tests.

C:\os_win> pip install -r requirements.txt
C:\os_win> pip install -r test-requirements.txt

You can run the unit tests with the following command.

C:\os_win> nosetests os_win\tests\unit

How to contribute

To contribute to this project, please go through the following steps.

  1. Clone the project and keep your working tree updated.
  2. Make modifications on your working tree.
  3. Run unit tests.
  4. If the tests pass, commit your code.
  5. Submit your code via git review.
  6. Check that Jenkins and the Microsoft Hyper-V CI pass on your patch.
  7. If there are issues with your commit, ammend, and submit it again via git review.
  8. Wait for the patch to be reviewed.

Features

os-win is currently used in the following OpenStack projects:

  • nova
  • cinder
  • compute-hyperv
  • networking-hyperv
  • ceilometer
  • os-brick