doc/variables.xml

   1 <variablelist>
   2   <varlistentry>
   3     <term>PLC_NAME</term>
   4     <listitem>
   5       <para>
   6                   Type: string</para>
   7       <para>
   8                   Default: PlanetLab Test</para>
   9       <para>The name of this PLC installation. It is used in
  10           the name of the default system site (e.g., PlanetLab Central)
  11           and in the names of various administrative entities (e.g.,
  12           PlanetLab Support).</para>
  13     </listitem>
  14   </varlistentry>
  15   <varlistentry>
  16     <term>PLC_SLICE_PREFIX</term>
  17     <listitem>
  18       <para>
  19                   Type: string</para>
  20       <para>
  21                   Default: pl</para>
  22       <para>The abbreviated name of this PLC
  23           installation. It is used as the prefix for system slices
  24           (e.g., pl_conf). Warning: Currently, this variable should
  25           not be changed.</para>
  26     </listitem>
  27   </varlistentry>
  28   <varlistentry>
  29     <term>PLC_ROOT_USER</term>
  30     <listitem>
  31       <para>
  32                   Type: email</para>
  33       <para>
  34                   Default: root@localhost.localdomain</para>
  35       <para>The name of the initial administrative
  36           account. We recommend that this account be used only to create
  37           additional accounts associated with real
  38           administrators, then disabled.</para>
  39     </listitem>
  40   </varlistentry>
  41   <varlistentry>
  42     <term>PLC_ROOT_PASSWORD</term>
  43     <listitem>
  44       <para>
  45                   Type: password</para>
  46       <para>
  47                   Default: root</para>
  48       <para>The password of the initial administrative
  49           account. Also the password of the root account on the Boot
  50           CD.</para>
  51     </listitem>
  52   </varlistentry>
  53   <varlistentry>
  54     <term>PLC_ROOT_SSH_KEY_PUB</term>
  55     <listitem>
  56       <para>
  57                   Type: file</para>
  58       <para>
  59                   Default: /etc/planetlab/root_ssh_key.pub</para>
  60       <para>The SSH public key used to access the root
  61           account on your nodes.</para>
  62     </listitem>
  63   </varlistentry>
  64   <varlistentry>
  65     <term>PLC_ROOT_SSH_KEY</term>
  66     <listitem>
  67       <para>
  68                   Type: file</para>
  69       <para>
  70                   Default: /etc/planetlab/root_ssh_key.rsa</para>
  71       <para>The SSH private key used to access the root
  72           account on your nodes.</para>
  73     </listitem>
  74   </varlistentry>
  75   <varlistentry>
  76     <term>PLC_DEBUG_SSH_KEY_PUB</term>
  77     <listitem>
  78       <para>
  79                   Type: file</para>
  80       <para>
  81                   Default: /etc/planetlab/debug_ssh_key.pub</para>
  82       <para>The SSH public key used to access the root
  83           account on your nodes when they are in Debug mode.</para>
  84     </listitem>
  85   </varlistentry>
  86   <varlistentry>
  87     <term>PLC_DEBUG_SSH_KEY</term>
  88     <listitem>
  89       <para>
  90                   Type: file</para>
  91       <para>
  92                   Default: /etc/planetlab/debug_ssh_key.rsa</para>
  93       <para>The SSH private key used to access the root
  94           account on your nodes when they are in Debug mode.</para>
  95     </listitem>
  96   </varlistentry>
  97   <varlistentry>
  98     <term>PLC_ROOT_GPG_KEY_PUB</term>
  99     <listitem>
 100       <para>
 101                   Type: file</para>
 102       <para>
 103                   Default: /etc/planetlab/pubring.gpg</para>
 104       <para>The GPG public keyring used to sign the Boot
 105           Manager and all node packages.</para>
 106     </listitem>
 107   </varlistentry>
 108   <varlistentry>
 109     <term>PLC_ROOT_GPG_KEY</term>
 110     <listitem>
 111       <para>
 112                   Type: file</para>
 113       <para>
 114                   Default: /etc/planetlab/secring.gpg</para>
 115       <para>The SSH private key used to access the root
 116           account on your nodes.</para>
 117     </listitem>
 118   </varlistentry>
 119   <varlistentry>
 120     <term>PLC_NET_DNS1</term>
 121     <listitem>
 122       <para>
 123                   Type: ip</para>
 124       <para>
 125                   Default: 128.112.136.10</para>
 126       <para>Primary DNS server address.</para>
 127     </listitem>
 128   </varlistentry>
 129   <varlistentry>
 130     <term>PLC_NET_DNS2</term>
 131     <listitem>
 132       <para>
 133                   Type: ip</para>
 134       <para>
 135                   Default: 128.112.136.12</para>
 136       <para>Secondary DNS server address.</para>
 137     </listitem>
 138   </varlistentry>
 139   <varlistentry>
 140     <term>PLC_MAIL_ENABLED</term>
 141     <listitem>
 142       <para>
 143                   Type: boolean</para>
 144       <para>
 145                   Default: false</para>
 146       <para>Set to false to suppress all e-mail notifications
 147           and warnings.</para>
 148     </listitem>
 149   </varlistentry>
 150   <varlistentry>
 151     <term>PLC_MAIL_SUPPORT_ADDRESS</term>
 152     <listitem>
 153       <para>
 154                   Type: email</para>
 155       <para>
 156                   Default: root+support@localhost.localdomain</para>
 157       <para>This address is used for support
 158           requests. Support requests may include traffic complaints,
 159           security incident reporting, web site malfunctions, and
 160           general requests for information. We recommend that the
 161           address be aliased to a ticketing system such as Request
 162           Tracker.</para>
 163     </listitem>
 164   </varlistentry>
 165   <varlistentry>
 166     <term>PLC_MAIL_BOOT_ADDRESS</term>
 167     <listitem>
 168       <para>
 169                   Type: email</para>
 170       <para>
 171                   Default: root+install-msgs@localhost.localdomain</para>
 172       <para>The API will notify this address when a problem
 173           occurs during node installation or boot.</para>
 174     </listitem>
 175   </varlistentry>
 176   <varlistentry>
 177     <term>PLC_MAIL_SLICE_ADDRESS</term>
 178     <listitem>
 179       <para>
 180                   Type: email</para>
 181       <para>
 182                   Default: root+SLICE@localhost.localdomain</para>
 183       <para>This address template is used for sending
 184           e-mail notifications to slices. SLICE will be replaced with
 185           the name of the slice.</para>
 186     </listitem>
 187   </varlistentry>
 188   <varlistentry>
 189     <term>PLC_DB_ENABLED</term>
 190     <listitem>
 191       <para>
 192                   Type: boolean</para>
 193       <para>
 194                   Default: true</para>
 195       <para>Enable the database server on this
 196           machine.</para>
 197     </listitem>
 198   </varlistentry>
 199   <varlistentry>
 200     <term>PLC_DB_TYPE</term>
 201     <listitem>
 202       <para>
 203                   Type: string</para>
 204       <para>
 205                   Default: postgresql</para>
 206       <para>The type of database server. Currently, only
 207           postgresql is supported.</para>
 208     </listitem>
 209   </varlistentry>
 210   <varlistentry>
 211     <term>PLC_DB_HOST</term>
 212     <listitem>
 213       <para>
 214                   Type: hostname</para>
 215       <para>
 216                   Default: localhost.localdomain</para>
 217       <para>The fully qualified hostname or IP address of
 218           the database server. This hostname must be resolvable and
 219           reachable by the rest of your installation.</para>
 220     </listitem>
 221   </varlistentry>
 222   <varlistentry>
 223     <term>PLC_DB_PORT</term>
 224     <listitem>
 225       <para>
 226                   Type: int</para>
 227       <para>
 228                   Default: 5432</para>
 229       <para>The TCP port number through which the database
 230           server should be accessed.</para>
 231     </listitem>
 232   </varlistentry>
 233   <varlistentry>
 234     <term>PLC_DB_NAME</term>
 235     <listitem>
 236       <para>
 237                   Type: string</para>
 238       <para>
 239                   Default: planetlab3</para>
 240       <para>The name of the database to access.</para>
 241     </listitem>
 242   </varlistentry>
 243   <varlistentry>
 244     <term>PLC_DB_USER</term>
 245     <listitem>
 246       <para>
 247                   Type: string</para>
 248       <para>
 249                   Default: pgsqluser</para>
 250       <para>The username to use when accessing the
 251           database.</para>
 252     </listitem>
 253   </varlistentry>
 254   <varlistentry>
 255     <term>PLC_DB_PASSWORD</term>
 256     <listitem>
 257       <para>
 258                   Type: password</para>
 259       <para>
 260                   Default: </para>
 261       <para>The password to use when accessing the
 262           database. If left blank, one will be
 263           generated.</para>
 264     </listitem>
 265   </varlistentry>
 266   <varlistentry>
 267     <term>PLC_API_ENABLED</term>
 268     <listitem>
 269       <para>
 270                   Type: boolean</para>
 271       <para>
 272                   Default: true</para>
 273       <para>Enable the API server on this
 274           machine.</para>
 275     </listitem>
 276   </varlistentry>
 277   <varlistentry>
 278     <term>PLC_API_DEBUG</term>
 279     <listitem>
 280       <para>
 281                   Type: boolean</para>
 282       <para>
 283                   Default: false</para>
 284       <para>Enable verbose API debugging. Do not enable on
 285           a production system!</para>
 286     </listitem>
 287   </varlistentry>
 288   <varlistentry>
 289     <term>PLC_API_HOST</term>
 290     <listitem>
 291       <para>
 292                   Type: hostname</para>
 293       <para>
 294                   Default: localhost.localdomain</para>
 295       <para>The fully qualified hostname or IP address of
 296           the API server. This hostname must be resolvable and
 297           reachable by the rest of your installation, as well as your
 298           nodes.</para>
 299     </listitem>
 300   </varlistentry>
 301   <varlistentry>
 302     <term>PLC_API_PORT</term>
 303     <listitem>
 304       <para>
 305                   Type: int</para>
 306       <para>
 307                   Default: 80</para>
 308       <para>The TCP port number through which the API
 309           should be accessed. Warning: SSL (port 443) access is not
 310           fully supported by the website code yet. We recommend that
 311           port 80 be used for now and that the API server either run
 312           on the same machine as the web server, or that they both be
 313           on a secure wired network.</para>
 314     </listitem>
 315   </varlistentry>
 316   <varlistentry>
 317     <term>PLC_API_PATH</term>
 318     <listitem>
 319       <para>
 320                   Type: string</para>
 321       <para>
 322                   Default: /PLCAPI/</para>
 323       <para>The base path of the API URL.</para>
 324     </listitem>
 325   </varlistentry>
 326   <varlistentry>
 327     <term>PLC_API_MAINTENANCE_USER</term>
 328     <listitem>
 329       <para>
 330                   Type: string</para>
 331       <para>
 332                   Default: maint@localhost.localdomain</para>
 333       <para>The username of the maintenance account. This
 334           account is used by local scripts that perform automated
 335           tasks, and cannot be used for normal logins.</para>
 336     </listitem>
 337   </varlistentry>
 338   <varlistentry>
 339     <term>PLC_API_MAINTENANCE_PASSWORD</term>
 340     <listitem>
 341       <para>
 342                   Type: password</para>
 343       <para>
 344                   Default: </para>
 345       <para>The password of the maintenance account. If
 346           left blank, one will be generated. We recommend that the
 347           password be changed periodically.</para>
 348     </listitem>
 349   </varlistentry>
 350   <varlistentry>
 351     <term>PLC_API_MAINTENANCE_SOURCES</term>
 352     <listitem>
 353       <para>
 354                   Type: hostname</para>
 355       <para>
 356                   Default: </para>
 357       <para>A space-separated list of IP addresses allowed
 358           to access the API through the maintenance account. The value
 359           of this variable is set automatically to allow only the API,
 360           web, and boot servers, and should not be
 361           changed.</para>
 362     </listitem>
 363   </varlistentry>
 364   <varlistentry>
 365     <term>PLC_API_SSL_CRT</term>
 366     <listitem>
 367       <para>
 368                   Type: file</para>
 369       <para>
 370                   Default: /etc/planetlab/api_ssl.crt</para>
 371       <para>The signed SSL certificate to use for HTTPS
 372           access. If not specified or non-existent, a self-signed
 373           certificate will be generated.</para>
 374     </listitem>
 375   </varlistentry>
 376   <varlistentry>
 377     <term>PLC_API_SSL_KEY</term>
 378     <listitem>
 379       <para>
 380                   Type: file</para>
 381       <para>
 382                   Default: /etc/planetlab/api_ssl.key</para>
 383       <para>The corresponding SSL private key used for
 384           signing the certificate, and for signing slice tickets. If
 385           not specified or non-existent, one will be
 386           generated.</para>
 387     </listitem>
 388   </varlistentry>
 389   <varlistentry>
 390     <term>PLC_API_SSL_KEY_PUB</term>
 391     <listitem>
 392       <para>
 393                   Type: file</para>
 394       <para>
 395                   Default: /etc/planetlab/api_ssl.pub</para>
 396       <para>The corresponding SSL public key. If not
 397           specified or non-existent, one will be
 398           generated.</para>
 399     </listitem>
 400   </varlistentry>
 401   <varlistentry>
 402     <term>PLC_WWW_ENABLED</term>
 403     <listitem>
 404       <para>
 405                   Type: boolean</para>
 406       <para>
 407                   Default: true</para>
 408       <para>Enable the web server on this
 409           machine.</para>
 410     </listitem>
 411   </varlistentry>
 412   <varlistentry>
 413     <term>PLC_WWW_DEBUG</term>
 414     <listitem>
 415       <para>
 416                   Type: boolean</para>
 417       <para>
 418                   Default: false</para>
 419       <para>Enable debugging output on web pages. Do not
 420           enable on a production system!</para>
 421     </listitem>
 422   </varlistentry>
 423   <varlistentry>
 424     <term>PLC_WWW_HOST</term>
 425     <listitem>
 426       <para>
 427                   Type: hostname</para>
 428       <para>
 429                   Default: localhost.localdomain</para>
 430       <para>The fully qualified hostname or IP address of
 431           the web server. This hostname must be resolvable and
 432           reachable by the rest of your installation, as well as your
 433           nodes.</para>
 434     </listitem>
 435   </varlistentry>
 436   <varlistentry>
 437     <term>PLC_WWW_PORT</term>
 438     <listitem>
 439       <para>
 440                   Type: int</para>
 441       <para>
 442                   Default: 80</para>
 443       <para>The TCP port number through which the
 444           unprotected portions of the web site should be
 445           accessed.</para>
 446     </listitem>
 447   </varlistentry>
 448   <varlistentry>
 449     <term>PLC_WWW_SSL_PORT</term>
 450     <listitem>
 451       <para>
 452                   Type: int</para>
 453       <para>
 454                   Default: 443</para>
 455       <para>The TCP port number through which the protected
 456           portions of the web site should be accessed.</para>
 457     </listitem>
 458   </varlistentry>
 459   <varlistentry>
 460     <term>PLC_WWW_SSL_CRT</term>
 461     <listitem>
 462       <para>
 463                   Type: file</para>
 464       <para>
 465                   Default: /etc/planetlab/www_ssl.crt</para>
 466       <para>The signed SSL certificate to use for HTTPS
 467           access. If not specified or non-existent, a self-signed
 468           certificate will be generated.</para>
 469     </listitem>
 470   </varlistentry>
 471   <varlistentry>
 472     <term>PLC_WWW_SSL_KEY</term>
 473     <listitem>
 474       <para>
 475                   Type: file</para>
 476       <para>
 477                   Default: /etc/planetlab/www_ssl.key</para>
 478       <para>The corresponding SSL private key. If not
 479           specified or non-existent, one will be
 480           generated.</para>
 481     </listitem>
 482   </varlistentry>
 483   <varlistentry>
 484     <term>PLC_BOOT_ENABLED</term>
 485     <listitem>
 486       <para>
 487                   Type: boolean</para>
 488       <para>
 489                   Default: true</para>
 490       <para>Enable the boot server on this
 491           machine.</para>
 492     </listitem>
 493   </varlistentry>
 494   <varlistentry>
 495     <term>PLC_BOOT_HOST</term>
 496     <listitem>
 497       <para>
 498                   Type: hostname</para>
 499       <para>
 500                   Default: localhost.localdomain</para>
 501       <para>The fully qualified hostname or IP address of
 502           the boot server. This hostname must be resolvable and
 503           reachable by the rest of your installation, as well as your
 504           nodes.</para>
 505     </listitem>
 506   </varlistentry>
 507   <varlistentry>
 508     <term>PLC_BOOT_PORT</term>
 509     <listitem>
 510       <para>
 511                   Type: int</para>
 512       <para>
 513                   Default: 80</para>
 514       <para>The TCP port number through which the
 515           unprotected portions of the boot server should be
 516           accessed.</para>
 517     </listitem>
 518   </varlistentry>
 519   <varlistentry>
 520     <term>PLC_BOOT_SSL_PORT</term>
 521     <listitem>
 522       <para>
 523                   Type: int</para>
 524       <para>
 525                   Default: 443</para>
 526       <para>The TCP port number through which the protected
 527           portions of the boot server should be
 528           accessed.</para>
 529     </listitem>
 530   </varlistentry>
 531   <varlistentry>
 532     <term>PLC_BOOT_SSL_CRT</term>
 533     <listitem>
 534       <para>
 535                   Type: binary</para>
 536       <para>
 537                   Default: /etc/planetlab/boot_ssl.crt</para>
 538       <para>The signed SSL certificate to use for HTTPS
 539           access. If not specified, or non-existent a self-signed
 540           certificate will be generated.</para>
 541     </listitem>
 542   </varlistentry>
 543   <varlistentry>
 544     <term>PLC_BOOT_SSL_KEY</term>
 545     <listitem>
 546       <para>
 547                   Type: binary</para>
 548       <para>
 549                   Default: /etc/planetlab/boot_ssl.key</para>
 550       <para>The corresponding SSL private key. If not
 551           specified or non-existent, one will be
 552           generated.</para>
 553     </listitem>
 554   </varlistentry>
 555 </variablelist>