Changeset - 55ccfc66479d
Parent rev.
Child rev.
[Not reviewed]
default
0 7 0
Mads Kiilerich - 10 years ago 2015-10-08 23:21:58
madski@unity3d.com
cache: make instance_id = * the default and deprecate it

Auto assigning instance_id's works perfectly fine now when the clean-up issue
has been resolved.
7 files changed with 1 insertions and 31 deletions:
development.ini
6
docs/setup.rst
5
docs/usage/performance.rst
1
kallithea/bin/template.ini.mako
6
kallithea/config/deployment.ini_tmpl
6
kallithea/config/environment.py
1
1
kallithea/tests/test.ini
6
0 comments (0 inline, 0 general)
development.ini
➞
Show inline comments
 
@@ -277,18 +277,12 @@ issue_prefix = #
 
# wiki-some-id -> https://wiki.example.com/some-id
 

			




	
	
	
		
 
#issue_pat_wiki = (?:wiki-)(.+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/{id}

			




	
	
	
		
 
#issue_prefix_wiki = WIKI-

			




	
	
	
		
 

			




	
	
	
		
 
## instance-id prefix

			




	
	
	
		
 
## a prefix key for this instance used for cache invalidation when running

			




	
	
	
		
 
## multiple instances of kallithea, make sure it's globally unique for

			




	
	
	
		
 
## all running kallithea instances. Leave empty if you don't use it

			




	
	
	
		
 
instance_id =

			




	
	
	
		
 

			




	
	
	
		
 
## alternative return HTTP header for failed authentication. Default HTTP

			




	
	
	
		
 
## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with

			




	
	
	
		
 
## handling that. Set this variable to 403 to return HTTPForbidden

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
## locking return code. When repository is locked return this HTTP code. 2XX

			




        

    


    
    

    

        

                

                    docs/setup.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -743,17 +743,12 @@ Or if using a dispatcher WSGI script wit

			




	
	
	
		
 
    WSGIPassAuthorization On

			




	
	
	
		
 

			




	
	
	
		
 
.. note::

			




	
	
	
		
 
   When running apache as root, please make sure it doesn't run Kallithea as

			




	
	
	
		
 
   root, for examply by adding: ``user=www-data group=www-data`` to the configuration.

			




	
	
	
		
 

			




	
	
	
		
 
.. note::

			




	
	
	
		
 
   If running Kallithea in multiprocess mode,

			




	
	
	
		
 
   make sure you set ``instance_id = *`` in the configuration so each process

			




	
	
	
		
 
   gets it's own cache invalidation key.

			




	
	
	
		
 

			




	
	
	
		
 
Example WSGI dispatch script:

			




	
	
	
		
 

			




	
	
	
		
 
.. code-block:: python

			




	
	
	
		
 

			




	
	
	
		
 
    import os

			




	
	
	
		
 
    os.environ["HGENCODING"] = "UTF-8"

			




        

    


    
    

    

        

                

                    docs/usage/performance.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -35,13 +35,12 @@ Follow these few steps to improve perfor

			




	
	
	
		
 

			




	
	
	
		
 
    Scaling horizontally can give huge performance benefits when dealing with

			




	
	
	
		
 
    large amounts of traffic (many users, CI servers, etc.). Kallithea can be

			




	
	
	
		
 
    scaled horizontally on one (recommended) or multiple machines. In order

			




	
	
	
		
 
    to scale horizontally you need to do the following:

			




	
	
	
		
 

			




	
	
	
		
 
    - Each instance needs its own .ini file and unique ``instance_id`` set.

			




	
	
	
		
 
    - Each instance's ``data`` storage needs to be configured to be stored on a

			




	
	
	
		
 
      shared disk storage, preferably together with repositories. This ``data``

			




	
	
	
		
 
      dir contains template caches, sessions, whoosh index and is used for

			




	
	
	
		
 
      task locking (so it is safe across multiple instances). Set the

			




	
	
	
		
 
      ``cache_dir``, ``index_dir``, ``beaker.cache.data_dir``, ``beaker.cache.lock_dir``

			




	
	
	
		
 
      variables in each .ini file to a shared location across Kallithea instances

			




        

    


    
    

    

        

                

                    kallithea/bin/template.ini.mako
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -275,18 +275,12 @@ issue_prefix = #

			




	
	
	
		
 
# wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 

			




	
	
	
		
 
#issue_pat_wiki = (?:wiki-)(.+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/{id}

			




	
	
	
		
 
#issue_prefix_wiki = WIKI-

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## instance-id prefix</%text>

			




	
	
	
		
 
<%text>## a prefix key for this instance used for cache invalidation when running</%text>

			




	
	
	
		
 
<%text>## multiple instances of kallithea, make sure it's globally unique for</%text>

			




	
	
	
		
 
<%text>## all running kallithea instances. Leave empty if you don't use it</%text>

			




	
	
	
		
 
instance_id =

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## alternative return HTTP header for failed authentication. Default HTTP</%text>

			




	
	
	
		
 
<%text>## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with</%text>

			




	
	
	
		
 
<%text>## handling that. Set this variable to 403 to return HTTPForbidden</%text>

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## locking return code. When repository is locked return this HTTP code. 2XX</%text>

			




        

    


    
    

    

        

                

                    kallithea/config/deployment.ini_tmpl
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -271,18 +271,12 @@ issue_prefix = #

			




	
	
	
		
 
# wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 

			




	
	
	
		
 
#issue_pat_wiki = (?:wiki-)(.+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/{id}

			




	
	
	
		
 
#issue_prefix_wiki = WIKI-

			




	
	
	
		
 

			




	
	
	
		
 
## instance-id prefix

			




	
	
	
		
 
## a prefix key for this instance used for cache invalidation when running

			




	
	
	
		
 
## multiple instances of kallithea, make sure it's globally unique for

			




	
	
	
		
 
## all running kallithea instances. Leave empty if you don't use it

			




	
	
	
		
 
instance_id =

			




	
	
	
		
 

			




	
	
	
		
 
## alternative return HTTP header for failed authentication. Default HTTP

			




	
	
	
		
 
## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with

			




	
	
	
		
 
## handling that. Set this variable to 403 to return HTTPForbidden

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
## locking return code. When repository is locked return this HTTP code. 2XX

			




        

    


    
    

    

        

                

                    kallithea/config/environment.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -115,13 +115,13 @@ def load_environment(global_conf, app_co

			




	
	
	
		
 

			




	
	
	
		
 
    set_available_permissions(config)

			




	
	
	
		
 
    repos_path = make_ui('db').configitems('paths')[0][1]

			




	
	
	
		
 
    config['base_path'] = repos_path

			




	
	
	
		
 
    set_app_settings(config)

			




	
	
	
		
 

			




	
	
	
		
 
    instance_id = kallithea.CONFIG.get('instance_id')

			




	
	
	
		
 
    instance_id = kallithea.CONFIG.get('instance_id', '*')

			




	
	
	
		
 
    if instance_id == '*':

			




	
	
	
		
 
        instance_id = '%s-%s' % (platform.uname()[1], os.getpid())

			




	
	
	
		
 
        kallithea.CONFIG['instance_id'] = instance_id

			




	
	
	
		
 

			




	
	
	
		
 
    # CONFIGURATION OPTIONS HERE (note: all config options will override

			




	
	
	
		
 
    # any Pylons config options)

			




        

    


    
    

    

        

                

                    kallithea/tests/test.ini
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -277,18 +277,12 @@ issue_prefix = #

			




	
	
	
		
 
# wiki-some-id -> https://wiki.example.com/some-id

			




	
	
	
		
 

			




	
	
	
		
 
#issue_pat_wiki = (?:wiki-)(.+)

			




	
	
	
		
 
#issue_server_link_wiki = https://wiki.example.com/{id}

			




	
	
	
		
 
#issue_prefix_wiki = WIKI-

			




	
	
	
		
 

			




	
	
	
		
 
## instance-id prefix

			




	
	
	
		
 
## a prefix key for this instance used for cache invalidation when running

			




	
	
	
		
 
## multiple instances of kallithea, make sure it's globally unique for

			




	
	
	
		
 
## all running kallithea instances. Leave empty if you don't use it

			




	
	
	
		
 
instance_id =

			




	
	
	
		
 

			




	
	
	
		
 
## alternative return HTTP header for failed authentication. Default HTTP

			




	
	
	
		
 
## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with

			




	
	
	
		
 
## handling that. Set this variable to 403 to return HTTPForbidden

			




	
	
	
		
 
auth_ret_code =

			




	
	
	
		
 

			




	
	
	
		
 
## locking return code. When repository is locked return this HTTP code. 2XX

			




        

    



    


    



    



      

      





    
    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.