fix(docs): add 'become: true' to example playbooks. fix #787 (#804)

Signed-off-by: Sebastian Gumprich <rndmh3ro@users.noreply.github.com>
dev-sec · Oct 9, 2024 · 62947a6 · 62947a6
1 parent 6ff5ceb
commit 62947a6
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 4 deletions.
diff --git a/.aar_doc.yml b/.aar_doc.yml
@@ -43,6 +43,7 @@ output_template: |
 
   ```
   - hosts: all
+    become: true
     roles:
       - name: {{ role }}
   ```

diff --git a/roles/mysql_hardening/README.md b/roles/mysql_hardening/README.md
@@ -24,7 +24,6 @@ Further information is available at [Deutsche Telekom (German)](http://www.telek
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 ## Supported Operating Systems
-
 - EL
   - 8, 9
 - Ubuntu
@@ -135,6 +134,7 @@ None.
 
 ```
 - hosts: all
+  become: true
   roles:
     - name: devsec.hardening.mysql_hardening
 ```

diff --git a/roles/nginx_hardening/README.md b/roles/nginx_hardening/README.md
@@ -17,7 +17,6 @@ It works with the following nginx-roles, including, but not limited to:
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 ## Supported Operating Systems
-
 - EL
   - 8, 9
 - Ubuntu
@@ -142,6 +141,7 @@ None.
 
 ```
 - hosts: all
+  become: true
   roles:
     - name: devsec.hardening.nginx_hardening
 ```

diff --git a/roles/os_hardening/README.md b/roles/os_hardening/README.md
@@ -145,7 +145,6 @@ This role is mostly based on guides by:
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 ## Supported Operating Systems
-
 - EL
   - 8, 9
 - Ubuntu
@@ -999,6 +998,7 @@ None.
 
 ```
 - hosts: all
+  become: true
   roles:
     - name: devsec.hardening.os_hardening
 ```

diff --git a/roles/ssh_hardening/README.md b/roles/ssh_hardening/README.md
@@ -46,7 +46,6 @@ For more information, see [this issue](https://github.com/dev-sec/ansible-collec
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 ## Supported Operating Systems
-
 - EL
   - 8, 9
 - Ubuntu
@@ -478,6 +477,7 @@ None.
 
 ```
 - hosts: all
+  become: true
   roles:
     - name: devsec.hardening.ssh_hardening
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,6 +43,7 @@ output_template: | @@
       ```
       - hosts: all
+        become: true
         roles:
           - name: {{ role }}
       ```
@@ Expand Down @@