You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by bu...@apache.org on 2012/12/11 15:35:11 UTC
svn commit: r841717 - in /websites/staging/vcl/trunk/content: ./
docs/VCL231InstallGuide.html
Author: buildbot
Date: Tue Dec 11 14:35:11 2012
New Revision: 841717
Log:
Staging update by buildbot for vcl
Modified:
websites/staging/vcl/trunk/content/ (props changed)
websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html
Propchange: websites/staging/vcl/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 11 14:35:11 2012
@@ -1 +1 @@
-1420182
+1420197
Modified: websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html
==============================================================================
--- websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html (original)
+++ websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html Tue Dec 11 14:35:11 2012
@@ -298,19 +298,24 @@
<li>
<p>Edit the secrets.php file:</p>
<div class="codehilite"><pre><span class="n">vi</span> <span class="n">secrets</span><span class="o">.</span><span class="n">php</span>
-
-<span class="o">*</span> <span class="n">Set</span> <span class="n">the</span> <span class="n">following</span> <span class="n">variables</span> <span class="n">to</span> <span class="n">match</span> <span class="n">your</span> <span class="n">database</span> <span class="n">configuration:</span>
- <span class="o">*</span> <span class="nv">$vclhost</span>
- <span class="o">*</span> <span class="nv">$vcldb</span>
- <span class="o">*</span> <span class="nv">$vclusername</span>
- <span class="o">*</span> <span class="nv">$vclpassword</span>
-<span class="o">*</span> <span class="n">Create</span> <span class="n">random</span> <span class="n">passwords</span> <span class="k">for</span> <span class="n">the</span> <span class="n">following</span> <span class="n">variables:</span>
- <span class="o">*</span> <span class="nv">$cryptkey</span>
- <span class="o">*</span> <span class="nv">$pemkey</span>
-<span class="o">*</span> <span class="n">Save</span> <span class="n">the</span> <span class="n">secrets</span><span class="o">.</span><span class="n">php</span> <span class="n">file</span>
</pre></div>
+<ul>
+<li>Set the following variables to match your database configuration:<ul>
+<li>$vclhost</li>
+<li>$vcldb</li>
+<li>$vclusername</li>
+<li>$vclpassword</li>
+</ul>
+</li>
+<li>Create random passwords for the following variables:<ul>
+<li>$cryptkey</li>
+<li>$pemkey</li>
+</ul>
+</li>
+<li>Save the secrets.php file</li>
+</ul>
</li>
<li>
<p>Run the genkeys.sh</p>
@@ -329,14 +334,15 @@
<li>
<p>Modify conf.php to match your site</p>
<div class="codehilite"><pre><span class="n">vi</span> <span class="n">conf</span><span class="o">.</span><span class="n">php</span>
-
-<span class="o">*</span> <span class="n">Modify</span> <span class="n">every</span> <span class="n">entry</span> <span class="n">under</span> <span class="s">"Things in this section must be modified"</span><span class="o">.</span>
-<span class="o">*</span> <span class="n">Descriptions</span> <span class="ow">and</span> <span class="n">pointers</span> <span class="k">for</span> <span class="nb">each</span> <span class="n">value</span> <span class="n">are</span> <span class="n">included</span> <span class="n">within</span> <span class="n">conf</span><span class="o">.</span><span class="n">php</span><span class="o">.</span>
-<span class="o">*</span> <span class="n">COOKIEDOMAIN</span> <span class="o">-</span> <span class="n">set</span> <span class="n">this</span> <span class="n">to</span> <span class="n">the</span> <span class="n">domain</span> <span class="n">name</span> <span class="n">your</span> <span class="n">web</span> <span class="n">server</span> <span class="n">is</span> <span class="n">using</span>
-<span class="o">*</span> <span class="ow">or</span> <span class="n">leave</span> <span class="n">it</span> <span class="n">blank</span> <span class="k">if</span> <span class="n">you</span> <span class="n">are</span> <span class="n">only</span> <span class="n">accessing</span> <span class="n">the</span> <span class="n">web</span> <span class="n">server</span> <span class="n">by</span> <span class="n">its</span> <span class="n">IP</span> <span class="n">address</span>
</pre></div>
+<ul>
+<li>Modify every entry under "Things in this section must be modified".
+Descriptions and pointers for each value are included within conf.php.</li>
+<li>COOKIEDOMAIN - set this to the domain name your web server is using
+or leave it blank if you are only accessing the web server by its IP address</li>
+</ul>
</li>
<li>
<p>Set the owner of the .ht-inc/maintenance directory to the web server user (normally 'apache'):</p>
@@ -417,12 +423,11 @@ To install phpMyAdmin, follow the instru
<hr />
<h1 id="managementnode">Install & Configure the Management Node Components</h1>
<p><strong>Prerequisites</strong>
-The following management node installation instructions assume the instructions on the following pages have previously been completed:</p>
-<div class="codehilite"><pre><span class="o">*</span> <span class="n">VCL</span> <span class="mf">2.3.1</span> <span class="n">Database</span> <span class="n">Installation</span>
-<span class="o">*</span> <span class="n">VCL</span> <span class="mf">2.3.1</span> <span class="n">Web</span> <span class="n">Code</span> <span class="n">Installation</span>
-</pre></div>
-
-
+The following management node installation instructions assume the instructions in these previous sections have been completed:</p>
+<ul>
+<li>VCL 2.3.1 Database Installation</li>
+<li>VCL 2.3.1 Web Code Installation</li>
+</ul>
<p><strong>Supported Operating Systems:</strong></p>
<p>The VCL management node daemon (vcld) has been developed to run on an operating system based on Red Hat Enterprise Linux (RHEL). It has been tested on the following:</p>
<ul>
@@ -521,16 +526,18 @@ The following management node installati
<li>
<p>Edit /etc/vcl/vcld.conf:</p>
<div class="codehilite"><pre><span class="n">vi</span> <span class="sr">/etc/</span><span class="n">vcl</span><span class="o">/</span><span class="n">vcld</span><span class="o">.</span><span class="n">conf</span>
-<span class="n">The</span> <span class="n">following</span> <span class="n">lines</span> <span class="n">must</span> <span class="n">be</span> <span class="n">configured</span> <span class="n">in</span> <span class="n">order</span> <span class="n">to</span> <span class="n">start</span> <span class="n">the</span> <span class="n">VCL</span> <span class="n">daemon</span> <span class="p">(</span><span class="n">vcld</span><span class="p">)</span> <span class="ow">and</span> <span class="n">allow</span> <span class="n">it</span> <span class="n">to</span> <span class="n">check</span> <span class="n">in</span> <span class="n">to</span> <span class="n">the</span> <span class="n">database:</span>
-<span class="o">*</span> <span class="n">FQDN</span> <span class="o">-</span> <span class="n">the</span> <span class="n">fully</span> <span class="n">qualified</span> <span class="n">name</span> <span class="n">of</span> <span class="n">the</span> <span class="n">management</span> <span class="n">node</span><span class="p">,</span> <span class="n">this</span> <span class="n">should</span> <span class="n">match</span> <span class="n">the</span> <span class="n">name</span> <span class="n">that</span> <span class="n">was</span> <span class="n">configured</span> <span class="k">for</span> <span class="n">the</span> <span class="n">management</span> <span class="n">node</span> <span class="n">in</span> <span class="n">the</span> <span class="n">database</span>
-<span class="o">*</span> <span class="n">server</span> <span class="o">-</span> <span class="n">the</span> <span class="n">IP</span> <span class="n">address</span> <span class="ow">or</span> <span class="n">FQDN</span> <span class="n">of</span> <span class="n">the</span> <span class="n">database</span> <span class="n">server</span>
-<span class="o">*</span> <span class="n">LockerWrtUser</span> <span class="o">-</span> <span class="n">database</span> <span class="n">user</span> <span class="n">account</span> <span class="n">with</span> <span class="nb">write</span> <span class="n">privileges</span>
-<span class="o">*</span> <span class="n">wrtPass</span> <span class="o">-</span> <span class="n">database</span> <span class="n">user</span> <span class="n">password</span>
-<span class="o">*</span> <span class="n">xmlrpc_pass</span> <span class="o">-</span> <span class="n">password</span> <span class="k">for</span> <span class="n">xmlrpc</span> <span class="n">api</span> <span class="n">from</span> <span class="n">vcld</span> <span class="n">to</span> <span class="n">the</span> <span class="n">web</span> <span class="n">interface</span><span class="p">(</span><span class="n">can</span> <span class="n">be</span> <span class="n">long</span><span class="p">)</span><span class="o">.</span> <span class="n">This</span> <span class="n">will</span> <span class="n">be</span> <span class="n">used</span> <span class="n">later</span> <span class="n">to</span> <span class="n">sync</span> <span class="n">the</span> <span class="n">database</span> <span class="n">vclsystem</span> <span class="n">user</span> <span class="n">account</span>
-<span class="o">*</span> <span class="n">xmlrpc_url</span> <span class="o">-</span> <span class="n">URL</span> <span class="k">for</span> <span class="n">xmlrpc</span> <span class="n">api</span> <span class="n">https:</span><span class="sr">//m</span><span class="n">y</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">org</span><span class="sr">/vcl/i</span><span class="n">ndex</span><span class="o">.</span><span class="n">php</span><span class="p">?</span><span class="n">mode</span><span class="o">=</span><span class="n">xmlrpccall</span>
</pre></div>
+<p>The following lines must be configured in order to start the VCL daemon (vcld) and allow it to check in to the database:</p>
+<ul>
+<li>FQDN - the fully qualified name of the management node, this should match the name that was configured for the management node in the database</li>
+<li>server - the IP address or FQDN of the database server</li>
+<li>LockerWrtUser - database user account with write privileges</li>
+<li>wrtPass - database user password</li>
+<li>xmlrpc_pass - password for xmlrpc api from vcld to the web interface(can be long). This will be used later to sync the database vclsystem user account</li>
+<li>xmlrpc_url - URL for xmlrpc api https://my.server.org/vcl/index.php?mode=xmlrpccall</li>
+</ul>
</li>
<li>
<p>Save the vcld.conf file</p>
@@ -544,13 +551,17 @@ The following management node installati
<li>
<p>Edit the ssh_config file:</p>
<div class="codehilite"><pre><span class="n">vi</span> <span class="sr">/etc/ss</span><span class="n">h</span><span class="o">/</span><span class="n">ssh_config</span>
-<span class="n">Set</span> <span class="n">the</span> <span class="n">following</span> <span class="n">parameters:</span><span class="sr"><br></span>
-<span class="n">UserKnownHostsFile</span> <span class="sr">/dev/</span><span class="n">null</span><span class="sr"><br></span>
-<span class="n">StrictHostKeyChecking</span> <span class="nb">no</span><span class="sr"><br></span>
</pre></div>
</li>
+<li>
+<p>Set the following parameters:</p>
+<ul>
+<li>UserKnownHostsFile /dev/null</li>
+<li>StrictHostKeyChecking no</li>
+</ul>
+</li>
</ul>
<p>Note: If you do not want these settings applied universally on the management node the SSH configuration can also be configured to only apply these settings to certain hosts or only for the root user. Consult the SSH documentation for more information.</p>
</li>
@@ -593,20 +604,23 @@ The following management node installati
</li>
</ul>
-<p>You should see the following being added to the log file every few seconds if the management node is checking in with the database:<br>
- 2012-05-15 13:23:45|25494|vcld:main(167)|lastcheckin time updated for management node 1: 2012-05-15 13:23:45</p>
+<p>You should see the following being added to the log file every few seconds if the management node is checking in with the database:</p>
+<div class="codehilite"><pre><span class="mi">2012</span><span class="o">-</span><span class="mo">05</span><span class="o">-</span><span class="mi">15</span> <span class="mi">13</span><span class="p">:</span><span class="mi">23</span><span class="p">:</span><span class="mi">45</span><span class="o">|</span><span class="mi">25494</span><span class="o">|</span><span class="n">vcld:main</span><span class="p">(</span><span class="mi">167</span><span class="p">)</span><span class="o">|</span><span class="n">lastcheckin</span> <span class="nb">time</span> <span class="n">updated</span> <span class="k">for</span> <span class="n">management</span> <span class="n">node</span> <span class="mi">1</span><span class="p">:</span> <span class="mi">2012</span><span class="o">-</span><span class="mo">05</span><span class="o">-</span><span class="mi">15</span> <span class="mi">13</span><span class="p">:</span><span class="mi">23</span><span class="p">:</span><span class="mi">45</span>
+</pre></div>
+
+
</li>
<li>
<p><strong>Set the vclsystem account password for xmlrpc api</strong></p>
<p>Using the vcld -setup tool, set the vclsystem account. This is needed to properly use the block allocation features.</p>
-<div class="codehilite"><pre> <span class="sr">/usr/</span><span class="nb">local</span><span class="sr">/vcl/</span><span class="n">bin</span><span class="o">/</span><span class="n">vcld</span> <span class="o">-</span><span class="n">setup</span>
+<div class="codehilite"><pre><span class="sr">/usr/</span><span class="nb">local</span><span class="sr">/vcl/</span><span class="n">bin</span><span class="o">/</span><span class="n">vcld</span> <span class="o">-</span><span class="n">setup</span>
</pre></div>
<p>Select the options listed below to set the password. When prompted paste or type the password from xmlrpc_pass variable in the vcld.conf file and hit enter. </p>
-<div class="codehilite"><pre> <span class="n">Select</span> <span class="mi">1</span><span class="o">.</span> <span class="n">VCL</span> <span class="n">Base</span> <span class="n">Module</span>
- <span class="n">Select</span> <span class="mi">2</span><span class="o">.</span> <span class="n">Set</span> <span class="n">Local</span> <span class="n">VCL</span> <span class="n">User</span> <span class="n">Account</span> <span class="n">Password</span>
- <span class="n">Select</span> <span class="mi">2</span><span class="o">.</span> <span class="n">vclsystem</span>
+<div class="codehilite"><pre><span class="n">Select</span> <span class="mi">1</span><span class="o">.</span> <span class="n">VCL</span> <span class="n">Base</span> <span class="n">Module</span>
+<span class="n">Select</span> <span class="mi">2</span><span class="o">.</span> <span class="n">Set</span> <span class="n">Local</span> <span class="n">VCL</span> <span class="n">User</span> <span class="n">Account</span> <span class="n">Password</span>
+<span class="n">Select</span> <span class="mi">2</span><span class="o">.</span> <span class="n">vclsystem</span>
</pre></div>
@@ -641,12 +655,12 @@ The following management node installati
</ul>
<p>Configure your dhcpd.conf file according to your network configuration.
The contents of the dhcpd.conf file will vary based on how your network is configured. Below is an example of a basic dhcpd.conf file:</p>
-<div class="codehilite"><pre> <span class="n">ddns</span><span class="o">-</span><span class="n">update</span><span class="o">-</span><span class="n">style</span> <span class="n">none</span><span class="p">;</span>
- <span class="n">shared</span><span class="o">-</span><span class="n">network</span> <span class="n">eth0</span> <span class="p">{</span>
- <span class="n">subnet</span> <span class="mf">10.100.0.0</span> <span class="n">netmask</span> <span class="mf">255.255.255.0</span> <span class="p">{</span>
- <span class="n">ignore</span> <span class="n">unknown</span><span class="o">-</span><span class="n">clients</span><span class="p">;</span>
- <span class="p">}</span>
+<div class="codehilite"><pre><span class="n">ddns</span><span class="o">-</span><span class="n">update</span><span class="o">-</span><span class="n">style</span> <span class="n">none</span><span class="p">;</span>
+<span class="n">shared</span><span class="o">-</span><span class="n">network</span> <span class="n">eth0</span> <span class="p">{</span>
+ <span class="n">subnet</span> <span class="mf">10.100.0.0</span> <span class="n">netmask</span> <span class="mf">255.255.255.0</span> <span class="p">{</span>
+ <span class="n">ignore</span> <span class="n">unknown</span><span class="o">-</span><span class="n">clients</span><span class="p">;</span>
<span class="p">}</span>
+<span class="p">}</span>
</pre></div>