X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=doc%2Fplc_variables.xml;fp=doc%2Fplc_variables.xml;h=e0d7806fdf2985d01340b1a05c21075074832308;hb=ef7a909a625a7f643c5fc78afac5c6150a265252;hp=0000000000000000000000000000000000000000;hpb=02659450a81bbc0869313218132c89a349673b8f;p=myplc.git diff --git a/doc/plc_variables.xml b/doc/plc_variables.xml new file mode 100644 index 0000000..e0d7806 --- /dev/null +++ b/doc/plc_variables.xml @@ -0,0 +1,709 @@ + + + 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_MA_SA_NAMESPACE + + + Type: ip + + Default: test + The namespace of your MA/SA. This should be a + globally unique value assigned by PlanetLab + Central. + + + + PLC_MA_SA_SSL_KEY + + + Type: file + + Default: /etc/planetlab/ma_sa_ssl.key + The SSL private key used for signing documents + with the signature of your MA/SA. If non-existent, one will + be generated. + + + + PLC_MA_SA_SSL_CRT + + + Type: file + + Default: /etc/planetlab/ma_sa_ssl.crt + The corresponding SSL public certificate. By + default, this certificate is self-signed. You may replace + the certificate later with one signed by the PLC root + CA. + + + + PLC_MA_SA_CA_SSL_CRT + + + Type: file + + Default: /etc/planetlab/ma_sa_ca_ssl.crt + If applicable, the certificate of the PLC root + CA. If your MA/SA certificate is self-signed, then this file + is the same as your MA/SA certificate. + + + + PLC_MA_SA_CA_SSL_KEY_PUB + + + Type: file + + Default: /etc/planetlab/ma_sa_ca_ssl.pub + If applicable, the public key of the PLC root + CA. If your MA/SA certificate is self-signed, then this file + is the same as your MA/SA public key. + + + + PLC_MA_SA_API_CRT + + + Type: file + + Default: /etc/planetlab/ma_sa_api.xml + The API Certificate is your MA/SA public key + embedded in a digitally signed XML document. By default, + this document is self-signed. You may replace this + certificate later with one signed by the PLC root + CA. + + + + PLC_NET_DNS1 + + + Type: ip + + Default: 127.0.0.1 + Primary DNS server address. + + + + PLC_NET_DNS2 + + + Type: ip + + Default: + Secondary DNS server address. + + + + PLC_DNS_ENABLED + + + Type: boolean + + Default: true + Enable the internal DNS server. The server does + not provide reverse resolution and is not a production + quality or scalable DNS solution. Use the internal DNS + server only for small deployments or for + testing. + + + + 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.localdomain + The fully qualified hostname of the database + server. + + + + PLC_DB_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the database server, if not + resolvable by the configured DNS servers. + + + + 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.localdomain + The fully qualified hostname of the API + server. + + + + PLC_API_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the API server, if not + resolvable by the configured DNS servers. + + + + 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_KEY + + + Type: file + + Default: /etc/planetlab/api_ssl.key + The SSL private key to use for encrypting HTTPS + traffic. If non-existent, one will be + generated. + + + + PLC_API_SSL_CRT + + + Type: file + + Default: /etc/planetlab/api_ssl.crt + The corresponding SSL public certificate. By + default, this certificate is self-signed. You may replace + the certificate later with one signed by a root + CA. + + + + PLC_API_CA_SSL_CRT + + + Type: file + + Default: /etc/planetlab/api_ca_ssl.crt + The certificate of the root CA, if any, that + signed your server certificate. If your server certificate is + self-signed, then this file is the same as your server + certificate. + + + + 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.localdomain + The fully qualified hostname of the web + server. + + + + PLC_WWW_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the web server, if not + resolvable by the configured DNS servers. + + + + 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_KEY + + + Type: file + + Default: /etc/planetlab/www_ssl.key + The SSL private key to use for encrypting HTTPS + traffic. If non-existent, one will be + generated. + + + + PLC_WWW_SSL_CRT + + + Type: file + + Default: /etc/planetlab/www_ssl.crt + The corresponding SSL public certificate for + the HTTP server. By default, this certificate is + self-signed. You may replace the certificate later with one + signed by a root CA. + + + + PLC_WWW_CA_SSL_CRT + + + Type: file + + Default: /etc/planetlab/www_ca_ssl.crt + The certificate of the root CA, if any, that + signed your server certificate. If your server certificate is + self-signed, then this file is the same as your server + certificate. + + + + PLC_BOOT_ENABLED + + + Type: boolean + + Default: true + Enable the boot server on this + machine. + + + + PLC_BOOT_HOST + + + Type: hostname + + Default: localhost.localdomain + The fully qualified hostname of the boot + server. + + + + PLC_BOOT_IP + + + Type: ip + + Default: 127.0.0.1 + The IP address of the boot server, if not + resolvable by the configured DNS servers. + + + + 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_KEY + + + Type: file + + Default: /etc/planetlab/boot_ssl.key + The SSL private key to use for encrypting HTTPS + traffic. + + + + PLC_BOOT_SSL_CRT + + + Type: file + + Default: /etc/planetlab/boot_ssl.crt + The corresponding SSL public certificate for + the HTTP server. By default, this certificate is + self-signed. You may replace the certificate later with one + signed by a root CA. + + + + PLC_BOOT_CA_SSL_CRT + + + Type: file + + Default: /etc/planetlab/boot_ca_ssl.crt + The certificate of the root CA, if any, that + signed your server certificate. If your server certificate is + self-signed, then this file is the same as your server + certificate. + + +