Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about the transform function #886

Merged
merged 3 commits into from
Dec 18, 2023
Merged

Add documentation about the transform function #886

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0f4db3
Add documentation about the transform function
jifox Dec 15, 2023
61c9608
Undo unwanted changes
jifox Dec 18, 2023
cc4f562
redo change
jifox Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/plugins/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Transform functions

A transform function is a plugin that manipulates the inventory independently from the inventory plugin used. Useful to extend data using the environment, a secret store or similar.

During inventory initialization, the transform function will be called in a for loop for each host. The transform function takes a host object as the first parameter and additional keyword arguments as specified in the `config.inventory.transform_function_options` dictionary.

Runners
_______

Expand Down
Loading