Changeset - 8551317a0e9f
Parent rev.
Child rev.
[Not reviewed]
0 2 0
Branko Majic (branko) - 5 years ago 2018-11-04 21:21:24
branko@majic.rs
MAR-135: Updated documentation related to new environment variable for running handlers explicitly:

- Updated the usage instructions.
- Updated the release notes to include mention of breaking change.
2 files changed with 12 insertions and 3 deletions:
docs/releasenotes.rst
8
docs/usage.rst
4
3
0 comments (0 inline, 0 general)
docs/releasenotes.rst
➞
Show inline comments
 
@@ -12,6 +12,14 @@ Breaking changes:
 
* Switched to Ansible 2.5.x, removing support for older versions. All
 
  documentation has been updated.
 

			




	
	
	
		
 
* All roles

			




	
	
	
		
 

			




	
	
	
		
 
  * In order to avoid collision with reserved name, the variable for

			




	
	
	
		
 
    running the handlers explicitly has been changed from ``handlers``

			




	
	
	
		
 
    to ``run_handlers``. E.g. to run all handlers a command similar to

			




	
	
	
		
 
    ``ansible-playbook -t handlers -e run_handlers=true

			




	
	
	
		
 
    playbooks/site.yml`` should be used.

			




	
	
	
		
 

			




	
	
	
		
 
* ``ldap_server`` role

			




	
	
	
		
 

			




	
	
	
		
 
  * Custom LDAP module ``m_ldap_entry`` has been removed. Role uses

			




        

    


    
    

    

        

                

                    docs/usage.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -2290,7 +2290,7 @@ handler execution.

			




	
	
	
		
 

			




	
	
	
		
 
To help handle this situation, Majic Ansible Roles all come with a special way

			




	
	
	
		
 
to invoke the handlers explicitly. Each role will include handlers as tasks,

			




	
	
	
		
 
provided that a special variable (``handlers``) is passed in to playbook run. To

			




	
	
	
		
 
provided that a special variable (``run_handlers``) is passed in to playbook run. To

			




	
	
	
		
 
make the run shorter, the handlers in such a run are also tagged with

			




	
	
	
		
 
``handlers``. This doubling of environment variable + tagging stems from current

			




	
	
	
		
 
limitations of Ansible (it is not possible to specify that certain task should

			




	
	
		
 
@@ -2299,9 +2299,10 @@ used).

			




	
	
	
		
 

			




	
	
	
		
 
Handlers alone can be invoked specifically with command similar to::

			




	
	
	
		
 

			




	
	
	
		
 
  ansible-playbook -t handlers -e handlers=true playbooks/site.yml

			




	
	
	
		
 
  ansible-playbook -t handlers -e run_handlers=true playbooks/site.yml

			




	
	
	
		
 

			




	
	
	
		
 
The ``handlers`` variable is treated as boolean, and by default it is not set.

			




	
	
	
		
 
The ``run_handlers`` variable is treated as boolean, and by default it

			




	
	
	
		
 
is not set.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Checking for available package upgrades

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








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