From: Thierry Parmentelat Date: Fri, 18 Aug 2006 14:38:43 +0000 (+0000) Subject: increase revision id to 1.2 for previous changes X-Git-Tag: planetlab-4_0-rc1~97 X-Git-Url: http://git.onelab.eu/?p=myplc.git;a=commitdiff_plain;h=99190e7caab7c2ed4daa3c30df8726a0f7f3c6f4 increase revision id to 1.2 for previous changes describes /root under /data --- diff --git a/doc/myplc.pdf b/doc/myplc.pdf index f4af01e..09412d2 100644 Binary files a/doc/myplc.pdf and b/doc/myplc.pdf differ diff --git a/doc/myplc.php b/doc/myplc.php index c4086c2..be76869 100644 --- a/doc/myplc.php +++ b/doc/myplc.php @@ -13,7 +13,7 @@

-MyPLC User's Guide

+MyPLC User's Guide

Mark Huang

@@ -29,6 +29,15 @@ + + + + + +
Revision History
MLH

Add development environment.

Revision 1.2August 18, 2006TPT
+

Review section on configuration and introduce plc-config-tty.

+

Present implementation details last.

+

Abstract

@@ -45,41 +54,41 @@

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.4. Login as a real user
+
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
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 @@ -102,7 +111,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 @@ -169,7 +178,7 @@ practically any Linux 2.6 based distribution.

-3.1. Installing MyPLC.

+3.1. Installing MyPLC.

  • If your distribution supports RPM:

    @@ -196,11 +205,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 @@ -212,11 +221,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
@@ -234,7 +243,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 - 
@@ -244,7 +253,7 @@ Want to create /etc/planetlab/configs [y]/n ? y
 Created directory /etc/planetlab/configs
 Enter command (u for usual changes, w to save, ? for help) u
 == PLC_NAME : [PlanetLab Test] OneLab
-== PLC_ROOT_USER : [root@localhost.localdomain] odie.inria.fr
+== PLC_ROOT_USER : [root@localhost.localdomain] root@odie.inria.fr
 == PLC_ROOT_PASSWORD : [root] plain-passwd
 == PLC_MAIL_SUPPORT_ADDRESS : [root+support@localhost.localdomain] support@one-lab.org
 == PLC_DB_HOST : [localhost.localdomain] odie.inria.fr
@@ -271,7 +280,7 @@ Enter command (u for usual changes, w to save, ? for help) q

If you used this method for configuring, you can skip to - the next section. As an alternative to using + the Section 3.4, “ Login as a real user ”. As an alternative to using plc-config-tty, you may also use a text editor, but this requires some understanding on how the configuration files are used within myplc. The @@ -336,7 +345,7 @@ Enter command (u for usual changes, w to save, ? for help) q

-3.4.  Login as a real user

+3.4.  Login as a real user

Now that myplc is up and running, you can connect to the web site that by default runs on port 80. You can either directly use the default administrator user that you configured @@ -349,7 +358,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 @@ -373,12 +382,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
@@ -401,7 +410,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 @@ -416,7 +425,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
 
@@ -432,7 +441,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  ]
@@ -490,7 +499,8 @@ PLC: Signing node packages:                                [  OK  ]
       all services, including the API server, are enabled and run on
       the same host, so check that PLC_API_HOST is
       either localhost or resolves to a local IP
-      address.

+      address. Also check that PLC_ROOT_USER looks like
+      an e-mail address.

 
  • Starting crond: If this step
       fails, it is likely that the previous steps (Starting
       web server and Bootstrapping the
@@ -579,6 +589,13 @@ PLC: Signing node packages:                                [  OK  ]
 	  Service uses to determine the state of slices. These XML
 	  files are refreshed periodically by cron
 	  jobs running in the MyPLC root.
    • 
+
  • /root: this is the
+	  location of the root-user's homedir, and for your
+	  convenience is stored under /data so
+	  that your local customizations survive across
+	  updates - this feature is inherited from the
+	  myplc-devel package, where it is probably
+	  more useful. 
    •

  • /etc/init.d/plc: This file @@ -620,7 +637,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 @@ -644,7 +661,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 @@ -699,6 +716,11 @@ PLC: Signing node packages: [ OK ] chroot jail. The build scripts in this directory are themselves source controlled; see Section 4.5, “Building MyPLC” for more information about executing builds.

    +

  • /root: this is the + location of the root-user's homedir, and for your + convenience is stored under /data so + that your local customizations survive across + updates.

  • /etc/init.d/plc-devel: This file is @@ -709,7 +731,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 @@ -741,7 +763,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
 
@@ -777,7 +799,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
 
@@ -821,18 +843,19 @@ make -C $DATE
    
 
    Because the CVS repository is not automatically upgraded,
       if you wish to keep your local repository synchronized with the
       public PlanetLab repository, it is highly recommended that you
-      use CVS's support for vendor
-      branches to track changes. Vendor branches ease the task
-      of merging upstream changes with your local modifications. To
-      import a new snapshot into your local repository (for example,
-      if you have just upgraded from
+      use CVS's support for vendor branches to track changes, as
+      described here
+      and here.
+      Vendor branches ease the task of merging upstream changes with
+      your local modifications. To import a new snapshot into your
+      local repository (for example, if you have just upgraded from
       myplc-devel-0.4-2 to
       myplc-devel-0.4-3 and you notice the new
       repository in /plc/devel/data/cvs-0.4-3),
       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
@@ -854,10 +877,10 @@ cvs -d /cvs import -m "Merging myplc-0.4-3" -ko -I ! . planetlab myplc-0_4-3
 popd
 rm -rf $TMP
    -

    If there any merge conflicts, use the command suggested by - CVS to help the merge. Explaining how to fix merge conflicts is - beyond the scope of this document; consult the CVS documentation - for more information on how to use CVS.

    +

    If there are any merge conflicts, use the command + suggested by CVS to help the merge. Explaining how to fix merge + conflicts is beyond the scope of this document; consult the CVS + documentation for more information on how to use CVS.

    @@ -872,7 +895,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
@@ -1528,7 +1551,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 b06c862..07e96a8 100644 --- a/doc/myplc.xml +++ b/doc/myplc.xml @@ -38,6 +38,15 @@ MLH Add development environment. + + 1.2 + August 18, 2006 + TPT + + Review section on configuration and introduce plc-config-tty. + Present implementation details last. + + @@ -227,7 +236,7 @@ Want to create /etc/planetlab/configs [y]/n ? y Created directory /etc/planetlab/configs Enter command (u for usual changes, w to save, ? for help) u == PLC_NAME : [PlanetLab Test] OneLab -== PLC_ROOT_USER : [root@localhost.localdomain] odie.inria.fr +== PLC_ROOT_USER : [root@localhost.localdomain] root@odie.inria.fr == PLC_ROOT_PASSWORD : [root] plain-passwd == PLC_MAIL_SUPPORT_ADDRESS : [root+support@localhost.localdomain] support@one-lab.org == PLC_DB_HOST : [localhost.localdomain] odie.inria.fr @@ -255,7 +264,7 @@ Enter command (u for usual changes, w to save, ? for help) q If you used this method for configuring, you can skip to - the next section. As an alternative to using + the . As an alternative to using plc-config-tty, you may also use a text editor, but this requires some understanding on how the configuration files are used within myplc. The @@ -327,7 +336,7 @@ Enter command (u for usual changes, w to save, ? for help) q PLC_NAME -
    Login as a real user +
    Login as a real user Now that myplc is up and running, you can connect to the web site that by default runs on port 80. You can either @@ -509,7 +518,8 @@ PLC: Signing node packages: [ OK ] all services, including the API server, are enabled and run on the same host, so check that PLC_API_HOST is either localhost or resolves to a local IP - address. + address. Also check that PLC_ROOT_USER looks like + an e-mail address. Starting crond: If this step fails, it is likely that the previous steps (Starting @@ -610,6 +620,15 @@ PLC: Signing node packages: [ OK ] Service uses to determine the state of slices. These XML files are refreshed periodically by cron jobs running in the MyPLC root. + + /root: this is the + location of the root-user's homedir, and for your + convenience is stored under /data so + that your local customizations survive across + updates - this feature is inherited from the + myplc-devel package, where it is probably + more useful. + @@ -747,8 +766,12 @@ PLC: Signing node packages: [ OK ] directory are themselves source controlled; see for more information about executing builds. - - + + /root: this is the + location of the root-user's homedir, and for your + convenience is stored under /data so + that your local customizations survive across + updates. /etc/init.d/plc-devel: This file is @@ -891,12 +914,14 @@ make -C $DATE]]> Because the CVS repository is not automatically upgraded, if you wish to keep your local repository synchronized with the public PlanetLab repository, it is highly recommended that you - use CVS's support for vendor - branches to track changes. Vendor branches ease the task - of merging upstream changes with your local modifications. To - import a new snapshot into your local repository (for example, - if you have just upgraded from + use CVS's support for vendor branches to track changes, as + described here + and here. + Vendor branches ease the task of merging upstream changes with + your local modifications. To import a new snapshot into your + local repository (for example, if you have just upgraded from myplc-devel-0.4-2 to myplc-devel-0.4-3 and you notice the new repository in /plc/devel/data/cvs-0.4-3), @@ -929,12 +954,11 @@ popd rm -rf $TMP]]> - If there any merge conflicts, use the command suggested by - CVS to help the merge. Explaining how to fix merge conflicts is - beyond the scope of this document; consult the CVS documentation - for more information on how to use CVS. -
    -
    + If there are any merge conflicts, use the command + suggested by CVS to help the merge. Explaining how to fix merge + conflicts is beyond the scope of this document; consult the CVS + documentation for more information on how to use CVS. + Configuration variables (for <emphasis>myplc</emphasis>) diff --git a/doc/plc_devel_variables.xml b/doc/plc_devel_variables.xml index 263aa3c..4dacd1c 100644 --- a/doc/plc_devel_variables.xml +++ b/doc/plc_devel_variables.xml @@ -29,7 +29,7 @@ Type: string - Default: file:///usr/share/mirrors/fedora + Default: file:///data/fedora Fedora Core mirror from which to install filesystems.