doc/plc_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: 127.0.0.1</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: </para>
 136       <para>Secondary DNS server address.</para>
 137     </listitem>
 138   </varlistentry>
 139   <varlistentry>
 140     <term>PLC_DNS_ENABLED</term>
 141     <listitem>
 142       <para>
 143                   Type: boolean</para>
 144       <para>
 145                   Default: true</para>
 146       <para>Enable the internal DNS server. The server does
 147           not provide reverse resolution and is not a production
 148           quality or scalable DNS solution. Use the internal DNS
 149           server only for small deployments or for
 150           testing.</para>
 151     </listitem>
 152   </varlistentry>
 153   <varlistentry>
 154     <term>PLC_MAIL_ENABLED</term>
 155     <listitem>
 156       <para>
 157                   Type: boolean</para>
 158       <para>
 159                   Default: false</para>
 160       <para>Set to false to suppress all e-mail notifications
 161           and warnings.</para>
 162     </listitem>
 163   </varlistentry>
 164   <varlistentry>
 165     <term>PLC_MAIL_SUPPORT_ADDRESS</term>
 166     <listitem>
 167       <para>
 168                   Type: email</para>
 169       <para>
 170                   Default: root+support@localhost.localdomain</para>
 171       <para>This address is used for support
 172           requests. Support requests may include traffic complaints,
 173           security incident reporting, web site malfunctions, and
 174           general requests for information. We recommend that the
 175           address be aliased to a ticketing system such as Request
 176           Tracker.</para>
 177     </listitem>
 178   </varlistentry>
 179   <varlistentry>
 180     <term>PLC_MAIL_BOOT_ADDRESS</term>
 181     <listitem>
 182       <para>
 183                   Type: email</para>
 184       <para>
 185                   Default: root+install-msgs@localhost.localdomain</para>
 186       <para>The API will notify this address when a problem
 187           occurs during node installation or boot.</para>
 188     </listitem>
 189   </varlistentry>
 190   <varlistentry>
 191     <term>PLC_MAIL_SLICE_ADDRESS</term>
 192     <listitem>
 193       <para>
 194                   Type: email</para>
 195       <para>
 196                   Default: root+SLICE@localhost.localdomain</para>
 197       <para>This address template is used for sending
 198           e-mail notifications to slices. SLICE will be replaced with
 199           the name of the slice.</para>
 200     </listitem>
 201   </varlistentry>
 202   <varlistentry>
 203     <term>PLC_DB_ENABLED</term>
 204     <listitem>
 205       <para>
 206                   Type: boolean</para>
 207       <para>
 208                   Default: true</para>
 209       <para>Enable the database server on this
 210           machine.</para>
 211     </listitem>
 212   </varlistentry>
 213   <varlistentry>
 214     <term>PLC_DB_TYPE</term>
 215     <listitem>
 216       <para>
 217                   Type: string</para>
 218       <para>
 219                   Default: postgresql</para>
 220       <para>The type of database server. Currently, only
 221           postgresql is supported.</para>
 222     </listitem>
 223   </varlistentry>
 224   <varlistentry>
 225     <term>PLC_DB_HOST</term>
 226     <listitem>
 227       <para>
 228                   Type: hostname</para>
 229       <para>
 230                   Default: localhost.localdomain</para>
 231       <para>The fully qualified hostname of the database
 232           server.</para>
 233     </listitem>
 234   </varlistentry>
 235   <varlistentry>
 236     <term>PLC_DB_IP</term>
 237     <listitem>
 238       <para>
 239                   Type: ip</para>
 240       <para>
 241                   Default: 127.0.0.1</para>
 242       <para>The IP address of the database server, if not
 243           resolvable by the configured DNS servers.</para>
 244     </listitem>
 245   </varlistentry>
 246   <varlistentry>
 247     <term>PLC_DB_PORT</term>
 248     <listitem>
 249       <para>
 250                   Type: int</para>
 251       <para>
 252                   Default: 5432</para>
 253       <para>The TCP port number through which the database
 254           server should be accessed.</para>
 255     </listitem>
 256   </varlistentry>
 257   <varlistentry>
 258     <term>PLC_DB_NAME</term>
 259     <listitem>
 260       <para>
 261                   Type: string</para>
 262       <para>
 263                   Default: planetlab4</para>
 264       <para>The name of the database to access.</para>
 265     </listitem>
 266   </varlistentry>
 267   <varlistentry>
 268     <term>PLC_DB_USER</term>
 269     <listitem>
 270       <para>
 271                   Type: string</para>
 272       <para>
 273                   Default: pgsqluser</para>
 274       <para>The username to use when accessing the
 275           database.</para>
 276     </listitem>
 277   </varlistentry>
 278   <varlistentry>
 279     <term>PLC_DB_PASSWORD</term>
 280     <listitem>
 281       <para>
 282                   Type: password</para>
 283       <para>
 284                   Default: </para>
 285       <para>The password to use when accessing the
 286           database. If left blank, one will be
 287           generated.</para>
 288     </listitem>
 289   </varlistentry>
 290   <varlistentry>
 291     <term>PLC_API_ENABLED</term>
 292     <listitem>
 293       <para>
 294                   Type: boolean</para>
 295       <para>
 296                   Default: true</para>
 297       <para>Enable the API server on this
 298           machine.</para>
 299     </listitem>
 300   </varlistentry>
 301   <varlistentry>
 302     <term>PLC_API_DEBUG</term>
 303     <listitem>
 304       <para>
 305                   Type: boolean</para>
 306       <para>
 307                   Default: false</para>
 308       <para>Enable verbose API debugging. Do not enable on
 309           a production system!</para>
 310     </listitem>
 311   </varlistentry>
 312   <varlistentry>
 313     <term>PLC_API_HOST</term>
 314     <listitem>
 315       <para>
 316                   Type: hostname</para>
 317       <para>
 318                   Default: localhost.localdomain</para>
 319       <para>The fully qualified hostname of the API
 320           server.</para>
 321     </listitem>
 322   </varlistentry>
 323   <varlistentry>
 324     <term>PLC_API_IP</term>
 325     <listitem>
 326       <para>
 327                   Type: ip</para>
 328       <para>
 329                   Default: 127.0.0.1</para>
 330       <para>The IP address of the API server, if not
 331           resolvable by the configured DNS servers.</para>
 332     </listitem>
 333   </varlistentry>
 334   <varlistentry>
 335     <term>PLC_API_PORT</term>
 336     <listitem>
 337       <para>
 338                   Type: int</para>
 339       <para>
 340                   Default: 443</para>
 341       <para>The TCP port number through which the API
 342           should be accessed.</para>
 343     </listitem>
 344   </varlistentry>
 345   <varlistentry>
 346     <term>PLC_API_PATH</term>
 347     <listitem>
 348       <para>
 349                   Type: string</para>
 350       <para>
 351                   Default: /PLCAPI/</para>
 352       <para>The base path of the API URL.</para>
 353     </listitem>
 354   </varlistentry>
 355   <varlistentry>
 356     <term>PLC_API_MAINTENANCE_USER</term>
 357     <listitem>
 358       <para>
 359                   Type: string</para>
 360       <para>
 361                   Default: maint@localhost.localdomain</para>
 362       <para>The username of the maintenance account. This
 363           account is used by local scripts that perform automated
 364           tasks, and cannot be used for normal logins.</para>
 365     </listitem>
 366   </varlistentry>
 367   <varlistentry>
 368     <term>PLC_API_MAINTENANCE_PASSWORD</term>
 369     <listitem>
 370       <para>
 371                   Type: password</para>
 372       <para>
 373                   Default: </para>
 374       <para>The password of the maintenance account. If
 375           left blank, one will be generated. We recommend that the
 376           password be changed periodically.</para>
 377     </listitem>
 378   </varlistentry>
 379   <varlistentry>
 380     <term>PLC_API_MAINTENANCE_SOURCES</term>
 381     <listitem>
 382       <para>
 383                   Type: hostname</para>
 384       <para>
 385                   Default: </para>
 386       <para>A space-separated list of IP addresses allowed
 387           to access the API through the maintenance account. The value
 388           of this variable is set automatically to allow only the API,
 389           web, and boot servers, and should not be
 390           changed.</para>
 391     </listitem>
 392   </varlistentry>
 393   <varlistentry>
 394     <term>PLC_API_SSL_KEY</term>
 395     <listitem>
 396       <para>
 397                   Type: file</para>
 398       <para>
 399                   Default: /etc/planetlab/api_ssl.key</para>
 400       <para>The SSL private key to use for encrypting HTTPS
 401           traffic. If non-existent, one will be
 402           generated.</para>
 403     </listitem>
 404   </varlistentry>
 405   <varlistentry>
 406     <term>PLC_API_SSL_CRT</term>
 407     <listitem>
 408       <para>
 409                   Type: file</para>
 410       <para>
 411                   Default: /etc/planetlab/api_ssl.crt</para>
 412       <para>The corresponding SSL public certificate. By
 413           default, this certificate is self-signed. You may replace
 414           the certificate later with one signed by a root
 415           CA.</para>
 416     </listitem>
 417   </varlistentry>
 418   <varlistentry>
 419     <term>PLC_API_CA_SSL_CRT</term>
 420     <listitem>
 421       <para>
 422                   Type: file</para>
 423       <para>
 424                   Default: /etc/planetlab/api_ca_ssl.crt</para>
 425       <para>The certificate of the root CA, if any, that
 426           signed your server certificate. If your server certificate is
 427           self-signed, then this file is the same as your server
 428           certificate.</para>
 429     </listitem>
 430   </varlistentry>
 431   <varlistentry>
 432     <term>PLC_WWW_ENABLED</term>
 433     <listitem>
 434       <para>
 435                   Type: boolean</para>
 436       <para>
 437                   Default: true</para>
 438       <para>Enable the web server on this
 439           machine.</para>
 440     </listitem>
 441   </varlistentry>
 442   <varlistentry>
 443     <term>PLC_WWW_DEBUG</term>
 444     <listitem>
 445       <para>
 446                   Type: boolean</para>
 447       <para>
 448                   Default: false</para>
 449       <para>Enable debugging output on web pages. Do not
 450           enable on a production system!</para>
 451     </listitem>
 452   </varlistentry>
 453   <varlistentry>
 454     <term>PLC_WWW_HOST</term>
 455     <listitem>
 456       <para>
 457                   Type: hostname</para>
 458       <para>
 459                   Default: localhost.localdomain</para>
 460       <para>The fully qualified hostname of the web
 461           server.</para>
 462     </listitem>
 463   </varlistentry>
 464   <varlistentry>
 465     <term>PLC_WWW_IP</term>
 466     <listitem>
 467       <para>
 468                   Type: ip</para>
 469       <para>
 470                   Default: 127.0.0.1</para>
 471       <para>The IP address of the web server, if not
 472           resolvable by the configured DNS servers.</para>
 473     </listitem>
 474   </varlistentry>
 475   <varlistentry>
 476     <term>PLC_WWW_PORT</term>
 477     <listitem>
 478       <para>
 479                   Type: int</para>
 480       <para>
 481                   Default: 80</para>
 482       <para>The TCP port number through which the
 483           unprotected portions of the web site should be
 484           accessed.</para>
 485     </listitem>
 486   </varlistentry>
 487   <varlistentry>
 488     <term>PLC_WWW_SSL_PORT</term>
 489     <listitem>
 490       <para>
 491                   Type: int</para>
 492       <para>
 493                   Default: 443</para>
 494       <para>The TCP port number through which the protected
 495           portions of the web site should be accessed.</para>
 496     </listitem>
 497   </varlistentry>
 498   <varlistentry>
 499     <term>PLC_WWW_SSL_KEY</term>
 500     <listitem>
 501       <para>
 502                   Type: file</para>
 503       <para>
 504                   Default: /etc/planetlab/www_ssl.key</para>
 505       <para>The SSL private key to use for encrypting HTTPS
 506           traffic. If non-existent, one will be
 507           generated.</para>
 508     </listitem>
 509   </varlistentry>
 510   <varlistentry>
 511     <term>PLC_WWW_SSL_CRT</term>
 512     <listitem>
 513       <para>
 514                   Type: file</para>
 515       <para>
 516                   Default: /etc/planetlab/www_ssl.crt</para>
 517       <para>The corresponding SSL public certificate for
 518           the HTTP server. By default, this certificate is
 519           self-signed. You may replace the certificate later with one
 520           signed by a root CA.</para>
 521     </listitem>
 522   </varlistentry>
 523   <varlistentry>
 524     <term>PLC_WWW_CA_SSL_CRT</term>
 525     <listitem>
 526       <para>
 527                   Type: file</para>
 528       <para>
 529                   Default: /etc/planetlab/www_ca_ssl.crt</para>
 530       <para>The certificate of the root CA, if any, that
 531           signed your server certificate. If your server certificate is
 532           self-signed, then this file is the same as your server
 533           certificate.</para>
 534     </listitem>
 535   </varlistentry>
 536   <varlistentry>
 537     <term>PLC_BOOT_ENABLED</term>
 538     <listitem>
 539       <para>
 540                   Type: boolean</para>
 541       <para>
 542                   Default: true</para>
 543       <para>Enable the boot server on this
 544           machine.</para>
 545     </listitem>
 546   </varlistentry>
 547   <varlistentry>
 548     <term>PLC_BOOT_HOST</term>
 549     <listitem>
 550       <para>
 551                   Type: hostname</para>
 552       <para>
 553                   Default: localhost.localdomain</para>
 554       <para>The fully qualified hostname of the boot
 555           server.</para>
 556     </listitem>
 557   </varlistentry>
 558   <varlistentry>
 559     <term>PLC_BOOT_IP</term>
 560     <listitem>
 561       <para>
 562                   Type: ip</para>
 563       <para>
 564                   Default: 127.0.0.1</para>
 565       <para>The IP address of the boot server, if not
 566           resolvable by the configured DNS servers.</para>
 567     </listitem>
 568   </varlistentry>
 569   <varlistentry>
 570     <term>PLC_BOOT_PORT</term>
 571     <listitem>
 572       <para>
 573                   Type: int</para>
 574       <para>
 575                   Default: 80</para>
 576       <para>The TCP port number through which the
 577           unprotected portions of the boot server should be
 578           accessed.</para>
 579     </listitem>
 580   </varlistentry>
 581   <varlistentry>
 582     <term>PLC_BOOT_SSL_PORT</term>
 583     <listitem>
 584       <para>
 585                   Type: int</para>
 586       <para>
 587                   Default: 443</para>
 588       <para>The TCP port number through which the protected
 589           portions of the boot server should be
 590           accessed.</para>
 591     </listitem>
 592   </varlistentry>
 593   <varlistentry>
 594     <term>PLC_BOOT_SSL_KEY</term>
 595     <listitem>
 596       <para>
 597                   Type: file</para>
 598       <para>
 599                   Default: /etc/planetlab/boot_ssl.key</para>
 600       <para>The SSL private key to use for encrypting HTTPS
 601           traffic.</para>
 602     </listitem>
 603   </varlistentry>
 604   <varlistentry>
 605     <term>PLC_BOOT_SSL_CRT</term>
 606     <listitem>
 607       <para>
 608                   Type: file</para>
 609       <para>
 610                   Default: /etc/planetlab/boot_ssl.crt</para>
 611       <para>The corresponding SSL public certificate for
 612           the HTTP server. By default, this certificate is
 613           self-signed. You may replace the certificate later with one
 614           signed by a root CA.</para>
 615     </listitem>
 616   </varlistentry>
 617   <varlistentry>
 618     <term>PLC_BOOT_CA_SSL_CRT</term>
 619     <listitem>
 620       <para>
 621                   Type: file</para>
 622       <para>
 623                   Default: /etc/planetlab/boot_ca_ssl.crt</para>
 624       <para>The certificate of the root CA, if any, that
 625           signed your server certificate. If your server certificate is
 626           self-signed, then this file is the same as your server
 627           certificate.</para>
 628     </listitem>
 629   </varlistentry>
 630 </variablelist>