diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b486253..bf3fab2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 `_ +to learn how to create your own filter for Nova Scheduler. diff --git a/doc/source/usage.rst b/doc/source/usage.rst index a807b45..1777857 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,31 @@ ===== Usage ===== +Follow the `Installation `_ 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 `_ +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 +