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.

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

Docs: Minor edits to rule docs #2418

Merged
merged 1 commit into from
Sep 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/ansiblelint/rules/deprecated_module.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Refer to the [Ansible module index](https://docs.ansible.com/ansible/latest/coll
hosts: localhost
tasks:
- name: Configure VLAN ID
ansible.netcommon.net_vlan: # <-- This module is deprecated.
ansible.netcommon.net_vlan: # <- Uses a deprecated module.
vlan_id: 20
```

Expand All @@ -26,7 +26,7 @@ Refer to the [Ansible module index](https://docs.ansible.com/ansible/latest/coll
hosts: localhost
tasks:
- name: Configure VLAN ID
dellemc.enterprise_sonic.sonic_vlans: # <-- Use a platform specific module.
dellemc.enterprise_sonic.sonic_vlans: # <- Uses a platform specific module.
config:
- vlan_id: 20
```
5 changes: 2 additions & 3 deletions src/ansiblelint/rules/no_log_password.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
This rule ensures playbooks do not write passwords to logs when using loops.
Always set the `no_log: true` attribute to protect sensitive data.

While most ansible modules know to mark sensitive data, if you happen to use
secrets inside a loop, they could end up being logged in some cases. Adding
an explicit `no_log: true` should prevent accidental exposure.
While most Ansible modules mask sensitive data, using secrets inside a loop can result in those secrets being logged.
Explicitly adding `no_log: true` prevents accidentally exposing secrets.

## Problematic Code

Expand Down