Changeset - bce03e4d9e85
Parent rev.
Child rev.
[Not reviewed]
0 1 0
Branko Majic (branko) - 5 years ago 2021-01-18 22:33:44
branko@majic.rs
MAR-151: Fix The Bug Genie backup example in usage instructions:

- Properly set-up the directory where files are uplaoded.
- Update instructions to mention what needs to be done in order to
upload some files in The Bug Genie.
1 file changed with 24 insertions and 3 deletions:
docs/usage.rst
24
3
0 comments (0 inline, 0 general)
docs/usage.rst
➞
Show inline comments
 
@@ -1542,48 +1542,64 @@ Before we start, here is a couple of useful pointers regarding the
 
          sha256sum: "688bf8f868643b420dded326614fcdf969572ac8ad7fbbb92c28a631157d39e8"
 
          owner: root
 
          group: root
 
          mode: 0755
 

			




	
	
	
		
 
      - name: Unpack TBG

			




	
	
	
		
 
        unarchive:

			




	
	
	
		
 
          src: "/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}.tar.gz"

			




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

			




	
	
	
		
 
          copy: no

			




	
	
	
		
 
          creates: "/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}"

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become_user: admin-tbg_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Allow use of lib-pcre version 10 (since PHP is built against it in Debian Buster)

			




	
	
	
		
 
        lineinfile:

			




	
	
	
		
 
          dest: "/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/{{ item }}"

			




	
	
	
		
 
          state: present

			




	
	
	
		
 
          regexp: '.*"lib-pcre".*'

			




	
	
	
		
 
          line: '        "lib-pcre": ">=8.0",'

			




	
	
	
		
 
        with_items:

			




	
	
	
		
 
          - "composer.json"

			




	
	
	
		
 
          - "composer.lock"

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Create directory for storing uploaded files

			




	
	
	
		
 
        file:

			




	
	
	
		
 
          path: "/var/www/tbg.example.com/files"

			




	
	
	
		
 
          state: directory

			




	
	
	
		
 
          mode: 02770

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become_user: admin-tbg_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Create symlink towards directory where uploaded files are stored

			




	
	
	
		
 
        file:

			




	
	
	
		
 
          src: "/var/www/tbg.example.com/files"

			




	
	
	
		
 
          dest: "/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/files"

			




	
	
	
		
 
          state: link

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become_user: admin-tbg_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Create TBG cache directory

			




	
	
	
		
 
        file:

			




	
	
	
		
 
          path: "/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/cache"

			




	
	
	
		
 
          state: directory

			




	
	
	
		
 
          mode: 02770

			




	
	
	
		
 
        become: yes

			




	
	
	
		
 
        become_user: admin-tbg_example_com

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Set-up the necessary write permissions for TBG directories

			




	
	
	
		
 
        file:

			




	
	
	
		
 
          path: "{{ item }}"

			




	
	
	
		
 
          mode: g+w

			




	
	
	
		
 
        with_items:

			




	
	
	
		
 
          - /var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/

			




	
	
	
		
 
          - /var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/public/

			




	
	
	
		
 
          - /var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/core/config/

			




	
	
	
		
 

			




	
	
	
		
 
      - name: Create symbolic link to TBG application

			




	
	
	
		
 
        file:

			




	
	
	
		
 
          src: "/var/www/tbg.example.com/thebuggenie-{{ tbg_version }}/public"

			




	
	
	
		
 
          path: "/var/www/tbg.example.com/htdocs"

			




	
	
	
		
 
          state: link

			




	
	
	
		
 
          owner: "admin-tbg_example_com"

			




	
	
	
		
 
          group: "web-tbg_example_com"

			




	
	
		
 
@@ -2380,51 +2396,56 @@ Genie*. So let's fix that one.

			




	
	
	
		
 

			




	
	
	
		
 
   .. warning::

			




	
	
	
		
 

			




	
	
	
		
 
      Make sure the addition is properly aligned in the yaml file to previous

			




	
	
	
		
 
      role dependency definitions.

			




	
	
	
		
 

			




	
	
	
		
 
   :file:`~/mysite/roles/tbg/meta/main.yml`

			




	
	
	
		
 

			




	
	
	
		
 
   .. Small workaround for Sphinx not preserving leading spaces in

			




	
	
	
		
 
      case all lines have the same amount of leading spaces.

			




	
	
	
		
 

			




	
	
	
		
 
   .. code-block:: none

			




	
	
	
		
 
      :name: sphinx_workaround

			




	
	
	
		
 

			




	
	
	
		
 
        - role: backup

			




	
	
	
		
 
          when: enable_backup

			




	
	
	
		
 
          backup_patterns_filename: "tbg"

			




	
	
	
		
 
          backup_patterns:

			




	
	
	
		
 
            - "/var/www/tbg.example.com/files"

			




	
	
	
		
 

			




	
	
	
		
 
2. Apply the changes::

			




	
	
	
		
 

			




	
	
	
		
 
     workon mysite && ansible-playbook playbooks/site.yml

			




	
	
	
		
 

			




	
	
	
		
 
3. Now rerun the backup on server ``www.example.com`` (as root). If you haven't

			




	
	
	
		
 
   uploaded any files, you may want to do so before testing to make sure

			




	
	
	
		
 
   something is backed-up.

			




	
	
	
		
 
3. Now rerun the backup on server ``www.example.com`` (as root). If

			




	
	
	
		
 
   you haven't uploaded any files, you may want to do so before

			




	
	
	
		
 
   testing to make sure something is backed-up. This will require

			




	
	
	
		
 
   enabling file uploads in `The Bug Genie settings

			




	
	
	
		
 
   <https://tbg.example.com/configure/files>`_, creating a test

			




	
	
	
		
 
   project, and then adding a new project release (via project's

			




	
	
	
		
 
   release center). While creating a new project release, it is

			




	
	
	
		
 
   possible to upload a release file.

			




	
	
	
		
 

			




	
	
	
		
 
   ::

			




	
	
	
		
 

			




	
	
	
		
 
     duply main backup

			




	
	
	
		
 

			




	
	
	
		
 
4. Verify that the files have been backed-up:

			




	
	
	
		
 

			




	
	
	
		
 
   ::

			




	
	
	
		
 

			




	
	
	
		
 
      duply main list

			




	
	
	
		
 

			




	
	
	
		
 
.. note:: If you wanted to run a script prior to backup run, you would simply

			




	
	
	
		
 
          deploy a shell script with desired content to

			




	
	
	
		
 
          ``/etc/duply/main/pre.d/``. Just make sure the permissions for it are

			




	
	
	
		
 
          ok (it has to be executable by the root user).

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Dealing with failures

			




	
	
	
		
 
---------------------

			




	
	
	
		
 

			




	
	
	
		
 
While the roles have been designed to be fairly robust, it should be taken into

			




	
	
	
		
 
account that certain handlers are used to bring the system into consistent

			




	
	
	
		
 
state. These handlers are mostly the ones dealing with service restarts, but

			




	
	
	
		
 
there are also a couple of handlers that take care of transforming certain data

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








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