Welcome to Ansible Rulebook documentation

Contents:

• Introduction
  • What is Event-Driven Ansible?
  • Why Event-Driven?
  • Why Rulebooks?
  • Getting started
  • Other Resources
• Getting started
  • Hello world!
  • A webhook example
• Installation
  • Pulling the container image
  • Installing with pip
• Development environment
  • Building the container image
  • Git pre-commit hooks
• Contributing
  • Getting in touch
  • Types of Contributions
• Usage
• Rulebooks
  • Rulesets
  • Including multiple sources
  • Using vaulted strings
• Rules
• Conditions
  • Supported data types
  • Navigate structured data
  • Supported Operators
  • Examples
  • FAQ
• Events and Facts
  • Differences between Events and Facts
• Variables
  • Accessing variables in your rulebook
  • Providing extra vars to actions
  • Using vaulted strings for variables
• Limiting hosts
  • Inserting hosts to meta
• Matching multiple events
• Actions
  • run_playbook
  • run_module
  • run_job_template
  • run_workflow_template
  • post_event
  • set_fact
  • retract_fact
  • print_event
  • shutdown
  • Results
  • debug
  • none
  • FAQ
• Jinja Filters
  • Usage in Actions
  • Available Filters
  • Python String Methods
  • Chaining Filters
  • Complete Examples
  • Built-in Jinja2 Filters
  • FAQ
• Event Sources
• Builtin Event Sources
  • eda.builtin.range
  • eda.builtin.generic
  • eda.builtin.webhook
  • eda.builtin.pg_listener
  • How to Develop a Custom Plugin
• Event Filters
• Builtin Event Filters
  • eda.builtin.insert_meta_info
  • eda.builtin.event_splitter
  • eda.builtin.dashes_to_underscores
  • eda.builtin.json_filter
  • eda.builtin.normalize_keys
  • eda.builtin.insert_hosts_to_meta
• Runner
• Rulebook and Collections
  • The structure of a Collection with Rulebook content
  • Using a rulebook included in a collection
• Plugin Lifecycle
  • Understanding the Plugin Lifecycle
  • Configuring Plugin Lifecycle in Collections
  • Deprecating a Plugin
  • Redirecting a Plugin
  • Tombstoning a Plugin
  • Complete Migration Example
  • Technical Details
  • See Also
• Decision Environment
  • Using your own rulebooks and projects with the decision environment

Indices and tables

• Module Index

• Search Page