From: Thierry Parmentelat Date: Fri, 11 Aug 2006 16:49:45 +0000 (+0000) Subject: regenerate from xml 1.12 X-Git-Tag: planetlab-4_0-rc1~111 X-Git-Url: http://git.onelab.eu/?p=myplc.git;a=commitdiff_plain;h=00b7306da94fab9fd5ae7e6526dc1161bb835300 regenerate from xml 1.12 --- diff --git a/doc/myplc.pdf b/doc/myplc.pdf index ac17097..05f7154 100644 Binary files a/doc/myplc.pdf and b/doc/myplc.pdf differ diff --git a/doc/myplc.php b/doc/myplc.php index 0bc3141..0dce9ad 100644 --- a/doc/myplc.php +++ b/doc/myplc.php @@ -13,7 +13,7 @@

-MyPLC User's Guide

+MyPLC User's Guide

Mark Huang

@@ -45,33 +45,33 @@

Table of Contents

-
1. Overview
-
1.1. Purpose of the myplc-devel +
1. Overview
+
1.1. Purpose of the myplc-devel package
2. Requirements
3. Installation
-
4. Quickstart
+
4. Quickstart
4.1. Changing the configuration
-
4.2. Installing nodes
-
4.3. Administering nodes
-
4.4. Creating a slice
+
4.2. Installing nodes
+
4.3. Administering nodes
+
4.4. Creating a slice
5. Rebuilding and customizing MyPLC
-
5.1. Installation
-
5.2. Fedora Core 4 mirror requirement
+
5.1. Installation
+
5.2. Fedora Core 4 mirror requirement
5.3. Building MyPLC
5.4. Updating CVS
-
A. Configuration variables (for myplc)
-
B. Development configuration variables(for myplc-devel)
-
Bibliography
+
A. Configuration variables (for myplc)
+
B. Development configuration variables (for myplc-devel)
+
Bibliography

-1. Overview

+1. Overview

MyPLC is a complete PlanetLab Central (PLC) portable installation contained within a chroot jail. The default installation consists of a web server, an @@ -94,7 +94,7 @@

-1.1.  Purpose of the myplc-devel +1.1.  Purpose of the myplc-devel package

The myplc package comes with all required node software, rebuilt from the public PlanetLab CVS @@ -120,9 +120,8 @@ supports rpm or not.

However, things are never that simple and there indeed are some known limitations to this, so here are a couple notes as a - recommended reading before you proceed with installing

-

As of August 2006 9, so this should apply to - myplc-0.5.2 :

+ recommended reading before you proceed with the installation.

+

As of August 2006 9 (i.e myplc-0.5) :

  • The software is vastly based on Fedora Core 4. Please note that the build server at Princeton @@ -145,6 +144,11 @@

+

  • In addition, as far as myplc is concerned, you + need to check your firewall configuration since you need, of course, + to open up the http and + https ports, so as to accept connections from + the managed nodes, and from the users desktops.

    • @@ -156,7 +160,7 @@ no external dependencies, allowing it to be installed on practically any Linux 2.6 based distribution:

    -

    Example 1. Installing MyPLC.

    +

    Example 1. Installing MyPLC.

    # If your distribution supports RPM
 rpm -U http://build.planet-lab.org/build/myplc-0_4-rc1/RPMS/i386/myplc-0.4-1.planetlab.i386.rpm
 
@@ -235,7 +239,7 @@ rpm2cpio /tmp/myplc-0.4-1.planetlab.i386.rpm | cpio -diu
  • -

    /etc/init.d/plc: This file +

    /etc/init.d/plc: This file is a System V init script installed on your host filesystem, that allows you to start up and shut down MyPLC with a single command. On a Red Hat or Fedora host system, it is customary to @@ -255,7 +259,7 @@ service plc stop the chkconfig command on a Red Hat or Fedora host system:

    -

    Example 3. Disabling automatic startup of MyPLC.

    +

    Example 3. Disabling automatic startup of MyPLC.

    # Disable automatic startup
 chkconfig plc off
 
@@ -280,13 +284,13 @@ chkconfig plc on

    -4. Quickstart

    +4. Quickstart

    • Once installed, start MyPLC (see Example 2, “Starting and stopping MyPLC.”). MyPLC must be started as root. Observe the output of this command for any failures. If no 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  ]
@@ -413,7 +417,7 @@ PLC: Signing node packages:                                [  OK  ]

    -4.2. Installing nodes

    +4.2. Installing nodes

    Install your first node by clicking Add Node under the Nodes tab. Fill in all the appropriate details, then click @@ -437,12 +441,12 @@ PLC: Signing node packages: [ OK ]

    -4.3. Administering nodes

    +4.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
    @@ -465,7 +469,7 @@ PLC: Signing node packages: [ OK ]

    -4.4. Creating a slice

    +4.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 @@ -480,7 +484,7 @@ PLC: Signing node packages: [ 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
 
@@ -509,7 +513,7 @@ vserver pl_conf exec service pl_conf restart
    repository.

    -5.1. Installation

    +5.1. Installation

    Install the MyPLC development environment similarly to how you would install MyPLC. You may install both packages on the same host system if you wish. As with MyPLC, the MyPLC development @@ -518,7 +522,7 @@ vserver pl_conf exec service pl_conf restart chroot jail should not be modified directly, as they are subject to upgrade.

    -

    Example 7. Installing the MyPLC development environment.

    +

    Example 7. Installing the MyPLC development environment.

    # If your distribution supports RPM
 rpm -U http://build.planet-lab.org/build/myplc-0_4-rc2/RPMS/i386/myplc-devel-0.4-2.planetlab.i386.rpm
 
@@ -580,7 +584,7 @@ rpm2cpio /tmp/myplc-devel-0.4-2.planetlab.i386.rpm | cpio -diu

    -5.2. Fedora Core 4 mirror requirement

    +5.2. Fedora Core 4 mirror requirement

    The MyPLC development environment requires access to a complete Fedora Core 4 i386 RPM repository, because several different filesystems based upon Fedora Core 4 are constructed @@ -612,7 +616,7 @@ rpm2cpio /tmp/myplc-devel-0.4-2.planetlab.i386.rpm | cpio -diu such as wget or rsync to download the RPMS from a public mirror:

    -

    Example 8. Setting up a local Fedora Core 4 repository.

    +

    Example 8. Setting up a local Fedora Core 4 repository.

    mkdir -p /plc/devel/data/fedora
 cd /plc/devel/data/fedora
 
@@ -640,7 +644,7 @@ done
    within the MyPLC development environment, execute the following commands as root:

    -

    Example 9. Building MyPLC.

    +

    Example 9. Building MyPLC.

    # Initialize MyPLC development environment
 service plc-devel start
 
@@ -695,7 +699,7 @@ make -C $DATE
    execute the following commands as root from within the MyPLC development environment:

    -

    Example 10. Updating /data/cvs from /data/cvs-0.4-3.

    +

    Example 10. Updating /data/cvs from /data/cvs-0.4-3.

    Warning: This may cause severe, irreversible changes to be made to your local repository. Always tag your local repository before @@ -725,7 +729,7 @@ rm -rf $TMP

    -A. Configuration variables (for myplc)

    +A. Configuration variables (for myplc)

    Listed below is the set of standard configuration variables and their default values, defined in the template /etc/planetlab/default_config.xml. Additional @@ -1324,7 +1328,7 @@ rm -rf $TMP

    -B. Development configuration variables(for myplc-devel)

    +B. Development configuration variables (for myplc-devel)
    PLC_DEVEL_FEDORA_RELEASE
    @@ -1376,7 +1380,7 @@ rm -rf $TMP

    -Bibliography

    +Bibliography

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

    Revision History