directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fel...@apache.org
Subject svn commit: r985594 - in /directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide: book.xml chapter-partitioning-replication.xml chapter-tuning.xml
Date Sat, 14 Aug 2010 22:23:01 GMT
Author: felixk
Date: Sat Aug 14 22:23:01 2010
New Revision: 985594

URL: http://svn.apache.org/viewvc?rev=985594&view=rev
Log:
Start with advanced-user-guide

Added:
    directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml
  (with props)
    directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml   (with
props)
Modified:
    directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/book.xml

Modified: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/book.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/book.xml?rev=985594&r1=985593&r2=985594&view=diff
==============================================================================
--- directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/book.xml (original)
+++ directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/book.xml Sat Aug 14 22:23:01
2010
@@ -73,6 +73,11 @@ under the License.</literallayout>
   <xi:include
     href="chapter-embedding-apacheds.xml" />
 
+  <xi:include
+    href="chapter-partitioning-replication.xml" />
+  <xi:include
+    href="chapter-tuning.xml" />
+
   <index> ... </index>
 
 </book>

Added: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml?rev=985594&view=auto
==============================================================================
--- directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml
(added)
+++ directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml
Sat Aug 14 22:23:01 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license
agreements. See the NOTICE file 
+  distributed with this work for additional information regarding copyright ownership. The
ASF licenses this file to you under 
+  the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
with the License. You may 
+  obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
by applicable law or agreed to 
+  in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF 
+  ANY KIND, either express or implied. See the License for the specific language governing
permissions and limitations under 
+  the License. -->
+<chapter
+  version="5.0"
+  xmlns="http://docbook.org/ns/docbook"
+  xmlns:xlink="http://www.w3.org/1999/xlink"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xmlns:ns5="http://www.w3.org/2000/svg"
+  xmlns:ns4="http://www.w3.org/1998/Math/MathML"
+  xmlns:ns3="http://www.w3.org/1999/xhtml"
+  xml:lang="en">
+  <title>Partitioning &amp; Replication</title>
+  <section
+    id="Referrals">
+    <title>Referrals</title>
+    <para>TODO ...</para>
+  </section>
+  <section
+    id="Replication">
+    <title>Replication</title>
+    <para>TODO ...</para>
+  </section>
+</chapter>

Propchange: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-partitioning-replication.xml
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Added: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml?rev=985594&view=auto
==============================================================================
--- directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml (added)
+++ directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml Sat
Aug 14 22:23:01 2010
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license
agreements. See the NOTICE file 
+  distributed with this work for additional information regarding copyright ownership. The
ASF licenses this file to you under 
+  the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
with the License. You may 
+  obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
by applicable law or agreed to 
+  in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF 
+  ANY KIND, either express or implied. See the License for the specific language governing
permissions and limitations under 
+  the License. -->
+<chapter
+  version="5.0"
+  xmlns="http://docbook.org/ns/docbook"
+  xmlns:xlink="http://www.w3.org/1999/xlink"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xmlns:ns5="http://www.w3.org/2000/svg"
+  xmlns:ns4="http://www.w3.org/1998/Math/MathML"
+  xmlns:ns3="http://www.w3.org/1999/xhtml"
+  xml:lang="en">
+  <title>Tuning</title>
+  <section
+    id="Performance Tuning">
+    <title>Performance Tuning</title>
+    <important>
+      <title>Work in progress</title>
+      <para>This site is in the process of being reviewed and updated.</para>
+    </important>
+    <section
+      id="Balancing Cache w/ Heap Memory Indexing Attributes">
+      <title>
+        Balancing Cache w/ Heap Memory<?linebrake?>
+        Indexing Attributes
+      </title>
+      <para>The default partition implementation is based on JDBM. By default it may
already index some common
+        attributes like objectClass and ou for example. However you really want to index
attributes that your
+        applications use frequently in canned queries.</para>
+      <para>Adding an index on an attribute is pretty simple. The configuration in
the server.xml file needs to be
+        altered before bulk loading data into the server. Otherwise your index will not work
properly.</para>
+      <important>
+        <para>Indices must be configured before loading data into the server. Indices
configured after loading entries
+          into the server will NOT work properly unless they are built using the index builder
command supplied with the
+          ApacheDS tools command line program. More information on this in the Building Indices
section below.</para>
+      </important>
+      <para>Indices are configured in the partition configuration section of your server.xml.
Each partition will have
+        it's own set of indexed attributes. These index configurations reside under the indexedAttributes
property of
+        the org.apache.directory.server.core.partition.impl.btree.MutableBTreePartitionConfiguration
spring bean. Here's
+        that section for the stock dc=example,dc=com partition that is configured out of
the box with ApacheDS.</para>
+      <programlisting><![CDATA[
+<property name="indexedAttributes">
+      <set>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.1</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.2</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.3</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.4</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.5</value></property>
+          <property name="cacheSize"><value>10</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.6</value></property>
+          <property name="cacheSize"><value>10</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>1.2.6.1.4.1.18060.1.1.1.3.7</value></property>
+          <property name="cacheSize"><value>10</value></property>
+        </bean>
+
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>dc</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>ou</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>krb5PrincipalName</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>uid</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+        <bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>objectClass</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+      </set>
+    </property>
+    ]]></programlisting>
+      <para>As you can see indices are specified using a MutableIndexConfiguration
spring bean. Just add one of these to
+        your existing configuration setting the attributeId to the OID or name of the attribute
you want to index. There
+        is cacheSize parameter used to set the amount of cache on your index as well. Most
of the time 100 will suffice
+        no matter how big in capacity your server is.</para>
+      <para>This number (100) is the number of entries stored in the cache, regardless
to their size. Be carefull when
+        dealing with huge entries - those which contains jpeg images - </para>
+      <para>So if I wanted to index the attribute initials all I have to do is append
the following xml fragment to this
+        set of indexed attributes:</para>
+      <programlisting><![CDATA[
+<bean class="org.apache.directory.server.core.partition.impl.btree.MutableIndexConfiguration">
+          <property name="attributeId"><value>initials</value></property>
+          <property name="cacheSize"><value>100</value></property>
+        </bean>
+    ]]></programlisting>
+      <para>That's it. Now queries on initials alone should perform about 50X faster.</para>
+    </section>
+  </section>
+</chapter>
\ No newline at end of file

Propchange: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: directory/sandbox/felixk/apacheds-docs/src/advanced-user-guide/chapter-tuning.xml
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision



Mime
View raw message