This is an automated email from the ASF dual-hosted git repository.
mwalch pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git
The following commit(s) were added to refs/heads/master by this push:
new 1348c64 Updated 2.0 client documentation (#91)
1348c64 is described below
commit 1348c649a384ff7626287cfcb9ac940176d5bbb7
Author: Mike Walch <[email protected]>
AuthorDate: Fri Jul 6 13:03:27 2018 -0400
Updated 2.0 client documentation (#91)
* Due to recent changes in master
* Client properties updates
---
_docs-2-0/development/client-properties.md | 13 +++++-----
_docs-2-0/getting-started/clients.md | 39 +++++++++++++++++++++---------
2 files changed, 34 insertions(+), 18 deletions(-)
diff --git a/_docs-2-0/development/client-properties.md
b/_docs-2-0/development/client-properties.md
index 498590d..4550da4 100644
--- a/_docs-2-0/development/client-properties.md
+++ b/_docs-2-0/development/client-properties.md
@@ -13,18 +13,17 @@ Below are properties set in `accumulo-client.properties`
that configure [Accumul
|----------|---------------|-------|-------------|
| <a name="instance_name" class="prop"></a> instance.name | *empty* | | Name
of Accumulo instance to connect to |
| <a name="instance_zookeepers" class="prop"></a> instance.zookeepers |
localhost:2181 | | Zookeeper connection information for Accumulo instance |
-| <a name="instance_zookeepers_timeout_sec" class="prop"></a>
instance.zookeepers.timeout.sec | 30 | | Zookeeper session timeout (in
seconds) |
-| <a name="auth_method" class="prop"></a> auth.method | password | |
Authentication method (i.e password, kerberos, provider). Set more properties
for chosen method below. |
-| <a name="auth_username" class="prop"></a> auth.username | *empty* | |
Accumulo username/principal for chosen authentication method |
-| <a name="auth_kerberos_keytab_path" class="prop"></a>
auth.kerberos.keytab.path | *empty* | | Path to Kerberos keytab |
-| <a name="auth_password" class="prop"></a> auth.password | *empty* | |
Accumulo user password |
-| <a name="auth_provider_name" class="prop"></a> auth.provider.name | *empty*
| | Alias used to extract Accumulo user password from CredentialProvider |
-| <a name="auth_provider_urls" class="prop"></a> auth.provider.urls | *empty*
| | Comma separated list of URLs defining CredentialProvider(s) |
+| <a name="instance_zookeepers_timeout" class="prop"></a>
instance.zookeepers.timeout | 30s | | Zookeeper session timeout |
+| <a name="auth_type" class="prop"></a> auth.type | password | |
Authentication method (i.e password, kerberos, PasswordToken, KerberosToken,
etc) |
+| <a name="auth_principal" class="prop"></a> auth.principal | *empty* | |
Accumulo principal/username for chosen authentication method |
+| <a name="auth_token" class="prop"></a> auth.token | *empty* | |
Authentication token (ex. mypassword, /path/to/keytab) |
| <a name="batch_writer_durability" class="prop"></a> batch.writer.durability
| default | | Change the durability for the BatchWriter session. To use the
table's durability setting. use "default" which is the table's durability
setting. |
| <a name="batch_writer_max_latency_sec" class="prop"></a>
batch.writer.max.latency.sec | 120 | | Max amount of time (in seconds) to hold
data in memory before flushing it |
| <a name="batch_writer_max_memory_bytes" class="prop"></a>
batch.writer.max.memory.bytes | 52428800 | | Max memory (in bytes) to batch
before writing |
| <a name="batch_writer_max_timeout_sec" class="prop"></a>
batch.writer.max.timeout.sec | 0 | | Max amount of time (in seconds) an
unresponsive server will be re-tried. An exception is thrown when this timeout
is exceeded. Set to zero for no timeout. |
| <a name="batch_writer_max_write_threads" class="prop"></a>
batch.writer.max.write.threads | 3 | | Maximum number of threads to use for
writing data to tablet servers. |
+| <a name="batch_scanner_num_query_threads" class="prop"></a>
batch.scanner.num.query.threads | 3 | | Number of concurrent query threads to
spawn for querying |
+| <a name="scanner_batch_size" class="prop"></a> scanner.batch.size | 1000 |
| Number of key/value pairs that will be fetched at time from tablet server |
| <a name="ssl_enabled" class="prop"></a> ssl.enabled | false | | Enable SSL
for client RPC |
| <a name="ssl_keystore_password" class="prop"></a> ssl.keystore.password |
*empty* | | Password used to encrypt keystore |
| <a name="ssl_keystore_path" class="prop"></a> ssl.keystore.path | *empty* |
| Path to SSL keystore file |
diff --git a/_docs-2-0/getting-started/clients.md
b/_docs-2-0/getting-started/clients.md
index 5d3baa7..277324d 100644
--- a/_docs-2-0/getting-started/clients.md
+++ b/_docs-2-0/getting-started/clients.md
@@ -43,20 +43,37 @@ of the following methods:
Properties props = new Properties()
props.put("instance.name", "myinstance")
props.put("instance.zookeepers", "zookeeper1,zookeeper2")
- props.put("auth.method", "password")
- props.put("auth.username", "myuser")
- props.put("auth.password", "mypassword")
+ props.put("auth.type", "password")
+ props.put("auth.principal", "myuser")
+ props.put("auth.token", "mypassword")
Connector conn = Connector.builder().usingProperties(props).build();
```
If a `accumulo-client.properties` file or a Java Properties object is used to
create a [Connector], the following
[client properties][client-props] must be set:
-* [instance.name]
-* [instance.zookeepers]
-* [auth.method]
-* [auth.username]
-* [auth.password]
+* [instance.name] - Name of Accumulo instance to connect to
+* [instance.zookeepers] - ZooKeeper connection information for this Accumulo
instance
+* [auth.type] - Authentication method. Possible values are `password`,
`kerberos`, or authentication token class (i.e `PasswordToken`,
`org.apache.accumulo.core.client.security.tokens.PasswordToken`)
+* [auth.principal] - Accumulo principal/username
+* [auth.token] - Token associated with `auth.type`. See table for mapping
below:
+
+| auth.type | expected auth.token | example auth.token |
+|-----------------|-------------------------|----------------------|
+| password | Password string | mypassword |
+| kerberos | Path to Kerberos keytab | /path/to/keytab |
+| Authentication token class | Base64 encoded token |
AAAAGh+LCAAAAAAAAAArTk0uSi0BAOXoolwGAAAA |
+
+If a token class is used for `auth.type`, you can create create a Base64
encoded token using the `accumulo create-token` command.
+
+```
+$ accumulo create-token
+Username (aka principal): root
+the password for the principal: ******
+auth.type = org.apache.accumulo.core.client.security.tokens.PasswordToken
+auth.principal = root
+auth.token = AAAAGh+LCAAAAAAAAAArTk0uSi0BAOXoolwGAAAA
+```
# Authentication
@@ -329,9 +346,9 @@ This page covers Accumulo client basics. Below are links
to additional document
[Connector]: {{ page.javadoc_core
}}/org/apache/accumulo/core/client/Connector.html
[client-props]: {{ page.docs_baseurl }}/development/client-properties
-[auth.method]: {{ page.docs_baseurl
}}/development/client-properties#auth_method
-[auth.username]: {{ page.docs_baseurl
}}/development/client-properties#auth_username
-[auth.password]: {{ page.docs_baseurl
}}/development/client-properties#auth_password
+[auth.type]: {{ page.docs_baseurl }}/development/client-properties#auth_type
+[auth.principal]: {{ page.docs_baseurl
}}/development/client-properties#auth_principal
+[auth.token]: {{ page.docs_baseurl }}/development/client-properties#auth_token
[instance.name]: {{ page.docs_baseurl
}}/development/client-properties#instance_name
[instance.zookeepers]: {{ page.docs_baseurl
}}/development/client-properties#instance_zookeepers
[batch.writer.durability]: {{ page.docs_baseurl
}}/development/client-properties#batch_writer_durability
