The name of the cluster.

For CDH clusters (Oracle Big Data Appliance or other), this name can be either the physical cluster name or the display name. The installer searches first by physical name and then by display name.

The name parameter is required only if Cloudera Manager will manage two or more clusters.

Possible values: "12.1"| "12.2"| "18"|"19"| "full"

For example, either of these settings enables support for Oracle Database 12.1, 12.2, 18c, and 19c.

"database_compatibility" : [ "12.1" ]
"database_compatibility" : [ "full" ]

Either of the following settings enables support for Oracle Database 12.2, and 18c, but disable support for Oracle Database 12.1. By disabling support for Oracle Database 12.1 if it is not needed, you conserve some system resources, particularly memory.

"database_compatibility" : [ "12.2" ]
"database_compatibility" : [ "18" ]

The default is "full".

Default: the local hostname.

The cluster health check verifies that HDFS, Hive and Yarn services are running with good health and are not stale. Additionally, for CDH clusters, management services should be running with good health and not stale.

Default: "false".

Cloudera Manager or Ambari REST API port.

By default, on CDH clusters this port is 7183 for secured and 7180 for unsecured access. For Ambari, is 8443 for secured and 8080 for unsecured.

Optional.

If “true”, then services with stale configurations are restarted at the end of install process. These services are HDFS NodeName, YARN NodeManager and/or Hive (depending upon the settings selected).

If “false”, the installation will finish but those services will remain on stale state. This is useful for avoiding unwanted service interruptions. You can then restart later when it is more convenient.

Optional. The default is “true”.

Default: "false"

Hostname of the node where the Query Server database will be running (if enabled).

Default: "false".

http_proxy
https_proxy

Specify the proxy settings to enable download of the Hadoop client tarballs and cluster settings files.

If both of these strings are empty, the OS environment proxy settings are used.

By default, both strings are empty.

Using these two parameters in the configuration file is optional. If they are needed, you could instead set them externally as in export http_proxy=<proxy value>

Not applicable to Oracle Big Data Appliance

List additional nodes where the BDSAgent should be installed

The BDSAgent and BDSServer roles are installed on all DataNodes instances. In addition, BDSAgent is installed on cluster nodes running HiveServer2 and HiveMetaStore instances. All remaining nodes are automatically excluded unless you add them here.

Default: empty

If "true", Hadoop impersonation for Multi-user Authorization support is enabled. This sets up the oracle OS user as the Hadoop proxy user and propagates the proxy user’s black list to the database nodes. If "false", this feature is not enabled.

Default value: "true" in Oracle Big Data SQL 4.x and higher.

The fully-qualified Kerberos principal name for a user. Before 4.1 the principal had to be oracle user. Starting with 4.1 the principal can be that of the oracle user or any other user. The Jaguar installer does not create the principal or the keytab. These must already exist.

The principal has three parts:

• The User Name:

  The name of the Linux account associated with the principal. Note that Kerberos principal names are case-sensitive.

• Qualifier: "/<qualifier>." This is optional information to help you organize and identify principals.

• Domain: "@MY.<DOMAIN>.COM." This is required information managed by the KDC.

The Oracle Big Data SQL installation uses the Kerberos principal field (and keytab field below) to set up Kerberos authentication and automated Kerberos ticket renewal for the user represented by the principal. It does this on the Hadoop cluster. It also does it on the Oracle Database system automatically if two conditions are true:

• The principal to be used on the Hadoop cluster and the Oracle Database system are the same.
• The principal for the database owner does not exist. If the database owner principle does exist, it takes precedence and is used for authentication.

Required for secured clusters.

Note: Later, when you perform the database-side installation of Big Data SQL, review the description of the --alternate-principal install parameter in the Command Line Parameter Reference for bds-database-install.sh . This reference provides steps to take prior the database-side installation if the principal used on the Hadoop and database sides are not the same, or if the principal required is not that of the database owner.

Specifies a principal on the KDC server for use by Query Server (and only Query Server). It is not used for authentication against an external Oracle Database.

Both db-service-principal and db-service-keytab are used to validate the Kerberos ticket presented by a client . Note that the parameters SQLNET.AUTHENTICATION_KERBEROS5_SERVICE and SQLNET.KERBEROS5_KEYTAB in sqlnet.ora will be set accordingly.

The qualifier for the principal name must match the fully qualified domain name of the node where the Query Server will be running.

Required for secured clusters.

Fully-qualified location of the keytab file for the principal specificed with db-service-principal.

Be sure to store the keytab in a location that is accessible to the Jaguar installer.

The sync_principals parameter specifies whether or not Jaguar automatically gets a list of principals from a KDC running on a cluster node and then uses the list to create externally-identified database users for Query Server.

If set to true, then an automatic synchronization with Kerberos principals occurs during Jaguar install and reconfigure operations. The user can also call this synchronization at any time by invoking the sync_principals operation of Jaguar on the command line.

Default: "true".

Fully-qualified path to the principal keytab file. A keytab file is created for each principal on the KDC server. It must exist in a location accessible to the Jaguar installer.

Required for secured clusters.

Fully-qualified location for the principal’s keytab file name.

Copy the keytab file to a location accessible to the Jaguar installer and set the path as the value of this parameter.

Fully-qualified Kerberos principal name for the "hdfs" user. It has three parts: User name, Qualifier, and Domain.

The User name is the fully-qualified principal name for the hdfs user. Qualifier is the cluster name prefixed by a forward slash, as in /mycluster. Domain is specified in the form @MY.<DOMAIN>.COM. All three are required. The principal name is defined on the KDC.

Required for secured clusters.

List of directories where the Hadoop clients for deployment on the database side are located. These directories can be on the local file system or on NFS. Directories are searched in the order listed. By default, the list is empty. If the dir list has any entries, these are searched before the URL list is searched, since this option should provide the fastest access to the clients. To give the installer the quickest access to the tarballs, you could set up a local repository, download the tarballs separately though a direct Internet connection, copy them into a directory on the same node where the Oracle Big Data SQL installer will run, and list that directory in the dir parameter.

Optional.

Not applicable to Oracle Big Data Appliance, which already includes the required clients.

Important: The dir and url parameters are not supported on Cloudera 6.x systems. On these systems, you can specify a repository when you run the installer on the database side.

This is the list of URLs where the Hadoop client tarballs for deployment on the database side are located. If you data center already has repositories set up for access via HTTP, then you may prefer to maintain the Hadoop tarballs in that repository and use URL parameter for Oracle Big Data SQL installations. The URLs can be to the localhost, an internal network, or a site on the Internet (if the node has Internet access). The URLs are tried in the order listed. Note that internal proxy values and/or OS environment proxy settings must be set to allow this access if needed.

If access to all listed repositories fails and/or Internet access is blocked, the database installation bundle is not created and a warning message is displayed. After correcting any problems and providing access to a repository, you can re-run the installer using the reconfigure and the installer should successfully generate the database-side installation bundle. Note that reconfigure detects and implements changes according the current directives in the configuration file. It does not uninstall and reinstall Oracle Big Data SQL on the cluster.

Not applicable to Big Data Appliance, where the tarballs are stored in a local repository in the cluster and the location is automatically added to the configuration file.

If “true”, the communication will be set through private network interface, if "false" by client network interface.

Used for Oracle Big Data Appliance clusters only.

Default value: “false”.

If Hadoop cluster nodes have several network interfaces, you can use selection_subnet to select one. The selected IP address will be the nearest to the selection subnetwork.

If the Hadoop cluster nodes have only one network interface, this parameter is ignored.

The default value depends upon these conditions:

• On non-Oracle commodity Hadoop clusters (CDH or HDP) the default selection is 0.0.0.0/0. (If a cluster node has several IP addresses, the lowest address is selected.)

• On Oracle Big Data Appliance, the default is either the private or client IP address, depending upon the setting of the use_infiniband parameter.

If "true", the database authentication through the GUID-key mechanism is enabled. This requires an extra step in the installation process in order to set up the database GUID-key pair on the cluster side.

If "false", the feature will not be enabled.

Default value: "true".

The Hadoop proxy users blacklisted for impersonation. This parameter is used only if Hadoop impersonation is enabled.

Since this is a required setting on the Oracle Database side, it is provided with a default value of "dummy" in order to avoid extproc errors that can occur if Hadoop Impersonation is not enabled.

If "true", the proxy hosts variable is set to the IP address of the database node.

If "false", the proxy hosts variable is set to the wildcard: "*".

Default value: "true".

The minimum amount of memory reserved for Big Data SQL, in megabytes. This parameter is used on CDH clusters (Oracle Big Data Appliance and others). It is not used on HDP clusters. By default, the value is 32768 MB (32 GB) .

If you set the database_compatibilityparameter to "full", then the value of min_hard_limit must be 64 MB.

On CDH clusters (Oracle Big Data Appliance and others) this parameter specifies the percentage of memory on each node to reserve for Big Data SQL. This percentage is considered from a total amount of: NodeManager if YARN ResourceManager is enabled for that node. Physical memory if not.

If the YARN Resource Manager is enabled for the node, then percentage should be based on the total amount of memory used by the NodeManager. Otherwise it should be a percentage of physical memory.

This parameter is ignored on HDP clusters.

Default value: "hdfs"

Note: By default, Jaguar assumes Hive and HDFS usernames and groups. But if you used different names in your Hadoop installation, then use the hadoop_ids parameters to identify them.

Default value: "hdfs"

Default value: "hive"

Default value: "hive"

The --requestdb parameter is not strictly required by the install operation, but you cannot enable Database Authentication if you do not generate a request key for each database.

Installs Oracle Big Data SQL on the Hadoop cluster identified in the configuration file and creates an installation bundle for the database side based on the parameters included in the configuration file (or default values for parameters not explicitly assigned value in the configuration file). Examples:

# ./jaguar --requestdb orcl,testdb,proddb install

No configuration file parameter is included in the above example. bds-config.json is the implicit default. You can specify a different configuration file as in./jaguar --requestdb mydb install myconfig.json

scl enable python27 "./jaguar install"

On Big Data Appliance clusters running Oracle Linux 6 and Oracle Linux 7, scl is not needed in order call the correct Python version for Jaguar.

Modify the current installation by applying changes you have made to the configuration file (bds-config.json or other).

# ./jaguar reconfigure myconfigfile.json

Note that if you run ./jaguar reconfigure <config file> to reconfigure Oracle Big Data SQL on the Hadoop cluster, a corresponding reconfiguration is required on the Oracle Database side. The two sides cannot communicate if the configurations do not match. The Jaguar utility regenerates the database-side bundle files to incorporate the changes, You must redeploy the bundle on all database servers where it was previously installed.

The --requestdb argument is required if database_auth_enabled is set to “true” in the updated configuration file. This is so that Jaguar will generate .reqkey files that are included in the database-side installation bundle. Note that we let the configuration file parameter default to bds-config.json.

# ./jaguar --requestdb demodb,testdb,proddb1 reconfigure 

Use this command to create the .reqkey file without repeating the Hadoop-side installation, or doing a reconfigure operation. (For example, if you forgot to include the --requestdb argument with the Jaguar install command), you can create a request key later with databasereq. This operation requires that database_auth_enabled is set to “true” (the default value) in the configuration.

# ./jaguar --requestdb demodb,testdb,proddb1 databasereq  

The “Database Acknowledge” process provides confirmation to the Oracle Big Data SQL installation on the Hadoop cluster that security features you enabled in the configuration file have been successfully implemented in the database-side installation. It then completes implementation of the selected security features on the Hadoop cluster side.

./jaguar databaseack bds-config.json

Only run databaseack if you chose to enable security features by setting either of these parameters in the configuration file to “true”:

• "impersonation_enabled" : "true"

• "database_auth_enabled" : "true"

If a database-side installation bundle is built with any of these features set to “true”, then the database-side installation from that bundle generates a ZIP file in the installation directory under $ORACLE_HOME on the database server. The format of the ZIP file name is <Hadoop cluster name>-<Number nodes in the cluster>-<FQDN of the cluster management server node>-<FQDN of this database node>.zip. For example:

$ ls $ORACLE_HOME/BDSJaguar-4.1.2/cdh510-6-node1.my.<domain>.com/*.zip
$ cdh510-6-node1.my.<domain>.com-myoradb1.my<domain>.com.zip

Copy this zip archive back to /opt/oracle/DM/databases/conf on the Hadoop cluster management server after the database-side installation is complete. Then, to fully enable the security features, run databaseack.

Gets a list of principals from a KDC running on a cluster node and use it to create externally-identified database users in Query Server. You can do the same by including the similarly-named sync_principals parameter in a Jaguar configuration file during Jaguar install and reconfigure operations.

Uninstall Oracle Big Data SQL from the Hadoop cluster.

The uninstall process stops the bd_cell process (the Oracle Big Data SQL process) on all Hadoop cluster nodes, removes all instances from Hadoop cluster, and release all related resources.