You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bu...@apache.org on 2017/04/10 14:25:26 UTC
svn commit: r1010167 - in /websites/staging/directory/trunk/content: ./
apacheds/basic-ug/
Author: buildbot
Date: Mon Apr 10 14:25:25 2017
New Revision: 1010167
Log:
Staging update by buildbot for directory
Modified:
websites/staging/directory/trunk/content/ (props changed)
websites/staging/directory/trunk/content/apacheds/basic-ug/1-how-to-begin.html
websites/staging/directory/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.html
websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.2-changing-admin-password.html
websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.3-adding-partition.html
websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.4-configure-logging.html
Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Apr 10 14:25:25 2017
@@ -1 +1 @@
-1785193
+1790836
Modified: websites/staging/directory/trunk/content/apacheds/basic-ug/1-how-to-begin.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/basic-ug/1-how-to-begin.html (original)
+++ websites/staging/directory/trunk/content/apacheds/basic-ug/1-how-to-begin.html Mon Apr 10 14:25:25 2017
@@ -191,7 +191,7 @@ h2:hover > .headerlink, h3:hover > .head
<li><a href="1.4-basic-configuration-tasks.html">1.4 - Basic configuration tasks</a><ul>
<li><a href="1.4.1-changing-server-port.html">1.4.1 - Changing the server port for LDAP</a></li>
<li><a href="1.4.2-changing-admin-password.html">1.4.2 - Changing the admin password</a></li>
-<li><a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition resp. suffix</a></li>
+<li><a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition</a></li>
<li><a href="1.4.4-configure-logging.html">1.4.4 - Configure logging</a></li>
<li><a href="1.4.5-anonymous-access.html">1.4.5 - Enable and disable anonymous access</a></li>
</ul>
Modified: websites/staging/directory/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.html (original)
+++ websites/staging/directory/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.html Mon Apr 10 14:25:25 2017
@@ -186,7 +186,7 @@ h2:hover > .headerlink, h3:hover > .head
<ul>
<li><a href="1.4.1-changing-server-port.html">1.4.1 - Changing the server port for LDAP</a></li>
<li><a href="1.4.2-changing-admin-password.html">1.4.2 - Changing the admin password</a></li>
-<li><a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition resp. suffix</a></li>
+<li><a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition</a></li>
<li><a href="1.4.4-configure-logging.html">1.4.4 - Configure logging</a></li>
<li><a href="1.4.5-anonymous-access.html">1.4.5 - Enable and disable anonymous access</a></li>
</ul>
Modified: websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.2-changing-admin-password.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.2-changing-admin-password.html (original)
+++ websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.2-changing-admin-password.html Mon Apr 10 14:25:25 2017
@@ -162,7 +162,7 @@
</div>
<div class="nav_next">
- <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition resp. suffix</a>
+ <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition </a>
</div>
<div class="clearfix"></div>
@@ -227,7 +227,7 @@ h2:hover > .headerlink, h3:hover > .head
</div>
<div class="nav_next">
- <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition resp. suffix</a>
+ <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition </a>
</div>
<div class="clearfix"></div>
Modified: websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.3-adding-partition.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.3-adding-partition.html (original)
+++ websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.3-adding-partition.html Mon Apr 10 14:25:25 2017
@@ -17,7 +17,7 @@
-->
<html>
<head>
- <title>1.4.3 - Adding your own partition resp. suffix — Apache Directory</title>
+ <title>1.4.3 - Adding your own partition — Apache Directory</title>
<link href="./../../css/common.css" rel="stylesheet" type="text/css">
<link href="./../../css/green.css" rel="stylesheet" type="text/css">
@@ -180,15 +180,20 @@
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
-<h1 id="143-adding-your-own-partition-resp-suffix">1.4.3 - Adding your own partition resp. suffix<a class="headerlink" href="#143-adding-your-own-partition-resp-suffix" title="Permanent link">¶</a></h1>
+<h1 id="143-adding-your-own-partition">1.4.3 - Adding your own partition<a class="headerlink" href="#143-adding-your-own-partition" title="Permanent link">¶</a></h1>
<p>This section describes how to add your own data partition.</p>
<div class="toc">
<ul>
-<li><a href="#143-adding-your-own-partition-resp-suffix">1.4.3 - Adding your own partition resp. suffix</a><ul>
+<li><a href="#143-adding-your-own-partition">1.4.3 - Adding your own partition</a><ul>
<li><a href="#what-are-partitions">What are partitions?</a></li>
<li><a href="#minimal-partition-definition">Minimal partition definition</a></li>
<li><a href="#adding-a-partition-programmatically">Adding a partition programmatically</a></li>
<li><a href="#more-configuration-options-for-a-jdbm-partition">More configuration options for a JDBM partition</a></li>
+<li><a href="#adding-a-partition-manually">Adding a partition manually</a><ul>
+<li><a href="#before-starting-the-server">Before starting the server</a></li>
+<li><a href="#with-ldapmodify-to-a-running-server">With ldapmodify to a running server</a></li>
+</ul>
+</li>
</ul>
</li>
</ul>
@@ -307,6 +312,44 @@ h2:hover > .headerlink, h3:hover > .head
</tr>
</tbody>
</table>
+<h2 id="adding-a-partition-manually">Adding a partition manually<a class="headerlink" href="#adding-a-partition-manually" title="Permanent link">¶</a></h2>
+<p>When migrating from an earlier release, or perhaps a different LDAP Directory product, you might prefer to manually add your own partition with your specific directory root DN. There are two techniques available, and the most appropriate will depend on whether you have already allowed the apacheds server to start.</p>
+<p>When the server starts for the first time after installation, <em>config.ldif</em> is renamed to <em>config.ldif_migrated</em>. After that time, this priming ldif file is never referred to again, so any changes you make will be ignored. <a href="https://issues.apache.org/jira/browse/DIRSERVER-2050">The reason for this change is discussed in a JIRA</a>.</p>
+<h3 id="before-starting-the-server">Before starting the server<a class="headerlink" href="#before-starting-the-server" title="Permanent link">¶</a></h3>
+<p>Therefore, if you would like to have your (empty) partition created immediately following installation, you should prevent your server from starting during or after installation, i.e. when config.ldif has not yet been migrated.</p>
+<p>Next, edit <em>config.ldif</em> to change all occurrences of "<strong>example</strong>" to suit the name of your own partition. Once the server has started and you run your first ldapsearch as the admin user, you will see that the server has created your own empty partition (instead of the example one).</p>
+<p>Note that the entry for the "<strong>example</strong>" partition does NOT have an <em>ads-contextEntry</em> attribute. This "signature" attribute is created during the "migration" process (see below for details).</p>
+<p>Subsequent ldif changes to your new partition should work provided they use the default schema.</p>
+<h3 id="with-ldapmodify-to-a-running-server">With ldapmodify to a running server<a class="headerlink" href="#with-ldapmodify-to-a-running-server" title="Permanent link">¶</a></h3>
+<p>This is task more tricky because the root of your new partition MUST have a valid <em>ads-contextEntry</em> attribute and you must determine its value. The other attributes (see the definitions above) are quite straightforward, but this control value must be synthesised based on the specific attribute values of your own partition.</p>
+<p>Let us look at the ldif required to add the "example" partition:</p>
+<div class="codehilite"><pre><span class="n">dn</span><span class="o">:</span> <span class="n">ads</span><span class="o">-</span><span class="n">partitionId</span><span class="o">=</span><span class="n">example</span><span class="o">,</span><span class="n">ou</span><span class="o">=</span><span class="n">partitions</span><span class="o">,</span><span class="n">ads</span><span class="o">-</span><span class="n">directoryServiceId</span><span class="o">=</span><span class="k">default</span><span class="o">,</span><span class="n">ou</span><span class="o">=</span><span class="n">config</span>
+<span class="n">objectclass</span><span class="o">:</span> <span class="n">top</span>
+<span class="n">objectClass</span><span class="o">:</span> <span class="n">ads</span><span class="o">-</span><span class="n">base</span>
+<span class="n">objectclass</span><span class="o">:</span> <span class="n">ads</span><span class="o">-</span><span class="n">partition</span>
+<span class="n">objectclass</span><span class="o">:</span> <span class="n">ads</span><span class="o">-</span><span class="n">jdbmPartition</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">partitionSuffix</span><span class="o">:</span> <span class="n">dc</span><span class="o">=</span><span class="n">example</span><span class="o">,</span><span class="n">dc</span><span class="o">=</span><span class="n">com</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">contextentry</span><span class="o">::</span> <span class="n">ZG46IGRjPWV4YW1wbGUsZGM9Y29tCmRjOiBleGFtcGxlCm9iamVjdGNsYXNzOiBkb21haW4Kb2JqZWN0Y2xhc3M6IHRvcAoK</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">jdbmpartitionoptimizerenabled</span><span class="o">:</span> <span class="n">TRUE</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">partitioncachesize</span><span class="o">:</span> <span class="mi">10000</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">partitionsynconwrite</span><span class="o">:</span> <span class="n">TRUE</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">partitionid</span><span class="o">:</span> <span class="n">example</span>
+<span class="n">ads</span><span class="o">-</span><span class="n">enabled</span><span class="o">:</span> <span class="n">TRUE</span>
+</pre></div>
+
+
+<p>The <em>ads-contextentry</em> attribute is a binary value which has been base64 encoded. The algorithm has to be followed accurately to be successful. Consider our example partition and take these four lines:</p>
+<div class="codehilite"><pre><span class="n">dn</span><span class="o">:</span> <span class="n">dc</span><span class="o">=</span><span class="n">example</span><span class="o">,</span><span class="n">dc</span><span class="o">=</span><span class="n">com</span>
+<span class="n">dc</span><span class="o">:</span> <span class="n">example</span>
+<span class="n">objectclass</span><span class="o">:</span> <span class="n">domain</span>
+<span class="n">objectclass</span><span class="o">:</span> <span class="n">top</span>
+</pre></div>
+
+
+<p>Base64 these four lines as a single string (with \n newlines, but without the prefix spaces). The result should match the <em>ads-contextentry</em> value shown above.</p>
+<p>However, you need to be careful because simply adding an extra space or newline will change the base64 value and make it unacceptable to the server. Also, any valid UTF-8 attribute values which are not in the base64 character set (such as accented characters) <strong><em>MUST</em></strong> be base64-encoded strings, which effectively makes them double-encoded.
+e.g. <strong><em>"dn: cn=lécharny,dc=com"</em></strong> needs to be specified as <strong><em>"dn:: Y249bMOpY2hhcm55LGRjPWNvbQ=="</em></strong>.</p>
+<p>You will probably want to create some associated index entries. You can use those of the "<strong>example</strong>" partition in <em>config.ldif-migrated</em> for your templates (which do not require any special encoded attributes).</p>
<div class="nav">
Modified: websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.4-configure-logging.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.4-configure-logging.html (original)
+++ websites/staging/directory/trunk/content/apacheds/basic-ug/1.4.4-configure-logging.html Mon Apr 10 14:25:25 2017
@@ -152,7 +152,7 @@
<div class="nav">
<div class="nav_prev">
- <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition resp. suffix</a>
+ <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition</a>
</div>
<div class="nav_up">
@@ -435,7 +435,7 @@ $<span class="n">APACHEDS_HOME</span> <s
<div class="nav">
<div class="nav_prev">
- <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition resp. suffix</a>
+ <a href="1.4.3-adding-partition.html">1.4.3 - Adding your own partition</a>
</div>
<div class="nav_up">