~ubuntu-branches/ubuntu/precise/glance/precise-proposed

« back to all changes in this revision

Viewing changes to doc/source/configuring.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short, Chuck Short, Adam Gandleman
  • Date: 2012-01-20 14:37:16 UTC
  • mfrom: (1.1.24)
  • Revision ID: package-import@ubuntu.com-20120120143716-2va2h1g2230m51zx
Tags: 2012.1~e3~20120120.1206-0ubuntu1
[Chuck Short]
* New upstream release.

[Adam Gandleman]
* debian/glance-api.install, glance-registry.install:  Install
  new paste configs that have been split among servers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
45
45
files distributed with Glance for example configuration files for each server
46
46
application with detailed comments on what each options does.
47
47
 
 
48
The PasteDeploy configuration (controlling the deployment of the WSGI
 
49
application for each component) may be found by default in
 
50
<component>-paste.ini alongside the main configuration file, <component>.conf.
 
51
For example, ``glance-api-paste.ini`` corresponds to ``glance-api.conf``.
 
52
This pathname for the paste config is configurable, as follows:
 
53
 
 
54
  [paste_deploy]
 
55
  config_file = /path/to/paste/config
 
56
 
 
57
 
48
58
Common Configuration Options in Glance
49
59
--------------------------------------
50
60
 
113
123
 
114
124
Optional. Default: ``4096``
115
125
 
 
126
* ``workers=PROCESSES``
 
127
 
 
128
Number of Glance API worker processes to start. Each worker
 
129
process will listen on the same port. Increasing this
 
130
value may increase performance (especially if using SSL
 
131
with compression enabled). Typically it is recommended
 
132
to have one worker process per CPU. The value `0` will
 
133
prevent any new processes from being created.
 
134
 
 
135
Optional. Default: ``0``
 
136
 
116
137
Configurating SSL Support
117
138
~~~~~~~~~~~~~~~~~~~~~~~~~
118
139
 
489
510
image files is transparent and happens using a piece of middleware that can
490
511
optionally be placed in the server application pipeline.
491
512
 
 
513
This pipeline is configured in the PasteDeploy configuration file,
 
514
<component>-paste.ini. You should not generally have to edit this file
 
515
directly, as it ships with ready-made pipelines for all common deployment
 
516
flavors.
 
517
 
492
518
Enabling the Image Cache Middleware
493
519
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
494
520
 
495
 
To enable the image cache middleware, you would insert the cache middleware
496
 
into your application pipeline **after** the appropriate context middleware.
 
521
To enable the image cache middleware, the cache middleware must occur in
 
522
the application pipeline **after** the appropriate context middleware.
497
523
 
498
 
The cache middleware should be in your ``glance-api.conf`` in a section titled
499
 
``[filter:cache]``. It should look like this::
 
524
The cache middleware should be in your ``glance-api-paste.ini`` in a section
 
525
titled ``[filter:cache]``. It should look like this::
500
526
 
501
527
  [filter:cache]
502
528
  paste.filter_factory = glance.common.wsgi:filter_factory
503
529
  glance.filter_factory = glance.api.middleware.cache:CacheFilter
504
530
 
505
 
 
506
 
For example, suppose your application pipeline in the ``glance-api.conf`` file
507
 
looked like so::
508
 
 
509
 
  [pipeline:glance-api]
510
 
  pipeline = versionnegotiation context apiv1app
511
 
 
512
 
In the above application pipeline, you would add the cache middleware after the
513
 
context middleware, like so::
514
 
 
515
 
  [pipeline:glance-api]
 
531
A ready-made application pipeline including this filter is defined in
 
532
the ``glance-api-paste.ini`` file, looking like so::
 
533
 
 
534
  [pipeline:glance-api-caching]
516
535
  pipeline = versionnegotiation context cache apiv1app
517
536
 
 
537
To enable the above application pipeline, in your main ``glance-api.conf``
 
538
configuration file, select the appropriate deployment flavor like so::
 
539
 
 
540
  [paste_deploy]
 
541
  flavor = caching
 
542
 
518
543
And that would give you a transparent image cache on the API server.
519
544
 
520
545
Configuration Options Affecting the Image Cache
667
692
Optional. Default: ``glance_notifications``
668
693
 
669
694
Topic to use for connection when using ``rabbit`` strategy.
 
695
 
 
696
* ``rabbit_max_retries``
 
697
 
 
698
Optional. Default: ``0``
 
699
 
 
700
Number of retries on communication failures when using ``rabbit`` strategy.
 
701
A value of 0 means to retry forever.
 
702
 
 
703
* ``rabbit_retry_backoff``
 
704
 
 
705
Optional. Default: ``2``
 
706
 
 
707
Number of seconds to wait before reconnecting on failures when using
 
708
``rabbit`` strategy.
 
709
 
 
710
* ``rabbit_retry_max_backoff``
 
711
 
 
712
Optional. Default: ``30``
 
713
 
 
714
Maximum seconds to wait before reconnecting on failures when using
 
715
``rabbit`` strategy.