Author: smolnar
Date: Tue Nov 8 16:03:44 2022
New Revision: 1905159
URL: http://svn.apache.org/viewvc?rev=1905159&view=rev
Log:
KNOX-2815 - Fixed generated content view with Knox metadata support
Modified:
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/config_knox_token.md
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=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/books/knox-2-0-0/user-guide.html (original)
+++ knox/site/books/knox-2-0-0/user-guide.html Tue Nov 8 16:03:44 2022
@@ -6207,8 +6207,15 @@ APACHE_HOME/bin/apachectl -k stop
<p>On the token generation page end-users can generate tokens on behalf of
other users by specifying the desired user name in the token
<code>impersonation</code> field. The following screenshot sows a successful
token generation for user <code>tom</code> (the logged in user is
<code>admin</code>).</p>
<p><img src="knoxtokenmanagement_token_generation_ui-successful-doas.png"
/></p>
<h5><a id="Token+metadata">Token metadata</a> <a href="#Token+metadata"><img
src="markbook-section-link.png"/></a></h5>
-<p>As indicated above, the <code>KNOXTOKEN</code> service maintains some
hard-coded token metadata out-of-the-box: * userName * comment * enabled *
passcode * createdBy (in case of impersonated tokens)</p>
-<p>In v2.0.0, the Knox team implemented a change in this service that allows
end-users to add accept query parameters starting with the
<code>âmd_â</code> prefix and treat them as Knox Token Metadata.</p>
+<p>As indicated above, the <code>KNOXTOKEN</code> service maintains some
hard-coded token metadata out-of-the-box:</p>
+<ul>
+ <li>userName</li>
+ <li>comment</li>
+ <li>enabled</li>
+ <li>passcode</li>
+ <li>createdBy (in case of impersonated tokens)</li>
+</ul>
+<p>In v2.0.0, the Knox team implemented a change in this service that allows
end-users to add accept query parameters starting with the <code>md_</code>
prefix and treat them as Knox Token Metadata.</p>
<p>For instance:</p>
<p><code>curl -iku admin:admin-password -X GET
'https://localhost:8443/gateway/sandbox/knoxtoken/api/v1/token?md_notebookName=accountantKnoxToken&md_souldBeRemovedBy=31March2022&md_otherMeaningfuMetadata=KnoxIsCool'</code>
When such a token is created by Knox, we should save the following metadata
too:</p>
<ul>
@@ -6216,11 +6223,11 @@ APACHE_HOME/bin/apachectl -k stop
<li>shouldBeRemovedBy=31March2022</li>
<li>otherMeaningfulMetadata=KnoxIsCool</li>
</ul>
-<p>Itâs not only Knox can save these metadata, but the Knox’s existing
<code>getUserTokens API</code> endpoint is able to fetch basic token
information using the supplied metadata name besides the user name
information.</p>
+<p>It’s not only Knox can save these metadata, but the Knox’s
existing <code>getUserTokens API</code> endpoint is able to fetch basic token
information using the supplied metadata name besides the user name
information.</p>
<p>It’s important to note the following: the <code>getUserTokens</code>
API returns tokens if <em>any</em> of the supplied metadata exists for the
given token. Metadata values may or may not be matched: you can either use the
<code>*</code> wildcard to match all metadata values with a given name
<em>or</em> you can further filter the stored metadata information by
specifying the desired value.</p>
<p>For instance:</p>
<p><code>curl -iku admin:admin-password -X GET
'https://localhost:8443/gateway/sandbox/knoxtoken/api/v1/token/getUserTokens?userName=admin&md_notebookName=accountantKnoxToken&md_name=*'</code></p>
-<p>will return all Knox tokens where metadata with
<code>ânotebookNameâ</code> exists and equals
<code>âaccountantKnoxTokenâ</code> OR metadata with <code>name</code>
exists.</p>
+<p>will return all Knox tokens where metadata with <code>notebookName</code>
exists and equals <code>accountantKnoxToken</code> OR metadata with
<code>name</code> exists.</p>
<p>Another sample:</p>
<ol>
<li>Create token1 with <code>md_Name=reina&md_Score=50</code></li>
Modified: knox/site/index.html
URL:
http://svn.apache.org/viewvc/knox/site/index.html?rev=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Tue Nov 8 16:03:44 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-11-04
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2022-11-08
| 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="20221104" />
+ <meta name="Date-Revision-yyyymmdd" content="20221108" />
<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-11-04</li>
+ <li id="publishDate">Last Published: 2022-11-08</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=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/issue-management.html (original)
+++ knox/site/issue-management.html Tue Nov 8 16:03:44 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-11-04
+ | 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-11-08
| 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="20221104" />
+ <meta name="Date-Revision-yyyymmdd" content="20221108" />
<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-11-04</li>
+ <li id="publishDate">Last Published: 2022-11-08</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/licenses.html
URL:
http://svn.apache.org/viewvc/knox/site/licenses.html?rev=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/licenses.html (original)
+++ knox/site/licenses.html Tue Nov 8 16:03:44 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-11-04
+ | 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-11-08
| 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="20221104" />
+ <meta name="Date-Revision-yyyymmdd" content="20221108" />
<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-11-04</li>
+ <li id="publishDate">Last Published: 2022-11-08</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=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/mailing-lists.html (original)
+++ knox/site/mailing-lists.html Tue Nov 8 16:03:44 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-11-04
+ | 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-11-08
| 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="20221104" />
+ <meta name="Date-Revision-yyyymmdd" content="20221108" />
<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-11-04</li>
+ <li id="publishDate">Last Published: 2022-11-08</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=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Tue Nov 8 16:03:44 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-11-04
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2022-11-08
| 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="20221104" />
+ <meta name="Date-Revision-yyyymmdd" content="20221108" />
<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-11-04</li>
+ <li id="publishDate">Last Published: 2022-11-08</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/team.html
URL:
http://svn.apache.org/viewvc/knox/site/team.html?rev=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/site/team.html (original)
+++ knox/site/team.html Tue Nov 8 16:03:44 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-11-04
+ | 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-11-08
| 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="20221104" />
+ <meta name="Date-Revision-yyyymmdd" content="20221108" />
<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-11-04</li>
+ <li id="publishDate">Last Published: 2022-11-08</li>
</ul>
</div>
<div class="row-fluid">
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=1905159&r1=1905158&r2=1905159&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/config_knox_token.md (original)
+++ knox/trunk/books/2.0.0/config_knox_token.md Tue Nov 8 16:03:44 2022
@@ -334,13 +334,14 @@ On the token generation page end-users c
##### Token metadata
As indicated above, the `KNOXTOKEN` service maintains some hard-coded token
metadata out-of-the-box:
-* userName
-* comment
-* enabled
-* passcode
-* createdBy (in case of impersonated tokens)
-In v2.0.0, the Knox team implemented a change in this service that allows
end-users to add accept query parameters starting with the `âmd_â` prefix
and treat them as Knox Token Metadata.
+* userName
+* comment
+* enabled
+* passcode
+* createdBy (in case of impersonated tokens)
+
+In v2.0.0, the Knox team implemented a change in this service that allows
end-users to add accept query parameters starting with the `md_` prefix and
treat them as Knox Token Metadata.
For instance:
@@ -351,7 +352,7 @@ When such a token is created by Knox, we
* shouldBeRemovedBy=31March2022
* otherMeaningfulMetadata=KnoxIsCool
-Itâs not only Knox can save these metadata, but the Knox's existing
`getUserTokens API` endpoint is able to fetch basic token information using the
supplied metadata name besides the user name information.
+It's not only Knox can save these metadata, but the Knox's existing
`getUserTokens API` endpoint is able to fetch basic token information using the
supplied metadata name besides the user name information.
It's important to note the following: the `getUserTokens` API returns tokens
if *any* of the supplied metadata exists for the given token. Metadata values
may or may not be matched: you can either use the `*` wildcard to match all
metadata values with a given name *or* you can further filter the stored
metadata information by specifying the desired value.
@@ -359,7 +360,7 @@ For instance:
`curl -iku admin:admin-password -X GET
'https://localhost:8443/gateway/sandbox/knoxtoken/api/v1/token/getUserTokens?userName=admin&md_notebookName=accountantKnoxToken&md_name=*'`
-will return all Knox tokens where metadata with `ânotebookNameâ` exists
and equals `âaccountantKnoxTokenâ` OR metadata with `name` exists.
+will return all Knox tokens where metadata with `notebookName` exists and
equals `accountantKnoxToken` OR metadata with `name` exists.
Another sample:
