From: Mark Huang Date: Mon, 24 Apr 2006 22:15:42 +0000 (+0000) Subject: regenerate X-Git-Tag: myplc-0_4-rc1~54 X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=cdfcd5a279e8d12d310803ef70e64867f5687e5f;p=myplc.git regenerate --- diff --git a/doc/myplc.pdf b/doc/myplc.pdf index 17e99a3..afa0578 100644 Binary files a/doc/myplc.pdf and b/doc/myplc.pdf differ diff --git a/doc/myplc.php b/doc/myplc.php index efcba75..e843064 100644 --- a/doc/myplc.php +++ b/doc/myplc.php @@ -13,7 +13,7 @@

-MyPLC User's Guide

+MyPLC User's Guide

Mark Huang

@@ -41,21 +41,22 @@

Table of Contents

-
1. Overview
-
2. Installation
-
3. Quickstart
+
1. Overview
+
2. Installation
+
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
-
Bibliography
+
A. Configuration variables
+
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 @@ -79,14 +80,14 @@

-2. Installation

+2. Installation

Though internally composed of commodity software subpackages, MyPLC should be treated as a monolithic software application. MyPLC is distributed as single RPM package that has 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 myplc-0.3-1.planetlab.i386.rpm
 
@@ -182,7 +183,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
 
@@ -207,13 +208,13 @@ chkconfig plc on

-3. Quickstart

+3. 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  ]
@@ -281,7 +282,7 @@ PLC: Rebuilding Boot Manager:                              [  OK  ]
     visit http://localhost/, which should bring you
     to the front page of your PLC installation. The password of the
     default administrator account
-    root@test.planet-lab.org (set by
+    root@localhost.localdomain (set by
     PLC_ROOT_USER) is root (set by
     PLC_ROOT_PASSWORD).

 

@@ -337,7 +338,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 @@ -361,12 +362,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
@@ -389,7 +390,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 @@ -404,7 +405,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
 
@@ -414,9 +415,480 @@ vserver pl_conf exec service pl_conf restart
+
+

+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 + variables and their defaults may be defined in site-specific XML + templates that should be placed in + /etc/planetlab/configs/.

+
+
PLC_NAME
+
+

+ Type: string

+

+ Default: PlanetLab Test

+

The name of this PLC installation. It is used in + the name of the default system site (e.g., PlanetLab Central) + and in the names of various administrative entities (e.g., + PlanetLab Support).

+
+
PLC_SLICE_PREFIX
+
+

+ Type: string

+

+ Default: pl

+

The abbreviated name of this PLC + installation. It is used as the prefix for system slices + (e.g., pl_conf). Warning: Currently, this variable should + not be changed.

+
+
PLC_ROOT_USER
+
+

+ Type: email

+

+ Default: root@localhost.localdomain

+

The name of the initial administrative + account. We recommend that this account be used only to create + additional accounts associated with real + administrators, then disabled.

+
+
PLC_ROOT_PASSWORD
+
+

+ Type: password

+

+ Default: root

+

The password of the initial administrative + account. Also the password of the root account on the Boot + CD.

+
+
PLC_ROOT_SSH_KEY_PUB
+
+

+ Type: file

+

+ Default: /etc/planetlab/root_ssh_key.pub

+

The SSH public key used to access the root + account on your nodes.

+
+
PLC_ROOT_SSH_KEY
+
+

+ Type: file

+

+ Default: /etc/planetlab/root_ssh_key.rsa

+

The SSH private key used to access the root + account on your nodes.

+
+
PLC_DEBUG_SSH_KEY_PUB
+
+

+ Type: file

+

+ Default: /etc/planetlab/debug_ssh_key.pub

+

The SSH public key used to access the root + account on your nodes when they are in Debug mode.

+
+
PLC_DEBUG_SSH_KEY
+
+

+ Type: file

+

+ Default: /etc/planetlab/debug_ssh_key.rsa

+

The SSH private key used to access the root + account on your nodes when they are in Debug mode.

+
+
PLC_ROOT_GPG_KEY_PUB
+
+

+ Type: file

+

+ Default: /etc/planetlab/pubring.gpg

+

The GPG public keyring used to sign the Boot + Manager and all node packages.

+
+
PLC_ROOT_GPG_KEY
+
+

+ Type: file

+

+ Default: /etc/planetlab/secring.gpg

+

The SSH private key used to access the root + account on your nodes.

+
+
PLC_NET_DNS1
+
+

+ Type: ip

+

+ Default: 128.112.136.10

+

Primary DNS server address.

+
+
PLC_NET_DNS2
+
+

+ Type: ip

+

+ Default: 128.112.136.12

+

Secondary DNS server address.

+
+
PLC_MAIL_ENABLED
+
+

+ Type: boolean

+

+ Default: false

+

Set to false to suppress all e-mail notifications + and warnings.

+
+
PLC_MAIL_SUPPORT_ADDRESS
+
+

+ Type: email

+

+ Default: root+support@localhost.localdomain

+

This address is used for support + requests. Support requests may include traffic complaints, + security incident reporting, web site malfunctions, and + general requests for information. We recommend that the + address be aliased to a ticketing system such as Request + Tracker.

+
+
PLC_MAIL_BOOT_ADDRESS
+
+

+ Type: email

+

+ Default: root+install-msgs@localhost.localdomain

+

The API will notify this address when a problem + occurs during node installation or boot.

+
+
PLC_MAIL_SLICE_ADDRESS
+
+

+ Type: email

+

+ Default: root+SLICE@localhost.localdomain

+

This address template is used for sending + e-mail notifications to slices. SLICE will be replaced with + the name of the slice.

+
+
PLC_DB_ENABLED
+
+

+ Type: boolean

+

+ Default: true

+

Enable the database server on this + machine.

+
+
PLC_DB_TYPE
+
+

+ Type: string

+

+ Default: postgresql

+

The type of database server. Currently, only + postgresql is supported.

+
+
PLC_DB_HOST
+
+

+ Type: hostname

+

+ Default: localhost

+

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

+
+
PLC_DB_PORT
+
+

+ Type: int

+

+ Default: 5432

+

The TCP port number through which the database + server should be accessed.

+
+
PLC_DB_NAME
+
+

+ Type: string

+

+ Default: planetlab3

+

The name of the database to access.

+
+
PLC_DB_USER
+
+

+ Type: string

+

+ Default: pgsqluser

+

The username to use when accessing the + database.

+
+
PLC_DB_PASSWORD
+
+

+ Type: password

+

+ Default:

+

The password to use when accessing the + database. If left blank, one will be + generated.

+
+
PLC_API_ENABLED
+
+

+ Type: boolean

+

+ Default: true

+

Enable the API server on this + machine.

+
+
PLC_API_DEBUG
+
+

+ Type: boolean

+

+ Default: false

+

Enable verbose API debugging. Do not enable on + a production system!

+
+
PLC_API_HOST
+
+

+ Type: hostname

+

+ Default: localhost

+

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.

+
+
PLC_API_PORT
+
+

+ Type: int

+

+ Default: 80

+

The TCP port number through which the API + should be accessed. Warning: SSL (port 443) access is not + fully supported by the website code yet. We recommend that + port 80 be used for now and that the API server either run + on the same machine as the web server, or that they both be + on a secure wired network.

+
+
PLC_API_PATH
+
+

+ Type: string

+

+ Default: /PLCAPI/

+

The base path of the API URL.

+
+
PLC_API_MAINTENANCE_USER
+
+

+ Type: string

+

+ Default: maint@localhost.localdomain

+

The username of the maintenance account. This + account is used by local scripts that perform automated + tasks, and cannot be used for normal logins.

+
+
PLC_API_MAINTENANCE_PASSWORD
+
+

+ Type: password

+

+ Default:

+

The password of the maintenance account. If + left blank, one will be generated. We recommend that the + password be changed periodically.

+
+
PLC_API_MAINTENANCE_SOURCES
+
+

+ Type: hostname

+

+ Default:

+

A space-separated list of IP addresses allowed + to access the API through the maintenance account. The value + of this variable is set automatically to allow only the API, + web, and boot servers, and should not be + changed.

+
+
PLC_API_SSL_CRT
+
+

+ Type: file

+

+ Default: /etc/planetlab/api_ssl.crt

+

The signed SSL certificate to use for HTTPS + access. If not specified or non-existent, a self-signed + certificate will be generated.

+
+
PLC_API_SSL_KEY
+
+

+ Type: file

+

+ Default: /etc/planetlab/api_ssl.key

+

The corresponding SSL private key used for + signing the certificate, and for signing slice tickets. If + not specified or non-existent, one will be + generated.

+
+
PLC_API_SSL_KEY_PUB
+
+

+ Type: file

+

+ Default: /etc/planetlab/api_ssl.pub

+

The corresponding SSL public key. If not + specified or non-existent, one will be + generated.

+
+
PLC_WWW_ENABLED
+
+

+ Type: boolean

+

+ Default: true

+

Enable the web server on this + machine.

+
+
PLC_WWW_DEBUG
+
+

+ Type: boolean

+

+ Default: false

+

Enable debugging output on web pages. Do not + enable on a production system!

+
+
PLC_WWW_HOST
+
+

+ Type: hostname

+

+ Default: localhost

+

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.

+
+
PLC_WWW_PORT
+
+

+ Type: int

+

+ Default: 80

+

The TCP port number through which the + unprotected portions of the web site should be + accessed.

+
+
PLC_WWW_SSL_PORT
+
+

+ Type: int

+

+ Default: 443

+

The TCP port number through which the protected + portions of the web site should be accessed.

+
+
PLC_WWW_SSL_CRT
+
+

+ Type: file

+

+ Default: /etc/planetlab/www_ssl.crt

+

The signed SSL certificate to use for HTTPS + access. If not specified or non-existent, a self-signed + certificate will be generated.

+
+
PLC_WWW_SSL_KEY
+
+

+ Type: file

+

+ Default: /etc/planetlab/www_ssl.key

+

The corresponding SSL private key. If not + specified or non-existent, one will be + generated.

+
+
PLC_BOOT_ENABLED
+
+

+ Type: boolean

+

+ Default: true

+

Enable the boot server on this + machine.

+
+
PLC_BOOT_HOST
+
+

+ Type: hostname

+

+ Default: localhost

+

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.

+
+
PLC_BOOT_PORT
+
+

+ Type: int

+

+ Default: 80

+

The TCP port number through which the + unprotected portions of the boot server should be + accessed.

+
+
PLC_BOOT_SSL_PORT
+
+

+ Type: int

+

+ Default: 443

+

The TCP port number through which the protected + portions of the boot server should be + accessed.

+
+
PLC_BOOT_SSL_CRT
+
+

+ Type: binary

+

+ Default: /etc/planetlab/boot_ssl.crt

+

The signed SSL certificate to use for HTTPS + access. If not specified, or non-existent a self-signed + certificate will be generated.

+
+
PLC_BOOT_SSL_KEY
+
+

+ Type: binary

+

+ Default: /etc/planetlab/boot_ssl.key

+

The corresponding SSL private key. If not + specified or non-existent, one will be + generated.

+
+
+

-Bibliography

+Bibliography

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

Revision History