Changeset - 4ca98a158269
Parent rev.
Child rev.
[Not reviewed]
0 6 0
Branko Majic (branko) - 7 years ago 2016-11-27 13:35:00
branko@majic.rs
MAR-70: Implemented support for having environment indicator on all HTML pages in wsgi_website and php_website roles.
6 files changed with 76 insertions and 2 deletions:
docs/rolereference.rst
52
docs/usage.rst
6
roles/php_website/defaults/main.yml
2
1
roles/php_website/templates/nginx_site.j2
7
roles/wsgi_website/defaults/main.yml
2
1
roles/wsgi_website/templates/nginx_site.j2
7
0 comments (0 inline, 0 general)
docs/rolereference.rst
➞
Show inline comments
 
@@ -1288,6 +1288,28 @@ Parameters
 
  be served with ``Strict-Transport-Security`` header with value of
 
  ``max-age=31536000; includeSubDomains``.
 

			




	
	
	
		
 
**environment_indicator** (dictionary, optional, ``null``)

			




	
	
	
		
 
  Specify configuration for including environment indicator on all HTML

			




	
	
	
		
 
  pages. Indicator is a simple strip at bottom of a page with custom background

			




	
	
	
		
 
  colour, text colour, and text.

			




	
	
	
		
 

			




	
	
	
		
 
  Specifying environment indicator is useful for avoiding mistakes when testing

			




	
	
	
		
 
  by having better visibility what environment you are in

			




	
	
	
		
 
  (production/staging/test).

			




	
	
	
		
 

			




	
	
	
		
 
  The following keys need to be specified:

			




	
	
	
		
 

			




	
	
	
		
 
  **background_colour** (string, mandatory)

			




	
	
	
		
 
    Background colour to use for the strip at bottom. This should be value

			




	
	
	
		
 
    compatible with CSS ``background-color`` attribute.

			




	
	
	
		
 

			




	
	
	
		
 
  **text_colour** (string, mandatory

			




	
	
	
		
 
    Text colour to use for the strip at bottom. This should be value compatible

			




	
	
	
		
 
    with CSS ``color`` attribute.

			




	
	
	
		
 

			




	
	
	
		
 
  **text** (string, mandatory)

			




	
	
	
		
 
    Text to show in show in the strip at bottom.

			




	
	
	
		
 

			




	
	
	
		
 
**fqdn** (string, mandatory)

			




	
	
	
		
 
  Fully-qualified domain name where the website is reachable. This value is used

			




	
	
	
		
 
  for calculating the user/group name for dedicated website user, as well as

			




	
	
		
 
@@ -1376,6 +1398,10 @@ running *ownCloud* and *The Bug Genie* applications):

			




	
	
	
		
 
      additional_fpm_config:

			




	
	
	
		
 
        "env[PATH]": "\"/usr/local/bin:/usr/bin:/bin\""

			




	
	
	
		
 
      website_mail_recipients: "root john.doe@example.com"

			




	
	
	
		
 
      environment_indicator:

			




	
	
	
		
 
        background_colour: "green"

			




	
	
	
		
 
        text_colour: "black"

			




	
	
	
		
 
        text: "TEST ENVIRONMENT"

			




	
	
	
		
 
    - role: php_website

			




	
	
	
		
 
      deny_files_regex:

			




	
	
	
		
 
        - ^\..*

			




	
	
		
 
@@ -1491,6 +1517,28 @@ Parameters

			




	
	
	
		
 
  be served with ``Strict-Transport-Security`` header with value of

			




	
	
	
		
 
  ``max-age=31536000; includeSubDomains``.

			




	
	
	
		
 

			




	
	
	
		
 
**environment_indicator** (dictionary, optional, ``null``)

			




	
	
	
		
 
  Specify configuration for including environment indicator on all HTML

			




	
	
	
		
 
  pages. Indicator is a simple strip at bottom of a page with custom background

			




	
	
	
		
 
  colour, text colour, and text.

			




	
	
	
		
 

			




	
	
	
		
 
  Specifying environment indicator is useful for avoiding mistakes when testing

			




	
	
	
		
 
  by having better visibility what environment you are in

			




	
	
	
		
 
  (production/staging/test).

			




	
	
	
		
 

			




	
	
	
		
 
  The following keys need to be specified:

			




	
	
	
		
 

			




	
	
	
		
 
  **background_colour** (string, mandatory)

			




	
	
	
		
 
    Background colour to use for the strip at bottom. This should be value

			




	
	
	
		
 
    compatible with CSS ``background-color`` attribute.

			




	
	
	
		
 

			




	
	
	
		
 
  **text_colour** (string, mandatory

			




	
	
	
		
 
    Text colour to use for the strip at bottom. This should be value compatible

			




	
	
	
		
 
    with CSS ``color`` attribute.

			




	
	
	
		
 

			




	
	
	
		
 
  **text** (string, mandatory)

			




	
	
	
		
 
    Text to show in show in the strip at bottom.

			




	
	
	
		
 

			




	
	
	
		
 
**environment_variables** (dict, optional, ``{}``)

			




	
	
	
		
 
  Specify additional environment variables that should be set for running the

			




	
	
	
		
 
  service. Environment variables will be set in both the systemd service and for

			




	
	
		
 
@@ -1589,6 +1637,10 @@ running a bare Django project):

			




	
	
	
		
 
        - comment: Use custom page for non-existing locations/files.

			




	
	
	
		
 
          value: error_page 404 /static/404.html;

			




	
	
	
		
 
      website_mail_recipients: "root john.doe@example.com"

			




	
	
	
		
 
      environment_indicator:

			




	
	
	
		
 
        background_colour: "green"

			




	
	
	
		
 
        text_colour: "black"

			




	
	
	
		
 
        text: "TEST ENVIRONMENT"

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Database Server

			




        

    


    
    

    

        

                

                    docs/usage.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -1236,6 +1236,9 @@ Before we start, here is a couple of useful pointers regarding the

			




	
	
	
		
 
* Mails deliverd to local admin/application users are forwarded to ``root``

			




	
	
	
		
 
  account instead (this can be configured via ``website_mail_recipients`` role

			




	
	
	
		
 
  parameter.

			




	
	
	
		
 
* If you ever find yourself mixing-up test and production websites, have a look

			




	
	
	
		
 
  at ``environment_indicator`` role parameter. It lets you insert small strip at

			




	
	
	
		
 
  bottom of each HTML page automatically.

			




	
	
	
		
 
* Static content (non-PHP) is served directly by *Nginx*.

			




	
	
	
		
 
* Each web application gets distinct sub-directory under ``/var/www``, named

			




	
	
	
		
 
  after the FQDN. All sub-directories created under there are created with

			




	
	
		
 
@@ -1485,6 +1488,9 @@ on the safe side:

			




	
	
	
		
 
* Mails deliverd to local admin/application users are forwarded to ``root``

			




	
	
	
		
 
  account instead (this can be configured via ``website_mail_recipients`` role

			




	
	
	
		
 
  parameter.

			




	
	
	
		
 
* If you ever find yourself mixing-up test and production websites, have a look

			




	
	
	
		
 
  at ``environment_indicator`` role parameter. It lets you insert small strip at

			




	
	
	
		
 
  bottom of each HTML page automatically.

			




	
	
	
		
 
* Static content is served directly by *Nginx*.

			




	
	
	
		
 
* Each web application gets distinct sub-directory under ``/var/www``, named

			




	
	
	
		
 
  after the FQDN. All sub-directories created under there are created with

			




        

    


    
    

    

        

                

                    roles/php_website/defaults/main.yml
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -11,4 +11,5 @@ rewrites: []

			




	
	
	
		
 
https_tls_certificate: "{{ lookup('file', tls_certificate_dir + '/' + fqdn + '_https.pem') }}"

			




	
	
	
		
 
https_tls_key: "{{ lookup('file', tls_private_key_dir + '/' + fqdn + '_https.key') }}"

			




	
	
	
		
 
additional_fpm_config: {}

			




	
	
	
		
 
website_mail_recipients: "root"

			




	
	
		
 
\ No newline at end of file

			




	
	
	
		
 
website_mail_recipients: "root"

			




	
	
	
		
 
environment_indicator: null

			




	
	
		
 
\ No newline at end of file

			




        

    


    
    

    

        

                

                    roles/php_website/templates/nginx_site.j2
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -73,6 +73,13 @@ server {

			




	
	
	
		
 
    }

			




	
	
	
		
 
    {% endif -%}

			




	
	
	
		
 

			




	
	
	
		
 
    {% if environment_indicator -%}

			




	
	
	
		
 
    # Show environment indicator on HTML pages.

			




	
	
	
		
 
    sub_filter_types text/html;

			




	
	
	
		
 
    sub_filter_once on;

			




	
	
	
		
 
    sub_filter "</body>" "<div id='website-environment' style='background-color: {{ environment_indicator.background_colour }}; width: 100%; text-align: center; position: fixed; bottom: 5px; color: {{ environment_indicator.text_colour }}; font-weight: bold;'>{{ environment_indicator.text }}</div></body>";

			




	
	
	
		
 
    {% endif -%}

			




	
	
	
		
 

			




	
	
	
		
 
    access_log /var/log/nginx/{{ fqdn }}-access.log;

			




	
	
	
		
 
    error_log /var/log/nginx/{{ fqdn }}-error.log;

			




	
	
	
		
 
}

			




        

    


    
    

    

        

                

                    roles/wsgi_website/defaults/main.yml
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -13,4 +13,5 @@ https_tls_certificate: "{{ lookup('file', tls_certificate_dir + '/' + fqdn + '_h

			




	
	
	
		
 
https_tls_key: "{{ lookup('file', tls_private_key_dir + '/' + fqdn + '_https.key') }}"

			




	
	
	
		
 
gunicorn_version: "19.6.0"

			




	
	
	
		
 
futures_version: "3.0.5"

			




	
	
	
		
 
website_mail_recipients: "root"

			




	
	
		
 
\ No newline at end of file

			




	
	
	
		
 
website_mail_recipients: "root"

			




	
	
	
		
 
environment_indicator: null

			




	
	
		
 
\ No newline at end of file

			




        

    


    
    

    

        

                

                    roles/wsgi_website/templates/nginx_site.j2
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -66,6 +66,13 @@ server {

			




	
	
	
		
 
        proxy_pass http://unix:/run/wsgi/{{ fqdn }}.sock;

			




	
	
	
		
 
    }

			




	
	
	
		
 

			




	
	
	
		
 
    {% if environment_indicator -%}

			




	
	
	
		
 
    # Show environment indicator on HTML pages.

			




	
	
	
		
 
    sub_filter_types text/html;

			




	
	
	
		
 
    sub_filter_once on;

			




	
	
	
		
 
    sub_filter "</body>" "<div id='website-environment' style='background-color: {{ environment_indicator.background_colour }}; width: 100%; text-align: center; position: fixed; bottom: 5px; color: {{ environment_indicator.text_colour }}; font-weight: bold;'>{{ environment_indicator.text }}</div></body>";

			




	
	
	
		
 
    {% endif -%}

			




	
	
	
		
 

			




	
	
	
		
 
    access_log /var/log/nginx/{{ fqdn }}-access.log;

			




	
	
	
		
 
    error_log /var/log/nginx/{{ fqdn }}-error.log;

			




	
	
	
		
 
}

			




        

    



    


    



    



      

      





    
    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.