http://git-wip-us.apache.org/repos/asf/kudu/blob/d114777e/docs/configuration_reference.html ---------------------------------------------------------------------- diff --git a/docs/configuration_reference.html b/docs/configuration_reference.html index 874e135..7600f4f 100644 --- a/docs/configuration_reference.html +++ b/docs/configuration_reference.html @@ -2,7 +2,7 @@ title: Apache Kudu Configuration Reference layout: default active_nav: docs -last_updated: 'Last updated 2017-02-02 14:03:11 PST' +last_updated: 'Last updated 2017-03-20 16:43:12 PDT' --- <!-- @@ -189,6 +189,35 @@ configuration tasks.</p> </div> </div> <div class="sect3"> +<h4 id="kudu-master_keytab_file"><a class="link" href="#kudu-master_keytab_file"><code>--keytab_file</code></a></h4> +<div class="paragraph"> +<p>Path to the Kerberos Keytab file for this server. Specifying a keytab file will cause the server to kinit, and enable Kerberos to be used to authenticate RPC connections.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> <h4 id="kudu-master_rpc_bind_addresses"><a class="link" href="#kudu-master_rpc_bind_addresses"><code>--rpc_bind_addresses</code></a></h4> <div class="paragraph"> <p>Comma-separated list of addresses to bind to for RPC connections. Currently, ephemeral ports (i.e. port 0) are not allowed.</p> @@ -218,6 +247,93 @@ configuration tasks.</p> </div> </div> <div class="sect3"> +<h4 id="kudu-master_superuser_acl"><a class="link" href="#kudu-master_superuser_acl"><code>--superuser_acl</code></a></h4> +<div class="paragraph"> +<p>The list of usernames to allow as super users, comma-separated. A '*' entry indicates that all authenticated users are allowed. If this is left unset or blank, the default behavior is that the identity of the daemon itself determines the superuser. If the daemon is logged in from a Keytab, then the local username from the Kerberos principal is used; otherwise, the local Unix username is used.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">sensitive,stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-master_user_acl"><a class="link" href="#kudu-master_user_acl"><code>--user_acl</code></a></h4> +<div class="paragraph"> +<p>The list of usernames who may access the cluster, comma-separated. A '*' entry indicates that all authenticated users are allowed.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">sensitive,stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-master_webserver_certificate_file"><a class="link" href="#kudu-master_webserver_certificate_file"><code>--webserver_certificate_file</code></a></h4> +<div class="paragraph"> +<p>The location of the debug webserver’s SSL certificate file, in PEM format. If empty, webserver SSL support is not enabled</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> <h4 id="kudu-master_webserver_port"><a class="link" href="#kudu-master_webserver_port"><code>--webserver_port</code></a></h4> <div class="paragraph"> <p>Port to bind to for the web server</p> @@ -247,6 +363,64 @@ configuration tasks.</p> </div> </div> <div class="sect3"> +<h4 id="kudu-master_webserver_private_key_file"><a class="link" href="#kudu-master_webserver_private_key_file"><code>--webserver_private_key_file</code></a></h4> +<div class="paragraph"> +<p>The full path to the private key used as a counterpart to the public key contained in --ssl_server_certificate. If --ssl_server_certificate is set, this option must be set as well.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-master_webserver_private_key_password_cmd"><a class="link" href="#kudu-master_webserver_private_key_password_cmd"><code>--webserver_private_key_password_cmd</code></a></h4> +<div class="paragraph"> +<p>A Unix command whose output returns the password used to decrypt the Webserver’s certificate private key file specified in --webserver_private_key_file. If the PEM key file is not password-protected, this command will not be invoked. The output of the command will be truncated to 1024 bytes, and then all trailing whitespace will be trimmed before it is used to decrypt the private key</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> <h4 id="kudu-master_log_filename"><a class="link" href="#kudu-master_log_filename"><code>--log_filename</code></a></h4> <div class="paragraph"> <p>Prefix of log filename - full path is <log_dir>/<log_filename>.[INFO|WARN|ERROR|FATAL]</p> @@ -1253,9 +1427,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_rpc_bind_addresses"><a class="link" href="#kudu-tserver_rpc_bind_addresses"><code>--rpc_bind_addresses</code></a></h4> +<h4 id="kudu-tserver_keytab_file"><a class="link" href="#kudu-tserver_keytab_file"><code>--keytab_file</code></a></h4> <div class="paragraph"> -<p>Comma-separated list of addresses to bind to for RPC connections. Currently, ephemeral ports (i.e. port 0) are not allowed.</p> +<p>Path to the Kerberos Keytab file for this server. Specifying a keytab file will cause the server to kinit, and enable Kerberos to be used to authenticate RPC connections.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1269,7 +1443,7 @@ configuration tasks.</p> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.0.0.0</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -1282,9 +1456,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_webserver_port"><a class="link" href="#kudu-tserver_webserver_port"><code>--webserver_port</code></a></h4> +<h4 id="kudu-tserver_rpc_bind_addresses"><a class="link" href="#kudu-tserver_rpc_bind_addresses"><code>--rpc_bind_addresses</code></a></h4> <div class="paragraph"> -<p>Port to bind to for the web server</p> +<p>Comma-separated list of addresses to bind to for RPC connections. Currently, ephemeral ports (i.e. port 0) are not allowed.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1294,11 +1468,11 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.0.0.0</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -1311,9 +1485,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_tserver_master_addrs"><a class="link" href="#kudu-tserver_tserver_master_addrs"><code>--tserver_master_addrs</code></a></h4> +<h4 id="kudu-tserver_superuser_acl"><a class="link" href="#kudu-tserver_superuser_acl"><code>--superuser_acl</code></a></h4> <div class="paragraph"> -<p>Comma separated addresses of the masters which the tablet server should connect to. The masters do not read this flag — configure the masters separately using 'rpc_bind_addresses'.</p> +<p>The list of usernames to allow as super users, comma-separated. A '*' entry indicates that all authenticated users are allowed. If this is left unset or blank, the default behavior is that the identity of the daemon itself determines the superuser. If the daemon is logged in from a Keytab, then the local username from the Kerberos principal is used; otherwise, the local Unix username is used.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1327,11 +1501,11 @@ configuration tasks.</p> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>127.0.0.1:7051</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sensitive,stable</p></td> </tr> </tbody> </table> @@ -1340,9 +1514,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_log_filename"><a class="link" href="#kudu-tserver_log_filename"><code>--log_filename</code></a></h4> +<h4 id="kudu-tserver_user_acl"><a class="link" href="#kudu-tserver_user_acl"><code>--user_acl</code></a></h4> <div class="paragraph"> -<p>Prefix of log filename - full path is <log_dir>/<log_filename>.[INFO|WARN|ERROR|FATAL]</p> +<p>The list of usernames who may access the cluster, comma-separated. A '*' entry indicates that all authenticated users are allowed.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1356,11 +1530,11 @@ configuration tasks.</p> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">sensitive,stable</p></td> </tr> </tbody> </table> @@ -1369,9 +1543,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_maintenance_manager_num_threads"><a class="link" href="#kudu-tserver_maintenance_manager_num_threads"><code>--maintenance_manager_num_threads</code></a></h4> +<h4 id="kudu-tserver_webserver_certificate_file"><a class="link" href="#kudu-tserver_webserver_certificate_file"><code>--webserver_certificate_file</code></a></h4> <div class="paragraph"> -<p>Size of the maintenance manager thread pool. For spinning disks, the number of threads should not be above the number of devices.</p> +<p>The location of the debug webserver’s SSL certificate file, in PEM format. If empty, webserver SSL support is not enabled</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1381,11 +1555,11 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -1398,9 +1572,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_memory_limit_hard_bytes"><a class="link" href="#kudu-tserver_memory_limit_hard_bytes"><code>--memory_limit_hard_bytes</code></a></h4> +<h4 id="kudu-tserver_webserver_port"><a class="link" href="#kudu-tserver_webserver_port"><code>--webserver_port</code></a></h4> <div class="paragraph"> -<p>Maximum amount of memory this daemon should use, in bytes. A value of 0 autosizes based on the total system memory. A value of -1 disables all memory limiting.</p> +<p>Port to bind to for the web server</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1410,7 +1584,7 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> @@ -1427,9 +1601,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_flagfile"><a class="link" href="#kudu-tserver_flagfile"><code>--flagfile</code></a></h4> +<h4 id="kudu-tserver_webserver_private_key_file"><a class="link" href="#kudu-tserver_webserver_private_key_file"><code>--webserver_private_key_file</code></a></h4> <div class="paragraph"> -<p>load flags from file</p> +<p>The full path to the private key used as a counterpart to the public key contained in --ssl_server_certificate. If --ssl_server_certificate is set, this option must be set as well.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1456,9 +1630,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_help"><a class="link" href="#kudu-tserver_help"><code>--help</code></a></h4> +<h4 id="kudu-tserver_webserver_private_key_password_cmd"><a class="link" href="#kudu-tserver_webserver_private_key_password_cmd"><code>--webserver_private_key_password_cmd</code></a></h4> <div class="paragraph"> -<p>show help on all flags [tip: all flags can have two dashes]</p> +<p>A Unix command whose output returns the password used to decrypt the Webserver’s certificate private key file specified in --webserver_private_key_file. If the PEM key file is not password-protected, this command will not be invoked. The output of the command will be truncated to 1024 bytes, and then all trailing whitespace will be trimmed before it is used to decrypt the private key</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1468,11 +1642,11 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -1485,9 +1659,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_version"><a class="link" href="#kudu-tserver_version"><code>--version</code></a></h4> +<h4 id="kudu-tserver_tserver_master_addrs"><a class="link" href="#kudu-tserver_tserver_master_addrs"><code>--tserver_master_addrs</code></a></h4> <div class="paragraph"> -<p>show version and build info and exit</p> +<p>Comma separated addresses of the masters which the tablet server should connect to. The masters do not read this flag — configure the masters separately using 'rpc_bind_addresses'.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1497,11 +1671,11 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>127.0.0.1:7051</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -1514,9 +1688,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_colorlogtostderr"><a class="link" href="#kudu-tserver_colorlogtostderr"><code>--colorlogtostderr</code></a></h4> +<h4 id="kudu-tserver_log_filename"><a class="link" href="#kudu-tserver_log_filename"><code>--log_filename</code></a></h4> <div class="paragraph"> -<p>color messages logged to stderr (if supported by terminal)</p> +<p>Prefix of log filename - full path is <log_dir>/<log_filename>.[INFO|WARN|ERROR|FATAL]</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1526,15 +1700,15 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">runtime,stable</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> </tr> </tbody> </table> @@ -1543,9 +1717,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_log_dir"><a class="link" href="#kudu-tserver_log_dir"><code>--log_dir</code></a></h4> +<h4 id="kudu-tserver_maintenance_manager_num_threads"><a class="link" href="#kudu-tserver_maintenance_manager_num_threads"><code>--maintenance_manager_num_threads</code></a></h4> <div class="paragraph"> -<p>If specified, logfiles are written into this directory instead of the default logging directory.</p> +<p>Size of the maintenance manager thread pool. For spinning disks, the number of threads should not be above the number of devices.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1555,11 +1729,11 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -1572,9 +1746,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_logtostderr"><a class="link" href="#kudu-tserver_logtostderr"><code>--logtostderr</code></a></h4> +<h4 id="kudu-tserver_memory_limit_hard_bytes"><a class="link" href="#kudu-tserver_memory_limit_hard_bytes"><code>--memory_limit_hard_bytes</code></a></h4> <div class="paragraph"> -<p>log messages go to stderr instead of logfiles</p> +<p>Maximum amount of memory this daemon should use, in bytes. A value of 0 autosizes based on the total system memory. A value of -1 disables all memory limiting.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1584,15 +1758,15 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">runtime,stable</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> </tr> </tbody> </table> @@ -1601,9 +1775,9 @@ configuration tasks.</p> </div> </div> <div class="sect3"> -<h4 id="kudu-tserver_max_log_size"><a class="link" href="#kudu-tserver_max_log_size"><code>--max_log_size</code></a></h4> +<h4 id="kudu-tserver_flagfile"><a class="link" href="#kudu-tserver_flagfile"><code>--flagfile</code></a></h4> <div class="paragraph"> -<p>approx. maximum log file size (in MB). A value of 0 will be silently overridden to 1.</p> +<p>load flags from file</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -1613,15 +1787,15 @@ configuration tasks.</p> <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1800</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">runtime,stable</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> </tr> </tbody> </table> @@ -1629,17 +1803,191 @@ configuration tasks.</p> <p> </p> </div> </div> -</div> -<div class="sect2"> -<h3 id="kudu-tserver_stable_advanced"><a class="link" href="#kudu-tserver_stable_advanced">Stable, Advanced Flags</a></h3> -<div class="paragraph"> -<p>Flags tagged <code>stable</code> and <code>advanced</code> are supported, but should be considered -"expert" options and should be used carefully and after thorough testing.</p> -</div> <div class="sect3"> -<h4 id="kudu-tserver_enable_process_lifetime_heap_profiling"><a class="link" href="#kudu-tserver_enable_process_lifetime_heap_profiling"><code>--enable_process_lifetime_heap_profiling</code></a></h4> +<h4 id="kudu-tserver_help"><a class="link" href="#kudu-tserver_help"><code>--help</code></a></h4> <div class="paragraph"> -<p>Enables heap profiling for the lifetime of the process. Profile output will be stored in the directory specified by -heap_profile_path. Enabling this option will disable the on-demand/remote server profile handlers.</p> +<p>show help on all flags [tip: all flags can have two dashes]</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-tserver_version"><a class="link" href="#kudu-tserver_version"><code>--version</code></a></h4> +<div class="paragraph"> +<p>show version and build info and exit</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-tserver_colorlogtostderr"><a class="link" href="#kudu-tserver_colorlogtostderr"><code>--colorlogtostderr</code></a></h4> +<div class="paragraph"> +<p>color messages logged to stderr (if supported by terminal)</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">runtime,stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-tserver_log_dir"><a class="link" href="#kudu-tserver_log_dir"><code>--log_dir</code></a></h4> +<div class="paragraph"> +<p>If specified, logfiles are written into this directory instead of the default logging directory.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-tserver_logtostderr"><a class="link" href="#kudu-tserver_logtostderr"><code>--logtostderr</code></a></h4> +<div class="paragraph"> +<p>log messages go to stderr instead of logfiles</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">runtime,stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +<div class="sect3"> +<h4 id="kudu-tserver_max_log_size"><a class="link" href="#kudu-tserver_max_log_size"><code>--max_log_size</code></a></h4> +<div class="paragraph"> +<p>approx. maximum log file size (in MB). A value of 0 will be silently overridden to 1.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1800</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">runtime,stable</p></td> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p> </p> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="kudu-tserver_stable_advanced"><a class="link" href="#kudu-tserver_stable_advanced">Stable, Advanced Flags</a></h3> +<div class="paragraph"> +<p>Flags tagged <code>stable</code> and <code>advanced</code> are supported, but should be considered +"expert" options and should be used carefully and after thorough testing.</p> +</div> +<div class="sect3"> +<h4 id="kudu-tserver_enable_process_lifetime_heap_profiling"><a class="link" href="#kudu-tserver_enable_process_lifetime_heap_profiling"><code>--enable_process_lifetime_heap_profiling</code></a></h4> +<div class="paragraph"> +<p>Enables heap profiling for the lifetime of the process. Profile output will be stored in the directory specified by -heap_profile_path. Enabling this option will disable the on-demand/remote server profile handlers.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -2274,6 +2622,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_min_compression_ratio"><a class="link" href="#kudu-master_min_compression_ratio"><code>--min_compression_ratio</code></a></h4> +<div class="paragraph"> +<p>If a column compression codec is configured, but the codec is unable to achieve a compression ratio at least as good as the configured value, then the data will be written uncompressed. This will reduce CPU overhead on the read side at the expense of a small amount of extra space if the codec encounters portions of data that are not easily compressible.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">double</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.90000000000000002</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_cfile_default_block_size"><a class="link" href="#kudu-master_cfile_default_block_size"><code>--cfile_default_block_size</code></a></h4> <div class="paragraph"> <p>The default block size to use in cfiles</p> @@ -2534,6 +2908,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_log_compression_codec"><a class="link" href="#kudu-master_log_compression_codec"><code>--log_compression_codec</code></a></h4> +<div class="paragraph"> +<p>Codec to use for compressing WAL segments.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>LZ4</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_log_max_segments_to_retain"><a class="link" href="#kudu-master_log_max_segments_to_retain"><code>--log_max_segments_to_retain</code></a></h4> <div class="paragraph"> <p>The maximum number of past log segments to keep at all times for the purposes of catching up other peers.</p> @@ -3004,7 +3404,7 @@ for informational purposes only. They are subject to change or be removed withou <div class="sect3"> <h4 id="kudu-master_block_manager_max_open_files"><a class="link" href="#kudu-master_block_manager_max_open_files"><code>--block_manager_max_open_files</code></a></h4> <div class="paragraph"> -<p>Maximum number of open file descriptors to be used for data blocks. If 0, there is no limit. If -1, Kudu will use half of its resource limit as per getrlimit(). This is a soft limit.</p> +<p>Maximum number of open file descriptors to be used for data blocks. If 0, there is no limit. If -1, Kudu will use 40% of its resource limit as per getrlimit(). This is a soft limit.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3392,9 +3792,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_master_registration_rpc_timeout_ms"><a class="link" href="#kudu-master_master_registration_rpc_timeout_ms"><code>--master_registration_rpc_timeout_ms</code></a></h4> +<h4 id="kudu-master_authn_token_validity_seconds"><a class="link" href="#kudu-master_authn_token_validity_seconds"><code>--authn_token_validity_seconds</code></a></h4> <div class="paragraph"> -<p>Timeout for retrieving master registration over RPC.</p> +<p>Period of time for which an issued authentication token is valid. It’s not possible to renew a token, hence the token validity interval defines the longest possible lifetime of an external job which uses a token for authentication.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3404,11 +3804,11 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1500</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>604800</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -3418,9 +3818,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_tserver_unresponsive_timeout_ms"><a class="link" href="#kudu-master_tserver_unresponsive_timeout_ms"><code>--tserver_unresponsive_timeout_ms</code></a></h4> +<h4 id="kudu-master_master_registration_rpc_timeout_ms"><a class="link" href="#kudu-master_master_registration_rpc_timeout_ms"><code>--master_registration_rpc_timeout_ms</code></a></h4> <div class="paragraph"> -<p>The period of time that a Master can go without receiving a heartbeat from a tablet server before considering it unresponsive. Unresponsive servers are not selected when assigning replicas during table creation or re-replication.</p> +<p>Timeout for retrieving master registration over RPC.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3434,19 +3834,19 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>60000</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1500</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-master_rpc_acceptor_listen_backlog"><a class="link" href="#kudu-master_rpc_acceptor_listen_backlog"><code>--rpc_acceptor_listen_backlog</code></a></h4> +<h4 id="kudu-master_tsk_rotation_seconds"><a class="link" href="#kudu-master_tsk_rotation_seconds"><code>--tsk_rotation_seconds</code></a></h4> <div class="paragraph"> -<p>Socket backlog parameter used when listening for RPC connections. This defines the maximum length to which the queue of pending TCP connections inbound to the RPC server may grow. If a connection request arrives when the queue is full, the client may receive an error. Higher values may help the server ride over bursts of new inbound connection requests.</p> +<p>Number of seconds between consecutive activations of newly generated TSKs (Token Signing Keys).</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3456,23 +3856,23 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>128</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>86400</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental,advanced</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-master_rpc_default_keepalive_time_ms"><a class="link" href="#kudu-master_rpc_default_keepalive_time_ms"><code>--rpc_default_keepalive_time_ms</code></a></h4> +<h4 id="kudu-master_ipki_ca_cert_expiration_seconds"><a class="link" href="#kudu-master_ipki_ca_cert_expiration_seconds"><code>--ipki_ca_cert_expiration_seconds</code></a></h4> <div class="paragraph"> -<p>If an RPC connection from a client is idle for this amount of time, the server will disconnect the client.</p> +<p>validity interval for self-signed root CA certifcate issued by Kudu IPKI (Internal Private Key Infrastructure, a.k.a. Internal Kudu CA)</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3482,23 +3882,23 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>65000</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>315360000</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-master_rpc_ssl_certificate_authority"><a class="link" href="#kudu-master_rpc_ssl_certificate_authority"><code>--rpc_ssl_certificate_authority</code></a></h4> +<h4 id="kudu-master_ipki_ca_key_size"><a class="link" href="#kudu-master_ipki_ca_key_size"><code>--ipki_ca_key_size</code></a></h4> <div class="paragraph"> -<p>Path to the certificate authority to be used by the client side of the connection to verify the validity of the certificate presented by the server.</p> +<p>the number of bits for self-signed root CA cert used by Kudu IPKI (Internal Private Key Infrastructure, a.k.a. Internal Kudu CA)</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3508,7 +3908,111 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2048</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_ipki_server_cert_expiration_seconds"><a class="link" href="#kudu-master_ipki_server_cert_expiration_seconds"><code>--ipki_server_cert_expiration_seconds</code></a></h4> +<div class="paragraph"> +<p>validity interval for server certificates issued by Kudu IPKI (Internal Private Key Infrastructure, a.k.a. Internal Kudu CA)</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>315360000</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_tserver_unresponsive_timeout_ms"><a class="link" href="#kudu-master_tserver_unresponsive_timeout_ms"><code>--tserver_unresponsive_timeout_ms</code></a></h4> +<div class="paragraph"> +<p>The period of time that a Master can go without receiving a heartbeat from a tablet server before considering it unresponsive. Unresponsive servers are not selected when assigning replicas during table creation or re-replication.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>60000</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_rpc_acceptor_listen_backlog"><a class="link" href="#kudu-master_rpc_acceptor_listen_backlog"><code>--rpc_acceptor_listen_backlog</code></a></h4> +<div class="paragraph"> +<p>Socket backlog parameter used when listening for RPC connections. This defines the maximum length to which the queue of pending TCP connections inbound to the RPC server may grow. If a connection request arrives when the queue is full, the client may receive an error. Higher values may help the server ride over bursts of new inbound connection requests.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>128</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_rpc_ca_certificate_file"><a class="link" href="#kudu-master_rpc_ca_certificate_file"><code>--rpc_ca_certificate_file</code></a></h4> +<div class="paragraph"> +<p>Path to the PEM encoded X509 certificate of the trusted external certificate authority. The provided certificate should be the root issuer of the certificate passed in '--rpc_certificate_file'.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> @@ -3522,9 +4026,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_rpc_ssl_private_key"><a class="link" href="#kudu-master_rpc_ssl_private_key"><code>--rpc_ssl_private_key</code></a></h4> +<h4 id="kudu-master_rpc_certificate_file"><a class="link" href="#kudu-master_rpc_certificate_file"><code>--rpc_certificate_file</code></a></h4> <div class="paragraph"> -<p>Path to the private key to be used to complement the public key present in --ssl_server_certificate</p> +<p>Path to a PEM encoded X509 certificate to use for securing RPC connections with SSL/TLS. If set, '--rpc_private_key_file' and '--rpc_ca_certificate_file' must be set as well.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3548,9 +4052,35 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_rpc_ssl_server_certificate"><a class="link" href="#kudu-master_rpc_ssl_server_certificate"><code>--rpc_ssl_server_certificate</code></a></h4> +<h4 id="kudu-master_rpc_default_keepalive_time_ms"><a class="link" href="#kudu-master_rpc_default_keepalive_time_ms"><code>--rpc_default_keepalive_time_ms</code></a></h4> +<div class="paragraph"> +<p>If an RPC connection from a client is idle for this amount of time, the server will disconnect the client.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>65000</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_rpc_private_key_file"><a class="link" href="#kudu-master_rpc_private_key_file"><code>--rpc_private_key_file</code></a></h4> <div class="paragraph"> -<p>Path to the SSL certificate to be used for the RPC layer.</p> +<p>Path to a PEM encoded private key paired with the certificate from '--rpc_certificate_file'</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3574,9 +4104,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_server_require_kerberos"><a class="link" href="#kudu-master_server_require_kerberos"><code>--server_require_kerberos</code></a></h4> +<h4 id="kudu-master_rpc_encrypt_loopback_connections"><a class="link" href="#kudu-master_rpc_encrypt_loopback_connections"><code>--rpc_encrypt_loopback_connections</code></a></h4> <div class="paragraph"> -<p>Whether to force all inbound RPC connections to authenticate with Kerberos</p> +<p>Whether to encrypt data transfer on RPC connections that stay within a single host. Encryption here is likely to offer no additional security benefit since only a local 'root' user could intercept the traffic, and wire encryption does not suitably protect against such an attacker.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3594,7 +4124,7 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> </tr> </tbody> </table> @@ -3782,7 +4312,7 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_kerberos_principal"><a class="link" href="#kudu-master_kerberos_principal"><code>--kerberos_principal</code></a></h4> +<h4 id="kudu-master_principal"><a class="link" href="#kudu-master_principal"><code>--principal</code></a></h4> <div class="paragraph"> <p>Kerberos principal that this daemon will log in as. The special token _HOST will be replaced with the FQDN of the local host.</p> </div> @@ -3802,15 +4332,41 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">unsafe,experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_ipki_server_key_size"><a class="link" href="#kudu-master_ipki_server_key_size"><code>--ipki_server_key_size</code></a></h4> +<div class="paragraph"> +<p>the number of bits for server cert’s private key. The server cert is used for TLS connections to and from clients and other servers.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2048</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> <td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-master_keytab"><a class="link" href="#kudu-master_keytab"><code>--keytab</code></a></h4> +<h4 id="kudu-master_rpc_tls_ciphers"><a class="link" href="#kudu-master_rpc_tls_ciphers"><code>--rpc_tls_ciphers</code></a></h4> <div class="paragraph"> -<p>Path to the Kerberos Keytab for this server</p> +<p>The cipher suite preferences to use for TLS-secured RPC connections. Uses the OpenSSL cipher preference list format. See man (1) ciphers for more information.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -3824,7 +4380,59 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_rpc_tls_min_protocol"><a class="link" href="#kudu-master_rpc_tls_min_protocol"><code>--rpc_tls_min_protocol</code></a></h4> +<div class="paragraph"> +<p>The minimum protocol version to allow when for securing RPC connections with TLS. May be one of 'TLSv1', 'TLSv1.1', or 'TLSv1.2'.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>TLSv1</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_tsk_num_rsa_bits"><a class="link" href="#kudu-master_tsk_num_rsa_bits"><code>--tsk_num_rsa_bits</code></a></h4> +<div class="paragraph"> +<p>Number of bits in RSA keys used for token signing.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2048</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -4042,6 +4650,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_webserver_enabled"><a class="link" href="#kudu-master_webserver_enabled"><code>--webserver_enabled</code></a></h4> +<div class="paragraph"> +<p>Whether to enable the web server on this daemon. NOTE: disabling the web server is also likely to prevent monitoring systems from properly capturing metrics.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_metrics_log_interval_ms"><a class="link" href="#kudu-master_metrics_log_interval_ms"><code>--metrics_log_interval_ms</code></a></h4> <div class="paragraph"> <p>Interval (in milliseconds) at which the server will dump its metrics to a local log file. The log files are located in the same directory as specified by the -log_dir flag. If this is not a positive value, then metrics logging will be disabled.</p> @@ -4094,6 +4728,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_webserver_x_frame_options"><a class="link" href="#kudu-master_webserver_x_frame_options"><code>--webserver_x_frame_options</code></a></h4> +<div class="paragraph"> +<p>The webserver will add an 'X-Frame-Options' HTTP header with this value to all responses. This can help prevent clickjacking attacks.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DENY</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_webserver_doc_root"><a class="link" href="#kudu-master_webserver_doc_root"><code>--webserver_doc_root</code></a></h4> <div class="paragraph"> <p>Files under <webserver_doc_root> are accessible via the debug webserver. Defaults to $KUDU_HOME/www, or if $KUDU_HOME is not set, disables the document root</p> @@ -4276,6 +4936,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_deltafile_default_compression_codec"><a class="link" href="#kudu-master_deltafile_default_compression_codec"><code>--deltafile_default_compression_codec</code></a></h4> +<div class="paragraph"> +<p>The compression codec used when writing deltafiles.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>lz4</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_default_composite_key_index_block_size_bytes"><a class="link" href="#kudu-master_default_composite_key_index_block_size_bytes"><code>--default_composite_key_index_block_size_bytes</code></a></h4> <div class="paragraph"> <p>Block size used for composite key indexes.</p> @@ -4536,9 +5222,61 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_flush_threshold_mb"><a class="link" href="#kudu-master_flush_threshold_mb"><code>--flush_threshold_mb</code></a></h4> +<h4 id="kudu-master_undo_delta_block_gc_init_budget_millis"><a class="link" href="#kudu-master_undo_delta_block_gc_init_budget_millis"><code>--undo_delta_block_gc_init_budget_millis</code></a></h4> +<div class="paragraph"> +<p>The maximum number of milliseconds we will spend initializing UNDO delta blocks per invocation of UndoDeltaBlockGCOp. Existing delta blocks must be initialized once per process startup to determine when they can be deleted.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1000</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced,evolving</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_flush_threshold_mb"><a class="link" href="#kudu-master_flush_threshold_mb"><code>--flush_threshold_mb</code></a></h4> +<div class="paragraph"> +<p>Size at which MemRowSet flushes are triggered. A MRS can still flush below this threshold if it if hasn’t flushed in a while, or if the server-wide memory limit has been reached.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1024</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_flush_threshold_secs"><a class="link" href="#kudu-master_flush_threshold_secs"><code>--flush_threshold_secs</code></a></h4> <div class="paragraph"> -<p>Size at which MemRowSet flushes are triggered. A MRS can still flush below this threshold if it if hasn’t flushed in a while, or if the server-wide memory limit has been reached.</p> +<p>Number of seconds after which a non-empty MemRowSet will become flushable even if it is not large.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -4552,7 +5290,7 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1024</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>120</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -4874,9 +5612,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_never_fsync"><a class="link" href="#kudu-master_never_fsync"><code>--never_fsync</code></a></h4> +<h4 id="kudu-master_env_use_fsync"><a class="link" href="#kudu-master_env_use_fsync"><code>--env_use_fsync</code></a></h4> <div class="paragraph"> -<p>Never fsync() anything to disk. This is used by certain test cases to speed up runtime. This is very unsafe to use in production.</p> +<p>Use fsync(2) instead of fdatasync(2) for synchronizing dirty data to disk.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -4894,15 +5632,15 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">unsafe,advanced</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">evolving,advanced</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-master_suicide_on_eio"><a class="link" href="#kudu-master_suicide_on_eio"><code>--suicide_on_eio</code></a></h4> +<h4 id="kudu-master_never_fsync"><a class="link" href="#kudu-master_never_fsync"><code>--never_fsync</code></a></h4> <div class="paragraph"> -<p>Kill the process if an I/O operation results in EIO</p> +<p>Never fsync() anything to disk. This is used by certain test cases to speed up runtime. This is very unsafe to use in production.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -4916,19 +5654,19 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">unsafe,advanced</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-master_writable_file_use_fsync"><a class="link" href="#kudu-master_writable_file_use_fsync"><code>--writable_file_use_fsync</code></a></h4> +<h4 id="kudu-master_suicide_on_eio"><a class="link" href="#kudu-master_suicide_on_eio"><code>--suicide_on_eio</code></a></h4> <div class="paragraph"> -<p>Use fsync(2) instead of fdatasync(2) for synchronizing dirty data to disk.</p> +<p>Kill the process if an I/O operation results in EIO</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -4942,7 +5680,7 @@ for informational purposes only. They are subject to change or be removed withou </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> @@ -5004,9 +5742,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-master_log_redact_user_data"><a class="link" href="#kudu-master_log_redact_user_data"><code>--log_redact_user_data</code></a></h4> +<h4 id="kudu-master_redact"><a class="link" href="#kudu-master_redact"><code>--redact</code></a></h4> <div class="paragraph"> -<p>Whether log and error messages will have row data redacted.</p> +<p>Comma-separated list of redactions. Supported redactions are 'flag', 'log' and 'all'. If 'flag' is specified, configuration flags which may include sensitive data will be redacted whenever server configuration is emitted. If 'log' is specified, row data will be redacted from log and error messages. If 'all' is specified, all of above will be redacted.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -5016,15 +5754,41 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>all</code></p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">experimental,runtime</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">evolving,advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_umask"><a class="link" href="#kudu-master_umask"><code>--umask</code></a></h4> +<div class="paragraph"> +<p>The umask that will be used when creating files and directories. Permissions of top-level data directories will also be modified at start-up to conform to the given umask. Changing this value may enable unauthorized local users to read or modify data stored by Kudu.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>077</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> </tr> </tbody> </table> @@ -5056,6 +5820,58 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_data_gc_min_size_mb"><a class="link" href="#kudu-master_data_gc_min_size_mb"><code>--data_gc_min_size_mb</code></a></h4> +<div class="paragraph"> +<p>The (exclusive) minimum number of megabytes of ancient data on disk, per tablet, needed to prioritize deletion of that data.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_data_gc_prioritization_prob"><a class="link" href="#kudu-master_data_gc_prioritization_prob"><code>--data_gc_prioritization_prob</code></a></h4> +<div class="paragraph"> +<p>The probability that we will prioritize data GC over performance improvement operations. If set to 1.0, we will always prefer to delete old data before running performance improvement operations such as delta compaction.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">double</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.5</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_log_target_replay_size_mb"><a class="link" href="#kudu-master_log_target_replay_size_mb"><code>--log_target_replay_size_mb</code></a></h4> <div class="paragraph"> <p>The target maximum size of logs to be replayed at startup. If a tablet has in-memory operations that are causing more than this size of logs to be retained, then the maintenance manager will prioritize flushing these operations to disk.</p> @@ -5186,6 +6002,58 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-master_enable_minidumps"><a class="link" href="#kudu-master_enable_minidumps"><code>--enable_minidumps</code></a></h4> +<div class="paragraph"> +<p>Whether to enable minidump generation upon process crash or SIGUSR1. Currently only supported on Linux systems.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">evolving,advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> +<h4 id="kudu-master_minidump_size_limit_hint_kb"><a class="link" href="#kudu-master_minidump_size_limit_hint_kb"><code>--minidump_size_limit_hint_kb</code></a></h4> +<div class="paragraph"> +<p>Size limit hint for minidump files in KB. If a minidump exceeds this value, then breakpad will reduce the stack memory it collects for each thread from 8KB to 2KB. However it will always include the full stack memory for the first 20 threads, including the thread that crashed.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>20480</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">evolving,advanced</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-master_local_ip_for_outbound_sockets"><a class="link" href="#kudu-master_local_ip_for_outbound_sockets"><code>--local_ip_for_outbound_sockets</code></a></h4> <div class="paragraph"> <p>IP to bind to when making outgoing socket connections. This must be an IP address of the form A.B.C.D, not a hostname. Advanced parameter, subject to change.</p> @@ -5402,6 +6270,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-tserver_min_compression_ratio"><a class="link" href="#kudu-tserver_min_compression_ratio"><code>--min_compression_ratio</code></a></h4> +<div class="paragraph"> +<p>If a column compression codec is configured, but the codec is unable to achieve a compression ratio at least as good as the configured value, then the data will be written uncompressed. This will reduce CPU overhead on the read side at the expense of a small amount of extra space if the codec encounters portions of data that are not easily compressible.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">double</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.90000000000000002</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-tserver_cfile_default_block_size"><a class="link" href="#kudu-tserver_cfile_default_block_size"><code>--cfile_default_block_size</code></a></h4> <div class="paragraph"> <p>The default block size to use in cfiles</p> @@ -5662,6 +6556,32 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> +<h4 id="kudu-tserver_log_compression_codec"><a class="link" href="#kudu-tserver_log_compression_codec"><code>--log_compression_codec</code></a></h4> +<div class="paragraph"> +<p>Codec to use for compressing WAL segments.</p> +</div> +<table class="tableblock frame-all grid-all" style="width: 50%;"> +<colgroup> +<col style="width: 25%;"> +<col style="width: 75%;"> +</colgroup> +<tbody> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>LZ4</code></p></td> +</tr> +<tr> +<th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect3"> <h4 id="kudu-tserver_log_max_segments_to_retain"><a class="link" href="#kudu-tserver_log_max_segments_to_retain"><code>--log_max_segments_to_retain</code></a></h4> <div class="paragraph"> <p>The maximum number of past log segments to keep at all times for the purposes of catching up other peers.</p> @@ -6132,7 +7052,7 @@ for informational purposes only. They are subject to change or be removed withou <div class="sect3"> <h4 id="kudu-tserver_block_manager_max_open_files"><a class="link" href="#kudu-tserver_block_manager_max_open_files"><code>--block_manager_max_open_files</code></a></h4> <div class="paragraph"> -<p>Maximum number of open file descriptors to be used for data blocks. If 0, there is no limit. If -1, Kudu will use half of its resource limit as per getrlimit(). This is a soft limit.</p> +<p>Maximum number of open file descriptors to be used for data blocks. If 0, there is no limit. If -1, Kudu will use 40% of its resource limit as per getrlimit(). This is a soft limit.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -6338,9 +7258,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-tserver_rpc_default_keepalive_time_ms"><a class="link" href="#kudu-tserver_rpc_default_keepalive_time_ms"><code>--rpc_default_keepalive_time_ms</code></a></h4> +<h4 id="kudu-tserver_rpc_ca_certificate_file"><a class="link" href="#kudu-tserver_rpc_ca_certificate_file"><code>--rpc_ca_certificate_file</code></a></h4> <div class="paragraph"> -<p>If an RPC connection from a client is idle for this amount of time, the server will disconnect the client.</p> +<p>Path to the PEM encoded X509 certificate of the trusted external certificate authority. The provided certificate should be the root issuer of the certificate passed in '--rpc_certificate_file'.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -6350,23 +7270,23 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Default</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock"><code>65000</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td> </tr> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Tags</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">advanced</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">experimental</p></td> </tr> </tbody> </table> </div> <div class="sect3"> -<h4 id="kudu-tserver_rpc_ssl_certificate_authority"><a class="link" href="#kudu-tserver_rpc_ssl_certificate_authority"><code>--rpc_ssl_certificate_authority</code></a></h4> +<h4 id="kudu-tserver_rpc_certificate_file"><a class="link" href="#kudu-tserver_rpc_certificate_file"><code>--rpc_certificate_file</code></a></h4> <div class="paragraph"> -<p>Path to the certificate authority to be used by the client side of the connection to verify the validity of the certificate presented by the server.</p> +<p>Path to a PEM encoded X509 certificate to use for securing RPC connections with SSL/TLS. If set, '--rpc_private_key_file' and '--rpc_ca_certificate_file' must be set as well.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -6390,9 +7310,9 @@ for informational purposes only. They are subject to change or be removed withou </table> </div> <div class="sect3"> -<h4 id="kudu-tserver_rpc_ssl_private_key"><a class="link" href="#kudu-tserver_rpc_ssl_private_key"><code>--rpc_ssl_private_key</code></a></h4> +<h4 id="kudu-tserver_rpc_default_keepalive_time_ms"><a class="link" href="#kudu-tserver_rpc_default_keepalive_time_ms"><code>--rpc_default_keepalive_time_ms</code></a></h4> <div class="paragraph"> -<p>Path to the private key to be used to complement the public key present in --ssl_server_certificate</p> +<p>If an RPC connection from a client is idle for this amount of time, the server will disconnect the client.</p> </div> <table class="tableblock frame-all grid-all" style="width: 50%;"> <colgroup> @@ -6402,23 +7322,23 @@ for informational purposes only. They are subject to change or be removed withou <tbody> <tr> <th class="tableblock halign-left valign-top"><p class="tableblock">Type</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock
<TRUNCATED>
