hawq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r...@apache.org
Subject [1/4] incubator-hawq git commit: HAWQ-39. Remove below unused mgmt scritps for hawq2.0:
Date Mon, 12 Oct 2015 09:19:50 GMT
Repository: incubator-hawq
Updated Branches:
  refs/heads/master b07297aa4 -> 8ec87e6a5


http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/8ec87e6a/tools/doc/gpinitsystem_help
----------------------------------------------------------------------
diff --git a/tools/doc/gpinitsystem_help b/tools/doc/gpinitsystem_help
deleted file mode 100755
index 046df0a..0000000
--- a/tools/doc/gpinitsystem_help
+++ /dev/null
@@ -1,362 +0,0 @@
-COMMAND NAME: gpinitsystem
-
-Initializes a HAWQ system by using configuration 
-parameters specified in a configuration file (gp_init_config).
-
-
-*****************************************************
-SYNOPSIS
-*****************************************************
-
-gpinitsystem -c <gpinitsystem_config> 
-            [-h <hostfile_gpinitsystem>]
-            [-B <parallel_processes>] 
-            [-p <postgresql_conf_param_file>]
-            [-s <standby_master_host>]
-            [--max_connections=<number>] [--shared_buffers=<size>]
-            [--locale=<locale>] [--lc-collate=<locale>] 
-            [--lc-ctype=<locale>] [--lc-messages=<locale>] 
-            [--lc-monetary=<locale>] [--lc-numeric=<locale>] 
-            [--lc-time=<locale>] [--su_password=<password>] 
-            [-a] [-q] [-l <logfile_directory>] [-D]
-
-gpinitsystem -? 
-
-gpinitsystem -v
-
-
-*****************************************************
-DESCRIPTION
-*****************************************************
-
-The gpinitsystem utility will create a HAWQ instance 
-using the values defined in a configuration file. See the 
-INITIALIZATION CONFIGURATION FILE FORMAT section below. 
- 
-Before running this utility, make sure that you have installed 
-the HAWQ software on all the hosts in the array.
-
-In a HAWQ DBMS, each database instance (the master 
-and all segments) must be initialized across all of the hosts in 
-the system in such a way that they can all work together as a 
-unified DBMS. The gpinitsystem utility takes care of initializing 
-the HAWQ master and each segment instance, and configuring 
-the system as a whole.
-
-Before running gpinitsystem, you must set the $GPHOME environment 
-variable to point to the location of your Greenplum Database 
-installation on the master host and exchange SSH keys between 
-all host addresses in the array using gpssh-exkeys.
-
-This utility performs the following tasks:
-
-* Verifies that the parameters in the configuration file are correct.
-* Ensures that a connection can be established to each host address. 
-  If a host address cannot be reached, the utility will exit.
-* Verifies the locale settings.
-* Displays the configuration that will be used and prompts the 
-  user for confirmation.
-* Initializes the master instance.
-* Initializes the standby master instance (if specified).
-* Initializes the primary segment instances.
-* Configures the HAWQ system and checks for errors.
-* Starts the HAWQ system.
-
-
-*****************************************************
-OPTIONS
-*****************************************************
-
--a (do not prompt)
-
- Do not prompt the user for confirmation.
-
-
--B <parallel_processes>
-
- The number of segments to create in parallel. If not specified, 
- the utility will start up to 4 parallel processes at a time.
-
-
--c <gpinitsystem_config>
-
- Required. The full path and filename of the configuration file, which 
- contains all of the defined parameters to configure and initialize a 
- new HAWQ system. See INITIALIZATION CONFIGURATION FILE FORMAT below.
-
--D (debug)
-
- Sets log output level to debug.
-
-
--h <hostfile_gpinitsystem>
-
- Optional. The full path and file name of a file that contains the host 
- addresses of your segment hosts. If not specified on the command line, 
- you can specify the host file using the MACHINE_LIST_FILE parameter 
- in the gpinitsystem_config file.
-
-
---locale=<locale> | -n <locale>  
-
- Sets the default locale used by HAWQ. If not specified, 
- the LC_ALL, LC_COLLATE, or LANG environment variable of the master 
- host determines the locale. If these are not set, the default locale 
- is C (POSIX). A locale identifier consists of a language identifier 
- and a region identifier, and optionally a character set encoding. 
- For example, sv_SE is Swedish as spoken in Sweden, en_US is U.S. 
- English, and fr_CA is French Canadian. If more than one character 
- set can be useful for a locale, then the specifications look like 
- this: en_US.UTF-8 (locale specification and character set encoding). 
- On most systems, the command locale will show the locale environment 
- settings and locale -a will show a list of all available locales.
-
-
---lc-collate=<locale>
-
- Similar to --locale, but sets the locale used for collation (sorting data). 
- The sort order cannot be changed after Greenplum Database is initialized, 
- so it is important to choose a collation locale that is compatible with 
- the character set encodings that you plan to use for your data. There is a 
- special collation name of C or POSIX (byte-order sorting as opposed to 
- dictionary-order sorting). The C collation can be used with any 
- character encoding.
-
-
---lc-ctype=<locale>
-
- Similar to --locale, but sets the locale used for character classification 
- (what character sequences are valid and how they are interpreted). This 
- cannot be changed after Greenplum Database is initialized, so it is 
- important to choose a character classification locale that is compatible 
- with the data you plan to store in HAWQ.
-
-
---lc-messages=<locale>
-
- Similar to --locale, but sets the locale used for messages output by 
- HAWQ. The current version of HAWQ does not 
- support multiple locales for output messages (all messages are in English), 
- so changing this setting will not have any effect.
-
-
---lc-monetary=<locale> 
-
- Similar to --locale, but sets the locale used for formatting currency amounts.
-
-
---lc-numeric=<locale> 
-
- Similar to --locale, but sets the locale used for formatting numbers.
-
-
---lc-time=<locale>
-
- Similar to --locale, but sets the locale used for formatting dates and times.
-
-
--l <logfile_directory>
-
- The directory to write the log file. Defaults to ~/gpAdminLogs.
-
-
---max_connections=<number> | -m <number>
-
- Sets the maximum number of client connections allowed to the master. 
- The default is 25.
-
-
--p <postgresql_conf_param_file>
-
- Optional. The name of a file that contains postgresql.conf parameter 
- settings that you want to set for HAWQ. These settings 
- will be used when the individual master and segment instances are 
- initialized. You can also set parameters after initialization using 
- the gpconfig utility.
-
-
--q (no screen output)
-
- Run in quiet mode. Command output is not displayed on the screen, 
- but is still written to the log file.
-
-
---shared_buffers=<size> | -b <size>
-
- Sets the amount of memory a HAWQ server instance uses for shared 
- memory buffers. You can specify sizing in kilobytes (kB), megabytes (MB) 
- or gigabytes (GB). The default is 125MB.
-
-
--s <standby_master_host>
-
- Optional. If you wish to configure a backup master host, specify the 
- host name using this option. The HAWQ software must 
- already be installed and configured on this host.
-
-
---su_password=<superuser_password> | -e <superuser_password>
-
- The password to set for the HAWQ
- superuser. Defaults 
- to 'gparray'. You can always change the superuser password at a 
- later time using the ALTER ROLE command. Client connections over 
- the network require a password login for the database superuser 
- account (for example, the gpadmin user).
-
- Best practises: Always use passwords, do not use default passwords,
- change default passwords immediately after installation.
-
-
--v (show utility version)
-
- Displays the version of this utility.
-
-
--? (help)
-
- Displays the online help.
-
-
-*****************************************************
-INITIALIZATION CONFIGURATION FILE FORMAT
-*****************************************************
-
-gpinitsystem requires a configuration file with the following
-parameters defined. An example initialization configuration 
-file can be found in 
-$GPHOME/docs/cli_help/gpconfigs/gpinitsystem_config.
-
-ARRAY_NAME
-
- Required. A name for the array you are configuring. You can use 
- any name you like. Enclose the name in quotes if the name 
- contains spaces.
-
-
-MACHINE_LIST_FILE
-
- Optional. Can be used in place of the -h option. This specifies 
- the file that contains the list of segment host address names that 
- comprise the Greenplum system. The master host is assumed to be 
- the host from which you are running the utility and should not be 
- included in this file. If your segment hosts have multiple network 
- interfaces, then this file would include all addresses for the host. 
- Give the absolute path to the file.
-
-
-SEG_PREFIX
-
- Required. This specifies a prefix that will be used to name the 
- data directories on the master and segment instances. The naming 
- convention for data directories in a HAWQ system is 
- SEG_PREFIX<number> where <number> starts with 0 for segment 
- instances (the master is always -1). So for example, if you choose 
- the prefix gpseg, your master instance data directory would be 
- named gpseg-1, and the segment instances would be named 
- gpseg0, gpseg1, gpseg2, gpseg3, and so on.
-
-
-PORT_BASE
-
- Required. This specifies the base number by which primary segment 
- port numbers are calculated. The first primary segment port on a 
- host is set as PORT_BASE, and then incremented by one for each 
- additional primary segment on that host. Valid values range from 
- 1 through 65535.
-
-
-DATA_DIRECTORY
-
- Required. This specifies the data storage location(s) where the 
- utility will create the primary segment data directories. The 
- number of locations in the list dictate the number of primary 
- segments that will get created per physical host (if multiple 
- addresses for a host are listed in the host file, the number of 
- segments will be spread evenly across the specified interface 
- addresses). It is OK to list the same data storage area multiple 
- times if you want your data directories created in the same location. 
- The user who runs gpinitsystem (for example, the gpadmin user) must 
- have permission to write to these directories. For example, this 
- will create six primary segments per host:
-
-  declare -a DATA_DIRECTORY=(/data1/primary /data1/primary 
-  /data1/primary /data2/primary /data2/primary /data2/primary)
-
-
-MASTER_HOSTNAME
-
- Required. The host name of the master instance. This host name must 
- exactly match the configured host name of the machine (run the hostname 
- command to determine the correct hostname).
-
-
-MASTER_DIRECTORY
-
- Required. This specifies the location where the data directory will 
- be created on the master host. You must make sure that the user who runs 
- gpinitsystem (for example, the gpadmin user) has permissions to write 
- to this directory.
-
-
-MASTER_PORT
-
- Required. The port number for the master instance. This is the port 
- number that users and client connections will use when accessing the 
- HAWQ system.
-
-DFS_NAME
-
- Required. The distributed file system name for the HAWQ storing files.  
- Currently, HAWQ only supported hdfs
- 
-DFS_URL
-
- Required. The hostname, port, and relative path of distributed 
- file system. Currently, HAWQ only supported HDFS.
-
-
-TRUSTED_SHELL
-
- Required. The shell the gpinitsystem utility uses to execute commands 
- on remote hosts. Allowed values are ssh. You must set up your trusted 
- host environment before running the gpinitsystem utility (you can 
- use gpssh-exkeys to do this).
-
-
-CHECK_POINT_SEGMENTS
-
- Required. Maximum distance between automatic write ahead log (WAL) 
- checkpoints, in log file segments (each segment is normally 16 megabytes). 
- This will set the checkpoint_segments parameter in the postgresql.conf 
- file for each segment instance in the HAWQ system.
-
-
-ENCODING
-
- Required. The character set encoding to use. This character set must 
- be compatible with the --locale settings used, especially --lc-collate 
- and --lc-ctype. HAWQ supports the same character sets 
- as PostgreSQL.
-
-
-DATABASE_NAME
-
- Optional. The name of a HAWQ database to create after 
- the system is initialized. You can always create a database later 
- using the CREATE DATABASE command or the createdb utility.
-
-
-*****************************************************
-EXAMPLES
-*****************************************************
-
-Initialize a HAWQ array and set the superuser remote password:
-
- $ gpinitsystem -c gpinitsystem_config -h hostfile_gpinitsystem 
-   --su-password=mypassword
-
-
-Initialize a HAWQ array with an optional standby master host:
-
- $ gpinitsystem -c gpinitsystem_config -h hostfile_gpinitsystem -s host09S

http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/8ec87e6a/tools/doc/gpseginstall_help
----------------------------------------------------------------------
diff --git a/tools/doc/gpseginstall_help b/tools/doc/gpseginstall_help
deleted file mode 100644
index 3602a80..0000000
--- a/tools/doc/gpseginstall_help
+++ /dev/null
@@ -1,157 +0,0 @@
-COMMAND NAME:  gpseginstall
-
-Installs Greenplum Database on segment hosts.
-
-
-*****************************************************
-SYNOPSIS
-*****************************************************
-
-gpseginstall -f host_file [-u user] [-p password] 
-             [-c [u|p|c|s|E|e|l|v]]
-
-gpseginstall --help 
-
-
-*****************************************************
-DESCRIPTION
-*****************************************************
-
-The gpseginstall utility provides a simple way to quickly install Greenplum 
-Database on segment hosts that you specify in a host list file. The utility 
-does not install or update Greenplum Database on the master host. You can 
-run gpseginstall as root or as a non-root user. gpseginstall does not perform 
-database initialization. See gpinitsystem for more information about 
-initializing Greenplum Database.
-
-When run as root, gpseginstall default actions are to add a system user 
-(default is gpadmin), create a password (default is changeme), and deploy and 
-install Greenplum Database on segment hosts. To do this, gpseginstall locates 
-the current Greenplum Database binaries on the master from the installation 
-path in the current user�s environment variables ($GPHOME). It compresses 
-Greenplum Database software into a tar.gz file and performs an MD5 checksum 
-to verify file integrity. 
-
-Then, it copies Greenplum Database to the segment hosts, installs 
-(decompresses) Greenplum Database, and changes the ownership of the Greenplum 
-Database installation to the system user you specify with the -u option. 
-Lastly, it exchanges keys between all Greenplum Database hosts as both root 
-and as the system user you specify with the -u option. gpseginstall also perform 
-a user limit check and verifies the version number of Greenplum Database on all 
-the segments.
-
-If you run gpseginstall as a non-root user, gpseginstall only compresses, copies, 
-and installs Greenplum Database on segment hosts. It can also exchanges keys 
-between Greenplum Database hosts for the current system user, and verifies the 
-version number of Greenplum Database on all the segments.
-
-
-*****************************************************
-OPTIONS
-*****************************************************
-
--c | --commands command_option(s)
-
-This allows you to customize gpseginstall actions. Note that these command 
-options are executed by default if you do not specify the -c option in the 
-gpseginstall syntax.
-
-    * u: Adds a system user. (root only)
-
-    * p: Changes the password for a system user. (root only)
-
-    * s: Compresses, copies, decompresses (installs) Greenplum Database on all 
-         segments.
- 
-    * c: Changes the ownership of the Greenplum Database installation directory on 
-         the segment hosts. (root only)
-
-    * E: Exchange keys between Greenplum Database master and segment hosts for the 
-         root user. (root only)
-
-    * e: Exchange keys between Greenplum Database master and segment hosts for the 
-         non-root system user. 
-
-    * l: (Linux only) Checks and modifies the user limits configuration file 
-         (/etc/security/limits.conf file) when adding a new user to segment hosts. 
-         (root only)
-
-    * v: Verifies the version of Greenplum Database running on all segments. 
-         gpseginstall checks the version number of the Greenplum Database 
-         installation referenced by the $GPHOME environment variable and symbolic 
-         link to the installation directory. An error occurs if there is a version 
-         number mismatch or the Greenplum Database installation directory cannot be 
-         found.
-
-
--f | --file host_file
-
-This option is required. This specifies the file that lists the segment hosts 
-onto which you want to install Greenplum Database.
-
-The host list file must have one host name per line and includes a host name 
-for each segment host in your Greenplum system. Make sure there are no blank 
-lines or extra spaces. If a host has multiple configured host names, use only 
-one host name per host. For example:
-
-sdw1-1
-sdw2-1
-sdw3-1
-sdw4-1
-
-If available, you can use the same gpssh-exkeys host list file you used to 
-exchange keys between Greenplum Database hosts.
-
-
--p | --password password
-
-This sets the password for the user you specify with the -u option. The 
-default password is changeme. This option is only available when you run 
-gpseginstall as root.
-
-Best practises: Always use passwords, do not use default passwords, 
-change default passwords immediately after installation.
-
-
--u | --user user
-
-This specifies the system user. This user is also the Greenplum Database 
-administrative user. This user owns Greenplum Database installation and 
-administers the database. This is also the user under which Greenplum 
-Database is started/initialized. This option is only available when you run 
-gpseginstall as root. The default is gpadmin. 
-
-
---help (help)
-
-Displays the online help.
-
-
-*****************************************************
-EXAMPLES
-*****************************************************
-
-As root, install a Greenplum Database on all segments, leave the system user 
-as the default (gpadmin) and set the gpadmin password to secret123:
-
-$ gpseginstall -f my_host_list_file -p secret123
-
-As a non-root user, compress and copy Greenplum Database binaries to all 
-segments (as gpadmin)
-
-$ gpseginstall -f host_file
-
-As root, add a user (gpadmin2), set the password for the user (secret1234), 
-exchange keys between hosts as the new user, check user limits, and verify 
-version numbers, but do not change ownership of Greenplum binaries, 
-compress/copy/ install Greenplum Database on segments, or exchange keys as 
-root.
-
-$ gpseginstall -f host_file -u gpadmin2 -p secret1234 -c upelv
-
-
-*****************************************************
-SEE ALSO
-*****************************************************
-
-gpinitsystem
\ No newline at end of file


Mime
View raw message