From 7945911088216fafe4d377816e7bbbb17d8a0aa7 Mon Sep 17 00:00:00 2001 From: Oliver Tappe Date: Tue, 3 Apr 2007 18:33:49 +0000 Subject: * even more work on consolidating the PODs. Hopefully, I'm finished now... git-svn-id: http://svn.openslx.org/svn/openslx/trunk@858 95ad53e4-c205-0410-b2fa-d234c58c8868 --- config-db/slxconfig | 183 +++++++-------------------------- config-db/slxconfig-demuxer | 245 ++++++++++++-------------------------------- config-db/slxsettings | 102 ++++++++++-------- 3 files changed, 164 insertions(+), 366 deletions(-) (limited to 'config-db') diff --git a/config-db/slxconfig b/config-db/slxconfig index bea096fd..8b2b2eca 100755 --- a/config-db/slxconfig +++ b/config-db/slxconfig @@ -539,36 +539,13 @@ __END__ =head1 NAME -slxconfig - OpenSLX-script to configure a vendor-OS for use with -OpenSLX. You can create systems that will use the specified vendor-OS -and you can create clients for that system, too. +slxconfig - OpenSLX-script to view & change the configurational database =head1 SYNOPSIS slxconfig [options] -=head3 OpenSLX Options - - --base-path= basic path to project files - --bin-path= path to binaries and scripts - --config-path= path to configuration files - --db-basepath= basic path to openslx database - --db-datadir= data folder created under db-basepath - --db-name= name of database - --db-spec= full DBI-specification of database - --db-type= type of database to connect to - --export-path= path to root of all exported filesystems - --locale= locale to use for translations - --logfile= file to write logging output to - --private-path= path to private data - --public-path= path to public (client-accesible) data - --share-path= path to sharable data - --stage1-path= path to stage1 systems - --temp-path= path to temporary data - --tftpboot-path= path to root of tftp-server - --verbose-level= level of logging verbosity (0-3) - -=head3 General Options +=head3 Options --help brief help message --man show full documentation @@ -624,128 +601,13 @@ removes a system from the config-DB =back -=head1 OPTIONS - -=head3 OpenSLX Options - -=over 8 - -=item B<< --base-path= >> - -Sets basic path to project files. - -Default is $SLX_BASE_PATH (usually F). - -=item B<< --bin-path= >> - -Sets path to binaries and scripts. - -Default is $SLX_BASE_PATH/bin (usually F). - -=item B<< --config-path= >> - -Sets path to configuration files. - -Default is $SLX_CONFIG_PATH (usually F). - -=item B<< --db-basepath= >> - -Sets basic path to openslx database. - -Default is $SLX_DB_PATH (usually F). - -=item B<< --db-datadir= >> - -Sets data folder created under db-basepath. - -Default is $SLX_DB_DATADIR (usually empty as it depends on db-type -whether or not such a directory is required at all). - -=item B<< --db-name= >> - -Gives the name of the database to connect to. - -Default is $SLX_DB_NAME (usually C). - -=item B<< --db-spec= >> - -Gives the full DBI-specification of database to connect to. Content depends -on the db-type. - -Default is $SLX_DB_SPEC (usually empty as it will be built automatically). - -=item B<< --db-type= >> - -Sets the type of database to connect to (CSV, SQLite, mysql, ...). - -Default $SLX_DB_TYPE (usually C). - -=item B<< --export-path= >> - -Sets path to root of all exported filesystems. For each type of export (NFS, -NBD, ...) a separate folder will be created in here. - -Default is $SLX_EXPORT_PATH (usually F. - -=item B<< --locale= >> +=head1 DESCRIPTION -Sets the locale to use for translations. +B can be used to view the contents of the configurational database. +Additionally, you can add systems as well as clients and change their specific +boot configuration. -Defaults to the system's standard locale. - -=item B<< --logfile= >> - -Specifies a file where logging output will be written to. - -Default is to log to STDERR. - -=item B<< --private-path= >> - -Sets path to private data, where the config-db, vendor_oses and configurational -extensions will be stored. - -Default is $SLX_PRIVATE_PATH (usually F. - -=item B<< --public-path= >> - -Sets path to public (client-accesible) data. - -Default is $SLX_PUBLIC_PATH (usually F. - -=item B<< --share-path= >> - -Sets path to sharable data, where distro-specs and functionality templates -will be stored. - -Default is $SLX_SHARE_PATH (usually F. - -=item B<< --stage1-path= >> - -Sets path to stage1 systems, where distributor-systems will be installed. - -Default is $SLX_STAGE1_PATH (usually F. - -=item B<< --temp-path= >> - -Sets path to temporary data. - -Default is $SLX_TEMP_PATH (usually F. - -=item B<< --tftpboot-path= >> - -Sets path to root of tftp-server from which clients will access their files. - -Default is $SLX_TFTPBOOT_PATH (usually F. - -=item B<< --verbose-level= >> - -Sets the level of logging verbosity (0-3). - -Default is $SLX_VERBOSE_LEVEL (usually 0, no logging). - -=back - -=head3 General Options +=head1 OPTIONS =over 8 @@ -896,4 +758,35 @@ removes the system/client with the given name. =back +=head1 SEE ALSO + +slxsettings, slxos-setup, slxos-export, slxconfig-demuxer + +=head1 GENERAL OPENSLX OPTIONS + +Being a part of OpenSLX, this script supports several other options +which can be used to overrule the OpenSLX settings: + + --base-path= basic path to project files + --bin-path= path to binaries and scripts + --config-path= path to configuration files + --db-basepath= basic path to openslx database + --db-datadir= data folder created under db-basepath + --db-name= name of database + --db-spec= full DBI-specification of database + --db-type= type of database to connect to + --export-path= path to root of all exported filesystems + --locale= locale to use for translations + --logfile= file to write logging output to + --private-path= path to private data + --public-path= path to public (client-accesible) data + --share-path= path to sharable data + --stage1-path= path to stage1 systems + --temp-path= path to temporary data + --tftpboot-path= path to root of tftp-server + --verbose-level= level of logging verbosity (0-3) + +Please refer to the C-manpage for a more detailed description +of these options. + =cut \ No newline at end of file diff --git a/config-db/slxconfig-demuxer b/config-db/slxconfig-demuxer index 87ca1fc6..17c93407 100755 --- a/config-db/slxconfig-demuxer +++ b/config-db/slxconfig-demuxer @@ -464,191 +464,15 @@ slxconfig-demuxer [options] (ISC,...) --dry-run avoids writing anything, for testing -=head3 OpenSLX Options - - --base-path= basic path to project files - --bin-path= path to binaries and scripts - --config-path= path to configuration files - --db-basepath= basic path to openslx database - --db-datadir= data folder created under db-basepath - --db-name= name of database - --db-spec= full DBI-specification of database - --db-type= type of database to connect to - --export-path= path to root of all exported filesystems - --locale= locale to use for translations - --logfile= file to write logging output to - --private-path= path to private data - --public-path= path to public (client-accesible) data - --share-path= path to sharable data - --stage1-path= path to stage1 systems - --temp-path= path to temporary data - --tftpboot-path= path to root of tftp-server - --verbose-level= level of logging verbosity (0-3) - =head3 General Options --help brief help message --man full documentation --version show version -=head1 OPTIONS - -=head3 Script Options - -=over 8 - -=item B<< --dhcp-type >> - -Specifies the type of DHCP-export that shall be used. Currently, only 'ISC' is -supported. - -=item B<< --dry-run >> - -Runs the script but avoids writing anything. This is useful for testing, as -you can learn from the logging output what would have been done. - -=back - -=head3 OpenSLX Options - -=over 8 - -=item B<< --base-path= >> - -Sets basic path to project files. - -Default is $SLX_BASE_PATH (usually F). - -=item B<< --bin-path= >> - -Sets path to binaries and scripts. - -Default is $SLX_BASE_PATH/bin (usually F). - -=item B<< --config-path= >> - -Sets path to configuration files. - -Default is $SLX_CONFIG_PATH (usually F). - -=item B<< --db-basepath= >> - -Sets basic path to openslx database. - -Default is $SLX_DB_PATH (usually F). - -=item B<< --db-datadir= >> - -Sets data folder created under db-basepath. - -Default is $SLX_DB_DATADIR (usually empty as it depends on db-type -whether or not such a directory is required at all). - -=item B<< --db-name= >> - -Gives the name of the database to connect to. - -Default is $SLX_DB_NAME (usually C). - -=item B<< --db-spec= >> - -Gives the full DBI-specification of database to connect to. Content depends -on the db-type. - -Default is $SLX_DB_SPEC (usually empty as it will be built automatically). - -=item B<< --db-type= >> - -Sets the type of database to connect to (CSV, SQLite, mysql, ...). - -Default $SLX_DB_TYPE (usually C). - -=item B<< --export-path= >> - -Sets path to root of all exported filesystems. For each type of export (NFS, -NBD, ...) a separate folder will be created in here. - -Default is $SLX_EXPORT_PATH (usually F. - -=item B<< --locale= >> - -Sets the locale to use for translations. - -Defaults to the system's standard locale. - -=item B<< --logfile= >> - -Specifies a file where logging output will be written to. - -Default is to log to STDERR. - -=item B<< --private-path= >> - -Sets path to private data, where the config-db, vendor_oses and configurational -extensions will be stored. - -Default is $SLX_PRIVATE_PATH (usually F. - -=item B<< --public-path= >> - -Sets path to public (client-accesible) data. - -Default is $SLX_PUBLIC_PATH (usually F. - -=item B<< --share-path= >> - -Sets path to sharable data, where distro-specs and functionality templates -will be stored. - -Default is $SLX_SHARE_PATH (usually F. - -=item B<< --stage1-path= >> - -Sets path to stage1 systems, where distributor-systems will be installed. - -Default is $SLX_STAGE1_PATH (usually F. - -=item B<< --temp-path= >> - -Sets path to temporary data. - -Default is $SLX_TEMP_PATH (usually F. - -=item B<< --tftpboot-path= >> - -Sets path to root of tftp-server from which clients will access their files. - -Default is $SLX_TFTPBOOT_PATH (usually F. - -=item B<< --verbose-level= >> - -Sets the level of logging verbosity (0-3). - -Default is $SLX_VERBOSE_LEVEL (usually 0, no logging). - -=back - -=head3 General Options - -=over 8 - -=item B<< --help >> - -Prints a brief help message and exits. - -=item B<< --man >> - -Prints the manual page and exits. - -=item B<< --version >> - -Prints the version and exits. - -=back - =head1 DESCRIPTION -B will read information about all systems, clients and +B will read information about all systems, clients and groups from the OpenSLX configuration database, mix & match the individual configurational attributes and then demultiplex the resulting information to a set of configuration files. These files are used by any OpenSLX-client @@ -728,4 +552,71 @@ into a concrete set of configuration settings for specific clients and their offered systems, making sure that each client/system combination uses the appropriate settings. +=head1 OPTIONS + +=head3 Script Options + +=over 8 + +=item B<< --dhcp-type >> + +Specifies the type of DHCP-export that shall be used. Currently, only 'ISC' is +supported. + +=item B<< --dry-run >> + +Runs the script but avoids writing anything. This is useful for testing, as +you can learn from the logging output what would have been done. + +=back + +=head3 General Options + +=over 8 + +=item B<< --help >> + +Prints a brief help message and exits. + +=item B<< --man >> + +Prints the manual page and exits. + +=item B<< --version >> + +Prints the version and exits. + +=back + +=head1 SEE ALSO + +slxsettings, slxos-setup, slxos-export, slxconfig + +=head1 GENERAL OPENSLX OPTIONS + +Being a part of OpenSLX, this script supports several other options +which can be used to overrule the OpenSLX settings: + + --base-path= basic path to project files + --bin-path= path to binaries and scripts + --config-path= path to configuration files + --db-basepath= basic path to openslx database + --db-datadir= data folder created under db-basepath + --db-name= name of database + --db-spec= full DBI-specification of database + --db-type= type of database to connect to + --export-path= path to root of all exported filesystems + --locale= locale to use for translations + --logfile= file to write logging output to + --private-path= path to private data + --public-path= path to public (client-accesible) data + --share-path= path to sharable data + --stage1-path= path to stage1 systems + --temp-path= path to temporary data + --tftpboot-path= path to root of tftp-server + --verbose-level= level of logging verbosity (0-3) + +Please refer to the C-manpage for a more detailed description +of these options. + =cut diff --git a/config-db/slxsettings b/config-db/slxsettings index 0189123e..4a57307c 100755 --- a/config-db/slxsettings +++ b/config-db/slxsettings @@ -157,13 +157,10 @@ slxsettings - OpenSLX-script to show & change local settings =head1 SYNOPSIS -slxsettings [options] +slxsettings [options] [action ...] - Script Options: - --quiet do not print anything - --remove= remove given key from settings +=head3 OpenSLX Options - OpenSLX Options: --base-path= basic path to project files --bin-path= path to binaries and scripts --config-path= path to configuration files @@ -182,137 +179,152 @@ slxsettings [options] --tftpboot-path= path to root of tftp-server --verbose-level= level of logging verbosity (0-3) - General Options: +=head3 General Options + --help brief help message --man full documentation + --quiet do not print anything --verbose show more information --version show version -=head1 OPTIONS - -=head3 Script Options +=head3 Actions =over 8 -=item B<--quiet> +=item B<< = >> -Runs the script without printing anything. +sets the specified openslx-option (without the leading '--') to the given value -=item B<--remove=> +=item B<< remove= >> -Removes given key from settings (apply more than once to remove several keys). +removes given openslx-option (sets it to an empty string) -=item B<--verbose> - -Prints the resulting settings after changes have been applied. =back +=head1 DESCRIPTION + +B can be used to show or change the local settings for OpenSLX. + +Any cmdline-argument passed to this script will change the local OpenSLX +settings file (usually /etc/opt/openslx/settings.local). + +If you invoke the script without any arguments, it will print the current +settings and exit. + +=head1 OPTIONS + =head3 OpenSLX Options =over 8 -=item B<--base-path=> +=item B<< --base-path= >> Sets basic path to project files. Default is $SLX_BASE_PATH (usually F). -=item B<--bin-path=> +=item B<< --bin-path= >> Sets path to binaries and scripts. Default is $SLX_BASE_PATH/bin (usually F). -=item B<--config-path=> +=item B<< --config-path= >> Sets path to configuration files. Default is $SLX_CONFIG_PATH (usually F). -=item B<--db-basepath=> +=item B<< --db-basepath= >> Sets basic path to openslx database. Default is $SLX_DB_PATH (usually F). -=item B<--db-datadir=> +=item B<< --db-datadir= >> Sets data folder created under db-basepath. Default is $SLX_DB_DATADIR (usually empty as it depends on db-type whether or not such a directory is required at all). -=item B<--db-name=> +=item B<< --db-name= >> Gives the name of the database to connect to. Default is $SLX_DB_NAME (usually C). -=item B<--db-spec=> +=item B<< --db-spec= >> Gives the full DBI-specification of database to connect to. Content depends on the db-type. Default is $SLX_DB_SPEC (usually empty as it will be built automatically). -=item B<--db-type=> +=item B<< --db-type= >> Sets the type of database to connect to (CSV, SQLite, mysql, ...). Default $SLX_DB_TYPE (usually C). -=item B<--export-path=> +=item B<< --export-path= >> Sets path to root of all exported filesystems. For each type of export (NFS, NBD, ...) a separate folder will be created in here. Default is $SLX_EXPORT_PATH (usually F. -=item B<--locale=> +=item B<< --locale= >> Sets the locale to use for translations. Defaults to the system's standard locale. -=item B<--logfile=> +=item B<< --logfile= >> Specifies a file where logging output will be written to. Default is to log to STDERR. -=item B<--private-path=> +=item B<< --private-path= >> Sets path to private data, where the config-db, vendor_oses and configurational extensions will be stored. Default is $SLX_PRIVATE_PATH (usually F. -=item B<--public-path=> +=item B<< --public-path= >> Sets path to public (client-accesible) data. Default is $SLX_PUBLIC_PATH (usually F. -=item B<--share-path=> +=item B<< --share-path= >> Sets path to sharable data, where distro-specs and functionality templates will be stored. Default is $SLX_SHARE_PATH (usually F. -=item B<--temp-path=> +=item B<< --stage1-path= >> + +Sets path to stage1 systems, where distributor-systems will be installed. + +Default is $SLX_STAGE1_PATH (usually F. + +=item B<< --temp-path= >> Sets path to temporary data. Default is $SLX_TEMP_PATH (usually F. -=item B<--tftpboot-path=> +=item B<< --tftpboot-path= >> Sets path to root of tftp-server from which clients will access their files. Default is $SLX_TFTPBOOT_PATH (usually F. -=item B<--verbose-level=> +=item B<< --verbose-level= >> Sets the level of logging verbosity (0-3). @@ -324,26 +336,28 @@ Default is $SLX_VERBOSE_LEVEL (usually 0, no logging). =over 8 -=item B<--help> +=item B< --help> Prints a brief help message and exits. -=item B<--man> +=item B< --man> Prints the manual page and exits. -=item B<--version> +=item B< --quiet> -Prints the version and exits. +Runs the script without printing anything. -=back +=item B< --verbose> -=head1 DESCRIPTION +Prints the resulting settings after changes have been applied. -B can be used to show or change the local settings for OpenSLX. +=item B< --version> -Any cmdline-argument passed to this script will change the local OpenSLX -settings file (usually /etc/opt/openslx/settings.local). +Prints the version and exits. -If you invoke the script without any arguments, it will print the current -settings and exit. +=back + +=head1 SEE ALSO + +slxos-setup, slxos-export, slxconfig, slxconfig-demuxer \ No newline at end of file -- cgit v1.2.3-55-g7522