Release Notes

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.

Features

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

Communication

We recommend using the standard communication channels, such as the OpenStack mailing list or IRC channels. The official IRC channel (#openstack-hyper-v) is not archived at the moment, so we recommend using #openstack-dev.

Please include one of the following tags when using the OpenStack mailing list:

Feel free to reach out to the Winstackers PTL or other core members.

Contacting the Core Team

The Winstackers core team is composed of:

New Feature Planning

If you want to propose a new feature, we recommend filing a blueprint and then contacting the core team.

Once the feature is approved, please propose the patches on Gerrit, following the Openstack contributor guide.

Task Tracking

We track our tasks in Launchpad.

Reporting a Bug

You found an issue and want to make sure we are aware of it? You can do so on Launchpad. More info about Launchpad usage can be found on OpenStack docs page.

Getting Your Patch Merged

Changes proposed to os-win generally require two Code-Review +2 votes from os-win core reviewers before merging. In case of trivial patches and urgent bug fixes, this rule is sometimes ignored.

Project Team Lead Duties

All common PTL duties are enumerated in the PTL guide.

Os-win Configuration Options

The following is a sample os-win configuration for adaptation and use.

The sample configuration can also be viewed in file from.

IMPORTANT:

[DEFAULT]
[os_win]
#
# From os_win
#
# Fibre Channel hbaapi library path. If no custom hbaapi library is requested,
# the default one will be used. (string value)
#hbaapi_lib_path = hbaapi.dll
# Caches temporary WMI objects in order to increase performance. This only
# affects networkutils, where almost all operations require a reference to a
# switch port. The cached objects are no longer valid if the VM they are
# associated with is destroyed. WARNING: use with caution, the cache may become
# invalid when certain resources are recreated. (boolean value)
#cache_temporary_wmi_objects = false
# The default amount of seconds to wait when stopping pending WMI jobs. Setting
# this value to 0 will disable the timeout. (integer value)
#wmi_job_terminate_timeout = 120
# The amount of time to wait for the Failover Cluster service to be available.
# (integer value)
#connect_cluster_timeout = 0
# The amount of seconds to wait for in-use files when performing moves or
# deletions. This can help mitigate issues occurring due to Hyper-V locks or
# even 3rd party backup tools. (integer value)
#file_in_use_timeout = 15