From: Thierry Parmentelat Date: Thu, 24 Aug 2006 17:13:33 +0000 (+0000) Subject: reference to the FAQ X-Git-Tag: planetlab-4_0-rc1~94 X-Git-Url: http://git.onelab.eu/?p=myplc.git;a=commitdiff_plain;h=a19ad89c8754a13b08ffcff1953514d2e021c448 reference to the FAQ --- diff --git a/doc/myplc.pdf b/doc/myplc.pdf index 09412d2..0da3ba3 100644 Binary files a/doc/myplc.pdf and b/doc/myplc.pdf differ diff --git a/doc/myplc.php b/doc/myplc.php index be76869..fc7b1e0 100644 --- a/doc/myplc.php +++ b/doc/myplc.php @@ -13,7 +13,7 @@

-MyPLC User's Guide

+MyPLC User's Guide

Mark Huang

@@ -54,41 +54,42 @@

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. Installating and using MyPLC
-
3.1. Installing MyPLC.
+
3.1. Installing MyPLC.
3.2. QuickStart
3.3. Changing the configuration
3.4. Login as a real user
-
3.5. Installing nodes
-
3.6. Administering nodes
-
3.7. Creating a slice
+
3.5. Installing nodes
+
3.6. Administering nodes
+
3.7. Creating a slice
3.8. Understanding the startup sequence
3.9. Files and directories involved in myplc
4. Rebuilding and customizing MyPLC
-
4.1. Installation
-
4.2. Configuration
+
4.1. Installation
+
4.2. Configuration
4.3. Files and directories involved in myplc-devl
-
4.4. Fedora Core 4 mirror requirement
+
4.4. Fedora Core 4 mirror requirement
4.5. Building MyPLC
4.6. Updating CVS
+
5. More information : the FAQ wiki page
A. Configuration variables (for myplc)
B. Development configuration variables (for myplc-devel)
-
Bibliography
+
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 @@ -111,7 +112,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 @@ -178,7 +179,7 @@ practically any Linux 2.6 based distribution.

-3.1. Installing MyPLC.

+3.1. Installing MyPLC.

  • If your distribution supports RPM:

    @@ -205,11 +206,11 @@ the service command to invoke System V init scripts. As the examples suggest, the service must be started as root:

    -

    Example 1. Starting MyPLC:

    +

    Example 1. Starting MyPLC:

    # service plc start
    -

    Example 2. Stopping MyPLC:

    +

    Example 2. Stopping MyPLC:

    # service plc stop

    In Section 3.8, “Understanding the startup sequence”, we provide greater @@ -221,11 +222,11 @@ chkconfig command on a Red Hat or Fedora host system:

    -

    Example 3. Disabling automatic startup of MyPLC.

    +

    Example 3. Disabling automatic startup of MyPLC.

    # chkconfig plc off
    -

    Example 4. Re-enabling automatic startup of MyPLC.

    +

    Example 4. Re-enabling automatic startup of MyPLC.

    # chkconfig plc on
@@ -243,7 +244,7 @@ guides you to the most useful ones. Here is sample session:

-

Example 5. Using plc-config-tty for configuration:

+

Example 5. Using plc-config-tty for configuration:

# service plc mount
 Mounting PLC:                                              [  OK  ]
 # chroot /plc/root su - 
@@ -358,7 +359,7 @@ Enter command (u for usual changes, w to save, ? for help) q

-3.5. Installing nodes

+3.5. Installing nodes

Install your first node by clicking Add Node under the Nodes tab. Fill in all the appropriate details, then click @@ -382,12 +383,12 @@ Enter command (u for usual changes, w to save, ? for help) q

-3.6. Administering nodes

+3.6. Administering nodes

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

-

Example 6. Accessing nodes via SSH. Replace +

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

ssh -i /etc/planetlab/root_ssh_key.rsa root@node
@@ -410,7 +411,7 @@ Enter command (u for usual changes, w to save, ? for help) q

-3.7. Creating a slice

+3.7. Creating a slice

Create a slice by clicking Create Slice under the Slices tab. Fill in all the appropriate details, then click Create. Add @@ -425,7 +426,7 @@ Enter command (u for usual changes, w to save, ? for help) q to determine if it needs to create or delete any slices. You may accelerate this process manually if desired.

-

Example 7. Forcing slice creation on a node.

+

Example 7. Forcing slice creation on a node.

# Update slices.xml immediately
 service plc start crond
 
@@ -441,7 +442,7 @@ vserver pl_conf exec service pl_conf restart
any failures. If no failures occur, you should see output similar to the following:

-

Example 8. A successful MyPLC startup.

+

Example 8. A successful MyPLC startup.

Mounting PLC:                                              [  OK  ]
 PLC: Generating network files:                             [  OK  ]
 PLC: Starting system logger:                               [  OK  ]
@@ -637,7 +638,7 @@ PLC: Signing node packages:                                [  OK  ]
     repository.

 

 

-4.1. Installation

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

-4.2. Configuration

+4.2. Configuration

The default configuration should work as-is on most sites. Configuring the development package can be achieved in a similar way as for myplc, as described in @@ -731,7 +732,7 @@ PLC: Signing node packages: [ OK ]

-4.4. Fedora Core 4 mirror requirement

+4.4. 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 @@ -763,7 +764,7 @@ PLC: Signing node packages: [ OK ] such as wget or rsync to download the RPMS from a public mirror:

-

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

+

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

# mkdir -p /plc/devel/data/fedora
 # cd /plc/devel/data/fedora
 
@@ -799,7 +800,7 @@ PLC: Signing node packages:                                [  OK  ]
       within the MyPLC development environment, execute the following
       commands as root:

 

-
Example 10. Building MyPLC.

+
Example 10. Building MyPLC.

 
# Initialize MyPLC development environment
 service plc-devel start
 
@@ -855,7 +856,7 @@ make -C $DATE

       execute the following commands as root from within the MyPLC
       development environment:

 

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

+
Example 11. 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
@@ -883,6 +884,12 @@ rm -rf $TMP
documentation for more information on how to use CVS.

+
+

+5.  More information : the FAQ wiki page

+

Please refer to, and feel free to contribute, +the FAQ page on the Princeton's wiki .

+

A. Configuration variables (for myplc)

@@ -895,7 +902,7 @@ rm -rf $TMP

This information is available online within plc-config-tty, e.g.:

-

Example A.1. Advanced usage of plc-config-tty

+

Example A.1. Advanced usage of plc-config-tty

<plc> # plc-config-tty
 Enter command (u for usual changes, w to save, ? for help) V plc_dns
 ========== Category = PLC_DNS
@@ -1551,7 +1558,7 @@ PLC_DNS_ENABLED

-Bibliography

+Bibliography

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

diff --git a/doc/myplc.xml b/doc/myplc.xml index 07e96a8..749deed 100644 --- a/doc/myplc.xml +++ b/doc/myplc.xml @@ -960,6 +960,12 @@ rm -rf $TMP]]> documentation for more information on how to use CVS. +
More information : the FAQ wiki page + + Please refer to, and feel free to contribute, +the FAQ page on the Princeton's wiki .
+ Configuration variables (for <emphasis>myplc</emphasis>) @@ -984,7 +990,6 @@ Enter command (u for usual changes, w to save, ? for help) V plc_dns PLC_DNS_ENABLED ]]> - List of the myplc configuration variables: &Variables;
Revision History