VCL231InstallGuide.html

buildbot Mon, 10 Dec 2012 07:35:23 -0800

Author: buildbot
Date: Mon Dec 10 15:34:56 2012
New Revision: 841429

Log:
Staging update by buildbot for vcl


Added:
    websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html
Removed:
    websites/staging/vcl/trunk/content/docs/VCL 2.3.1 Installation Guide
Modified:
    websites/staging/vcl/trunk/content/   (props changed)

Propchange: websites/staging/vcl/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Dec 10 15:34:56 2012
@@ -1 +1 @@
-1419522
+1419526

Added: websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html
==============================================================================
--- websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html (added)
+++ websites/staging/vcl/trunk/content/docs/VCL231InstallGuide.html Mon Dec 10 
15:34:56 2012
@@ -0,0 +1,686 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<!--
+
+    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.
+-->
+
+  <link href="/css/vcl.css" rel="stylesheet" type="text/css">
+  <link href="/css/code.css" rel="stylesheet" type="text/css">
+  <title>Apache VCL - VCL 2.3.1 Installation Guide</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+  <div id="sitetitle">
+    <table width="100%" border="0" cellspacing="0" cellpadding="5">
+      <tr>
+         <td><a href="/index.html"><img src="/img/vcl-logo.png" height="100" 
align="left" alt="Apache VCL logo"></a></td>
+         <td><a href="http://www.apache.org";><img src="/img/asf-logo.png" 
align="right" alt="Apache Software Foundation logo"></a></td>
+      </tr>
+    </table>
+  </div>
+
+  <div id="navigation"> 
+  <ul>
+<li>Information<ul>
+<li><a href="/info/about.html">What is VCL?</a></li>
+<li><a href="/info/features.html">Features</a></li>
+<li><a href="/info/architecture.html">Architecture</a></li>
+<li><a href="/info/use-cases.html">Use Cases</a></li>
+<li><a href="/downloads/download.cgi">Download</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a></li>
+<li><a href="/info/faq.html">FAQ</a></li>
+</ul>
+</li>
+<li><a href="/docs/index.html">Documentation</a><ul>
+<li><a href="/docs/using-vcl.html">Using VCL</a></li>
+<li><a href="/docs/image-creation.html">Image Creation</a></li>
+<li><a href="/docs/administration.html">Administration</a></li>
+<li><a href="/docs/installation.html">Installation</a></li>
+<li><a href="/docs/deployment-planning.html">Deployment Planning</a></li>
+</ul>
+</li>
+<li><a href="/comm/index.html">Community</a><ul>
+<li><a href="/comm/index.html#getInvolved">Getting Involved</a></li>
+<li><a href="/comm/index.html#mail-list">Mailing Lists</a></li>
+<li><a href="/comm/index.html#how-do-i-join-the-project">How can I 
Join</a></li>
+<li><a href="/comm/wiki.html">Wiki</a></li>
+<li><a href="/dev/index.html">Development</a><ul>
+<li><a href="/dev/jira.html">Issue Tracking</a></li>
+<li><a href="/dev/code-documentation.html">Code Documentation</a></li>
+<li><a href="/dev/roadmap.html">Roadmap</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="http://www.apache.org";>Apache Software Foundation</a><ul>
+<li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html";>Become a 
Sponsor</a></li>
+</ul>
+</li>
+</ul>
+  </div>
+  
+  <div id="content">
+    <h1 class="title">VCL 2.3.1 Installation Guide</h1>
+    <p><strong>VCL 2.3.1 Installation Guide</strong></p>
+<p>This guide will provide the necessary steps to install and configure VCL 
software. It covers the set up of the database , web portal, and management 
node.</p>
+<div class="toc">
+<ul>
+<li><a href="#database">Install &amp; Configure the Database</a></li>
+<li><a href="#web">Install and Configure the Web Components</a></li>
+<li><a href="#managementnode">Install &amp; Configure the Management Node 
Components</a></li>
+</ul>
+</div>
+<h1 id="database">Install &amp; Configure the Database</h1>
+<p>VCL currently supports the use of mysql database.</p>
+<ol>
+<li>
+<p>Download and Extract the Apache VCL Source</p>
+<ul>
+<li>
+<p>If you have not already done so, download and the Apache VCL source to the 
database server:</p>
+<div class="codehilite"><pre><span class="n">wget</span> <span 
class="o">--</span><span class="n">trust</span><span class="o">-</span><span 
class="n">server</span><span class="o">-</span><span class="n">names</span> 
<span 
class="s">&#39;http://vcl.apache.org/downloads/download.cgi?action=download&amp;filename=%2Fvcl%2Fapache-VCL-2.3.1.tar.bz2&#39;</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Extract the files:</p>
+<div class="codehilite"><pre><span class="n">tar</span> <span 
class="o">-</span><span class="n">jxvf</span> <span 
class="n">apache</span><span class="o">-</span><span class="n">VCL</span><span 
class="o">-</span><span class="mf">2.3.1</span><span class="o">.</span><span 
class="n">tar</span><span class="o">.</span><span class="n">bz2</span>
+</pre></div>
+
+
+</li>
+</ul>
+</li>
+<li>
+<p>Install MySQL Server</p>
+<ul>
+<li>
+<p>Install MySQL Server 5.x</p>
+<div class="codehilite"><pre><span class="n">yum</span> <span 
class="n">install</span> <span class="n">mysql</span><span 
class="o">-</span><span class="n">server</span> <span class="o">-</span><span 
class="n">y</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Configure the MySQL daemon (mysqld) to start automatically:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/c</span><span 
class="n">hkconfig</span> <span class="o">--</span><span class="n">level</span> 
<span class="mi">345</span> <span class="n">mysqld</span> <span 
class="n">on</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Start the MySQL daemon:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/s</span><span 
class="n">ervice</span> <span class="n">mysqld</span> <span 
class="n">start</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>If the iptables firewall is being used and the web server and management 
nodes will be on different machines, port 3306 should be opened up. Add the 
following to your iptables config and restart iptables service. Note insert 
your web server and management node IP address in the right locations.</p>
+<div class="codehilite"><pre><span class="n">vi</span> <span 
class="sr">/etc/s</span><span class="n">ysconfig</span><span 
class="o">/</span><span class="n">iptables</span>
+<span class="o">-</span><span class="n">A</span> <span 
class="n">RH</span><span class="o">-</span><span class="n">Firewall</span><span 
class="o">-</span><span class="mi">1</span><span class="o">-</span><span 
class="n">INPUT</span> <span class="o">-</span><span class="n">m</span> <span 
class="n">state</span> <span class="o">--</span><span class="n">state</span> 
<span class="n">NEW</span> <span class="o">-</span><span class="n">s</span> 
<span class="o">&lt;</span><span class="n">web</span> <span 
class="n">server</span> <span class="n">IP</span><span class="o">&gt;</span> 
<span class="o">-</span><span class="n">p</span> <span class="n">tcp</span> 
<span class="o">--</span><span class="n">dport</span> <span 
class="mi">3306</span> <span class="o">-</span><span class="n">j</span> <span 
class="n">ACCEPT</span>
+<span class="o">-</span><span class="n">A</span> <span 
class="n">RH</span><span class="o">-</span><span class="n">Firewall</span><span 
class="o">-</span><span class="mi">1</span><span class="o">-</span><span 
class="n">INPUT</span> <span class="o">-</span><span class="n">m</span> <span 
class="n">state</span> <span class="o">--</span><span class="n">state</span> 
<span class="n">NEW</span> <span class="o">-</span><span class="n">s</span> 
<span class="o">&lt;</span><span class="n">management</span> <span 
class="n">node</span> <span class="n">IP</span><span class="o">&gt;</span> 
<span class="o">-</span><span class="n">p</span> <span class="n">tcp</span> 
<span class="o">--</span><span class="n">dport</span> <span 
class="mi">3306</span> <span class="o">-</span><span class="n">j</span> <span 
class="n">ACCEPT</span>
+<span class="n">service</span> <span class="n">iptables</span> <span 
class="n">restart</span>
+</pre></div>
+
+
+</li>
+</ul>
+</li>
+<li>
+<p>Create the VCL Database</p>
+<ul>
+<li>
+<p>Run the MySQL command-line client:</p>
+<div class="codehilite"><pre><span class="n">mysql</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Create a database:</p>
+<div class="codehilite"><pre><span class="n">CREATE</span> <span 
class="n">DATABASE</span> <span class="n">vcl</span><span class="p">;</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Create a user with SELECT, INSERT, UPDATE, DELETE, and CREATE TEMPORARY 
TABLES privileges on the database you just created:</p>
+<div class="codehilite"><pre><span class="n">GRANT</span> <span 
class="n">SELECT</span><span class="p">,</span><span 
class="n">INSERT</span><span class="p">,</span><span 
class="n">UPDATE</span><span class="p">,</span><span 
class="n">DELETE</span><span class="p">,</span><span class="n">CREATE</span> 
<span class="n">TEMPORARY</span> <span class="n">TABLES</span> <span 
class="n">ON</span> <span class="n">vcl</span><span class="o">.*</span> <span 
class="n">TO</span> <span class="s">&#39;**vcluser**&#39;</span><span 
class="nv">@</span><span class="err">&#39;</span><span 
class="nv">localhost</span><span class="s">&#39; IDENTIFIED BY 
&#39;</span><span class="o">**</span><span 
class="n">vcluserpassword</span><span class="o">**</span><span 
class="err">&#39;</span><span class="p">;</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Exit the MySQL command-line client</p>
+<div class="codehilite"><pre><span class="nb">exit</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Import the vcl.sql file into the database. The <strong>vcl.sql</strong> 
file is included in the <strong>mysql</strong> directory within the Apache VCL 
source code</p>
+<div class="codehilite"><pre><span class="n">mysql</span> <span 
class="n">vcl</span> <span class="o">&lt;</span> <span 
class="n">apache</span><span class="o">-</span><span class="n">VCL</span><span 
class="o">-</span><span class="mf">2.3</span><span 
class="sr">/mysql/</span><span class="n">vcl</span><span 
class="o">.</span><span class="n">sql</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>If you want to use libvirt provisioning for KVM, you need to add one entry 
to the database that was left out of the release.</p>
+<div class="codehilite"><pre><span class="n">echo</span> <span 
class="s">&quot;INSERT IGNORE provisioningOSinstalltype (provisioningid, 
OSinstalltypeid) SELECT provisioning.id, OSinstalltype.id FROM provisioning, 
OSinstalltype WHERE provisioning.name = &#39;libvirt&#39; AND 
OSinstalltype.name = &#39;vmware&#39;;&quot;</span> <span class="o">|</span> 
<span class="n">mysql</span> <span class="n">vcl</span>
+</pre></div>
+
+
+</li>
+</ul>
+</li>
+</ol>
+<hr />
+<h1 id="web">Install and Configure the Web Components</h1>
+<p><strong>Prerequisites</strong></p>
+<ul>
+<li>Apache VCL 2.3 had been downloaded</li>
+<li>VCL database has been installed and configured</li>
+</ul>
+<p><strong>Web Server:</strong></p>
+<ul>
+<li>Apache HTTP Server v1.3 or v2.x with SSL enabled</li>
+<li>PHP 5.0 or later</li>
+</ul>
+<p><strong>Required Linux Packages:</strong></p>
+<ul>
+<li>httpd - Apache HTTP Server</li>
+<li>mod_ssl - SSL/TLS module for the Apache HTTP server</li>
+<li>php - The PHP HTML-embedded scripting language</li>
+<li>libmcrypt - Encryption algorithms library (this requirement can be removed 
with a patch)</li>
+</ul>
+<p><strong>Required PHP Modules:</strong></p>
+<ul>
+<li>php-gd</li>
+<li>php-json (required if your PHP version is 5.2 or later)</li>
+<li>php-mysql</li>
+<li>php-openssl</li>
+<li>php-sysvsem</li>
+<li>php-xml</li>
+<li>php-xmlrpc</li>
+<li>php-ldap (if you will be using LDAP authentication)</li>
+<li>php-process (for RHEL/CentOS 6)</li>
+</ul>
+<hr />
+<ol>
+<li>
+<p><strong>Install the Required Linux Packages &amp; PHP Modules</strong></p>
+<ul>
+<li>
+<p>If your web server is running a Red Hat-based OS, the required components 
can be installed with:
+    For RHEL / CentOS 5</p>
+<div class="codehilite"><pre><span class="n">yum</span> <span 
class="n">install</span> <span class="n">httpd</span> <span 
class="n">mod_ssl</span> <span class="n">php</span> <span 
class="n">php</span><span class="o">-</span><span class="n">gd</span> <span 
class="n">php</span><span class="o">-</span><span class="n">mysql</span> <span 
class="n">php</span><span class="o">-</span><span class="n">xml</span> <span 
class="n">php</span><span class="o">-</span><span class="n">xmlrpc</span> <span 
class="n">php</span><span class="o">-</span><span class="n">ldap</span> <span 
class="o">-</span><span class="n">y</span>
+</pre></div>
+
+
+<p>For RHEL / CentOS 6</p>
+<div class="codehilite"><pre>    <span class="n">yum</span> <span 
class="n">install</span> <span class="n">httpd</span> <span 
class="n">mod_ssl</span> <span class="n">php</span> <span 
class="n">php</span><span class="o">-</span><span class="n">gd</span> <span 
class="n">php</span><span class="o">-</span><span class="n">mysql</span> <span 
class="n">php</span><span class="o">-</span><span class="n">xml</span> <span 
class="n">php</span><span class="o">-</span><span class="n">xmlrpc</span> <span 
class="n">php</span><span class="o">-</span><span class="n">ldap</span> <span 
class="n">php</span><span class="o">-</span><span class="n">process</span> 
<span class="o">-</span><span class="n">y</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Configure the web server daemon (httpd) to start automatically:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/c</span><span 
class="n">hkconfig</span> <span class="o">--</span><span class="n">level</span> 
<span class="mi">345</span> <span class="n">httpd</span> <span 
class="n">on</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Start the web server daemon</p>
+<div class="codehilite"><pre><span class="sr">/sbin/s</span><span 
class="n">ervice</span> <span class="n">httpd</span> <span 
class="n">start</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>If SELinux is enabled, run the following command to allow the web server to 
connect to the database:</p>
+<div class="codehilite"><pre><span class="sr">/usr/s</span><span 
class="n">bin</span><span class="o">/</span><span class="n">setsebool</span> 
<span class="o">-</span><span class="n">P</span> <span 
class="n">httpd_can_network_connect</span><span class="o">=</span><span 
class="mi">1</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>If the iptables firewall is being used, port 80 and 443 should be opened 
up:</p>
+<div class="codehilite"><pre><span class="n">vi</span> <span 
class="sr">/etc/s</span><span class="n">ysconfig</span><span 
class="o">/</span><span class="n">iptables</span>
+<span class="o">-</span><span class="n">A</span> <span 
class="n">RH</span><span class="o">-</span><span class="n">Firewall</span><span 
class="o">-</span><span class="mi">1</span><span class="o">-</span><span 
class="n">INPUT</span> <span class="o">-</span><span class="n">m</span> <span 
class="n">state</span> <span class="o">--</span><span class="n">state</span> 
<span class="n">NEW</span> <span class="o">-</span><span class="n">p</span> 
<span class="n">tcp</span> <span class="o">--</span><span 
class="n">dport</span> <span class="mi">80</span> <span class="o">-</span><span 
class="n">j</span> <span class="n">ACCEPT</span>
+<span class="o">-</span><span class="n">A</span> <span 
class="n">RH</span><span class="o">-</span><span class="n">Firewall</span><span 
class="o">-</span><span class="mi">1</span><span class="o">-</span><span 
class="n">INPUT</span> <span class="o">-</span><span class="n">m</span> <span 
class="n">state</span> <span class="o">--</span><span class="n">state</span> 
<span class="n">NEW</span> <span class="o">-</span><span class="n">p</span> 
<span class="n">tcp</span> <span class="o">--</span><span 
class="n">dport</span> <span class="mi">443</span> <span 
class="o">-</span><span class="n">j</span> <span class="n">ACCEPT</span>
+<span class="n">service</span> <span class="n">iptables</span> <span 
class="n">restart</span>
+</pre></div>
+
+
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Install the VCL Frontend Web Code</strong></p>
+<ul>
+<li>
+<p>If you have not already done so, download and extract the source files on 
the web server:</p>
+<div class="codehilite"><pre><span class="n">wget</span> <span 
class="o">--</span><span class="n">trust</span><span class="o">-</span><span 
class="n">server</span><span class="o">-</span><span class="n">names</span> 
<span 
class="s">&#39;http://vcl.apache.org/downloads/download.cgi?action=download&amp;filename=%2Fvcl%2Fapache-VCL-2.3.tar.bz2&#39;</span>
+<span class="n">tar</span> <span class="o">-</span><span class="n">jxvf</span> 
<span class="n">apache</span><span class="o">-</span><span 
class="n">VCL</span><span class="o">-</span><span class="mf">2.3</span><span 
class="o">.</span><span class="n">tar</span><span class="o">.</span><span 
class="n">bz2</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Copy the <strong>web</strong> directory to a location under the web root of 
your web server and navigate to the destination <strong>.ht-inc</strong> 
subdirectory:</p>
+<div class="codehilite"><pre><span class="n">cp</span> <span 
class="o">-</span><span class="n">r</span> <span class="n">apache</span><span 
class="o">-</span><span class="n">VCL</span><span class="o">-</span><span 
class="mf">2.3</span><span class="sr">/web/</span> <span 
class="sr">/var/</span><span class="n">www</span><span 
class="sr">/html/</span><span class="n">vcl</span>
+<span class="n">cd</span> <span class="sr">/var/</span><span 
class="n">www</span><span class="sr">/html/</span><span 
class="n">vcl</span><span class="o">/.</span><span class="n">ht</span><span 
class="o">-</span><span class="n">inc</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Copy secrets-default.php to secrets.php:</p>
+<div class="codehilite"><pre><span class="n">cp</span> <span 
class="n">secrets</span><span class="o">-</span><span 
class="n">default</span><span class="o">.</span><span class="n">php</span> 
<span class="n">secrets</span><span class="o">.</span><span class="n">php</span>
+</pre></div>
+
+
+</li>
+<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>
+
+
+</li>
+<li>
+<p>Run the genkeys.sh</p>
+<div class="codehilite"><pre><span class="o">./</span><span 
class="n">genkeys</span><span class="o">.</span><span class="n">sh</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Copy conf-default.php to conf.php:</p>
+<div class="codehilite"><pre><span class="n">cp</span> <span 
class="n">conf</span><span class="o">-</span><span 
class="n">default</span><span class="o">.</span><span class="n">php</span> 
<span class="n">conf</span><span class="o">.</span><span class="n">php</span>
+</pre></div>
+
+
+</li>
+<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">&quot;Things in this section must be 
modified&quot;</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="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>
+
+
+</li>
+<li>
+<p>Set the owner of the .ht-inc/maintenance directory to the web server user 
(normally 'apache'):</p>
+<div class="codehilite"><pre><span class="nb">chown</span> <span 
class="n">apache</span> <span class="n">maintenance</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Open the testsetup.php page in a web browser:</p>
+<ul>
+<li>If you set up your site to be https://my.server.org/vcl/ open 
https://my.server.org/vcl/testsetup.php</li>
+<li>Debug any issues reported by testsetup.php</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Log In to the VCL Website</strong></p>
+<ul>
+<li>
+<p>Open the index.php page in your browser 
(https://my.server.org/vcl/index.php)</p>
+<ul>
+<li>Select Local Account</li>
+<li>Username: admin</li>
+<li>Password: adminVc1passw0rd</li>
+</ul>
+</li>
+<li>
+<p>Set the admin user password (optional):</p>
+<ul>
+<li>Click User Preferences</li>
+<li>Enter the current password: adminVc1passw0rd</li>
+<li>Enter a new password</li>
+<li>Click Submit Changes</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Add a Management Node to the Database</strong></p>
+<ul>
+<li>Click the Management Nodes link<ul>
+<li>Click Add</li>
+<li>Fill in these required fields:<ul>
+<li>Hostname - The name of the management node server. This value doesn't 
necessarily need to be a name registered in DNS nor does it need to be the 
value displayed by the Linux hostname command. For example, if you are 
installing all of the VCL components on the same machine you can set this value 
to localhost.</li>
+<li>IP address - the public IP address of the management node</li>
+<li>SysAdmin Email Address - error emails will be sent to this address</li>
+<li>Install Path - this is parent directory under which image files will be 
stored - only required if doing bare metal installs or using VMWare with local 
disks</li>
+<li>End Node SSH Identity Key Files - enter /etc/vcl/vcl.key unless you know 
you are using a different SSH identity key file</li>
+</ul>
+</li>
+<li>Optionally, fill in these fields:<ul>
+<li>Address for Shadow Emails - End users are sent various emails about the 
status of their reservations. If this field is configured, copies of all of 
those emails will be sent to this address.</li>
+<li>Public NIC configuration method - this defaults to Dynamic DHCP - if DHCP 
is not available for the public interface of your nodes, you can set this to 
Static. Then, the IP configuration on the nodes will be manually set using 
Public Netmask, Public Gateway, Public DNS Server, and the IP address set for 
the computer under Manage Computers     <br />
+</li>
+</ul>
+</li>
+<li>Click Confirm Management Node</li>
+<li>Click Submit</li>
+<li>Click the Management Nodes link<ul>
+<li>Select Edit Management Node Grouping</li>
+<li>Click Submit</li>
+<li>Select the checkbox for your management node</li>
+<li>Click Submit Changes</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Install &amp; Configure phpMyAdmin (Optional):</strong>
+<a href="http://www.phpmyadmin.net/";>phpMyAdmin</a> is a free and optional 
tool which allows <a href="http://www.mysql.com/";>MySQL</a> to be administered 
using a web browser. It makes administering the VCL database easier. This tool 
can be installed on the VCL web server.
+To install phpMyAdmin, follow the instructions on: VCL 2.3 phpMyAdmin 
Installation &amp; Configuration</p>
+</li>
+</ol>
+<hr />
+<h1 id="managementnode">Install &amp; 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</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</span> <span class="n">Web</span> <span class="n">Code</span> 
<span class="n">Installation</span>
+</pre></div>
+
+
+<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>
+<li>Red Hat Enterprise Linux 4.x</li>
+<li>Red Hat Enterprise Linux 5.x</li>
+<li>Red Hat Enterprise Linux 6.x</li>
+<li>CentOS 5.x</li>
+<li>CentOS 6.x</li>
+</ul>
+<p><strong>Required Linux Packages:</strong></p>
+<p>The VCL management node daemon (vcld) requires the following Linux packages 
and Perl modules in order to run (see step 2 below for installation 
instructions):</p>
+<ul>
+<li>expat - A library for parsing XML</li>
+<li>expat-devel - Libraries and include files to develop XML applications with 
expat</li>
+<li>gcc - Various compilers (C, C++, Objective-C, Java, ...)</li>
+<li>krb5-libs - The shared libraries used by Kerberos 5</li>
+<li>krb5-devel - Development files needed to compile Kerberos 5 programs</li>
+<li>libxml2 - Library providing XML and HTML support</li>
+<li>libxml2-devel - Libraries, includes, etc. to develop XML and HTML 
applications</li>
+<li>mysql - MySQL client programs and shared libraries</li>
+<li>nmap - Network exploration tool and security scanner</li>
+<li>openssh - The OpenSSH implementation of SSH protocol versions 1 and 2</li>
+<li>openssl - The OpenSSL toolkit</li>
+<li>openssl-devel - Files for development of applications which will use 
OpenSSL</li>
+<li>perl - The Perl programming language</li>
+<li>perl-DBD-MySQL - A MySQL interface for perl</li>
+<li>xmlsec1-openssl - OpenSSL crypto plugin for XML Security Library</li>
+</ul>
+<p><strong>Required Perl Modules:</strong></p>
+<p>The VCL management node daemon (vcld) is written in Perl and has been 
tested on Perl 5.8.x. The following Perl modules available from CPAN are also 
required (see step 2 below for installation instructions):</p>
+<ul>
+<li>DBI - Generic Database Interface</li>
+<li>Digest::SHA1 - NIST SHA message digest algorithm</li>
+<li>Mail::Mailer - Simple mail agent interface</li>
+<li>Object::InsideOut - Comprehensive inside-out object support</li>
+<li>RPC::XML - Set of classes for core data, message, XML handling</li>
+<li>YAML - YAML Ain't Markup Language
+<BR></li>
+</ul>
+<hr />
+<ol>
+<li>
+<p><strong>Install the VCL Management Node Code - Perl Daemon</strong></p>
+<ul>
+<li>
+<p>If you have not already done so, download and extract the source files on 
the web server:</p>
+<div class="codehilite"><pre><span class="n">wget</span> <span 
class="o">--</span><span class="n">trust</span><span class="o">-</span><span 
class="n">server</span><span class="o">-</span><span class="n">names</span> 
<span 
class="s">&#39;http://vcl.apache.org/downloads/download.cgi?action=download&amp;filename=%2Fvcl%2Fapache-VCL-2.3.tar.bz2&#39;</span>
+<span class="n">tar</span> <span class="o">-</span><span class="n">jxvf</span> 
<span class="n">apache</span><span class="o">-</span><span 
class="n">VCL</span><span class="o">-</span><span class="mf">2.3</span><span 
class="o">.</span><span class="n">tar</span><span class="o">.</span><span 
class="n">bz2</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Copy the managementnode directory to the location where you want it to 
reside (typically /usr/local):</p>
+<div class="codehilite"><pre><span class="n">cp</span> <span 
class="o">-</span><span class="n">r</span> <span class="n">apache</span><span 
class="o">-</span><span class="n">VCL</span><span class="o">-</span><span 
class="mf">2.3</span><span class="sr">/managementnode /</span><span 
class="n">usr</span><span class="sr">/local/</span><span class="n">vcl</span>
+</pre></div>
+
+
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Install the Required Linux Packages &amp; Perl Modules</strong></p>
+<ul>
+<li>
+<p>Run the install_perl_libs.pl script located in the bin directory:</p>
+<div class="codehilite"><pre><span class="n">perl</span> <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">install_perl_libs</span><span class="o">.</span><span 
class="n">pl</span>
+</pre></div>
+
+
+</li>
+</ul>
+<p>The last line of the install_perl_libs.pl script output should be:</p>
+<p><em>COMPLETE: installed all components</em></p>
+<p>Note: The script will hang or terminate if it encounters a problem. If this 
occurs, you will need to troubleshoot the problem by looking at the output. </p>
+<p>The install_perl_libs.pl script included in the VCL distribution will 
attempt to download and install the required Linux packages and Perl modules. 
It uses the yum utility to install the required Linux packages. The required 
Perl modules are available from CPAN - The Comprehensive Perl Archive Network. 
The install_perl_libs.pl script attempts to download and install the required 
Perl modules by using the CPAN.pm module which is included with most Perl 
distributions. </p>
+<p>The yum utility should exist on any modern Red Hat-based Linux distribution 
(Red Hat, CentOS, Fedora, etc). If yum isn't available on your management node 
OS, you will need to download and install the required Linux packages manually 
or by using another package management utility. After installing the required 
Linux packages, attempt to run the install_perl_libs.pl script again.</p>
+</li>
+<li>
+<p><strong>Configure vcld.conf</strong></p>
+<ul>
+<li>
+<p>Create the /etc/vcl directory:</p>
+<div class="codehilite"><pre><span class="nb">mkdir</span> <span 
class="sr">/etc/</span><span class="n">vcl</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Copy the stock vcld.conf file to /etc/vcl:</p>
+<div class="codehilite"><pre><span class="n">cp</span> <span 
class="sr">/usr/</span><span class="nb">local</span><span 
class="sr">/vcl/</span><span class="n">etc</span><span 
class="sr">/vcl/</span><span class="n">vcld</span><span class="o">.</span><span 
class="n">conf</span> <span class="sr">/etc/</span><span class="n">vcl</span>
+</pre></div>
+
+
+</li>
+<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>
+
+
+</li>
+<li>
+<p>Save the vcld.conf file</p>
+</li>
+</ul>
+</li>
+<li>
+<p><strong>Configure the SSH Client</strong></p>
+<p>The SSH client on the management node should be configured to prevent SSH 
processes spawned by the root user to the computers it controls from hanging 
because of missing or different entries in the known_hosts file. </p>
+<ul>
+<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">&lt;br&gt;</span>
+<span class="n">UserKnownHostsFile</span> <span class="sr">/dev/</span><span 
class="n">null</span><span class="sr">&lt;br&gt;</span>
+<span class="n">StrictHostKeyChecking</span> <span class="nb">no</span><span 
class="sr">&lt;br&gt;</span>
+</pre></div>
+
+
+</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>
+<li>
+<p><strong>Install and Start the VCL Daemon (vcld) Service</strong></p>
+<ul>
+<li>
+<p>Copy the vcld service script to /etc/init.d and name it vcld:</p>
+<div class="codehilite"><pre><span class="n">cp</span> <span 
class="sr">/usr/</span><span class="nb">local</span><span 
class="sr">/vcl/</span><span class="n">bin</span><span 
class="sr">/S99vcld.linux /</span><span class="n">etc</span><span 
class="sr">/init.d/</span><span class="n">vcld</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Add the vcld service using chkconfig:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/c</span><span 
class="n">hkconfig</span> <span class="o">--</span><span class="n">add</span> 
<span class="n">vcld</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Configure the vcld service to automatically run at runtime levels 3-5:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/c</span><span 
class="n">hkconfig</span> <span class="o">--</span><span class="n">level</span> 
<span class="mi">345</span> <span class="n">vcld</span> <span 
class="n">on</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Start the vcld service:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/s</span><span 
class="n">ervice</span> <span class="n">vcld</span> <span class="n">start</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Check the vcld service by monitoring the vcld.log file:</p>
+<div class="codehilite"><pre><span class="n">tail</span> <span 
class="o">-</span><span class="n">f</span> <span class="sr">/var/</span><span 
class="nb">log</span><span class="o">/</span><span class="n">vcld</span><span 
class="o">.</span><span class="nb">log</span>
+</pre></div>
+
+
+</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>
+</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>
+</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>
+</pre></div>
+
+
+</li>
+<li>
+<p><strong>Install &amp; Configure the DHCP Service</strong></p>
+<p>DHCP service is needed for the private network to provide address to 
provisioned machines.</p>
+<ul>
+<li>
+<p>Install dhcp if it is not already installed:</p>
+<div class="codehilite"><pre><span class="n">yum</span> <span 
class="n">install</span> <span class="n">dhcp</span> <span 
class="o">-</span><span class="n">y</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Configure the dhcpd service to automatically start at runlevels 3-5:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/c</span><span 
class="n">hkconfig</span> <span class="n">dhcpd</span> <span class="n">on</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Configure the dhcpd.conf file.</p>
+<div class="codehilite"><pre><span class="n">vi</span> <span 
class="sr">/etc/</span><span class="n">dhcpd</span><span 
class="o">.</span><span class="n">conf</span>
+<span class="o">-</span><span class="ow">or</span><span class="o">-</span>
+<span class="n">vi</span> <span class="sr">/etc/</span><span 
class="n">dhcp</span><span class="o">/</span><span class="n">dhcpd</span><span 
class="o">.</span><span class="n">conf</span>
+</pre></div>
+
+
+</li>
+</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>
+    <span class="p">}</span>
+</pre></div>
+
+
+<p>You will add host definitions to the dhcpd.conf file after you add 
computers to VCL using the website. 
+The website will display the dhcpd.conf host definitions after the computers 
have been added to VCL, 
+which can be copied and pasted into the dhcpd.conf file.</p>
+<ul>
+<li>
+<p>Start the dhcpd service:</p>
+<div class="codehilite"><pre><span class="sr">/sbin/s</span><span 
class="n">ervice</span> <span class="n">dhcpd</span> <span 
class="n">start</span>
+</pre></div>
+
+
+</li>
+</ul>
+</li>
+</ol>
+<hr />
+  </div>
+  
+  <div id="footer">
+    <div class="copyright">
+      <p>
+        Copyright &copy; 2012 The Apache Software Foundation, Licensed under 
+        the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache 
License, Version 2.0</a>.
+        <br />
+        Apache and the Apache feather logo are trademarks of The Apache 
Software Foundation.
+      </p>
+    </div>
+  </div>
+  
+</body>
+</html>

svn commit: r841429 - in /websites/staging/vcl/trunk/content: ./ docs/VCL 2.3.1 Installation Guide docs/VCL231InstallGuide.html

Reply via email to