[ https://issues.apache.org/jira/browse/DRILL-4587?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Paul Rogers updated DRILL-4587: ------------------------------- Description: Drill provides the drillbit.sh script to launch Drill. When Drill is run in production environments, or when managed by a tool such as Mesos or YARN, customers have many options to customize the launch options. We should document this information as below. The user can configure Drill launch in one of four ways, depending on their needs. 1. Using the properties in drill-override.conf. Sets only startup and runtime properties. All drillbits should use a copy of the file so that properties set here apply to all drill bits and to client applications. 2. By setting environment variables prior to launching Drill. See the list below. Use this to customize properties per drill-bit, such as for setting port numbers. This option is useful when launching Drill from a tool such as Mesos or YARN. 3. By setting environment variables in $DRILL_HOME/conf/drill-env.sh. See the list below. This script is intended to be unique to each node and is another way to customize properties for this one node. 4. In Drill 1.7 and later, the administrator can set Drill configuration options directly on the launch command as shown below. This option is also useful when launching Drill from a tool such as YARN or Mesos. Options are of the form: $ drillbit.sh start -Dvariable=value For example, to control the HTTP port: $ drillbit.sh start -Ddrill.exec.http.port=8099 Properties are of three types. 1. Launch-only properties: those that can be set only through environment variables (such as JAVA_HOME.) 2. Drill startup properties which can be set in the locations detailed below. 3. Drill runtime properties which are set in drill-override.conf also via SQL. Drill startup propeties can be set in a number of locations. Those listed later take precedence over those listed earlier. 1. Drill-override.conf as identified by DRILL_CONF_DIR or its default. 2. Set in the environment using DRILL_JAVA_OPTS or DRILL_DRILLBIT_JAVA_OPTS. 3. Set in drill-env.sh using the above two variables. 4. Set on the drill.bit command line as explained above. (Drill 1.7 and later.) You can see the actual set of properties used (from items 2-3 above) by using the "debug" command (Drill 1.7 or later): $ drillbit.sh debug was: Drill provides the drillbit.sh script to launch Drill. When Drill is run in production environments, or when managed by a tool such as Mesos or YARN, customers have many options to customize the launch options. We should document this information as below. The user can configure Drill launch in one of four ways, depending on their needs. 1. Using the properties in drill-override.conf. Sets only startup and runtime properties. All drillbits should use a copy of the file so that properties set here apply to all drill bits and to client applications. 2. By setting environment variables prior to launching Drill. See the list below. Use this to customize properties per drill-bit, such as for setting port numbers. This option is useful when launching Drill from a tool such as Mesos or YARN. 3. By setting environment variables in $DRILL_HOME/conf/drill-env.sh. See the list below. This script is intended to be unique to each node and is another way to customize properties for this one node. 4. In Drill 1.7 and later, the administrator can set Drill configuration options directly on the launch command as shown below. This option is also useful when launching Drill from a tool such as YARN or Mesos. Options are of the form: $ drillbit.sh start -Dvariable=value For example, to control the HTTP port: $ drillbit.sh start -Ddrill.exec.http.port=8099 Properties are of three types. 1. Launch-only properties: those that can be set only through environment variables (such as JAVA_HOME.) 2. Drill startup properties which can be set in the locations detailed below. 3. Drill runtime properties which are set in drill-override.conf also via SQL. Drill startup propeties can be set in a number of locations. Those listed later take precedence over those listed earlier. 1. Drill-override.conf as identified by DRILL_CONF_DIR or its default. 2. Set in the environment using DRILL_JAVA_OPTS or DRILL_DRILLBIT_JAVA_OPTS. 3. Set in drill-env.sh using the above two variables. 4. Set on the drill.bit command line as explained above. (Drill 1.7 and later.) You can see the actual set of properties used (from items 2-3 above) by using the "debug" command: $ drillbit.sh debug > Document Drillbit launch options > -------------------------------- > > Key: DRILL-4587 > URL: https://issues.apache.org/jira/browse/DRILL-4587 > Project: Apache Drill > Issue Type: Improvement > Components: Documentation > Reporter: Paul Rogers > Assignee: Bridget Bevens > > Drill provides the drillbit.sh script to launch Drill. When Drill is run in > production environments, or when managed by a tool such as Mesos or YARN, > customers have many options to customize the launch options. We should > document this information as below. > The user can configure Drill launch in one of four ways, depending on their > needs. > 1. Using the properties in drill-override.conf. Sets only startup and runtime > properties. All drillbits should use a copy of the file so that properties > set here apply to all drill bits and to client applications. > 2. By setting environment variables prior to launching Drill. See the list > below. Use this to customize properties per drill-bit, such as for setting > port numbers. This option is useful when launching Drill from a tool such as > Mesos or YARN. > 3. By setting environment variables in $DRILL_HOME/conf/drill-env.sh. See the > list below. This script is intended to be unique to each node and is another > way to customize properties for this one node. > 4. In Drill 1.7 and later, the administrator can set Drill configuration > options directly on the launch command as shown below. This option is also > useful when launching Drill from a tool such as YARN or Mesos. Options are of > the form: > $ drillbit.sh start -Dvariable=value > For example, to control the HTTP port: > $ drillbit.sh start -Ddrill.exec.http.port=8099 > Properties are of three types. > 1. Launch-only properties: those that can be set only through environment > variables (such as JAVA_HOME.) > 2. Drill startup properties which can be set in the locations detailed below. > 3. Drill runtime properties which are set in drill-override.conf also via SQL. > Drill startup propeties can be set in a number of locations. Those listed > later take precedence over those listed earlier. > 1. Drill-override.conf as identified by DRILL_CONF_DIR or its default. > 2. Set in the environment using DRILL_JAVA_OPTS or DRILL_DRILLBIT_JAVA_OPTS. > 3. Set in drill-env.sh using the above two variables. > 4. Set on the drill.bit command line as explained above. (Drill 1.7 and > later.) > You can see the actual set of properties used (from items 2-3 above) by using > the "debug" command (Drill 1.7 or later): > $ drillbit.sh debug -- This message was sent by Atlassian JIRA (v6.3.4#6332)