summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Suggest to use egg based filter_factory rather than fragile full pathJulien Danjou2016-11-292-4/+4
| | | | | | This makes sure that if the module organization change, nothing breaks. Change-Id: Ib4fb1e2210a9cea6b12214e0d1e3570086ac2e68
* Merge "Deprecated set_latent"Jenkins2016-10-171-18/+0
|\
| * Deprecated set_latentMichael Krotscheck2016-05-051-18/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the introduction of set_defaults, as well as new documentation features for default values in oslo_config, the CORS middleware has been placed in the odd position where its configuration behaves inconsistently. A user may use set_defaults to set persisted default values that may be overridden, or they may use set_latent to add values that will be applied to every request. As both of these serve essentially the same function, and the latter is only necessary if it is feasible to configure multiple allowed_origins with different CORS properties. With the depecation of multiple configuration blocks, it is no longer necessary to maintain this feature. Therefore, this patch adds the necessary deprecation flags, and removes it from the documentation. Change-Id: Icd44684b3d05ff6a07665348c08adff8245f2523
* | Deprecate multiple config block parsing.Michael Krotscheck2016-05-091-25/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the introduction of set_defaults, as well as new documentation features for default values in oslo_config, the CORS middleware has been placed in the odd position where its configuration behaves inconsistently. If you configure via add_origin, then defaults set in set_defaults are not honored. If you configure via multiple configuration blocks ([cors.foo]), then the defaults are also not honored. Additionally, with the conversion of allowed_origin into a list_opt, there is less direct need for multiple config-block parsing. In order to ensure that the middleware behaves consistently with the rest of oslo, as well as adheres to a set of basic sane assumptions made by consumers, this patch deprecates the code path that searches oslo's configuration for multiple [cors.*] blocks. Subsequent patches will add additional deprecation flags to this end. Change-Id: I49c15ccc2dce03b0dea33ec45ef6e271e58582da
* | Removed simple headers from documentation examples3.10.0Michael Krotscheck2016-05-041-4/+4
|/ | | | | | | | | These headers were removed from the defaults in https://review.openstack.org/#/c/293566/ - as they are already automatically managed in accordance to the CORS specification. This patch removes them from the example code. Change-Id: Ic2728d65c31dcd2f6a887ce8b112f544fd5730f3
* Revert "work around doc build error"Doug Hellmann2016-02-243-18/+1
| | | | | | | | | | | This reverts commit bb8dbeb3a361586886b1bb060a3d98ffbf5f7e31. Making this work will depend on having a new release of oslo.config with the fix in the dependent patch. Depends-On: Ia024722d05ce8adaa57c58559cb42f2913653bb9 Change-Id: I33b37c74abf63bcaa95e668ec74c9c9849cc3773 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* work around doc build error3.7.0Doug Hellmann2016-02-243-1/+18
| | | | | | | | | | | This patch addresses a documentation build issue caused by the oslo.config sphinx integration. In order to unblock this repo, we can work around the issue here while fixing it in oslo.config, then revert this change. Change-Id: Ie4a29e8e8d44d00354ea0dd8420bac5b8812a717 Related-Bug: #1549106 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Switched StrOpt to ListOpt in CORS allowed_originsMichael Krotscheck2015-11-161-9/+10
| | | | | | | | | | | | | This patch switches the 'allowed_origin' CORS configuration option from a single string to an array of strings. This will let you configure multiple domains simultaneously with the same options, without having to add additional configuration blocks. By doing this, pastedeploy users will no longer have to configure mulitple filters if they wish to grant access to more than one domain. Change-Id: Ie2e57b76717604f701daa16ebf8ffa8c06835e3c
* Enable latent CORS configuration via pastedeployMichael Krotscheck2015-11-161-0/+6
| | | | | | | | | | | | In the case where paste deployment and oslo are used in concert, it is not possible for an application to easily ship required configuraton properties, such as custom headers, with their release artifact. This patch adds parameters which expose set_latent to paste.ini users, permitting the above. Tests and documentation have been updated. Change-Id: Id98002f6813055efe698f0b96a3e0d408c58ed7c
* Add oslo_config program support to paste middlewareMichael Krotscheck2015-11-132-0/+14
| | | | | | | | | | | | | | | | | oslo_config's configfile autodiscovery permits an additional parameter named 'prog', which will add an additional file name to the possible files that are checked in oslo_config directories. This patch adds this parameter to paste-ini initialization, permitting access to more configuration files. This feature is required by glance, as glance does not make use of ./glance/glance.conf. Instead, they use ./glance/glance-api.conf. The appropriate middleware configuration in this case would then be: oslo_config_project=glance oslog_config_program=glance-api Change-Id: Ie530e4fac8076dc46b705770d12940ef91cb4644
* Merge "Include changelog/history in docs"Jenkins2015-09-252-0/+9
|\
| * Include changelog/history in docsJoshua Harlow2015-09-242-0/+9
| | | | | | | | Change-Id: I5b2a3002d91ed9b6634d8a43c80e896fd66628d3
* | Add plugin doco generated with stevedore.sphinxextCraige McWhirter2015-09-182-0/+8
|/ | | | | | | | | | | As per: http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html The point behind the addition of the stevedore.sphinxext extension is "to document drivers and other types of plugins to make the available sets built into projects easier to discover" (dhellman). Change-Id: If24f70704dd4840c44e6e72928157078fea80b51
* Split option discovery function by middlewareDoug Hellmann2015-08-273-2/+21
| | | | | | | | | | | | | Create separate option discovery functions for each piece of middleware, so an application that only uses one piece can include only those options in its sample configuration file. Test the results with some unit tests that simply ensure the functions do not raise exceptions, and by adding configuration options to the documentation for the library, using the new integration of oslo.config with sphinx. Change-Id: I4c777cd70c063441f430c48ab1f9c9cac2c1fc75
* Added latent properties to CORS middleware.Michael Krotscheck2015-08-121-0/+11
| | | | | | | | | | | | Latent properties allow a consumer of this middleware to declare system-required headers and methods options. For instance, if an API exposes version-negotiation headers, these may be hard coded when the middleware is attached. This only works when the middleware is explicitly used. It does not work in paste configuration. Change-Id: Ic55b1af23603a0d83a32d20054c18e50367be8fb
* Allow to get option from paste-deployMehdi Abaakouk2015-08-073-0/+57
| | | | | | | | This change allows any middleware that use oslo.config to be configured via paste-deploy, like the cors does. Related-bug: #1482086 Change-Id: Ibb3e951b45b51c9bc602c9113df18a58226d92d1
* Support PasteDeployMichael Krotscheck2015-06-301-11/+44
| | | | | | | | | This patch removes the oslo_config specific code out of the middleware's class, and instead provides a factory method by which this middleware may be constructed. It then also provides a similar factory method that supports pastedeploy's filter_factory protocol. Change-Id: I68d9c5439707a624aa24f3dbe7bbfd616b382a6d
* Added CORS wildcard handling1.3.0Michael Krotscheck2015-05-261-4/+12
| | | | | | | | | | The CORS specification permits the declaration of '*' as a response wildcard domain, which explicitly allows _all_ domains to break the single-origin policy. While we DO NOT recommend this method, the ability to set a global policy should be included for the sake of completeness. Change-Id: Ifcc65ca74fa976dbd322a7ffd4ffba5443d1df5b
* Add CORS Middleware for Oslo.Michael Krotscheck2015-04-082-0/+63
| | | | | | | | | | This aims to provide a comprehensive middleware solution for the CORS (Cross-Origin-Resource-Sharing) specification - http://www.w3.org/TR/cors/. Tests and documentation have been provided. Change-Id: I3c0ff620f10bec2cbf7b748d48fff025aab44351
* Fixes the healthcheck factory method and docs0.4.0Mehdi Abaakouk2015-01-262-0/+7
| | | | | | | | This change fix the factory method of the healthcheck middleware It also adds documentation about how to configure the middleware Change-Id: Ie549d4686e921a9d407ba2829f69f92216bfcf9a
* Move files out of the namespace package0.3.0Doug Hellmann2015-01-061-1/+1
| | | | | | | | | | Move the public API out of oslo.middleware to oslo_middleware. Retain the ability to import from the old namespace package for backwards compatibility for this release cycle. bp/drop-namespace-packages Change-Id: If88c65c82b64f096a02f7ec62e019aea4de2f9d3
* Update docs for first releaseDoug Hellmann2014-08-265-21/+15
| | | | | | | | | | Ensure each exported class has a docstring. Add API to the sphinx docs. Fix a few formatting issues so the rendered docs look OK. Change-Id: Ieef7bae3783a084249169fe9b80ab17518eee15f
* Cleaning up index.rst fileChristian Berendt2014-07-221-6/+1
| | | | Removed notes about the generation of the file and fixed the syntax.
* exported from oslo-incubator by graduate.shGordon Chung2014-06-246-0/+120