openstack/openstack-manuals
Code Issues Proposed changes

Add List Endpoints to object storage confref

Browse Source 
This feature was implemented in Havana. Adding a short section
explaining it and the single configuration option it references/

Change-Id: I5a2a393a77741ce5964736f1608cd0d4bbd84847
Closes-Bug: 1095496
This commit is contained in:
Tom Fifield 2014-01-10 16:46:10 +08:00 committed by Diane Fleming
parent ea98951a78
commit ab58e88c22
3 changed files with 35 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/config-reference/object-storage/section_object-storage-cors.xml
View File

@ -4,14 +4,14 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="object-storage-cores">
<title>Cross-origin resource sharing</title>
<para>Cross-Origin Resource Sharing (CORS) is a mechanisim to allow code
running in a browser (Javascript for example) to make requests to a domain
<para>Cross-Origin Resource Sharing (CORS) is a mechanism to allow code
running in a browser (JavaScript for example) to make requests to a domain
other then the one from where it originated. Swift supports CORS requests
to containers and objects within the containers using metadata held on the
container.
</para>
<para>In addition to the metadata on containers, the
<literal>cors_allow_origin</literal> flag in
<filename>proxy-server.conf</filename> may be used to set a list of hosts that
<para>In addition to the metadata on containers, you can use the
<option>cors_allow_origin</option> option in the
<filename>proxy-server.conf</filename> file to set a list of hosts that
are included with any CORS request by default.</para>
</section>

1
doc/config-reference/object-storage/section_object-storage-features.xml
View File

@ -668,4 +668,5 @@ signature = hmac.new(key, hmac_body, sha1).hexdigest()
/>
</section>
<xi:include href="section_object-storage-cors.xml"/>
<xi:include href="section_object-storage-listendpoints.xml"/>
</section>

29
doc/config-reference/object-storage/section_object-storage-listendpoints.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="object-storage-listendpoints">
<title>Endpoint listing middleware</title>
<para>The endpoint listing middleware enables third-party services
that use data locality information to integrate with swift.
This middleware reduces network overhead and is designed for
third-party services that run inside the firewall. Deploy this
middleware on a proxy server because usage of this middleware
is not authenticated.</para>
<para>Format requests for endpoints, as follows:</para>
<screen><userinput>/endpoints/<replaceable>{account}</replaceable>/<replaceable>{container}</replaceable>/<replaceable>{object}</replaceable>
/endpoints/<replaceable>{account}</replaceable>/<replaceable>{container}</replaceable>
/endpoints/<replaceable>{account}</replaceable></userinput></screen>
<para>Use the <option>list_endpoints_path</option> configuration
option in the <filename>proxy_server.conf</filename> file to
customize the <literal>/endpoints/</literal> path.</para>
<para>Responses are JSON-encoded lists of endpoints, as
follows:</para>
<screen><computeroutput>http://<replaceable>{server}</replaceable>:<replaceable>{port}</replaceable>/<replaceable>{dev}</replaceable>/<replaceable>{part}</replaceable>/<replaceable>{acc}</replaceable>/<replaceable>{cont}</replaceable>/<replaceable>{obj}</replaceable>
http://<replaceable>{server}</replaceable>:<replaceable>{port}</replaceable>/<replaceable>{dev}</replaceable>/<replaceable>{part}</replaceable>/<replaceable>{acc}</replaceable>/<replaceable>{cont}</replaceable>
http://<replaceable>{server}</replaceable>:<replaceable>{port}</replaceable>/<replaceable>{dev}</replaceable>/<replaceable>{part}</replaceable>/<replaceable>{acc}</replaceable></computeroutput></screen>
<para>An example response is:</para>
<screen><computeroutput>http://10.1.1.1:6000/sda1/2/a/c2/o1
http://10.1.1.1:6000/sda1/2/a/c2
http://10.1.1.1:6000/sda1/2/a </computeroutput></screen>
</section>