Changeset - 7be03b9a5d15
Parent rev.
Child rev.
[Not reviewed]
mar-245-ansible_11
0 2 0
Branko Majic (branko) - 1 month ago 2025-02-21 19:01:44
branko@majic.rs
MAR-245: Fix some linting errors in documentation:

- Use proper truthy YAML expressions.
- Explicitly specify file permissions.
2 files changed with 31 insertions and 29 deletions:
docs/rolereference.rst
1
1
docs/usage.rst
30
28
0 comments (0 inline, 0 general) First comment
docs/rolereference.rst
➞
Show inline comments
 
@@ -1479,7 +1479,7 @@ Here is an example configuration for setting-up the mail forwarder:
 

			




	
	
	
		
 
  smtp_relay_host_port: 27

			




	
	
	
		
 

			




	
	
	
		
 
  smtp_from_relay_allowed: False

			




	
	
	
		
 
  smtp_from_relay_allowed: false

			




	
	
	
		
 

			




	
	
	
		
 
  smtp_relay_truststore: /etc/ssl/certs/example_ca_chain.pem

			




	
	
	
		
 

			




        

    


    
    

    

        

                

                    docs/usage.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -522,7 +522,7 @@ Let's take care of this common configuration right away:

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: communications

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 

			




	
	
		
 
@@ -535,7 +535,7 @@ Let's take care of this common configuration right away:

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 

			




	
	
		
 
@@ -548,7 +548,7 @@ Let's take care of this common configuration right away:

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: backup

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 

			




	
	
		
 
@@ -634,7 +634,7 @@ one up first. This includes both the LDAP *server* and *client* configuration.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: communications

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -650,7 +650,7 @@ one up first. This includes both the LDAP *server* and *client* configuration.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -785,7 +785,7 @@ role.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: communications

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -996,7 +996,7 @@ external addresses on those two servers goes through our anti-virus scanner.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -1009,7 +1009,7 @@ external addresses on those two servers goes through our anti-virus scanner.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: backup

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - mail_forwarder

			




	
	
		
 
@@ -1086,7 +1086,7 @@ role.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: communications

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -1261,7 +1261,7 @@ Nginx.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -1344,7 +1344,7 @@ server.

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -1558,16 +1558,17 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 
          url: "https://download.nextcloud.com/server/releases/nextcloud-29.0.4.tar.bz2"

			




	
	
	
		
 
          dest: "/var/www/nextcloud.example.com/nextcloud-29.0.4.tar.gz"

			




	
	
	
		
 
          checksum: "sha256:19c469e264b31ee80400f8396460854546569e88db4c15fc0854e192f96027eb"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
          mode: "0640"

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: admin-nextcloud_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Unpack the application archive

			




	
	
	
		
 
        ansible.builtin.unarchive:

			




	
	
	
		
 
          src: "/var/www/nextcloud.example.com/nextcloud-29.0.4.tar.gz"

			




	
	
	
		
 
          dest: "/var/www/nextcloud.example.com/"

			




	
	
	
		
 
          copy: no

			




	
	
	
		
 
          copy: false

			




	
	
	
		
 
          creates: "/var/www/nextcloud.example.com/nextcloud"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: admin-nextcloud_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      # Majic Ansible Roles currently only support utf8 encoding.

			




	
	
		
 
@@ -1607,7 +1608,8 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 
        ansible.builtin.copy:

			




	
	
	
		
 
          content: ""

			




	
	
	
		
 
          dest: "/var/www/nextcloud.example.com/data/nextcloud.log"

			




	
	
	
		
 
          force: no

			




	
	
	
		
 
          force: false

			




	
	
	
		
 
          mode: "0660"

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Set-up log file permissions

			




	
	
	
		
 
        ansible.builtin.file:

			




	
	
		
 
@@ -1632,11 +1634,11 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Get application installation status

			




	
	
	
		
 
        ansible.builtin.command: "/var/www/nextcloud.example.com/nextcloud/occ status"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: "admin-nextcloud_example_com"

			




	
	
	
		
 
        register: nextcloud_status

			




	
	
	
		
 
        changed_when: False

			




	
	
	
		
 
        failed_when: False

			




	
	
	
		
 
        changed_when: false

			




	
	
	
		
 
        failed_when: false

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Check if application is installed

			




	
	
	
		
 
        ansible.builtin.set_fact:

			




	
	
		
 
@@ -1653,7 +1655,7 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Install application

			




	
	
	
		
 
        ansible.builtin.command: "/var/www/nextcloud.example.com/install_nextcloud.py"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: "admin-nextcloud_example_com"

			




	
	
	
		
 
        when: "not nextcloud_installed"

			




	
	
	
		
 

			




	
	
		
 
@@ -1666,8 +1668,8 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 
        ansible.builtin.file:

			




	
	
	
		
 
          path: "/var/www/nextcloud.example.com/data"

			




	
	
	
		
 
          mode: g+w

			




	
	
	
		
 
          recurse: yes

			




	
	
	
		
 
          follow: no

			




	
	
	
		
 
          recurse: true

			




	
	
	
		
 
          follow: false

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Deploy local configuration overrides

			




	
	
	
		
 
        ansible.builtin.copy:

			




	
	
		
 
@@ -1754,7 +1756,7 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -1943,7 +1945,7 @@ on the safe side:

			




	
	
	
		
 
        args:

			




	
	
	
		
 
          chdir: "/var/www/wiki.example.com"

			




	
	
	
		
 
          creates: "/var/www/wiki.example.com/code/wiki_example_com"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: admin-wiki_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Deploy settings for wiki website

			




	
	
		
 
@@ -1964,7 +1966,7 @@ on the safe side:

			




	
	
	
		
 
          command: "{{ item }}"

			




	
	
	
		
 
          app_path: "/var/www/wiki.example.com/code/"

			




	
	
	
		
 
          virtualenv: "/var/www/wiki.example.com/virtualenv/"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: admin-wiki_example_com

			




	
	
	
		
 
        with_items:

			




	
	
	
		
 
          - migrate

			




	
	
		
 
@@ -1982,7 +1984,7 @@ on the safe side:

			




	
	
	
		
 
        ansible.builtin.command: "/var/www/wiki.example.com/virtualenv/bin/exec ./create_superuser.py"

			




	
	
	
		
 
        args:

			




	
	
	
		
 
          chdir: "/var/www/wiki.example.com/code/"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        become_user: admin-wiki_example_com

			




	
	
	
		
 
        register: wiki_superuser

			




	
	
	
		
 
        changed_when: "wiki_superuser.stdout ==  'Created superuser.'"

			




	
	
		
 
@@ -2211,7 +2213,7 @@ on the safe side:

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: web

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - ldap_client

			




	
	
		
 
@@ -2289,7 +2291,7 @@ straight to it:

			




	
	
	
		
 

			




	
	
	
		
 
      - hosts: backup

			




	
	
	
		
 
        remote_user: ansible

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become: true

			




	
	
	
		
 
        roles:

			




	
	
	
		
 
          - common

			




	
	
	
		
 
          - mail_forwarder

			




	
	
		
 
@@ -2372,7 +2374,7 @@ So, back to the business:

			




	
	
	
		
 
   :file:`~/mysite/group_vars/all.yml`

			




	
	
	
		
 
   ::

			




	
	
	
		
 

			




	
	
	
		
 
      enable_backup: yes

			




	
	
	
		
 
      enable_backup: true

			




	
	
	
		
 
      backup_encryption_key: "{{ lookup('pipe', 'gpg --homedir ~/mysite/gnupg/ --armour --export-secret-keys ' + ansible_fqdn ) }}"

			




	
	
	
		
 
      backup_server: bak.example.com

			




	
	
	
		
 
      backup_server_host_ssh_public_keys:

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    First comment





    


  

  

      

      

          

            You need to be logged in to comment. Login now
          

      

      

      
      

      

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.99,
        which is
        © 2010–2024 by various authors & licensed under GPLv3.