From 709845436e5a1d7ea36a7dfb397aa7b66081d1f2 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Tue, 30 Oct 2018 00:34:32 +0530 Subject: [PATCH] Update plugin filter documentation (#46665) Signed-off-by: Abhijeet Kasurde (cherry picked from commit 6d36849f72efe868af05361576f55d66627ec653) --- changelogs/fragments/46665-plugin_filter_doc_fix.yaml | 2 ++ docs/docsite/rst/user_guide/plugin_filtering_config.rst | 9 +++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 changelogs/fragments/46665-plugin_filter_doc_fix.yaml diff --git a/changelogs/fragments/46665-plugin_filter_doc_fix.yaml b/changelogs/fragments/46665-plugin_filter_doc_fix.yaml new file mode 100644 index 00000000000..af18205cde9 --- /dev/null +++ b/changelogs/fragments/46665-plugin_filter_doc_fix.yaml @@ -0,0 +1,2 @@ +minor_changes: +- Update plugin filter documentation. diff --git a/docs/docsite/rst/user_guide/plugin_filtering_config.rst b/docs/docsite/rst/user_guide/plugin_filtering_config.rst index 04fb0d368d6..fd5a3e93492 100644 --- a/docs/docsite/rst/user_guide/plugin_filtering_config.rst +++ b/docs/docsite/rst/user_guide/plugin_filtering_config.rst @@ -5,7 +5,8 @@ Plugin Filter Configuration Ansible 2.5 adds the ability for a site administrator to blacklist modules that they do not want to be available to Ansible. This is configured via a yaml configuration file (by default, -:file:`/etc/ansible/plugin_filters.yml`). The format of the file is: +:file:`/etc/ansible/plugin_filters.yml`). Use ``plugin_filters_cfg`` configuration +in ``defaults`` section to change this configuration file path. The format of the file is: .. code-block:: YAML @@ -20,7 +21,11 @@ be available to Ansible. This is configured via a yaml configuration file (by de The file contains two fields: * a version so that it will be possible to update the format while keeping backwards - compatibility in the future The present version should be the string, ``"1.0"`` + compatibility in the future. The present version should be the string, ``"1.0"`` * a list of modules to blacklist. Any module listed here will not be found by Ansible when it searches for a module to invoke for a task. + +.. note:: + + The ``stat`` module is required for Ansible to run. So, please make sure you do not add this module in a blacklist modules list.