x/nfv-filters
Code Issues Proposed changes

Add documentation: how to enable a new filter in Nova

Browse Source 
Added instructions to make available and enable a new
filter, implemented in this repository, in Nova
Scheduler.

Closes-Bug: #1646066
Change-Id: Ic96afa2b28025c4ddb4811c082c69a82daa4ff0d
This commit is contained in:
Rodolfo Alonso Hernandez 2016-11-30 12:36:02 +00:00
parent 345510ca1a
commit 5c6a3b3735
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.rst
View File

@ -15,3 +15,6 @@ Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/nfv-filters
See `Filter scheduler#Writing your own filter <http://docs.openstack.org/developer/nova/filter_scheduler.html#writing-your-own-filter>`_
to learn how to create your own filter for Nova Scheduler.

24
doc/source/usage.rst
View File

@ -1,7 +1,31 @@
=====
Usage
=====
Follow the `Installation <installation.html>`_ document first. This document
describes how to install this project.
To use nfv-filters in a project::
import nfv_filters
local.conf settings
-------------------
See `Configuring filters <http://docs.openstack.org/developer/nova/filter_scheduler.html#configuring-filters>`_
to learn how to use configure Nova Scheduler filters.
To make available a new filter in Nova, not located in Nova Scheduler default
filters, you should add the file containing the filter class to the variable
`scheduler_available_filters` in the default section::
[[post-config|$NOVA_CONF]]
[DEFAULT]
filter_scheduler.available_filters=nova.scheduler.filters.all_filters,nfv_filters.nova.scheduler.filters.aggregate_instance_type_filter
To enable this filter in Nova Scheduler, add your filter to the variable
`scheduler_default_filters`::
[[post-config|$NOVA_CONF]]
[DEFAULT]
scheduler_default_filters=RamFilter,ComputeFilter,AggregateInstanceTypeFilter