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

RPL-213: Ansible plugin - Add info about inventory yaml fields #1600

Open
wants to merge 1 commit into
base: 5.9.0
Choose a base branch
from
Open

RPL-213: Ansible plugin - Add info about inventory yaml fields #1600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file modified docs/.vuepress/public/assets/img/howto-ansible-yaml-data-size.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/assets/img/howto-ansible-yaml-max-aliases.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 19 additions & 6 deletions docs/learning/howto/using-ansible.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,20 +101,33 @@ Time for a quick test.

To see the output you may need to switch to the _Log Output_ view.

## Gather Facts
When Gather Facts is enabled, Ansible collects information from the nodes and verifies if it is possible to connect to them. On the other hand, when Gather Facts is disabled, Ansible skips the connection validation, significantly saving time and reducing CPU and RAM usage.
In addition, it is necessary to modify this property in ansible.cfg file to _"duplicate_dict_key=ignore"_, this is to avoid a warning message when are duplicate node names.
## Inventory Yaml
When Gather Facts is false, the inventory file is read as Yaml data.
This avoids connection validation, significantly saving time and reducing CPU and RAM usage.

## Inventory File
When Gather Facts is false, the inventory file is read as Yaml data. It supports up to 10MB of data by default, which supports around 19,000 nodes. However, it depends on the operating system.
- <b>Data Size</b>
It supports up to 10MB of data by default, which supports around 19,000 nodes. However, it depends on the operating system.

This parameter can be increased if necessary in this field:
<br><br>![ Yaml Data Size ](/assets/img/howto-ansible-yaml-data-size.png)<br><br>
![ Yaml Data Size ](/assets/img/howto-ansible-yaml-data-size.png)<br>

When the limit is exceeded it throws this error in rundeck.log file:
```
ResourceModelSourceException: Cannot load yaml data coming from Ansible: The incoming YAML document exceeds the limit: 10485760 code points.
```
<br>

- <b>Max Aliases</b>
It supports up to 1000 of aliases by default. This is to avoid the application vulnerable to certain types of attacks.

This parameter can be increased if necessary in this field:
![ Yaml Max_Aliases ](/assets/img/howto-ansible-yaml-max-aliases.png)<br>

When the limit is exceeded it throws this error in rundeck.log file:
```
ResourceModelSourceException: Cannot load yaml data coming from Ansible: Number of aliases for non-scalar nodes exceeds the specified max=1000.
```
<br>

## Additional Information

Expand Down
Loading