drill-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bridg...@apache.org
Subject drill-site git commit: 1.5 doc updates to web console page and minor edits
Date Mon, 08 Feb 2016 22:03:52 GMT
Repository: drill-site
Updated Branches:
  refs/heads/asf-site 2cb56a575 -> 162a09614


1.5 doc updates to web console page and minor edits


Project: http://git-wip-us.apache.org/repos/asf/drill-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/drill-site/commit/162a0961
Tree: http://git-wip-us.apache.org/repos/asf/drill-site/tree/162a0961
Diff: http://git-wip-us.apache.org/repos/asf/drill-site/diff/162a0961

Branch: refs/heads/asf-site
Commit: 162a09614f7c8b73833af32224dd81457282b24c
Parents: 2cb56a5
Author: Bridget Bevens <bbevens@maprtech.com>
Authored: Mon Feb 8 14:03:29 2016 -0800
Committer: Bridget Bevens <bbevens@maprtech.com>
Committed: Mon Feb 8 14:03:29 2016 -0800

----------------------------------------------------------------------
 .../index.html                                  | 327 +++++++++++++++----
 .../index.html                                  |  10 +-
 feed.xml                                        |   4 +-
 3 files changed, 271 insertions(+), 70 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/drill-site/blob/162a0961/docs/configuring-web-console-and-rest-api-security/index.html
----------------------------------------------------------------------
diff --git a/docs/configuring-web-console-and-rest-api-security/index.html b/docs/configuring-web-console-and-rest-api-security/index.html
index b9df374..944421e 100644
--- a/docs/configuring-web-console-and-rest-api-security/index.html
+++ b/docs/configuring-web-console-and-rest-api-security/index.html
@@ -1042,16 +1042,16 @@
 
     </div>
 
-     
+     Feb 8, 2016
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
     <div class="int_text" align="left">
       
-        <!-- Drill 1.2 extends [Drill user authentication](/docs/configuring-user-authentication/)
to the Web Console and underlying REST API. As administrator, you can control the extent of
access to the Web Console and REST API client applications. For example,
-you can limit the access of certain users to Web Console functionality, such as viewing the
in-progress or completed queries of other users. You can limit users from viewing other users'
query profiles, who can cancel queries of other users, and other functionality.
+        <p>Drill 1.5 extends <a href="/docs/configuring-user-authentication/">Drill
user authentication</a> to the Web Console and underlying REST API. As administrator,
you can control the extent of access to the Web Console and REST API client applications.
For example,
+you can limit the access of certain users to Web Console functionality, such as viewing the
in-progress or completed queries of other users. You can limit users from viewing other users&#39;
query profiles, who can cancel queries of other users, and other functionality.</p>
 
-With Web Console security in place, users who do not have administrator privileges need to
use the SHOW SCHEMAS command instead of the Web Console for storage plugin configuration information.
-->
+<p>With Web Console security in place, users who do not have administrator privileges
need to use the SHOW SCHEMAS command instead of the Web Console for storage plugin configuration
information.</p>
 
 <h2 id="https-support">HTTPS Support</h2>
 
@@ -1078,86 +1078,285 @@ Path to the trusted CA certificates in a keystore file.<br></li>
 Password for accessing the trusted keystore file.</li>
 </ul>
 
-<!-- 
-## Prerequisites for Web Console and REST API Security
+<h2 id="prerequisites-for-web-console-and-rest-api-security">Prerequisites for Web
Console and REST API Security</h2>
 
-You need to perform the following configuration tasks using Web Console and REST API security.
 
+<p>You need to perform the following configuration tasks using Web Console and REST
API security.  </p>
 
-* Configure [user authentication](/docs/configuring-user-authentication/)  
-* Set up Web Console administrators  
-  Optionally, you can set up Web Console administrator-user groups to facilitate management
of multiple Web Console administrators.
+<ul>
+<li>Configure <a href="/docs/configuring-user-authentication/">user authentication</a><br></li>
+<li>Set up Web Console administrators<br>
+Optionally, you can set up Web Console administrator-user groups to facilitate management
of multiple Web Console administrators.</li>
+</ul>
 
-## Setting up Web Console Administrators and Administrator-User Groups
+<h2 id="setting-up-web-console-administrators-and-administrator-user-groups">Setting
up Web Console Administrators and Administrator-User Groups</h2>
 
-Configure the following system options using the [ALTER SYSTEM](/docs/alter-system/) command:
+<p>Configure the following system options using the <a href="/docs/alter-system/">ALTER
SYSTEM</a> command:</p>
 
-* security.admin.users  
-  Set the value of this option to a comma-separated list of user names who you want to give
administrator privileges, such as changing system options.  
-* security.admin.user_groups  
-  Set the value of this option to a comma-separated list of administrator groups.
+<ul>
+<li>security.admin.users<br>
+Set the value of this option to a comma-separated list of user names who you want to give
administrator privileges, such as changing system options.<br></li>
+<li>security.admin.user_groups<br>
+Set the value of this option to a comma-separated list of administrator groups.</li>
+</ul>
 
-Any user who is a member of any group listed in security.admin.user.groups is a Drill cluster
administrator. Any user for whom you have configured Drill user authentication, but not set
up as a Drill cluster administrator, has only user privileges to access the Web Console and
REST API client applications.
+<p>Any user who is a member of any group listed in security.admin.user.groups is a
Drill cluster administrator. Any user for whom you have configured Drill user authentication,
but not set up as a Drill cluster administrator, has only user privileges to access the Web
Console and REST API client applications.</p>
 
-## Web Console and REST API Privileges
+<h2 id="web-console-and-rest-api-privileges">Web Console and REST API Privileges</h2>
 
-The following table and subsections describe the privilege levels for accessing the REST
API methods and corresponding Web Console functions:
+<p>The following table and subsections describe the privilege levels for accessing
the REST API methods and corresponding Web Console functions:</p>
 
-* Administrator (ADMIN)  
-* User (USER)  
-* Administrator and User (ALL) 
+<ul>
+<li>Administrator (ADMIN)<br></li>
+<li>User (USER)<br></li>
+<li>Administrator and User (ALL) </li>
+</ul>
 
-| Resource Method          | Path                         | Request Type | Output Type  
   | Functionality                                                                       
                                                                                         
                                                                             | Privilege Level
                                                                                         
    |
-|--------------------------|------------------------------|--------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
-| getStats                 | /                            | GET          | text/html    
   | Returns Drillbit stats in a table in HTML format.                                   
                                                                                         
                                                                             | ALL       
                                                                                         
         |
-| getStatsJSON             | /stats.json                  | GET          | application/json
| Returns Drillbit stats such as ports and max direct memory in json format.             
                                                                                         
                                                                          | ALL          
                                                                                         
      |
-| getStatus                | /status                      | GET          | text/html    
   | Returns Running!                                                                    
                                                                                         
                                                                             | ALL       
                                                                                         
         |
-| getSystemOptionsJSON     | /options.json                | GET          | application/json
| Returns a list of options. Each option consists of name-value-type-kind (for example: (boot
system datatype).                                                                        
                                                                      | ALL              
                                                                                         
  |
-| getSystemOptions         | /options                     | GET          | text/html    
   | Returns an HTML table where each row is a form containing the option details that allows
option values to be modified.                                                            
                                                                         | ALL           
                                                                                         
     |
-| updateSystemOption       | /option/{optionName}         | POST         | text/html    
   | Updates the options and calls getSystemOptions. So again an option list is displayed.
                                                                                         
                                                                            | ADMIN      
                                                                                         
        |
-| getStoragePluginsJSON    | /storage.json                | GET          | application/json
| Returns a list of storage plugin wrappers each containing name-config (instance of StoragePluginConfig)
and enabled.                                                                             
                                                          | ADMIN                        
                                                                                |
-| getStoragePlugins        | /storage                     | GET          | text/html    
   | Returns an HTML page with two sections: The first section contains a table of rows that
are forms containing the plugin button for the update page and a button to disable the plugin.
The second section is the same except the button enables the plugin. | ADMIN             
                                                                                         
 |
-| getStoragePluginJSON     | /storage/{name}.json         | GET          | application/json
| Returns a plugin config wrapper for the requested web page.                            
                                                                                         
                                                                          | ADMIN        
                                                                                         
      |
-| getStoragePlugin         | /storage/{name}              | GET          | text/html    
   | Returns an HTML page that has an editable text box for configuration changes and buttons
for creating/updating/deleting. Each button makes calls that regenerate the page.        
                                                                         | ADMIN         
                                                                                         
     |
-| enablePlugin             | /storage/{name}/enable/{val} | GET          | application/json
| Updates the storage plugin configuration status. Returns success or failure.           
                                                                                         
                                                                          | ADMIN        
                                                                                         
      |
-| deletePluginJSON         | /storage/{name}.json         | DELETE       | application/json
| Deletes the storage plugin. Returns success or failure.                                
                                                                                         
                                                                          | ADMIN        
                                                                                         
      |
-| deletePlugin             | /storage/{name}/delete       | GET          | application/json
| Same as deletePluginJSON but a GET instead of a DELETE request.                        
                                                                                         
                                                                          | ADMIN        
                                                                                         
      |
-| createOrUpdatePluginJSON | /storage/{name}.json         | POST         | application/json
| Creates or updates the storage plugin configuration. Returns success or failure. Expects
JSON input.                                                                              
                                                                         | ADMIN         
                                                                                         
     |
-| createOrUpdatePlugin     | /storage/{name}              | POST         | application/json
| Same as createOrUpdatePluginJSON expects JSON or FORM input.                           
                                                                                         
                                                                          | ADMIN        
                                                                                         
      |
-| getProfilesJSON          | /profiles.json               | GET          | application/json
| Returns currently running and completed profiles from PStore. For each profile a queryId,
startTime, foremanAddress, query, user, and state is returned. Each list (running and completed)
is organized in reverse chronological order.                     | [ADMIN, USER](/docs/configuring-web-console-and-rest-api-security/#get-/profiles.json)
            |
-| getProfiles              | /profiles                    | GET          | text/html    
   | Generates an HTML page from the data returned by getProfilesJSON with a hyperlink to
a detailed query page,                                                                   
                                                                             | [ADMIN, USER](/docs/configuring-web-console-and-rest-api-security/#get-/profiles)
                 |
-| getProfileJSON           | /profiles/{queryid}.json     | GET          | application/json
| Returns the entire profile in JSON.                                                    
                                                                                         
                                                                          | [ADMIN, USER](/docs/configuring-web-console-and-rest-api-security/#get-/profiles/{queryid}.json)
  |
-| getProfile               | /profiles/{queryid}          | GET          | text/html    
   | Returns a complicated profile page.                                                 
                                                                                         
                                                                             | [ADMIN, USER](/docs/configuring-web-console-and-rest-api-security/#get-/profiles/{queryid})
       |
-| cancelQuery              | /profiles/cancel/{queryid}   | GET          | text/html    
   | Cancels the given query and sends a message.                                        
                                                                                         
                                                                             | [ADMIN, USER](/docs/configuring-web-console-and-rest-api-security/#get-/profiles/cancel/{queryid})
|
-| getQuery                 | /query                       | GET          | text/html    
   | Gets the query input page.                                                          
                                                                                         
                                                                             | ALL       
                                                                                         
         |
-| submitQueryJSON          | /query.json                  | POST         | application/json
| Submits a query and waits until it is completed and then returns the results as one big
JSON object.                                                                             
                                                                          | ALL          
                                                                                         
      |
-| submitQuery              | /query                       | POST         | text/html    
   | Returns results from submitQueryJSON populated in a HTML table.                     
                                                                                         
                                                                             | ALL       
                                                                                         
         |
-| getMetrics               | /metrics                     | GET          | text/html    
   | Returns a page that fetches metric info from resource, status, and metrics.         
                                                                                         
                                                                             | ALL       
                                                                                         
         |
-| getThreads               | /threads                     | GET          | text/html    
   | Returns a page that fetches metric information from resource, status, and threads.  
                                                                                         
                                                                             | ALL       
                                                                                         
         |
+<table><thead>
+<tr>
+<th>Resource Method</th>
+<th>Path</th>
+<th>Request Type</th>
+<th>Output Type</th>
+<th>Functionality</th>
+<th>Privilege Level</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>getStats</td>
+<td>/</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns Drillbit stats in a table in HTML format.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>getStatsJSON</td>
+<td>/stats.json</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Returns Drillbit stats such as ports and max direct memory in json format.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>getStatus</td>
+<td>/status</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns Running!</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>getSystemOptionsJSON</td>
+<td>/options.json</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Returns a list of options. Each option consists of name-value-type-kind (for example:
(boot system datatype).</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>getSystemOptions</td>
+<td>/options</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns an HTML table where each row is a form containing the option details that
allows option values to be modified.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>updateSystemOption</td>
+<td>/option/{optionName}</td>
+<td>POST</td>
+<td>text/html</td>
+<td>Updates the options and calls getSystemOptions. So again an option list is displayed.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>getStoragePluginsJSON</td>
+<td>/storage.json</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Returns a list of storage plugin wrappers each containing name-config (instance
of StoragePluginConfig) and enabled.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>getStoragePlugins</td>
+<td>/storage</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns an HTML page with two sections: The first section contains a table of rows
that are forms containing the plugin button for the update page and a button to disable the
plugin. The second section is the same except the button enables the plugin.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>getStoragePluginJSON</td>
+<td>/storage/{name}.json</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Returns a plugin config wrapper for the requested web page.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>getStoragePlugin</td>
+<td>/storage/{name}</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns an HTML page that has an editable text box for configuration changes and
buttons for creating/updating/deleting. Each button makes calls that regenerate the page.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>enablePlugin</td>
+<td>/storage/{name}/enable/{val}</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Updates the storage plugin configuration status. Returns success or failure.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>deletePluginJSON</td>
+<td>/storage/{name}.json</td>
+<td>DELETE</td>
+<td>application/json</td>
+<td>Deletes the storage plugin. Returns success or failure.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>deletePlugin</td>
+<td>/storage/{name}/delete</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Same as deletePluginJSON but a GET instead of a DELETE request.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>createOrUpdatePluginJSON</td>
+<td>/storage/{name}.json</td>
+<td>POST</td>
+<td>application/json</td>
+<td>Creates or updates the storage plugin configuration. Returns success or failure.
Expects JSON input.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>createOrUpdatePlugin</td>
+<td>/storage/{name}</td>
+<td>POST</td>
+<td>application/json</td>
+<td>Same as createOrUpdatePluginJSON expects JSON or FORM input.</td>
+<td>ADMIN</td>
+</tr>
+<tr>
+<td>getProfilesJSON</td>
+<td>/profiles.json</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Returns currently running and completed profiles from PStore. For each profile
a queryId, startTime, foremanAddress, query, user, and state is returned. Each list (running
and completed) is organized in reverse chronological order.</td>
+<td><a href="/docs/configuring-web-console-and-rest-api-security/#get-/profiles.json">ADMIN,
USER</a></td>
+</tr>
+<tr>
+<td>getProfiles</td>
+<td>/profiles</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Generates an HTML page from the data returned by getProfilesJSON with a hyperlink
to a detailed query page,</td>
+<td><a href="/docs/configuring-web-console-and-rest-api-security/#get-/profiles">ADMIN,
USER</a></td>
+</tr>
+<tr>
+<td>getProfileJSON</td>
+<td>/profiles/{queryid}.json</td>
+<td>GET</td>
+<td>application/json</td>
+<td>Returns the entire profile in JSON.</td>
+<td><a href="/docs/configuring-web-console-and-rest-api-security/#get-/profiles/%7Bqueryid%7D.json">ADMIN,
USER</a></td>
+</tr>
+<tr>
+<td>getProfile</td>
+<td>/profiles/{queryid}</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns a complicated profile page.</td>
+<td><a href="/docs/configuring-web-console-and-rest-api-security/#get-/profiles/%7Bqueryid%7D">ADMIN,
USER</a></td>
+</tr>
+<tr>
+<td>cancelQuery</td>
+<td>/profiles/cancel/{queryid}</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Cancels the given query and sends a message.</td>
+<td><a href="/docs/configuring-web-console-and-rest-api-security/#get-/profiles/cancel/%7Bqueryid%7D">ADMIN,
USER</a></td>
+</tr>
+<tr>
+<td>getQuery</td>
+<td>/query</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Gets the query input page.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>submitQueryJSON</td>
+<td>/query.json</td>
+<td>POST</td>
+<td>application/json</td>
+<td>Submits a query and waits until it is completed and then returns the results as
one big JSON object.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>submitQuery</td>
+<td>/query</td>
+<td>POST</td>
+<td>text/html</td>
+<td>Returns results from submitQueryJSON populated in a HTML table.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>getMetrics</td>
+<td>/metrics</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns a page that fetches metric info from resource, status, and metrics.</td>
+<td>ALL</td>
+</tr>
+<tr>
+<td>getThreads</td>
+<td>/threads</td>
+<td>GET</td>
+<td>text/html</td>
+<td>Returns a page that fetches metric information from resource, status, and threads.</td>
+<td>ALL</td>
+</tr>
+</tbody></table>
 
-### GET /profiles.json
+<h3 id="get-/profiles.json">GET /profiles.json</h3>
 
-* ADMIN - gets all profiles on the system.  
-* USER - only the profiles of the queries the user has launched.
+<ul>
+<li>ADMIN - gets all profiles on the system.<br></li>
+<li>USER - only the profiles of the queries the user has launched.</li>
+</ul>
 
-### GET /profiles
+<h3 id="get-/profiles">GET /profiles</h3>
 
-* ADMIN - gets all profiles on the system.  
-* USER - only the profiles of the queries the user has launched.
+<ul>
+<li>ADMIN - gets all profiles on the system.<br></li>
+<li>USER - only the profiles of the queries the user has launched.</li>
+</ul>
 
-### GET /profiles/{queryid}.json
+<h3 id="get-/profiles/{queryid}.json">GET /profiles/{queryid}.json</h3>
 
-* ADMIN - return the profile.  
-* USER - if the query is launched the by the requesting user return it. Otherwise, return
an error saying no such profile exists.
+<ul>
+<li>ADMIN - return the profile.<br></li>
+<li>USER - if the query is launched the by the requesting user return it. Otherwise,
return an error saying no such profile exists.</li>
+</ul>
 
-### GET /profiles/{queryid}
+<h3 id="get-/profiles/{queryid}">GET /profiles/{queryid}</h3>
 
-* ADMIN - return the profile.   
-* USER - if the query is launched the by the requesting user return it. Otherwise, return
an error saying no such profile exists
+<ul>
+<li>ADMIN - return the profile.<br></li>
+<li>USER - if the query is launched the by the requesting user return it. Otherwise,
return an error saying no such profile exists</li>
+</ul>
 
-### GET /profiles/cancel/{queryid}
+<h3 id="get-/profiles/cancel/{queryid}">GET /profiles/cancel/{queryid}</h3>
 
-* ADMIN - can cancel the query.  
-* USER - cancel the query only if the query is launched by the user requesting the cancellation.
-->
+<ul>
+<li>ADMIN - can cancel the query.<br></li>
+<li>USER - cancel the query only if the query is launched by the user requesting the
cancellation. </li>
+</ul>
 
     
       

http://git-wip-us.apache.org/repos/asf/drill-site/blob/162a0961/docs/optimizing-parquet-metadata-reading/index.html
----------------------------------------------------------------------
diff --git a/docs/optimizing-parquet-metadata-reading/index.html b/docs/optimizing-parquet-metadata-reading/index.html
index 19dcf41..a7b9990 100644
--- a/docs/optimizing-parquet-metadata-reading/index.html
+++ b/docs/optimizing-parquet-metadata-reading/index.html
@@ -1042,7 +1042,7 @@
 
     </div>
 
-     
+     Feb 8, 2016
 
     <link href="/css/docpage.css" rel="stylesheet" type="text/css">
 
@@ -1081,11 +1081,13 @@
 
 <p>After running the REFRESH TABLE METADATA command, Drill traverses directories in
the case of nested directories to find the Parquet files. From the footers of the files, Drill
gathers metadata, such as row counts and node affinity based on HDFS block locations. For
each directory level, Drill saves a summary of the information from the footers in a single
Parquet metadata cache file. The summary at each level covers that particular level and all
child levels; consequently, after generating metadata, you can query nested directories from
any level. In order to leverage the metadata cache file for a table t, the file must exist
at the root directory of that table. For example, you can query a subdirectory of Parquet
files because Drill stores a Parquet metadata cache file at each level.</p>
 
-<p>At planning time, Drill reads only the metadata file. Parquet metadata caching has
no effect on execution time. At execution time, Drill reads the actual files.</p>
+<p>At planning time, Drill reads only the metadata file. Parquet metadata caching has
no effect on execution time. At execution time, Drill reads the actual files.  </p>
 
-<h2 id="security-limitations">Security Limitations</h2>
+<!--
+## Security Limitations
+TBD  
 
-<p>TBD</p>
+-->
 
     
       

http://git-wip-us.apache.org/repos/asf/drill-site/blob/162a0961/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index f0b787d..f11b8a9 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
 </description>
     <link>/</link>
     <atom:link href="/feed.xml" rel="self" type="application/rss+xml"/>
-    <pubDate>Fri, 05 Feb 2016 16:22:11 -0800</pubDate>
-    <lastBuildDate>Fri, 05 Feb 2016 16:22:11 -0800</lastBuildDate>
+    <pubDate>Mon, 08 Feb 2016 14:00:31 -0800</pubDate>
+    <lastBuildDate>Mon, 08 Feb 2016 14:00:31 -0800</lastBuildDate>
     <generator>Jekyll v2.5.2</generator>
     
       <item>


Mime
View raw message