- fix version number, bump release number, added changelog
[myplc.git] / plc_config.xml
index a9e1a7e..5f17219 100644 (file)
@@ -6,7 +6,7 @@ Default PLC configuration file
 Mark Huang <mlhuang@cs.princeton.edu>
 Copyright (C) 2006 The Trustees of Princeton University
 
-$Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
+$Id: plc_config.xml,v 1.15 2006/07/10 21:04:17 mlhuang Exp $
 -->
 
 <!DOCTYPE configuration PUBLIC "-//PlanetLab Central//DTD PLC configuration//EN" "plc_config.dtd">
@@ -104,6 +104,66 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
       </variablelist>
     </category>
 
+    <category id="plc_ma_sa">
+      <name>Management and Slice Authority</name>
+      <description>These variables control how your site interacts
+      with other PlanetLab sites as a Management Authority (MA) and/or
+      Slice Authority (SA).</description>
+
+      <variablelist>
+       <variable id="namespace" type="ip">
+         <name>Namespace</name>
+         <value>test</value>
+         <description>The namespace of your MA/SA. This should be a
+         globally unique value assigned by PlanetLab
+         Central.</description>
+       </variable>
+
+       <variable id="ssl_key" type="file">
+         <name>SSL Private Key</name>
+         <value>/etc/planetlab/ma_sa_ssl.key</value>
+         <description>The SSL private key used for signing documents
+         with the signature of your MA/SA. If non-existent, one will
+         be generated.</description>
+       </variable>
+
+       <variable id="ssl_crt" type="file">
+         <name>SSL Public Certificate</name>
+         <value>/etc/planetlab/ma_sa_ssl.crt</value>
+         <description>The corresponding SSL public certificate. By
+         default, this certificate is self-signed. You may replace
+         the certificate later with one signed by the PLC root
+         CA.</description>
+       </variable>
+
+       <variable id="ca_ssl_crt" type="file">
+         <name>Root CA SSL Public Certificate</name>
+         <value>/etc/planetlab/ma_sa_ca_ssl.crt</value>
+         <description>If applicable, the certificate of the PLC root
+         CA. If your MA/SA certificate is self-signed, then this file
+         is the same as your MA/SA certificate.</description>
+       </variable>
+
+       <variable id="ca_ssl_key_pub" type="file">
+         <name>Root CA SSL Public Key</name>
+         <value>/etc/planetlab/ma_sa_ca_ssl.pub</value>
+         <description>If applicable, the public key of the PLC root
+         CA. If your MA/SA certificate is self-signed, then this file
+         is the same as your MA/SA public key.</description>
+       </variable>
+
+       <variable id="api_crt" type="file">
+         <name>API Certificate</name>
+         <value>/etc/planetlab/ma_sa_api.xml</value>
+         <description>The API Certificate is your MA/SA public key
+         embedded in a digitally signed XML document. By default,
+         this document is self-signed. You may replace this
+         certificate later with one signed by the PLC root
+         CA.</description>
+       </variable>
+      </variablelist>
+    </category>
+
     <category id="plc_net">
       <name>Network</name>
       <description>Network environment.</description>
@@ -111,18 +171,41 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
       <variablelist>
        <variable id="dns1" type="ip">
          <name>Primary DNS Server</name>
-         <value>128.112.136.10</value>
+         <value>127.0.0.1</value>
          <description>Primary DNS server address.</description>
        </variable>
 
        <variable id="dns2" type="ip">
          <name>Secondary DNS Server</name>
-         <value>128.112.136.12</value>
+         <value></value>
          <description>Secondary DNS server address.</description>
        </variable>
       </variablelist>
     </category>
 
+    <category id="plc_dns">
+      <name>DNS</name>
+      <description>MyPLC can provide forward DNS resolution for itself
+      and for its nodes. To enable resolution for MyPLC itself, set
+      the Primary DNS Server address to 127.0.0.1 and provide external
+      IP addresses for the database, API, web, and boot servers
+      below. To enable resolution for nodes, use the external IP
+      address of this machine as the primary DNS server address for
+      each node.</description>
+
+      <variablelist>
+        <variable id="enabled" type="boolean">
+          <name>Enable DNS</name>
+          <value>true</value>
+          <description>Enable the internal DNS server. The server does
+          not provide reverse resolution and is not a production
+          quality or scalable DNS solution. Use the internal DNS
+          server only for small deployments or for
+          testing.</description>
+        </variable>
+      </variablelist>
+    </category>
+
     <category id="plc_mail">
       <name>Mail</name>
       <description>Many maintenance scripts, as well as the API and
@@ -187,11 +270,17 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
        <variable id="host" type="hostname">
          <name>Hostname</name>
          <value>localhost.localdomain</value>
-         <description>The fully qualified hostname or IP address of
-         the database server. This hostname must be resolvable and
-         reachable by the rest of your installation.</description>
+         <description>The fully qualified hostname of the database
+         server.</description>
        </variable>
 
+        <variable id="ip" type="ip">
+          <name>IP Address</name>
+          <value>127.0.0.1</value>
+          <description>The IP address of the database server, if not
+          resolvable by the configured DNS servers.</description>
+        </variable>
+
        <variable id="port" type="int">
          <name>Port</name>
          <value>5432</value>
@@ -244,12 +333,17 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
        <variable id="host" type="hostname">
          <name>Hostname</name>
          <value>localhost.localdomain</value>
-         <description>The fully qualified hostname or IP address of
-         the API server. This hostname must be resolvable and
-         reachable by the rest of your installation, as well as your
-         nodes.</description>
+         <description>The fully qualified hostname of the API
+         server.</description>
        </variable>
 
+        <variable id="ip" type="ip">
+          <name>IP Address</name>
+          <value>127.0.0.1</value>
+          <description>The IP address of the API server, if not
+          resolvable by the configured DNS servers.</description>
+        </variable>
+
        <variable id="port" type="int">
          <name>Port</name>
          <value>80</value>
@@ -298,29 +392,30 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
             be downloaded, or its contents replaced by a file upload,
             but the actual <value> shouldn't need to be changed.  -->
 
-       <variable id="ssl_crt" type="file">
-         <name>SSL Certificate</name>
-         <value>/etc/planetlab/api_ssl.crt</value>
-         <description>The signed SSL certificate to use for HTTPS
-         access. If not specified or non-existent, a self-signed
-         certificate will be generated.</description>
-       </variable>
-
        <variable id="ssl_key" type="file">
-         <name>SSL Key</name>
+         <name>SSL Private Key</name>
          <value>/etc/planetlab/api_ssl.key</value>
-         <description>The corresponding SSL private key used for
-         signing the certificate, and for signing slice tickets. If
-         not specified or non-existent, one will be
+         <description>The SSL private key to use for encrypting HTTPS
+         traffic. If non-existent, one will be
          generated.</description>
        </variable>
 
-       <variable id="ssl_key_pub" type="file">
-         <name>SSL Key</name>
-         <value>/etc/planetlab/api_ssl.pub</value>
-         <description>The corresponding SSL public key. If not
-         specified or non-existent, one will be
-         generated.</description>
+       <variable id="ssl_crt" type="file">
+         <name>SSL Public Certificate</name>
+         <value>/etc/planetlab/api_ssl.crt</value>
+         <description>The corresponding SSL public certificate. By
+         default, this certificate is self-signed. You may replace
+         the certificate later with one signed by a root
+         CA.</description>
+       </variable>
+
+       <variable id="ca_ssl_crt" type="file">
+         <name>Root CA SSL Public Certificate</name>
+         <value>/etc/planetlab/api_ca_ssl.crt</value>
+         <description>The certificate of the root CA, if any, that
+         signed your server certificate. If your server certificate is
+         self-signed, then this file is the same as your server
+         certificate.</description>
        </variable>
       </variablelist>
     </category>
@@ -347,12 +442,17 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
        <variable id="host" type="hostname">
          <name>Hostname</name>
          <value>localhost.localdomain</value>
-         <description>The fully qualified hostname or IP address of
-         the web server. This hostname must be resolvable and
-         reachable by the rest of your installation, as well as your
-         nodes.</description>
+         <description>The fully qualified hostname of the web
+         server.</description>
        </variable>
 
+        <variable id="ip" type="ip">
+          <name>IP Address</name>
+          <value>127.0.0.1</value>
+          <description>The IP address of the web server, if not
+          resolvable by the configured DNS servers.</description>
+        </variable>
+
        <variable id="port" type="int">
          <name>Port</name>
          <value>80</value>
@@ -373,20 +473,30 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
             be downloaded, or its contents replaced by a file upload,
             but the actual <value> shouldn't need to be changed.  -->
 
+       <variable id="ssl_key" type="file">
+         <name>SSL Private Key</name>
+         <value>/etc/planetlab/www_ssl.key</value>
+         <description>The SSL private key to use for encrypting HTTPS
+         traffic. If non-existent, one will be
+         generated.</description>
+       </variable>
+
        <variable id="ssl_crt" type="file">
-         <name>SSL Certificate</name>
+         <name>SSL Public Certificate</name>
          <value>/etc/planetlab/www_ssl.crt</value>
-         <description>The signed SSL certificate to use for HTTPS
-         access. If not specified or non-existent, a self-signed
-         certificate will be generated.</description>
+         <description>The corresponding SSL public certificate for
+         the HTTP server. By default, this certificate is
+         self-signed. You may replace the certificate later with one
+         signed by a root CA.</description>
        </variable>
 
-       <variable id="ssl_key" type="file">
-         <name>SSL Key</name>
-         <value>/etc/planetlab/www_ssl.key</value>
-         <description>The corresponding SSL private key. If not
-         specified or non-existent, one will be
-         generated.</description>
+       <variable id="ca_ssl_crt" type="file">
+         <name>Root CA SSL Public Certificate</name>
+         <value>/etc/planetlab/www_ca_ssl.crt</value>
+         <description>The certificate of the root CA, if any, that
+         signed your server certificate. If your server certificate is
+         self-signed, then this file is the same as your server
+         certificate.</description>
        </variable>
       </variablelist>
     </category>
@@ -410,12 +520,17 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
        <variable id="host" type="hostname">
          <name>Hostname</name>
          <value>localhost.localdomain</value>
-         <description>The fully qualified hostname or IP address of
-         the boot server. This hostname must be resolvable and
-         reachable by the rest of your installation, as well as your
-         nodes.</description>
+         <description>The fully qualified hostname of the boot
+         server.</description>
        </variable>
 
+        <variable id="ip" type="ip">
+          <name>IP Address</name>
+          <value>127.0.0.1</value>
+          <description>The IP address of the boot server, if not
+          resolvable by the configured DNS servers.</description>
+        </variable>
+
        <variable id="port" type="int">
          <name>Port</name>
          <value>80</value>
@@ -437,20 +552,29 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
             be downloaded, or its contents replaced by a file upload,
             but the actual <value> shouldn't need to be changed.  -->
 
-       <variable id="ssl_crt" type="binary">
-         <name>SSL Certificate</name>
+       <variable id="ssl_key" type="file">
+         <name>SSL Private Key</name>
+         <value>/etc/planetlab/boot_ssl.key</value>
+         <description>The SSL private key to use for encrypting HTTPS
+         traffic.</description>
+       </variable>
+
+       <variable id="ssl_crt" type="file">
+         <name>SSL Public Certificate</name>
          <value>/etc/planetlab/boot_ssl.crt</value>
-         <description>The signed SSL certificate to use for HTTPS
-         access. If not specified, or non-existent a self-signed
-         certificate will be generated.</description>
+         <description>The corresponding SSL public certificate for
+         the HTTP server. By default, this certificate is
+         self-signed. You may replace the certificate later with one
+         signed by a root CA.</description>
        </variable>
 
-       <variable id="ssl_key" type="binary">
-         <name>SSL Key</name>
-         <value>/etc/planetlab/boot_ssl.key</value>
-         <description>The corresponding SSL private key. If not
-         specified or non-existent, one will be
-         generated.</description>
+       <variable id="ca_ssl_crt" type="file">
+         <name>Root CA SSL Public Certificate</name>
+         <value>/etc/planetlab/boot_ca_ssl.crt</value>
+         <description>The certificate of the root CA, if any, that
+         signed your server certificate. If your server certificate is
+         self-signed, then this file is the same as your server
+         certificate.</description>
        </variable>
       </variablelist>
     </category>
@@ -476,6 +600,9 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
        <packagereq type="mandatory">sendmail</packagereq>
        <packagereq type="mandatory">sendmail-cf</packagereq>
 
+       <!-- Caching DNS server -->
+       <packagereq type="mandatory">dnsmasq</packagereq>
+
        <!-- (Optional) Synchronizing with PLC -->
        <packagereq type="mandatory">rsync</packagereq>
 
@@ -534,6 +661,7 @@ $Id: plc_config.xml,v 1.11 2006/04/24 18:04:25 mlhuang Exp $
 
        <!-- API server uses a few non-standard packages -->
        <packagereq type="mandatory">PyXML</packagereq>
+       <packagereq type="mandatory">PlanetLabAuth</packagereq>
 
        <!-- API server uses SSL to sign tickets -->
        <packagereq type="mandatory">xmlsec1</packagereq>