This is an automated email from the ASF dual-hosted git repository.
dzamo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/drill-site.git
The following commit(s) were added to refs/heads/master by this push:
new ca7f615 Update links from configuring-user-authentication to
configuring-plain-security.
ca7f615 is described below
commit ca7f61510861fc3f3a8acdf66cce2fbb3624f09f
Author: James Turton <[email protected]>
AuthorDate: Tue Nov 30 16:55:06 2021 +0200
Update links from configuring-user-authentication to
configuring-plain-security.
---
.../120-configuring-the-drill-shell.md | 82 +++++++++++-----------
.../drill-on-yarn/080-enabling-web-ui-security.md | 2 +-
.../090-appendix-a-release-note-issues.md | 2 +-
_docs/en/install/060-starting-the-web-ui.md | 6 +-
4 files changed, 46 insertions(+), 46 deletions(-)
diff --git a/_docs/en/configure-drill/120-configuring-the-drill-shell.md
b/_docs/en/configure-drill/120-configuring-the-drill-shell.md
index f8a9e69..b0a4b03 100644
--- a/_docs/en/configure-drill/120-configuring-the-drill-shell.md
+++ b/_docs/en/configure-drill/120-configuring-the-drill-shell.md
@@ -2,13 +2,13 @@
title: "Configuring the Drill Shell"
slug: "Configuring the Drill Shell"
parent: "Configure Drill"
----
-Drill uses SQLLine as the Drill shell. SQLLine is a pure-Java console-based
utility for connecting to relational databases and running SQL commands.
+---
+Drill uses SQLLine as the Drill shell. SQLLine is a pure-Java console-based
utility for connecting to relational databases and running SQL commands.
+
+Starting in Drill 1.17, Drill uses SQLLine 1.9.
-Starting in Drill 1.17, Drill uses SQLLine 1.9.
+Drill 1.16 uses SQLLine 1.7, which changes the default Drill prompt to `apache
drill>`. If you switch to a specific schema, for example `dfs.tmp`, the prompt
includes the current schema, as shown:
-Drill 1.16 uses SQLLine 1.7, which changes the default Drill prompt to `apache
drill>`. If you switch to a specific schema, for example `dfs.tmp`, the prompt
includes the current schema, as shown:
-
use dfs.tmp;
|------|-------------------------------------|
| ok | summary |
@@ -20,41 +20,41 @@ Drill 1.16 uses SQLLine 1.7, which changes the default
Drill prompt to `apache d
To return to the previous prompt display, modify
`drill-sqlline-override.conf`, and set `drill.sqlline.prompt.with_schema` to
false.
-Alternatively, you can define a custom prompt using the command `!set prompt
<new-prompt>`, as shown:
-
+Alternatively, you can define a custom prompt using the command `!set prompt
<new-prompt>`, as shown:
+
apache drill (dfs.tmp)> !set prompt good-drill
- good-drill
+ good-drill
You can use `prompt`, `promptScript`, or `rightPrompt` with the `!set`
command. These properties can be overridden in `drill-sqlline-override.conf`.
-Starting in Drill 1.15, Drill uses SQLLine 1.6, which you can customize
through the Drill [configuration file,
drill-sqlline-override.conf]({{site.baseurl}}/docs/configuring-the-drill-shell/#customizing-sqlline-in-the-drill-sqlline-override-conf-file).
Before installing and running Drill with SQLLine 1.6, delete the old SQLLine
history file located in:
+Starting in Drill 1.15, Drill uses SQLLine 1.6, which you can customize
through the Drill [configuration file,
drill-sqlline-override.conf]({{site.baseurl}}/docs/configuring-the-drill-shell/#customizing-sqlline-in-the-drill-sqlline-override-conf-file).
Before installing and running Drill with SQLLine 1.6, delete the old SQLLine
history file located in:
- $HOME/.sqlline/history (UNIX, Linux, Mac OS)
-- $HOME/sqlline/history (Windows)
+- $HOME/sqlline/history (Windows)
-After [starting the Drill
shell]({{site.baseurl}}/docs/starting-drill-on-linux-and-mac-os-x/), you can
run Drill shell commands and queries from the command line. Typing the shell
command "!help" lists configuration and other options that you can set to
manage shell functionality.
+After [starting the Drill
shell]({{site.baseurl}}/docs/starting-drill-on-linux-and-mac-os-x/), you can
run Drill shell commands and queries from the command line. Typing the shell
command "!help" lists configuration and other options that you can set to
manage shell functionality.
-Formatting tables takes time, which you may notice when running a huge query
using the default outputFormat. The default outputFormat is “table.” You can
set the outputFormat to a more performant table formatting, such as csv, as
shown in the
[examples]({{site.baseurl}}/docs/configuring-the-drill-shell/#examples-of-configuring-the-drill-shell).
+Formatting tables takes time, which you may notice when running a huge query
using the default outputFormat. The default outputFormat is “table.” You can
set the outputFormat to a more performant table formatting, such as csv, as
shown in the
[examples]({{site.baseurl}}/docs/configuring-the-drill-shell/#examples-of-configuring-the-drill-shell).
-## SQLLine Connection Parameters
+## SQLLine Connection Parameters
-You can use a jdbc connection string to connect to SQLLine when Drill is
installed in embedded mode or distributed mode, as shown in the following
examples:
+You can use a jdbc connection string to connect to SQLLine when Drill is
installed in embedded mode or distributed mode, as shown in the following
examples:
-- Embedded mode:
-`./sqlline -u jdbc:drill:drillbit=local`
-- Distributed mode:
-`./sqlline –u jdbc:drill:zk=cento23,centos24,centos26:2181`
+- Embedded mode:
+`./sqlline -u jdbc:drill:drillbit=local`
+- Distributed mode:
+`./sqlline –u jdbc:drill:zk=cento23,centos24,centos26:2181`
-When you use a jdbc connection string to connect to Drill via SQLLine, you can
include SQLLine connection parameters in the connection string, as shown in the
following example:
+When you use a jdbc connection string to connect to Drill via SQLLine, you can
include SQLLine connection parameters in the connection string, as shown in the
following example:
-`./sqlline -u 'jdbc:drill:drillbit=local' --help`
+`./sqlline -u 'jdbc:drill:drillbit=local' --help`
+
+**Note:** Use single quotes around the jdbc portion of the connection string
when using SQLLine parameters.
-**Note:** Use single quotes around the jdbc portion of the connection string
when using SQLLine parameters.
-
The --help command prints all the SQLLine connection parameters that you can
include in the jdbc connection string, as shown in the following table:
-
+
| **Connection Parameter** |
**Description** |
|----------------------------------------------------------------------------|-------------------------------------------------------------|
@@ -100,18 +100,18 @@ The --help command prints all the SQLLine connection
parameters that you can inc
| --run=/path/to/file |
run one script and then exit |
| --historyfile=/path/to/file |
use or create history file in specified path |
| --useLineContinuation=[true/false] |
Use line continuation |
-| --help |
display parameters and commands |
+| --help |
display parameters and commands |
-### Example Connection String with Parameter
+### Example Connection String with Parameter
-This example shows a jdbc connection string that includes the `-e` parameter
to pass a query during the connection to Drill. The `-e` parameter is
equivalent to the `-q` parameter. This connection string starts Drill, runs the
query and then closes the connection. This type of connection string is useful
in a script. The connection is run from DRILL_HOME/bin.
+This example shows a jdbc connection string that includes the `-e` parameter
to pass a query during the connection to Drill. The `-e` parameter is
equivalent to the `-q` parameter. This connection string starts Drill, runs the
query and then closes the connection. This type of connection string is useful
in a script. The connection is run from DRILL_HOME/bin.
- [root@doc23 bin]# ./sqlline -u 'jdbc:drill:zk=local' -e 'select * from
cp.`employee.json` limit 2;'
+ [root@doc23 bin]# ./sqlline -u 'jdbc:drill:zk=local' -e 'select * from
cp.`employee.json` limit 2;'
Dec 28, 2018 2:13:30 PM org.jline.utils.Log logr
WARNING: Unable to create a system terminal, creating a dumb terminal
(enable debug logging for more information)
Apache Drill 1.15.0-SNAPSHOT
"Say hello to my little Drill."
- 0: jdbc:drill:zk=local>
+ 0: jdbc:drill:zk=local>
|--------------|------------------|-------------|------------|--------------|---------------------|-----------|----------------|-------------|------------------------|----------|----------------|------------------|-----------------|---------|--------------------|
| employee_id | full_name | first_name | last_name |
position_id | position_title | store_id | department_id | birth_date |
hire_date | salary | supervisor_id | education_level |
marital_status | gender | management_role |
|--------------|------------------|-------------|------------|--------------|---------------------|-----------|----------------|-------------|------------------------|----------|----------------|------------------|-----------------|---------|--------------------|
@@ -124,9 +124,9 @@ This example shows a jdbc connection string that includes
the `-e` parameter to
## Drill Shell Commands
-The following table lists some of the Drill shell commands that you can run
from the command line. To see a complete list of shell commands issue the
`!help` command.
+The following table lists some of the Drill shell commands that you can run
from the command line. To see a complete list of shell commands issue the
`!help` command.
-**Note:** Some new shell commands, such as `!reset`, and key-strokes were
introduced when Drill upgraded to SQLLine 1.6 (Drill 1.15 and later); however,
not all of the commands are supported.
+**Note:** Some new shell commands, such as `!reset`, and key-strokes were
introduced when Drill upgraded to SQLLine 1.6 (Drill 1.15 and later); however,
not all of the commands are supported.
| **Command** | **Description **
|
@@ -161,23 +161,23 @@ For example, quit the Drill shell:
0: jdbc:drill:zk=local> !quit
-List the current connections.
+List the current connections.
0: jdbc:drill:zk=local> !list
1 active connection:
- #0 open jdbc:drill:zk=local
+ #0 open jdbc:drill:zk=local
### Example of Hiding the Password When Starting Drill
-When starting Drill in authentication mode, you can use the **!connect**
command as shown in the section, ["User Authentication
Process"]({{site.baseurl}}/docs/configuring-user-authentication/#user-authentication-process),
instead of using a command such as **sqlline**, **drill-embedded**, or
**drill-conf** commands. For example, after running the sqlline script, you
enter this command to connect to Drill:
+When starting Drill in authentication mode, you can use the **!connect**
command as shown in the section, ["User Authentication
Process"]({{site.baseurl}}/docs/configuring-plain-security/#authentication-process),
instead of using a command such as **sqlline**, **drill-embedded**, or
**drill-conf** commands. For example, after running the sqlline script, you
enter this command to connect to Drill:
-`sqlline> !connect jdbc:drill:zk=localhost:2181`
+`sqlline> !connect jdbc:drill:zk=localhost:2181`
When prompted you enter a user name and password, which is hidden as you type
it.
-## Set Command Variables
-The following table lists some of the set command variables that you can use
with the !set command:
+## Set Command Variables
+The following table lists some of the set command variables that you can use
with the !set command:
**Note:** Issue the !set command without a variable to see the full list of
command variables.
@@ -209,21 +209,21 @@ The following table lists some of the set command
variables that you can use wit
| verbose | true/false | Show unabbreviated error messages
and debug info.
|
-### Examples of the set Command with Variables
+### Examples of the set Command with Variables
Set the maximum width of the Drill shell to 10000.
0: jdbc:drill:zk=local> !set maxwidth 10000
Set the output format to CSV to improve performance of a huge query.
- 0: jdbc:drill:zk=local> !set outputFormat csv
+ 0: jdbc:drill:zk=local> !set outputFormat csv
## Customizing SQLLine in the drill-sqlline-override.conf File
-Starting in Drill 1.15, SQLLine (the Drill shell) is upgraded to version 1.6.
You can customize SQLLine through the Drill configuration file,
`drill-sqlline-override.conf`, located in the `<drill-installation>/conf`
directory.
+Starting in Drill 1.15, SQLLine (the Drill shell) is upgraded to version 1.6.
You can customize SQLLine through the Drill configuration file,
`drill-sqlline-override.conf`, located in the `<drill-installation>/conf`
directory.
-You can customize quotes of the day; the quotes you see at the command prompt
when starting Drill, such as “Just Drill it,” and you can override the SQLLine
default properties. The SQLLine default properties are those that print when
you run `!set` from the Drill shell.
+You can customize quotes of the day; the quotes you see at the command prompt
when starting Drill, such as “Just Drill it,” and you can override the SQLLine
default properties. The SQLLine default properties are those that print when
you run `!set` from the Drill shell.
-Drill reads the `drill-sqlline-override.conf` file and applies the custom
configuration during start-up. You must restart Drill for the changes to take
effect. The file remains in the directory and Drill applies the custom
configuration at each restart.
+Drill reads the `drill-sqlline-override.conf` file and applies the custom
configuration during start-up. You must restart Drill for the changes to take
effect. The file remains in the directory and Drill applies the custom
configuration at each restart.
**Note:** The SQLLine configuration file in the `<drill-installation>/conf`
directory is named `drill-sqlline-override-example.conf`. Use this file and the
information provided in the file as guidance for the
`drill-sqlline-override.conf` file you create and store in the directory with
your customizations.
diff --git a/_docs/en/drill-on-yarn/080-enabling-web-ui-security.md
b/_docs/en/drill-on-yarn/080-enabling-web-ui-security.md
index 038b4ef..fe81701 100644
--- a/_docs/en/drill-on-yarn/080-enabling-web-ui-security.md
+++ b/_docs/en/drill-on-yarn/080-enabling-web-ui-security.md
@@ -29,4 +29,4 @@ must match that of the user that started the Drill-on-YARN
application. To enabl
}
You must have previously enabled Drill user authentication, as described in
the [Drill
-Documentation]({{site.baseurl}}/docs/configuring-user-authentication/) .
\ No newline at end of file
+Documentation]({{site.baseurl}}/docs/configuring-plain-security/) .
\ No newline at end of file
diff --git a/_docs/en/drill-on-yarn/090-appendix-a-release-note-issues.md
b/_docs/en/drill-on-yarn/090-appendix-a-release-note-issues.md
index b14df0a..5a9797a 100644
--- a/_docs/en/drill-on-yarn/090-appendix-a-release-note-issues.md
+++ b/_docs/en/drill-on-yarn/090-appendix-a-release-note-issues.md
@@ -170,4 +170,4 @@ Under YARN, restart the YARN cluster:
If you configure user authentication for Drill, then user authentication is
automatically configured in the Application Master also. Only users with admin
privileges can use the AM web UI.
### Testing User Authentication on the Mac
-The [Drill
Documentation]({{site.baseurl}}/docs/configuring-user-authentication/)
describes how to configure user authentication using PAM, including
instructions for downloading a required native library. However, if you are
testing security on the Mac, the referenced library does not work on modern
Macs. Instead, see the workaround in
[DRILL-4756](https://issues.apache.org/jira/browse/DRILL-4756).
\ No newline at end of file
+The [Drill Documentation]({{site.baseurl}}/docs/configuring-plain-security/)
describes how to configure user authentication using PAM, including
instructions for downloading a required native library. However, if you are
testing security on the Mac, the referenced library does not work on modern
Macs. Instead, see the workaround in
[DRILL-4756](https://issues.apache.org/jira/browse/DRILL-4756).
\ No newline at end of file
diff --git a/_docs/en/install/060-starting-the-web-ui.md
b/_docs/en/install/060-starting-the-web-ui.md
index e1a95e1..10b81f3 100644
--- a/_docs/en/install/060-starting-the-web-ui.md
+++ b/_docs/en/install/060-starting-the-web-ui.md
@@ -38,7 +38,7 @@ The pop-up serves as an indicator that a query is in progress
and prevents any f
## Web UI Security
-If [user
authentication]({{site.baseurl}}/docs/configuring-user-authentication/) is not
enabled, all the Web UI controls appear to users as well as administrators:
+If [user authentication]({{site.baseurl}}/docs/configuring-plain-security/) is
not enabled, all the Web UI controls appear to users as well as administrators:
@@ -46,11 +46,11 @@ If [user
authentication]({{site.baseurl}}/docs/configuring-user-authentication/)
**Note:** As of Drill 1.13, an administrator can configure FORM and/or SPNEGO
authentication mechanisms. The Drill Web UI provides two possible log in
options for a user depending on the configuration. If a user selects FORM, s/he
must enter their username and password to access restricted pages in the Drill
Web UI. The user is authenticated through PAM. If the user selects SPNEGO, the
user is automatically logged in if they are an authenticated Kerberos user. If
accessing a protected pa [...]
-If [user
authentication]({{site.baseurl}}/docs/configuring-user-authentication/) is
enabled, Drill prompts you for a user name/password:
+If [user authentication]({{site.baseurl}}/docs/configuring-plain-security/) is
enabled, Drill prompts you for a user name/password:
-If an [administrator]({{ site.baseurl
}}/docs/configuring-user-authentication/#administrator-privileges) logs in, all
the Web UI controls appear: Query, Profiles, Storage, Metrics, Threads, and
Options. The Profiles page for administrators contains the profiles of all
queries executed on a cluster. Only administrators can see and use the Storage
tab to view, update, or add a new [storage plugin
configuration]({{site.baseurl}}/docs/plugin-configuration-basics/). Only
administrators can se [...]
+If an [administrator]({{ site.baseurl
}}/docs/configuring-plain-security/#administrator-privileges) logs in, all the
Web UI controls appear: Query, Profiles, Storage, Metrics, Threads, and
Options. The Profiles page for administrators contains the profiles of all
queries executed on a cluster. Only administrators can see and use the Storage
tab to view, update, or add a new [storage plugin
configuration]({{site.baseurl}}/docs/plugin-configuration-basics/). Only
administrators can see and [...]
