From: Mark Huang Date: Mon, 24 Apr 2006 22:14:56 +0000 (+0000) Subject: - add variable list as an appendix X-Git-Tag: myplc-0_4-rc1~55 X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=f614fcee4a47845a79cd3b59f228d24989e9e084;p=myplc.git - add variable list as an appendix --- diff --git a/doc/Makefile b/doc/Makefile index da88c87..0b30792 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -4,15 +4,19 @@ # Mark Huang # Copyright (C) 2006 The Trustees of Princeton University # -# $Id: Makefile,v 1.1 2006/04/12 21:21:36 mlhuang Exp $ +# $Id: Makefile,v 1.2 2006/04/13 15:11:38 mlhuang Exp $ # vpath GenDoc.xsl ../../plc_www/doc +vpath plc_config.xml .. all: myplc.pdf # Dependencies -.myplc.xml.valid: architecture.eps architecture.png +.myplc.xml.valid: architecture.eps architecture.png variables.xml + +variables.xml: variables.xsl plc_config.xml + xsltproc $(XSLFLAGS) --output $@ $^ # Validate the XML .%.xml.valid: %.xml @@ -39,7 +43,7 @@ endef $(foreach format,$(FORMATS),$(eval $(call docbook2,$(format)))) docclean: - rm -f $(patsubst %,*.%,$(FORMATS)) *.pdf .*.xml.valid + rm -f $(patsubst %,*.%,$(FORMATS)) *.pdf .*.xml.valid variables.xml clean: docclean diff --git a/doc/myplc.pdf b/doc/myplc.pdf index 4417ef9..17e99a3 100644 Binary files a/doc/myplc.pdf and b/doc/myplc.pdf differ diff --git a/doc/myplc.xml b/doc/myplc.xml index 5fdfeb6..9c1a2e3 100644 --- a/doc/myplc.xml +++ b/doc/myplc.xml @@ -1,6 +1,8 @@ +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ + +]>
MyPLC User's Guide @@ -470,6 +472,19 @@ vserver pl_conf exec service pl_conf restart]]> + + 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/. + + &Variables; + + Bibliography diff --git a/doc/variables.xml b/doc/variables.xml new file mode 100644 index 0000000..8b3bf84 --- /dev/null +++ b/doc/variables.xml @@ -0,0 +1,555 @@ + + + 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. + + + diff --git a/doc/variables.xsl b/doc/variables.xsl new file mode 100644 index 0000000..1b3c2e8 --- /dev/null +++ b/doc/variables.xsl @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + _ + + + + Type: + + + Default: + + + + + + + + + + + + + +