Author: smolnar
Date: Thu Oct 6 13:38:04 2022
New Revision: 1904427
URL: http://svn.apache.org/viewvc?rev=1904427&view=rev
Log:
KNOX-2802 - Document service definition management on Admin UI
Added:
knox/site/books/knox-2-0-0/adminui/delete-icon.png (with props)
knox/site/books/knox-2-0-0/adminui/image22.png (with props)
knox/site/books/knox-2-0-0/adminui/image23.png (with props)
knox/site/books/knox-2-0-0/adminui/image24.png (with props)
knox/site/books/knox-2-0-0/adminui/image25.png (with props)
knox/site/books/knox-2-0-0/adminui/image26.png (with props)
knox/site/books/knox-2-0-0/adminui/image27.png (with props)
knox/site/books/knox-2-0-0/adminui/image28.png (with props)
knox/site/books/knox-2-0-0/adminui/tip-icon.png (with props)
knox/trunk/books/2.0.0/img/adminui/delete-icon.png (with props)
knox/trunk/books/2.0.0/img/adminui/image22.png (with props)
knox/trunk/books/2.0.0/img/adminui/image23.png (with props)
knox/trunk/books/2.0.0/img/adminui/image24.png (with props)
knox/trunk/books/2.0.0/img/adminui/image25.png (with props)
knox/trunk/books/2.0.0/img/adminui/image26.png (with props)
knox/trunk/books/2.0.0/img/adminui/image27.png (with props)
knox/trunk/books/2.0.0/img/adminui/image28.png (with props)
knox/trunk/books/2.0.0/img/adminui/tip-icon.png (with props)
Modified:
knox/site/books/knox-2-0-0/adminui/image1.png
knox/site/books/knox-2-0-0/user-guide.html
knox/site/index.html
knox/site/issue-management.html
knox/site/licenses.html
knox/site/mailing-lists.html
knox/site/project-info.html
knox/site/team.html
knox/trunk/books/2.0.0/admin_ui.md
knox/trunk/books/2.0.0/img/adminui/image1.png
Added: knox/site/books/knox-2-0-0/adminui/delete-icon.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/delete-icon.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/delete-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: knox/site/books/knox-2-0-0/adminui/image1.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image1.png?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
Binary files - no diff available.
Added: knox/site/books/knox-2-0-0/adminui/image22.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image22.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image22.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/image23.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image23.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image23.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/image24.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image24.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image24.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/image25.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image25.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image25.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/image26.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image26.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image26.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/image27.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image27.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image27.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/image28.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/image28.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/image28.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/site/books/knox-2-0-0/adminui/tip-icon.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/adminui/tip-icon.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/site/books/knox-2-0-0/adminui/tip-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: knox/site/books/knox-2-0-0/user-guide.html
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/user-guide.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/books/knox-2-0-0/user-guide.html (original)
+++ knox/site/books/knox-2-0-0/user-guide.html Thu Oct 6 13:38:04 2022
@@ -2058,6 +2058,35 @@ ls -alrt {GATEWAY_HOME}/data/deployment
</tr>
</tbody>
</table>
+<h4><a id="Batch+alias+creation">Batch alias creation</a> <a
href="#Batch+alias+creation"><img src="markbook-section-link.png"/></a></h4>
+<h5><a
id="`bin/knoxcli.sh+create-aliases+--alias+alias1+[--value+value1]+--alias+alias2+[--value+value2]+--alias+aliasN+[--value+valueN]+...+[--cluster+clustername]+[--generate]`"><code>bin/knoxcli.sh
create-aliases --alias alias1 [--value value1] --alias alias2 [--value value2]
--alias aliasN [--value valueN] ... [--cluster clustername]
[--generate]</code></a> <a
href="#`bin/knoxcli.sh+create-aliases+--alias+alias1+[--value+value1]+--alias+alias2+[--value+value2]+--alias+aliasN+[--value+valueN]+...+[--cluster+clustername]+[--generate]`"><img
src="markbook-section-link.png"/></a></h5>
+<p>Creates multiple password aliases and stores them in a credential store
within the <code>{GATEWAY_HOME}/data/security/keystores</code> dir.</p>
+<table>
+ <thead>
+ <tr>
+ <th>Argument </th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>--alias </td>
+ <td>Name of an alias to create.</td>
+ </tr>
+ <tr>
+ <td>--value </td>
+ <td>Parameter for specifying the actual password otherwise prompted.
Escape complex passwords or surround with single quotes.</td>
+ </tr>
+ <tr>
+ <td>--generate </td>
+ <td>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.</td>
+ </tr>
+ <tr>
+ <td>--cluster </td>
+ <td>Name of Hadoop cluster for the cluster specific credential store
otherwise assumes that it is for the gateway itself</td>
+ </tr>
+ </tbody>
+</table>
<h4><a id="Alias+deletion">Alias deletion</a> <a href="#Alias+deletion"><img
src="markbook-section-link.png"/></a></h4>
<h5><a
id="`bin/knoxcli.sh+delete-alias+name+[--cluster+c]+[--help]`"><code>bin/knoxcli.sh
delete-alias name [--cluster c] [--help]</code></a> <a
href="#`bin/knoxcli.sh+delete-alias+name+[--cluster+c]+[--help]`"><img
src="markbook-section-link.png"/></a></h5>
<p>Deletes a password and alias mapping from a credential store within
<code>{GATEWAY_HOME}/data/security/keystores</code>.</p>
@@ -5450,6 +5479,12 @@ APACHE_HOME/bin/apachectl -k stop
</param>
</code></pre>
<p>NOTE: This is NOT a secure mechanism and must NOT be used in production
deployments.</p>
+<p>By default Knox will accept the subject of the returned UserProfile and
pass it as the PrimaryPrincipal to the proxied service. If you want to use a
different user attribute, you can set the UserProfile attribute name as
configuration parameter called pac4j.id_attribute.</p>
+<pre><code><param>
+ <name>pac4j.id_attribute</name>
+ <value>nickname</value>
+</param>
+</code></pre>
<p>Otherwise, you can use Facebook, Twitter, a CAS server, a SAML IdP or an
OpenID Connect provider by using the following parameters:</p>
<h5><a id="For+OAuth+support:">For OAuth support:</a> <a
href="#For+OAuth+support:"><img src="markbook-section-link.png"/></a></h5>
<table>
@@ -5862,7 +5897,12 @@ APACHE_HOME/bin/apachectl -k stop
<tr>
<td>knox.token.impersonation.enabled </td>
<td>This is a <code>boolean</code> flag indicates if token impersonation
is enabled </td>
- <td><code>true</code></td>
+ <td><code>true</code> </td>
+ </tr>
+ <tr>
+ <td>knox.token.issuer </td>
+ <td>This is an optional configuration parameter to specify the issuer of
a token. </td>
+ <td>KNOXSSO </td>
</tr>
</tbody>
</table>
@@ -6692,6 +6732,17 @@ session.waitFor( readmeFuture, licenseFu
<h4><a id="Session">Session</a> <a href="#Session"><img
src="markbook-section-link.png"/></a></h4>
<p>This construct encapsulates the client side session state that will be
shared between all command invocations. In particular it will simplify the
management of any tokens that need to be presented with each command
invocation. It also manages a thread pool that is used by all asynchronous
commands which is why it is important to call one of the shutdown methods.</p>
<p>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.</p>
+<h4><a id="ClientContext">ClientContext</a> <a href="#ClientContext"><img
src="markbook-section-link.png"/></a></h4>
+<p>The ClientContext encapsulates the connection parameters, such as the URL,
socket timeout parameters, retry configuration and connection pool
parameters.</p>
+<pre><code>ClientContext context =
ClientContext.with("http://localhost:8443");
+context.connection().retryCount(2).requestSentRetryEnabled(false).retryIntervalMillis(1000).end();
+KnoxSession session = KnoxSession.login(context);
+</code></pre>
+<ul>
+ <li>retryCount - how many times to retry; -1 means no retries</li>
+ <li>requestSentRetryEnabled - true if it’s OK to retry requests that
have been sent</li>
+ <li>retryIntervalMillis - The interval between the subsequent auto-retries
when the service is unavailable</li>
+</ul>
<h4><a id="Services">Services</a> <a href="#Services"><img
src="markbook-section-link.png"/></a></h4>
<p>Services are the primary extension point for adding new suites of commands.
The current built-in examples are: Hdfs, Job and Workflow. The desire for
extensibility is the reason for the slightly awkward
<code>Hdfs.ls(session)</code> syntax. Certainly something more like
<code>session.hdfs().ls()</code> would have been preferred but this would
prevent adding new commands easily. At a minimum it would result in extension
commands with a different syntax from the “built-in” commands.</p>
<p>The service objects essentially function as a factory for a suite of
commands.</p>
@@ -10000,7 +10051,7 @@ curl -i -k -u username:password -H "
</service>
</code></pre>
<h3><a id="Admin+UI">Admin UI</a> <a href="#Admin+UI"><img
src="markbook-section-link.png"/></a></h3>
-<p>The Admin UI is a web application hosted by Knox, which provides the
ability to manage provider configurations, descriptors, and topologies.</p>
+<p>The Admin UI is a web application hosted by Knox, which provides the
ability to manage provider configurations, descriptors, topologies ans service
definitions.</p>
<p>As an authoring facility, it eliminates the need for ssh/scp access to the
Knox host(s) to effect topology changes.<br> Furthermore, using the Admin UI
simplifies the management of topologies in Knox HA deployments by eliminating
the need to copy files to multiple Knox hosts.</p>
<h4><a id="Admin+UI+URL">Admin UI URL</a> <a href="#Admin+UI+URL"><img
src="markbook-section-link.png"/></a></h4>
<p>The URL mapping for the Knox Admin UI is:</p>
@@ -10015,10 +10066,10 @@ curl -i -k -u username:password -H "
<h5><a id="Authentication">Authentication</a> <a href="#Authentication"><img
src="markbook-section-link.png"/></a></h5>
<p>The admin UI is deployed using the <strong>manager</strong> topology. The
out-of-box authentication mechanism is KNOXSSO, backed by the demo LDAP server.
Only someone in the <strong>admin</strong> role can access the UI
functionality.</p>
<h5><a id="Basic+Navigation">Basic Navigation</a> <a
href="#Basic+Navigation"><img src="markbook-section-link.png"/></a></h5>
-<p>Initially, the Admin UI presents the types of resources which can be
managed: <a href="#Provider+Configurations"><strong>Provider
Configurations</strong></a>, <a
href="#Descriptors"><strong>Descriptors</strong></a>, and <a
href="#Topologies"><strong>Topologies</strong></a>.</p>
+<p>Initially, the Admin UI presents the types of resources which can be
managed: <a href="#Provider+Configurations"><strong>Provider
Configurations</strong></a>, <a
href="#Descriptors"><strong>Descriptors</strong></a>, <a
href="#Topologies"><strong>Topologies</strong></a> and <a
href="#Service+Definitions"><strong>Service Definitions</strong></a>.</p>
<img src="adminui/image1.png" style="width:6.5in;height:3.28403in" />
<p>Selecting a resource type yields a listing of the existing resources of
that type in the adjacent column, and selecting an individual resource presents
the details of that selected resource.</p>
-<p>For the provider configuration and descriptor resources types, the <img
src="adminui/plus-icon.png"
style="width:20px;height:20px;vertical-align:bottom"/> icon next to the
resource list header is the trigger for the respective facility for creating a
new resource of that type.<br> Modification options, including deletion, are
available from the detail view for an individual resource.</p>
+<p>For the provider configuration, descriptor and service definition resources
types, the <img src="adminui/plus-icon.png"
style="width:20px;height:20px;vertical-align:bottom"/> icon next to the
resource list header is the trigger for the respective facility for creating a
new resource of that type.<br> Modification options, including deletion, are
available from the detail view for an individual resource.</p>
<h5><a id="Provider+Configurations">Provider Configurations</a> <a
href="#Provider+Configurations"><img src="markbook-section-link.png"/></a></h5>
<p>The Admin UI lists the provider configurations currently deployed to
Knox.</p>
<p>By choosing a particular provider configuration from the list, its details
can be viewed and edited.<br> The provider configuration can also be deleted
(as long as there are no referencing descriptors).</p>
@@ -10094,7 +10145,47 @@ curl -i -k -u username:password -H "
<p>Topologies which are generated from descriptors are treated as read-only in
the Admin UI. This is to avoid the potential confusion resulting from an
administrator directly editing a generated topology only to have those changes
overwritten by a regeneration of that same topology because the source
descriptor or provider configuration changed.</p>
<h5><a id="Knox+HA+Considerations">Knox HA Considerations</a> <a
href="#Knox+HA+Considerations"><img src="markbook-section-link.png"/></a></h5>
<p>If the Knox instance which is hosting the Admin UI is configured for <a
href="#Remote+Configuration+Monitor">remote configuration monitoring</a>, then
provider configuration and descriptor changes will be persisted in the
configured ZooKeeper ensemble. Then, every Knox instance which is also
configured to monitor configuration in this same ZooKeeper will apply those
changes, and [re]generate/[re]deploy the affected topologies. In this way, Knox
HA deployments can be managed by making changes once, and from any of the Knox
instances.</p>
-<br>
+<h5><a id="Service+Definitions">Service Definitions</a> <a
href="#Service+Definitions"><img src="markbook-section-link.png"/></a></h5>
+<p>The Admin UI allows an administrator to view, modify, create and delete
service definitions which are currently supported by Knox.</p>
+<img src="adminui/image22.png" style="height:3.5in" />
+<p>A service definition is a declarative way of plugging-in a new Service. It
consists of two separate files as described in the relevant section in <a
href="https://knox.apache.org/books/knox-2-0-0/dev-guide.html#Service+Definition+Files";>Knox’s
Developer Guide</a>. The Admin UI lists the service definitions currently
supported by Knox in a data table ordered by the service name. If a particular
service has more than one service definition (for different versions), a
separate service definition entry is displayed in the table. Under the table
there is a pagination panel that let’s end-users to navigate to the
desired service definition.</p>
+<p>By choosing a particular service definition from the table, its details can
be viewed and edited. The service definition can also be deleted.</p>
+<img src="adminui/image23.png" style="height:3.5in" />
+<h6><a id="Editing+Service+Definitions">Editing Service Definitions</a> <a
href="#Editing+Service+Definitions"><img
src="markbook-section-link.png"/></a></h6>
+<p>When a particular service definition is selected, the Admin UI displays a
free-text area where the content can be updated and saved. End-users will see
the following structure in this text area:</p>
+<pre><code><serviceDefinition>
+ <service>
+ ...
+ </service>
+ <rules>
+ ...
+ </rules>
+</serviceDefinition>
+</code></pre>
+<p>Everything within the <code><service></code> section will be written
into the given service’s <code>service.xml</code> file whereas the
content of <code>rules</code> are going into the <code>rewrite.xml</code>.</p>
+<p>To persist changes, the <img src="adminui//save-icon.png"
style="height:32px;vertical-align:bottom"> button must be clicked. To revert
<em>unsaved</em> changes, simply choose another resource. In case you choose to
save your changes, a confirmation window is shown asking for your approval,
where you can make your changes final by clicking the <img
src="adminui/ok-button.png" style="height:24px;vertical-align:bottom"/>
button.</p>
+<img src="adminui/image24.png" style="height:3.5in" />
+<br />
+<br />
+<img src="adminui/image25.png" style="height:3.5in" />
+<p>If you are unsure about the change you made, you can still click the
<code>Cancel</code> button and select another resource to revert your unsaved
change.</p>
+<p><strong>Important note:</strong> editing a service definition will result
in redeploying all topologies that include the updated service (identified by
it’s name and, optionally, version).</p>
+<h6><a id="Deleting+Service+Definitions">Deleting Service Definitions</a> <a
href="#Deleting+Service+Definitions"><img
src="markbook-section-link.png"/></a></h6>
+<p>Similarly to the service definition editing function, end-users have to
select the service defintion first they are about to remove.</p>
+<p>The service definition details are displayed along with the <img
src="adminui//delete-icon.png" style="height:32px;vertical-align:bottom">
button in the bottom-left corner of the service definition details window. To
remove the selected service definition, you have to cick that button and you
will be shown a confirmation window where you can verify the service definition
removal by clicking the <img src="adminui/ok-button.png"
style="height:24px;vertical-align:bottom"/> button.</p>
+<img src="adminui/image26.png" style="height:3.5in" />
+<br />
+<br />
+<img src="adminui/image27.png" style="height:3.5in" />
+<p><strong>Important note:</strong> deleting a service definition will result
in redeploying all topologies that included the removed service (identified by
it’s name and, optionally, version).</p>
+<h6><a id="Creating+Service+Definitions">Creating Service Definitions</a> <a
href="#Creating+Service+Definitions"><img
src="markbook-section-link.png"/></a></h6>
+<p>The Admin UI provides the ability to define new service definitions which
can be included in topologies later on.</p>
+<p>The new service definition dialog provides the ability to specify the
service name, role and version as well as all the required information in
<code>service.xml</code> and <code>rewrite.xml</code> files such as routes and
rewrite rules.</p>
+<p>To create a new service provider, please click the <img
src="adminui/plus-icon.png"
style="width:20px;height:20px;vertical-align:bottom"/> button after you
selected <code>Service Definitions</code> from the <code>Resource Types</code>
list.</p>
+<img src="adminui/image28.png" style="height:3.5in" />
+<p>After defining all details, you have to click the <img
src="adminui/ok-button.png" style="height:24px;vertical-align:bottom"/> button
to save the newly created service definition on the disk.</p>
+<p><img src="adminui/tip-icon.png" style="height:24px;vertical-align:bottom"/>
You may want to copy-paste a valid service definition before you open the new
service definition dialog and self-tailor the content for your needs.</p>
+<br />
<h2><a id="Limitations">Limitations</a> <a href="#Limitations"><img
src="markbook-section-link.png"/></a></h2>
<h3><a id="Secure+Oozie+POST/PUT+Request+Payload+Size+Restriction">Secure
Oozie POST/PUT Request Payload Size Restriction</a> <a
href="#Secure+Oozie+POST/PUT+Request+Payload+Size+Restriction"><img
src="markbook-section-link.png"/></a></h3>
<p>With one exception there are no known size limits for requests or responses
payloads that pass through the gateway. The exception involves POST or PUT
request payload sizes for Oozie in a Kerberos secured Hadoop cluster. In this
one case there is currently a 4Kb payload size limit for the first request made
to the Hadoop cluster. This is a result of how the gateway negotiates a trust
relationship between itself and the cluster via SPNEGO. There is an
undocumented configuration setting to modify this limit’s value if
required. In the future this will be made more easily configurable and at that
time it will be documented.</p>
Modified: knox/site/index.html
URL:
http://svn.apache.org/viewvc/knox/site/index.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Thu Oct 6 13:38:04 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2022-10-05
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2022-10-06
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221005" />
+ <meta name="Date-Revision-yyyymmdd" content="20221006" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Announcing Apache Knox 1.6.1!</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-05</li>
+ <li id="publishDate">Last Published: 2022-10-06</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/issue-management.html
URL:
http://svn.apache.org/viewvc/knox/site/issue-management.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/issue-management.html (original)
+++ knox/site/issue-management.html Thu Oct 6 13:38:04 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management
at 2022-10-05
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management
at 2022-10-06
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221005" />
+ <meta name="Date-Revision-yyyymmdd" content="20221006" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Issue Management</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-05</li>
+ <li id="publishDate">Last Published: 2022-10-06</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/licenses.html
URL:
http://svn.apache.org/viewvc/knox/site/licenses.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/licenses.html (original)
+++ knox/site/licenses.html Thu Oct 6 13:38:04 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at
2022-10-05
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at
2022-10-06
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221005" />
+ <meta name="Date-Revision-yyyymmdd" content="20221006" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Licenses</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-05</li>
+ <li id="publishDate">Last Published: 2022-10-06</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/mailing-lists.html
URL:
http://svn.apache.org/viewvc/knox/site/mailing-lists.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/mailing-lists.html (original)
+++ knox/site/mailing-lists.html Thu Oct 6 13:38:04 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists
at 2022-10-05
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists
at 2022-10-06
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221005" />
+ <meta name="Date-Revision-yyyymmdd" content="20221006" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Mailing Lists</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-05</li>
+ <li id="publishDate">Last Published: 2022-10-06</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/project-info.html
URL:
http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Thu Oct 6 13:38:04 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2022-10-05
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2022-10-06
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221005" />
+ <meta name="Date-Revision-yyyymmdd" content="20221006" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Information</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-05</li>
+ <li id="publishDate">Last Published: 2022-10-06</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/team.html
URL:
http://svn.apache.org/viewvc/knox/site/team.html?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/site/team.html (original)
+++ knox/site/team.html Thu Oct 6 13:38:04 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at
2022-10-05
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at
2022-10-06
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221005" />
+ <meta name="Date-Revision-yyyymmdd" content="20221006" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Team</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-05</li>
+ <li id="publishDate">Last Published: 2022-10-06</li>
</ul>
</div>
<div class="row-fluid">
@@ -257,22 +257,7 @@
<td>Kevin Risden</td>
<td><a href="krisden(at)apache(dot)org">krisden(at)apache(dot)org</a></td>
<td>-</td>
-<td>PMC</td></tr>
-<tr class="a">
-<td><img
src="https://www.gravatar.com/avatar/3024dda44d5e80eb010f0e7e3942920a?d=mm&s=60";
alt="" /></td>
-<td><a name="smolnar"></a>smolnar</td>
-<td>Sandor Molnar</td>
-<td><a href="smolnar(at)apache(dot)org">smolnar(at)apache(dot)org</a></td>
-<td>Cloudera</td>
-<td>PMC</td></tr>
-<tr class="a">
-<td><img
src="https://www.gravatar.com/avatar/3024dda44d5e80eb010f0e7e3942920a?d=mm&s=60";
alt="" /></td>
-<td><a name="amagyar"></a>amagyar</td>
-<td>Attila Magyar</td>
-<td><a href="amagyar(at)apache(dot)org">amagyar(at)apache(dot)org</a></td>
-<td>Cloudera</td>
-<td>PMC</td></tr>
-</table></div>
+<td>PMC</td></tr></table></div>
<div class="section">
<h3><a name="Contributors"></a>Contributors</h3><a name="Contributors"></a>
<p>The following additional people have contributed to this project through
the way of suggestions, patches or documentation.</p>
Modified: knox/trunk/books/2.0.0/admin_ui.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/admin_ui.md?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/admin_ui.md (original)
+++ knox/trunk/books/2.0.0/admin_ui.md Thu Oct 6 13:38:04 2022
@@ -17,7 +17,7 @@
### Admin UI ###
-The Admin UI is a web application hosted by Knox, which provides the ability
to manage provider configurations, descriptors, and topologies.
+The Admin UI is a web application hosted by Knox, which provides the ability
to manage provider configurations, descriptors, topologies ans service
definitions.
As an authoring facility, it eliminates the need for ssh/scp access to the
Knox host(s) to effect topology changes.<br>
Furthermore, using the Admin UI simplifies the management of topologies in
Knox HA deployments by eliminating the need to copy files to multiple Knox
hosts.
@@ -37,14 +37,14 @@ The admin UI is deployed using the __man
Only someone in the __admin__ role can access the UI functionality.
##### Basic Navigation
-Initially, the Admin UI presents the types of resources which can be managed:
[__Provider Configurations__](#Provider+Configurations),
[__Descriptors__](#Descriptors), and [__Topologies__](#Topologies).
+Initially, the Admin UI presents the types of resources which can be managed:
[__Provider Configurations__](#Provider+Configurations),
[__Descriptors__](#Descriptors), [__Topologies__](#Topologies) and [__Service
Definitions__](#Service+Definitions).
<img src="adminui/image1.png" style="width:6.5in;height:3.28403in" />
Selecting a resource type yields a listing of the existing resources of that
type in the adjacent column, and selecting an individual resource
presents the details of that selected resource.
-For the provider configuration and descriptor resources types, the <img
src="adminui/plus-icon.png"
style="width:20px;height:20px;vertical-align:bottom"/>
+For the provider configuration, descriptor and service definition resources
types, the <img src="adminui/plus-icon.png"
style="width:20px;height:20px;vertical-align:bottom"/>
icon next to the resource list header is the trigger for the respective
facility for creating a new resource of that type.<br>
Modification options, including deletion, are available from the detail view
for an individual resource.
@@ -208,7 +208,71 @@ be persisted in the configured ZooKeeper
those changes, and [re]generate/[re]deploy the affected topologies. In this
way, Knox HA deployments can be managed by making changes once, and from any of
the
Knox instances.
+##### Service Definitions
+The Admin UI allows an administrator to view, modify, create and delete
service definitions which are currently supported by Knox.
-<br>
+<img src="adminui/image22.png" style="height:3.5in" />
+
+A service definition is a declarative way of plugging-in a new Service. It
consists of two separate files as described in the relevant section in [Knox's
Developer
Guide](https://knox.apache.org/books/knox-2-0-0/dev-guide.html#Service+Definition+Files).
The Admin UI lists the service definitions currently supported by Knox in a
data table ordered by the service name. If a particular service has more than
one service definition (for different versions), a separate service definition
entry is displayed in the table. Under the table there is a pagination panel
that let's end-users to navigate to the desired service definition.
+
+By choosing a particular service definition from the table, its details can be
viewed and edited. The service definition can also be deleted.
+
+<img src="adminui/image23.png" style="height:3.5in" />
+
+###### Editing Service Definitions
+
+When a particular service definition is selected, the Admin UI displays a
free-text area where the content can be updated and saved. End-users will see
the following structure in this text area:
+
+
+ <serviceDefinition>
+ <service>
+ ...
+ </service>
+ <rules>
+ ...
+ </rules>
+ </serviceDefinition>
+
+Everything within the `<service>` section will be written into the given
service's `service.xml` file whereas the content of `rules` are going into the
`rewrite.xml`.
+
+To persist changes, the <img src="adminui//save-icon.png"
style="height:32px;vertical-align:bottom"> button must be clicked. To revert
*unsaved* changes, simply choose another resource. In case you choose to save
your changes, a confirmation window is shown asking for your approval, where
you can make your changes final by clicking the <img
src="adminui/ok-button.png" style="height:24px;vertical-align:bottom"/> button.
+
+<img src="adminui/image24.png" style="height:3.5in" />
+<br />
+<br />
+<img src="adminui/image25.png" style="height:3.5in" />
+
+If you are unsure about the change you made, you can still click the `Cancel`
button and select another resource to revert your unsaved change.
+
+**Important note:** editing a service definition will result in redeploying
all topologies that include the updated service (identified by it's name and,
optionally, version).
+
+###### Deleting Service Definitions
+
+Similarly to the service definition editing function, end-users have to select
the service defintion first they are about to remove.
+
+The service definition details are displayed along with the <img
src="adminui//delete-icon.png" style="height:32px;vertical-align:bottom">
button in the bottom-left corner of the service definition details window. To
remove the selected service definition, you have to cick that button and you
will be shown a confirmation window where you can verify the service definition
removal by clicking the <img src="adminui/ok-button.png"
style="height:24px;vertical-align:bottom"/> button.
+
+<img src="adminui/image26.png" style="height:3.5in" />
+<br />
+<br />
+<img src="adminui/image27.png" style="height:3.5in" />
+
+**Important note:** deleting a service definition will result in redeploying
all topologies that included the removed service (identified by it's name and,
optionally, version).
+
+###### Creating Service Definitions
+
+The Admin UI provides the ability to define new service definitions which can
be included in topologies later on.
+
+The new service definition dialog provides the ability to specify the service
name, role and version as well as all the required information in `service.xml`
and `rewrite.xml` files such as routes and rewrite rules.
+
+To create a new service provider, please click the <img
src="adminui/plus-icon.png"
style="width:20px;height:20px;vertical-align:bottom"/> button after you
selected `Service Definitions` from the `Resource Types` list.
+
+<img src="adminui/image28.png" style="height:3.5in" />
+
+After defining all details, you have to click the <img
src="adminui/ok-button.png" style="height:24px;vertical-align:bottom"/> button
to save the newly created service definition on the disk.
+
+<img src="adminui/tip-icon.png" style="height:24px;vertical-align:bottom"/>
You may want to copy-paste a valid service definition before you open the new
service definition dialog and self-tailor the content for your needs.
+
+<br />
Added: knox/trunk/books/2.0.0/img/adminui/delete-icon.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/delete-icon.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/delete-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: knox/trunk/books/2.0.0/img/adminui/image1.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image1.png?rev=1904427&r1=1904426&r2=1904427&view=diff
==============================================================================
Binary files - no diff available.
Added: knox/trunk/books/2.0.0/img/adminui/image22.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image22.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image22.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/image23.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image23.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image23.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/image24.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image24.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image24.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/image25.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image25.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image25.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/image26.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image26.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image26.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/image27.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image27.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image27.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/image28.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/image28.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/image28.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: knox/trunk/books/2.0.0/img/adminui/tip-icon.png
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/img/adminui/tip-icon.png?rev=1904427&view=auto
==============================================================================
Binary file - no diff available.
Propchange: knox/trunk/books/2.0.0/img/adminui/tip-icon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
