Skip to content

Commit

Permalink
Removes openstack-object-storage-admin directory, moving content.
Browse files Browse the repository at this point in the history
Moves config info to Config Ref
Moves Admin CLI task to Admin User Guide
Moves CLI tasks to User Guide
Moves Monitoring section to Cloud Admin Guide
Removes anything that was a copy/paste from dev docs completely, refers
to developer docs instead

Change-Id: If201d68c1e72a24c57a61775bc22d1784beea324
Closes-bug: 1216037
  • Loading branch information
annegentle committed Sep 6, 2013
1 parent 4f6cb13 commit 82fa21b
Show file tree
Hide file tree
Showing 21 changed files with 256 additions and 25,947 deletions.
10 changes: 10 additions & 0 deletions doc/src/docbkx/admin-guide-cloud/bk-admin-guide-cloud.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@
</abstract>
<revhistory>
<!-- ... continue adding more revisions here as you change this document using the markup shown below... -->
<revision>
<date>2013-09-05</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Moves object storage monitoring section to this guide.</para></listitem>
<listitem><para>Removes redundant object storage info.</para></listitem>
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-09-03</date>
<revdescription>
Expand Down
2,638 changes: 5 additions & 2,633 deletions doc/src/docbkx/admin-guide-cloud/ch_objectstorage.xml

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions doc/src/docbkx/admin-guide-cloud/section_object-storage-admin.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?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="ch_running-openstack-object-storage">
<title>System Administration for OpenStack Object Storage</title>
<para>By understanding the concepts inherent to the Object Storage
system you can better monitor and administer your storage
solution. The majority of the administration information is maintained
in developer documentation at
<link xlink:href="http://docs.openstack.org/developer/swift/">docs.openstack.org/developer/swift/</link>.</para>
<para>Refer to the <citetitle>OpenStack Configuration Reference</citetitle>
for a listing of all configuration options for OpenStack Object
Storage.</para>
</section>
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
<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="ch_introduction-to-openstack-object-storage-monitoring">
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ch_introduction-to-openstack-object-storage-monitoring">
<title>OpenStack Object Storage Monitoring</title>
<?dbhtml stop-chunking?>
<para>Excerpted from a blog post by <link
Expand Down Expand Up @@ -228,5 +230,4 @@ def process_container(self, dbfile):
benefit of not introducing another external library
dependency into Object Storage.</para>
</section>

</chapter>
</section>
13 changes: 13 additions & 0 deletions doc/src/docbkx/common/section_about-object-storage.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?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="ch_introduction-to-openstack-object-storage">
<title>Introduction to OpenStack Object Storage</title>
<para>OpenStack Object Storage is a scalable object storage system - it is not a file system in the
traditional sense. You will not be able to mount this system like traditional SAN or NAS volumes.
Since OpenStack Object Storage is a different way of thinking when it comes to storage, take a few
moments to review the key concepts in the developer documentation at
<link xlink:href="http://docs.openstack.org/developer/swift/">docs.openstack.org/developer/swift/</link>.</para>
</section>
20 changes: 1 addition & 19 deletions doc/src/docbkx/openstack-config/ch_objectstorageconfigure.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,8 @@
background daemons, and paste.deploy to manage server configurations. Default configuration
options are set in the <code>[DEFAULT]</code> section, and any options specified there can
be overridden in any of the other sections.</para>
<xi:include href="../common/section_about-object-storage.xml"/>
<xi:include href="object-storage/section_object-storage-general-service-conf.xml"/>
<!--these need to be placed under appropriate sections
<section xml:id="memcache-conf">
<title>Sample Memcache configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/memcache.conf-sample"/></programlisting></section>
<section xml:id="mime-types-conf">
<title>Sample Mime.Types configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/mime.types-sample"/></programlisting></section>
<section xml:id="object-expirer-conf">
<title>Sample Object Expirer configuration file</title>
<programlisting><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/object-expirer.conf-sample"/></programlisting></section>
<section xml:id="rsyncd-conf">
<title>Sample Rsyncd configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/rsyncd.conf-sample"/></programlisting></section>
<section xml:id="swift-bench-conf">
<title>Sample Swift bench configuration file</title>
<programlisting language="ini"><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/swift-bench.conf-sample"/></programlisting></section>
<section xml:id="swift-conf">
<title>Sample Swift configuration file</title>
<programlisting><xi:include parse="text" href="https://raw.github.com/openstack/swift/master/etc/swift.conf-sample"/></programlisting></section>-->
<section xml:id="object-server-configuration">
<title>Object Server Configuration</title>
<para>An example Object Server configuration can be found at
Expand Down
134 changes: 0 additions & 134 deletions doc/src/docbkx/openstack-object-storage-admin/aboutobjectstorage.xml

This file was deleted.

0 comments on commit 82fa21b

Please sign in to comment.