Copies the Platfora software and configuration directories from the current node to the specified remote node(s).
Synopsis
install-node --host hostname | --hostsfile filename [-h] [-q] [-v] [-V] Description
The install-node utility copies the $PLATFORA_HOME directory from the current node to the specified remote nodes. It also synchronizes the configuration files in the $PLATFORA_CONF_DIR directory. You can use the install-node utility to copy a Platfora software installation to a remote node that has not yet been added to your Platfora cluster configuration.
This utility is also called indirectly by the platfora-services sync, platfora-node add, platfora-node sync, and setup.py upgrade utilities. Platfora recommends using these utilities when adding new nodes or upgrading existing nodes in your Platfora cluster configuration.
Files are copied to the remote node as the currently logged in system user. The $PLATFORA_HOME and $PLATFORA_CONF_DIR directory locations must exist on the remote node, and the current system must have sufficient file system permissions to write to these locations.
Required Arguments
One of either --host or --hostsfile is required. --host hostname
Copies the Platfora software and configuration directories to the specified host name or IP address. --host hostsfile
Copies the Platfora software and configuration directories to the host names or IP addresses specified in the named file, one host per line.
Optional Arguments -h | --help
Shows the command-line syntax help and then exits. -q | --quiet
Runs in quiet mode. Do not send output messages to STDOUT. -v, -vv, -vvv | --verbose
-V | --version
Shows the software version information and then exits. Examples
Install the Platfora software on the remote host named myremotehost by copying over the Platfora installation installed on the local host:
$ install-node --host myremotehost
platfora-catalog
Manages the Platfora metadata catalog database in PostgreSQL. Synopsis
platfora-catalog [-h] [-q] [-v] [-V] init | start | stop | status | backup | restore | upgrade | pswd | keygen | ssl [sub-command options]
Description
Use the platfora-catalog utility to manage the Platfora metadata catalog database in PostgreSQL. When you first install and initialize Platfora using setup.py, it initializes a PostgreSQL database instance using the default PostgreSQL port (5432) and creates a platfora database in the
$PLATFORA_DATA_DIR location. You run this utility by passing one its subcommands either directly or indirectly through the setup.py and platfora-services utilities. The following subcommands you can call directly.
Subcommand Description
backup Dumps the contents of the platfora catalog database to a backup file. restore Restores the platfora catalog database using a backup file.
pswd Creates a new encrypted superuser password for the platfora
metadata catalog database. Platfora encrypts the stored password using 128-bit AES encryption. This command is called by setup.py during new installations (in 4.1.3 and later releases). You must run platfora- services stop before running this command.
keygen Generates a new key that is used to encrypt the password used to access the platfora metadata catalog database and re-encrypts the password using the new key. You must run platfora-services stop before running this command.
Subcommand Description
ssl Controls whether or not worker nodes use an SSL connection to communicate with the metadata catalog database. You must run platfora-services stop before running this command. These subcommands are called indirectly, but you can also call them directly:
Subcommand Description
init Initializes a new Platfora metadata catalog database. This command is called by setup.py during new installations.
start Starts the PostgreSQL database server. This command is called by platfora-services start.
stop Stops the PostgreSQL database server. This command is called by platfora-services stop.
status Shows the status of the PostgreSQL database server process. This command is called by platfora-services status.
migrate Migrates individual elements in the platfora metadata catalog database from one DFS location to another.
upgrade Upgrades the schema in the platfora catalog to the latest installed Platfora version. This command is called by setup.py during upgrade. Required Arguments
Requires one of the following sub-commands: init, start, stop, status, backup, restore, pswd, keygen, ssl, or upgrade. To see the arguments available with a sub-command, enter the following command-line string:
platfora-catalog sub-command --help Optional Arguments
-h | --help
Shows the command-line syntax help and then exits. -q | --quiet
Runs in quiet mode. Do not send output messages to STDOUT. -v, -vv, -vvv | --verbose
Shows the software version information and then exits.
platfora-catalog ssl
Controls whether or not worker nodes use an SSL connection to communicate with the metadata catalog database in PostgreSQL.
Synopsis
platfora-catalog ssl [-h] [--enable] [--disable] [--self] [--manual] [-- cert_file certificate_file] [--key_file private_key_file]
Description
The platfora-catalog ssl command controls whether or not worker nodes use an SSL connection to communicate with the metadata catalog database in PostgreSQL. By default, SSL connections are not enabled. Note that the Platfora server must be stopped to run this command.
To enable SSL connections between worker nodes and the metadata database on the master node, the PostgreSQL database that Platfora uses must support and enable SSL.
Required Arguments
No required arguments.
Optional Arguments
-h | --help
Shows the command-line syntax help and then exits. --enable
Specifies that worker nodes should use an SSL connection when communicating with the metadata database on the master node. When enabled, Platfora distributes the server certificate to the worker nodes every time the server starts. Enabling SSL may increase lens build times. Platfora only recommends enabling this feature if your organization's security requirements deem it necessary. --disable
Disables SSL connections between worker nodes and the metadata database on the master node. --self
Specifies to use a self-signed server certificate and key when enabling SSL connections. When you use this argument, Platfora generates and signs its own server certificate and private key.
Specifies to use a server certificate and private key uploaded to Platfora, typically generated by a certificate authority (CA). You must specify the certificate and private key using the --cert_file and --
key_file arguments. --cert_file certificate_file
The path and file name of the server certificate to use. --key_file private_key_file
The path and file name of the server private key to use.
Examples
Use SSL connections between worker nodes and the PostgreSQL database using a self-signed server certificate and private key:
$ platfora-catalog ssl --enable --self
Use SSL connections between worker nodes and the PostgreSQL database using a server certificate and private key generated by a certificate authority (CA).
$ platfora-catalog ssl --enable --manual --cert_file file.crt --key_file file.key
Disable SSL connections between the worker node and the PostgreSQL database: $ platfora-catalog ssl --disable