Filters

There will often be modules which should only be applied in a certain scenario. For example, a module that installs an apt package should not run on OSX, as Aptitude will not be available. To solve this problem, Peridot uses the concept of filters when a module is listed in a config file.

A filter is a list of values for which a match indicates the module should be applied. If there is no match, the module is simply ignored.

For example, the following module will only be applied on Linux, when the architecture is either amd64 or arm64.

modules:
  - name: filter example
    source: ./my-module
    variables:
      message: this module only runs on linux
    filters:
      arch:
        - amd64
        - arm64
      os: 
        - linux

The filters property allows the following: