Author: amagyar
Date: Wed Oct 5 11:18:56 2022
New Revision: 1904415
URL: http://svn.apache.org/viewvc?rev=1904415&view=rev
Log:
KNOX-2816 Add missing documentations KNOX-2764 KNOX-2817 KNOX-2818
Modified:
knox/trunk/books/2.0.0/book_client-details.md
knox/trunk/books/2.0.0/config_knox_token.md
knox/trunk/books/2.0.0/knox_cli.md
Modified: knox/trunk/books/2.0.0/book_client-details.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/book_client-details.md?rev=1904415&r1=1904414&r2=1904415&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/book_client-details.md (original)
+++ knox/trunk/books/2.0.0/book_client-details.md Wed Oct 5 11:18:56 2022
@@ -406,7 +406,18 @@ It also manages a thread pool that is us
The syntax associated with this is expected to change. We expect that
credentials will not need to be provided to the gateway. Rather it is expected
that some form of access token will be used to initialize the session.
+#### ClientContext ####
+The ClientContext encapsulates the connection parameters, such as the URL,
socket timeout parameters, retry configuration and connection pool parameters.
+
+ ClientContext context = ClientContext.with("http://localhost:8443";);
+
context.connection().retryCount(2).requestSentRetryEnabled(false).retryIntervalMillis(1000).end();
+ KnoxSession session = KnoxSession.login(context);
+
+* retryCount - how many times to retry; -1 means no retries
+* requestSentRetryEnabled - true if it's OK to retry requests that have been
sent
+* retryIntervalMillis - The interval between the subsequent auto-retries when
the service is unavailable
+
#### Services ####
Services are the primary extension point for adding new suites of commands.
Modified: knox/trunk/books/2.0.0/config_knox_token.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/config_knox_token.md?rev=1904415&r1=1904414&r2=1904415&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/config_knox_token.md (original)
+++ knox/trunk/books/2.0.0/config_knox_token.md Wed Oct 5 11:18:56 2022
@@ -38,7 +38,8 @@ knox.token.renewer.whitelist | This is
knox.token.exp.renew-interval | This is an optional configuration parameter to
specify the amount of time (milliseconds) to be added to a token's TTL when a
renewal request is approved. | 86400000 (24 hours) |
knox.token.exp.max-lifetime | This is an optional configuration parameter to
specify the maximum allowed lifetime (milliseconds) of a token, after which
renewal will not be permitted. | 604800000 (7 days) |
knox.token.type | If this is configured the generated JWT's header will have
this value as the `typ` property | |
-knox.token.impersonation.enabled | This is a `boolean` flag indicates if token
impersonation is enabled | `true`
+knox.token.impersonation.enabled | This is a `boolean` flag indicates if token
impersonation is enabled | `true` |
+knox.token.issuer | This is an optional configuration parameter to specify
the issuer of a token. | KNOXSSO |
Note that server-managed token state can be configured for all KnoxToken
service deployments in gateway-site (see
[gateway.knox.token.exp.server-managed](#Gateway+Server+Configuration)). If it
is configured at the gateway level, then the associated service parameter, if
configured, will override the gateway configuration.
Modified: knox/trunk/books/2.0.0/knox_cli.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/knox_cli.md?rev=1904415&r1=1904414&r2=1904415&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/knox_cli.md (original)
+++ knox/trunk/books/2.0.0/knox_cli.md Wed Oct 5 11:18:56 2022
@@ -59,6 +59,19 @@ name | Name of the alias to crea
\-\-value | Parameter for specifying the actual password otherwise
prompted. Escape complex passwords or surround with single quotes
\-\-generate | Boolean flag to indicate whether the tool should just generate
the value. This assumes that \-\-value is not set - will result in error
otherwise. User will not be prompted for the value when \-\-generate is set.
+#### Batch alias creation ####
+
+##### `bin/knoxcli.sh create-aliases --alias alias1 [--value value1] --alias
alias2 [--value value2] --alias aliasN [--value valueN] ... [--cluster
clustername] [--generate]` #####
+
+Creates multiple password aliases and stores them in a credential store within
the `{GATEWAY_HOME}/data/security/keystores` dir.
+
+Argument | Description
+-------------|-----------
+\-\-alias | Name of an alias to create.
+\-\-value | Parameter for specifying the actual password otherwise
prompted. Escape complex passwords or surround with single quotes.
+\-\-generate | Boolean flag to indicate whether the tool should just generate
the value. This assumes that \-\-value is not set - will result in error
otherwise. User will not be prompted for the value when \-\-generate is set.
+\-\-cluster | Name of Hadoop cluster for the cluster specific credential
store otherwise assumes that it is for the gateway itself
+
#### Alias deletion ####
##### `bin/knoxcli.sh delete-alias name [--cluster c] [--help]` #####
Deletes a password and alias mapping from a credential store within
`{GATEWAY_HOME}/data/security/keystores`.
