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: planetlab4</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: 443</para>
 416       <para>The TCP port number through which the API
 417           should be accessed.</para>
 418     </listitem>
 419   </varlistentry>
 420   <varlistentry>
 421     <term>PLC_API_PATH</term>
 422     <listitem>
 423       <para>
 424                   Type: string</para>
 425       <para>
 426                   Default: /PLCAPI/</para>
 427       <para>The base path of the API URL.</para>
 428     </listitem>
 429   </varlistentry>
 430   <varlistentry>
 431     <term>PLC_API_MAINTENANCE_USER</term>
 432     <listitem>
 433       <para>
 434                   Type: string</para>
 435       <para>
 436                   Default: maint@localhost.localdomain</para>
 437       <para>The username of the maintenance account. This
 438           account is used by local scripts that perform automated
 439           tasks, and cannot be used for normal logins.</para>
 440     </listitem>
 441   </varlistentry>
 442   <varlistentry>
 443     <term>PLC_API_MAINTENANCE_PASSWORD</term>
 444     <listitem>
 445       <para>
 446                   Type: password</para>
 447       <para>
 448                   Default: </para>
 449       <para>The password of the maintenance account. If
 450           left blank, one will be generated. We recommend that the
 451           password be changed periodically.</para>
 452     </listitem>
 453   </varlistentry>
 454   <varlistentry>
 455     <term>PLC_API_MAINTENANCE_SOURCES</term>
 456     <listitem>
 457       <para>
 458                   Type: hostname</para>
 459       <para>
 460                   Default: </para>
 461       <para>A space-separated list of IP addresses allowed
 462           to access the API through the maintenance account. The value
 463           of this variable is set automatically to allow only the API,
 464           web, and boot servers, and should not be
 465           changed.</para>
 466     </listitem>
 467   </varlistentry>
 468   <varlistentry>
 469     <term>PLC_API_SSL_KEY</term>
 470     <listitem>
 471       <para>
 472                   Type: file</para>
 473       <para>
 474                   Default: /etc/planetlab/api_ssl.key</para>
 475       <para>The SSL private key to use for encrypting HTTPS
 476           traffic. If non-existent, one will be
 477           generated.</para>
 478     </listitem>
 479   </varlistentry>
 480   <varlistentry>
 481     <term>PLC_API_SSL_CRT</term>
 482     <listitem>
 483       <para>
 484                   Type: file</para>
 485       <para>
 486                   Default: /etc/planetlab/api_ssl.crt</para>
 487       <para>The corresponding SSL public certificate. By
 488           default, this certificate is self-signed. You may replace
 489           the certificate later with one signed by a root
 490           CA.</para>
 491     </listitem>
 492   </varlistentry>
 493   <varlistentry>
 494     <term>PLC_API_CA_SSL_CRT</term>
 495     <listitem>
 496       <para>
 497                   Type: file</para>
 498       <para>
 499                   Default: /etc/planetlab/api_ca_ssl.crt</para>
 500       <para>The certificate of the root CA, if any, that
 501           signed your server certificate. If your server certificate is
 502           self-signed, then this file is the same as your server
 503           certificate.</para>
 504     </listitem>
 505   </varlistentry>
 506   <varlistentry>
 507     <term>PLC_WWW_ENABLED</term>
 508     <listitem>
 509       <para>
 510                   Type: boolean</para>
 511       <para>
 512                   Default: true</para>
 513       <para>Enable the web server on this
 514           machine.</para>
 515     </listitem>
 516   </varlistentry>
 517   <varlistentry>
 518     <term>PLC_WWW_DEBUG</term>
 519     <listitem>
 520       <para>
 521                   Type: boolean</para>
 522       <para>
 523                   Default: false</para>
 524       <para>Enable debugging output on web pages. Do not
 525           enable on a production system!</para>
 526     </listitem>
 527   </varlistentry>
 528   <varlistentry>
 529     <term>PLC_WWW_HOST</term>
 530     <listitem>
 531       <para>
 532                   Type: hostname</para>
 533       <para>
 534                   Default: localhost.localdomain</para>
 535       <para>The fully qualified hostname of the web
 536           server.</para>
 537     </listitem>
 538   </varlistentry>
 539   <varlistentry>
 540     <term>PLC_WWW_IP</term>
 541     <listitem>
 542       <para>
 543                   Type: ip</para>
 544       <para>
 545                   Default: 127.0.0.1</para>
 546       <para>The IP address of the web server, if not
 547           resolvable by the configured DNS servers.</para>
 548     </listitem>
 549   </varlistentry>
 550   <varlistentry>
 551     <term>PLC_WWW_PORT</term>
 552     <listitem>
 553       <para>
 554                   Type: int</para>
 555       <para>
 556                   Default: 80</para>
 557       <para>The TCP port number through which the
 558           unprotected portions of the web site should be
 559           accessed.</para>
 560     </listitem>
 561   </varlistentry>
 562   <varlistentry>
 563     <term>PLC_WWW_SSL_PORT</term>
 564     <listitem>
 565       <para>
 566                   Type: int</para>
 567       <para>
 568                   Default: 443</para>
 569       <para>The TCP port number through which the protected
 570           portions of the web site should be accessed.</para>
 571     </listitem>
 572   </varlistentry>
 573   <varlistentry>
 574     <term>PLC_WWW_SSL_KEY</term>
 575     <listitem>
 576       <para>
 577                   Type: file</para>
 578       <para>
 579                   Default: /etc/planetlab/www_ssl.key</para>
 580       <para>The SSL private key to use for encrypting HTTPS
 581           traffic. If non-existent, one will be
 582           generated.</para>
 583     </listitem>
 584   </varlistentry>
 585   <varlistentry>
 586     <term>PLC_WWW_SSL_CRT</term>
 587     <listitem>
 588       <para>
 589                   Type: file</para>
 590       <para>
 591                   Default: /etc/planetlab/www_ssl.crt</para>
 592       <para>The corresponding SSL public certificate for
 593           the HTTP server. By default, this certificate is
 594           self-signed. You may replace the certificate later with one
 595           signed by a root CA.</para>
 596     </listitem>
 597   </varlistentry>
 598   <varlistentry>
 599     <term>PLC_WWW_CA_SSL_CRT</term>
 600     <listitem>
 601       <para>
 602                   Type: file</para>
 603       <para>
 604                   Default: /etc/planetlab/www_ca_ssl.crt</para>
 605       <para>The certificate of the root CA, if any, that
 606           signed your server certificate. If your server certificate is
 607           self-signed, then this file is the same as your server
 608           certificate.</para>
 609     </listitem>
 610   </varlistentry>
 611   <varlistentry>
 612     <term>PLC_BOOT_ENABLED</term>
 613     <listitem>
 614       <para>
 615                   Type: boolean</para>
 616       <para>
 617                   Default: true</para>
 618       <para>Enable the boot server on this
 619           machine.</para>
 620     </listitem>
 621   </varlistentry>
 622   <varlistentry>
 623     <term>PLC_BOOT_HOST</term>
 624     <listitem>
 625       <para>
 626                   Type: hostname</para>
 627       <para>
 628                   Default: localhost.localdomain</para>
 629       <para>The fully qualified hostname of the boot
 630           server.</para>
 631     </listitem>
 632   </varlistentry>
 633   <varlistentry>
 634     <term>PLC_BOOT_IP</term>
 635     <listitem>
 636       <para>
 637                   Type: ip</para>
 638       <para>
 639                   Default: 127.0.0.1</para>
 640       <para>The IP address of the boot server, if not
 641           resolvable by the configured DNS servers.</para>
 642     </listitem>
 643   </varlistentry>
 644   <varlistentry>
 645     <term>PLC_BOOT_PORT</term>
 646     <listitem>
 647       <para>
 648                   Type: int</para>
 649       <para>
 650                   Default: 80</para>
 651       <para>The TCP port number through which the
 652           unprotected portions of the boot server should be
 653           accessed.</para>
 654     </listitem>
 655   </varlistentry>
 656   <varlistentry>
 657     <term>PLC_BOOT_SSL_PORT</term>
 658     <listitem>
 659       <para>
 660                   Type: int</para>
 661       <para>
 662                   Default: 443</para>
 663       <para>The TCP port number through which the protected
 664           portions of the boot server should be
 665           accessed.</para>
 666     </listitem>
 667   </varlistentry>
 668   <varlistentry>
 669     <term>PLC_BOOT_SSL_KEY</term>
 670     <listitem>
 671       <para>
 672                   Type: file</para>
 673       <para>
 674                   Default: /etc/planetlab/boot_ssl.key</para>
 675       <para>The SSL private key to use for encrypting HTTPS
 676           traffic.</para>
 677     </listitem>
 678   </varlistentry>
 679   <varlistentry>
 680     <term>PLC_BOOT_SSL_CRT</term>
 681     <listitem>
 682       <para>
 683                   Type: file</para>
 684       <para>
 685                   Default: /etc/planetlab/boot_ssl.crt</para>
 686       <para>The corresponding SSL public certificate for
 687           the HTTP server. By default, this certificate is
 688           self-signed. You may replace the certificate later with one
 689           signed by a root CA.</para>
 690     </listitem>
 691   </varlistentry>
 692   <varlistentry>
 693     <term>PLC_BOOT_CA_SSL_CRT</term>
 694     <listitem>
 695       <para>
 696                   Type: file</para>
 697       <para>
 698                   Default: /etc/planetlab/boot_ca_ssl.crt</para>
 699       <para>The certificate of the root CA, if any, that
 700           signed your server certificate. If your server certificate is
 701           self-signed, then this file is the same as your server
 702           certificate.</para>
 703     </listitem>
 704   </varlistentry>
 705 </variablelist>