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