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