From: Mark Huang Date: Tue, 23 May 2006 18:15:51 +0000 (+0000) Subject: regenerate X-Git-Tag: myplc-0_4-rc1~25 X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=bdc4d5808c4599f0e7af4e991cfa025e4bfa9606;p=myplc.git regenerate --- diff --git a/doc/myplc.pdf b/doc/myplc.pdf index d64e3c0..60617cc 100644 Binary files a/doc/myplc.pdf and b/doc/myplc.pdf differ diff --git a/doc/myplc.php b/doc/myplc.php index d03b6b5..9fd62c3 100644 --- a/doc/myplc.php +++ b/doc/myplc.php @@ -46,12 +46,12 @@
3. Quickstart
3.1. Changing the configuration
-
3.2. Installing nodes
-
3.3. Administering nodes
-
3.4. Creating a slice
+
3.2. Installing nodes
+
3.3. Administering nodes
+
3.4. Creating a slice
-
A. Configuration variables
-
Bibliography
+
A. Configuration variables
+
Bibliography
@@ -154,7 +154,7 @@ rpm2cpio myplc-0.3-1.planetlab.i386.rpm | cpio -diu createrepo to update the yum caches in this directory after installing a new RPM. PlanetLab Central cannot support any - changes to this file.

+ changes to this directory.

  • /var/www/html/xml: This directory contains various XML files that the Slice Creation Service uses to determine the state of slices. These XML @@ -214,7 +214,7 @@ chkconfig plc on failures occur, you should see output similar to the following:

    -

    Example 4. A successful MyPLC startup.

    +

    Example 4. A successful MyPLC startup.

    Mounting PLC:                                              [  OK  ]
     PLC: Generating network files:                             [  OK  ]
     PLC: Starting system logger:                               [  OK  ]
    @@ -223,9 +223,11 @@ PLC: Generating SSL certificates:                          [  OK  ]
     PLC: Generating SSH keys:                                  [  OK  ]
     PLC: Starting web server:                                  [  OK  ]
     PLC: Bootstrapping the database:                           [  OK  ]
    +PLC: Starting DNS server:                                  [  OK  ]
     PLC: Starting crond:                                       [  OK  ]
     PLC: Rebuilding Boot CD:                                   [  OK  ]
     PLC: Rebuilding Boot Manager:                              [  OK  ]
    +PLC: Signing node packages:                                [  OK  ]
     

    If /plc/root is mounted successfully, a @@ -241,8 +243,11 @@ PLC: Rebuilding Boot Manager: [ OK ] mounts, or your kernel may not support loopback mounting, bind mounting, or the ext3 filesystem. Try freeing at least one loopback device, or re-compiling your kernel to support loopback - mounting, bind mounting, and the ext3 - filesystem.

  • + mounting, bind mounting, and the ext3 filesystem. SELinux may + also be enabled. If you install MyPLC on Fedora Core 4 or 5, use + the Security Level Configuration + utility to configure SELinux to be + Permissive.

  • Starting database server: If this step fails, check /plc/root/var/log/pgsql and @@ -277,12 +282,6 @@ PLC: Rebuilding Boot Manager: [ OK ] generates the initial set of XML files that the Slice Creation Service uses to determine slice state.

  • -

    Please also note that SELinux, when enabled, has been - reported to prevent the system from operating smoothly. These - reports were based on attempts made on FC4 and FC5. If you run any - of those linux distributions, you should use the 'Security Level - Configuration' utility and make sure SELinux is not configured as - 'Enforcing', but as 'Permissive' at most.

    If no failures occur, then MyPLC should be active with a default configuration. Open a web browser on the host system and visit http://localhost/, which should bring you @@ -322,18 +321,16 @@ PLC: Rebuilding Boot Manager: [ OK ] name of your PLC installation.

  • PLC_ROOT_PASSWORD: Change this to a more secure password.

  • -
  • PLC_NET_DNS1, - PLC_NET_DNS2: Change these to the IP addresses - of your primary and secondary DNS servers. Check - /etc/resolv.conf on your host - filesystem.

  • PLC_MAIL_SUPPORT_ADDRESS: Change this to the e-mail address at which you would like to receive support requests.

  • PLC_DB_HOST, - PLC_API_HOST, PLC_WWW_HOST, - PLC_BOOT_HOST: Change all of these to the - preferred FQDN of your host system.

  • + PLC_DB_IP, PLC_API_HOST, + PLC_API_IP, PLC_WWW_HOST, + PLC_WWW_IP, PLC_BOOT_HOST, + PLC_BOOT_IP: Change all of these to the + preferred FQDN and external IP address of your host + system.

    After changing these variables, save the file, then restart MyPLC with service plc start. You @@ -344,7 +341,7 @@ PLC: Rebuilding Boot Manager: [ OK ]

    -3.2. Installing nodes

    +3.2. Installing nodes

    Install your first node by clicking Add Node under the Nodes tab. Fill in all the appropriate details, then click @@ -368,12 +365,12 @@ PLC: Rebuilding Boot Manager: [ OK ]

    -3.3. Administering nodes

    +3.3. Administering nodes

    You may administer nodes as root by using the SSH key stored in /etc/planetlab/root_ssh_key.rsa.

    -

    Example 5. Accessing nodes via SSH. Replace +

    Example 5. Accessing nodes via SSH. Replace node with the hostname of the node.

    ssh -i /etc/planetlab/root_ssh_key.rsa root@node
    @@ -396,7 +393,7 @@ PLC: Rebuilding Boot Manager: [ OK ]

    -3.4. Creating a slice

    +3.4. Creating a slice

    Create a slice by clicking Create Slice under the Slices tab. Fill in all the appropriate details, then click Create. Add @@ -411,7 +408,7 @@ PLC: Rebuilding Boot Manager: [ OK ] to determine if it needs to create or delete any slices. You may accelerate this process manually if desired.

    -

    Example 6. Forcing slice creation on a node.

    +

    Example 6. Forcing slice creation on a node.

    # Update slices.xml immediately
     service plc start crond
     
    @@ -423,7 +420,7 @@ vserver pl_conf exec service pl_conf restart

    -A. Configuration variables

    +A. Configuration variables

    Listed below is the set of standard configuration variables and their default values, defined in the template /etc/planetlab/default_config.xml. Additional @@ -533,7 +530,7 @@ vserver pl_conf exec service pl_conf restart

    Type: ip

    - Default: 128.112.136.10

    + Default: 127.0.0.1

    Primary DNS server address.

    PLC_NET_DNS2
    @@ -541,9 +538,21 @@ vserver pl_conf exec service pl_conf restart

    Type: ip

    - Default: 128.112.136.12

    + Default:

    Secondary DNS server address.

    +
    PLC_DNS_ENABLED
    +
    +

    + Type: boolean

    +

    + Default: true

    +

    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.

    +
    PLC_MAIL_ENABLED

    @@ -609,9 +618,17 @@ vserver pl_conf exec service pl_conf restart Type: hostname

    Default: localhost.localdomain

    -

    The fully qualified hostname or IP address of - the database server. This hostname must be resolvable and - reachable by the rest of your installation.

    +

    The fully qualified hostname of the database + server.

    +
    +
    PLC_DB_IP
    +
    +

    + Type: ip

    +

    + Default: 127.0.0.1

    +

    The IP address of the database server, if not + resolvable by the configured DNS servers.

    PLC_DB_PORT
    @@ -673,10 +690,17 @@ vserver pl_conf exec service pl_conf restart Type: hostname

    Default: localhost.localdomain

    -

    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.

    +

    The fully qualified hostname of the API + server.

    +
    +
    PLC_API_IP
    +
    +

    + Type: ip

    +

    + Default: 127.0.0.1

    +

    The IP address of the API server, if not + resolvable by the configured DNS servers.

    PLC_API_PORT
    @@ -786,10 +810,17 @@ vserver pl_conf exec service pl_conf restart Type: hostname

    Default: localhost.localdomain

    -

    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.

    +

    The fully qualified hostname of the web + server.

    +
    +
    PLC_WWW_IP
    +
    +

    + Type: ip

    +

    + Default: 127.0.0.1

    +

    The IP address of the web server, if not + resolvable by the configured DNS servers.

    PLC_WWW_PORT
    @@ -845,10 +876,17 @@ vserver pl_conf exec service pl_conf restart Type: hostname

    Default: localhost.localdomain

    -

    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.

    +

    The fully qualified hostname of the boot + server.

    +
    +
    PLC_BOOT_IP
    +
    +

    + Type: ip

    +

    + Default: 127.0.0.1

    +

    The IP address of the boot server, if not + resolvable by the configured DNS servers.

    PLC_BOOT_PORT
    @@ -894,7 +932,7 @@ vserver pl_conf exec service pl_conf restart

    -Bibliography

    +Bibliography

    [1] Mark Huang. PlanetLab Technical Contact's Guide.

    diff --git a/doc/myplc.xml b/doc/myplc.xml index 4bbd6ea..9bf5e1a 100644 --- a/doc/myplc.xml +++ b/doc/myplc.xml @@ -165,7 +165,7 @@ rpm2cpio myplc-0.3-1.planetlab.i386.rpm | cpio -diu]]> createrepo to update the yum caches in this directory after installing a new RPM. PlanetLab Central cannot support any - changes to this file. + changes to this directory. /var/www/html/xml: This directory contains various XML files that the Slice Creation @@ -247,9 +247,11 @@ PLC: Generating SSL certificates: [ OK ] PLC: Generating SSH keys: [ OK ] PLC: Starting web server: [ OK ] PLC: Bootstrapping the database: [ OK ] +PLC: Starting DNS server: [ OK ] PLC: Starting crond: [ OK ] PLC: Rebuilding Boot CD: [ OK ] PLC: Rebuilding Boot Manager: [ OK ] +PLC: Signing node packages: [ OK ] ]]> @@ -267,8 +269,11 @@ PLC: Rebuilding Boot Manager: [ OK ] mounts, or your kernel may not support loopback mounting, bind mounting, or the ext3 filesystem. Try freeing at least one loopback device, or re-compiling your kernel to support loopback - mounting, bind mounting, and the ext3 - filesystem. + mounting, bind mounting, and the ext3 filesystem. SELinux may + also be enabled. If you install MyPLC on Fedora Core 4 or 5, use + the Security Level Configuration + utility to configure SELinux to be + Permissive. Starting database server: If this step fails, check @@ -308,13 +313,6 @@ PLC: Rebuilding Boot Manager: [ OK ] Service uses to determine slice state. - Please also note that SELinux, when enabled, has been - reported to prevent the system from operating smoothly. These - reports were based on attempts made on FC4 and FC5. If you run any - of those linux distributions, you should use the 'Security Level - Configuration' utility and make sure SELinux is not configured as - 'Enforcing', but as 'Permissive' at most. - If no failures occur, then MyPLC should be active with a default configuration. Open a web browser on the host system and visit http://localhost/, which should bring you @@ -359,20 +357,17 @@ PLC: Rebuilding Boot Manager: [ OK ] PLC_ROOT_PASSWORD: Change this to a more secure password. - PLC_NET_DNS1, - PLC_NET_DNS2: Change these to the IP addresses - of your primary and secondary DNS servers. Check - /etc/resolv.conf on your host - filesystem. - PLC_MAIL_SUPPORT_ADDRESS: Change this to the e-mail address at which you would like to receive support requests. PLC_DB_HOST, - PLC_API_HOST, PLC_WWW_HOST, - PLC_BOOT_HOST: Change all of these to the - preferred FQDN of your host system. + PLC_DB_IP, PLC_API_HOST, + PLC_API_IP, PLC_WWW_HOST, + PLC_WWW_IP, PLC_BOOT_HOST, + PLC_BOOT_IP: Change all of these to the + preferred FQDN and external IP address of your host + system. After changing these variables, save the file, then diff --git a/doc/variables.xml b/doc/variables.xml index 00cc12d..c3f7af3 100644 --- a/doc/variables.xml +++ b/doc/variables.xml @@ -122,7 +122,7 @@ Type: ip - Default: 128.112.136.10 + Default: 127.0.0.1 Primary DNS server address. @@ -132,10 +132,24 @@ Type: ip - Default: 128.112.136.12 + Default: Secondary DNS server address. + + PLC_DNS_ENABLED + + + Type: boolean + + Default: true + 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. + + PLC_MAIL_ENABLED @@ -214,9 +228,19 @@ Type: hostname Default: localhost.localdomain - The fully qualified hostname or IP address of - the database server. This hostname must be resolvable and - reachable by the rest of your installation. + The fully qualified hostname of the database + server. + + + + PLC_DB_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the database server, if not + resolvable by the configured DNS servers. @@ -292,10 +316,19 @@ Type: hostname Default: localhost.localdomain - 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. + The fully qualified hostname of the API + server. + + + + PLC_API_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the API server, if not + resolvable by the configured DNS servers. @@ -427,10 +460,19 @@ Type: hostname Default: localhost.localdomain - 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. + The fully qualified hostname of the web + server. + + + + PLC_WWW_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the web server, if not + resolvable by the configured DNS servers. @@ -498,10 +540,19 @@ Type: hostname Default: localhost.localdomain - 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. + The fully qualified hostname of the boot + server. + + + + PLC_BOOT_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the boot server, if not + resolvable by the configured DNS servers.