summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/no_prompting.md
blob: 7e525c87a0cfcea0b9586e0c6120f211dedd858b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# no-prompting

This rule checks for `vars_prompt` or the `ansible.builtin.pause` module in playbooks.
You should enable this rule to ensure that playbooks can run unattended and in CI/CD pipelines.

This is an opt-in rule.
You must enable it in your Ansible-lint configuration as follows:

```yaml
enable_list:
  - no-prompting
```

## Problematic Code

```yaml
---
- name: Example playbook
  hosts: all
  vars_prompt: # <- Prompts the user to input credentials.
    - name: username
      prompt: What is your username?
      private: false

    - name: password
      prompt: What is your password?
  tasks:
    - name: Pause for 5 minutes
      ansible.builtin.pause:
        minutes: 5 # <- Pauses playbook execution for a set period of time.
```

## Correct Code

Correct code for this rule is to omit `vars_prompt` and the `ansible.builtin.pause` module from your playbook.