Author: more
Date: Thu Jan 5 19:28:22 2023
New Revision: 1906411
URL: http://svn.apache.org/viewvc?rev=1906411&view=rev
Log:
KNOX-2837 - Update KnoxShell docs to add sudoers user requirements
Modified:
knox/site/books/knox-2-0-0/deployment-overview.png
knox/site/books/knox-2-0-0/deployment-provider.png
knox/site/books/knox-2-0-0/deployment-service.png
knox/site/books/knox-2-0-0/general_saml_flow.png
knox/site/books/knox-2-0-0/runtime-overview.png
knox/site/books/knox-2-0-0/runtime-request-processing.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/webshell.md
Modified: knox/site/books/knox-2-0-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/deployment-overview.png?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-2-0-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/deployment-provider.png?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-2-0-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/deployment-service.png?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-2-0-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/general_saml_flow.png?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-2-0-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/runtime-overview.png?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-2-0-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/runtime-request-processing.png?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
Binary files - no diff available.
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=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/books/knox-2-0-0/user-guide.html (original)
+++ knox/site/books/knox-2-0-0/user-guide.html Thu Jan 5 19:28:22 2023
@@ -10331,6 +10331,13 @@ curl -i -k -u username:password -H "
<h2><a id="Webshell">Webshell</a> <a href="#Webshell"><img
src="markbook-section-link.png"/></a></h2>
<h3><a id="Introduction">Introduction</a> <a href="#Introduction"><img
src="markbook-section-link.png"/></a></h3>
<p>This feature enables shell access to the machine running Apache Knox. Users
can SSO into Knox and then access shell using the Knox WebShell URL on knox
homepage. There are some out of band configuration changes that are required
for the feature to work. </p>
+<h3><a id="Prerequisite">Prerequisite</a> <a href="#Prerequisite"><img
src="markbook-section-link.png"/></a></h3>
+<p>This feature works only on *nix systems given it relies on sudoers file.
Make sure following prerequisite are met before turning on the feature.</p>
+<ul>
+ <li>Make sure Knox process user (user under which knox process runs) exists
on local machine.</li>
+ <li>Make sure the user used to login exists on local machine.</li>
+ <li>Make sure you have proper rights to create/update sudoers file descibed
in “Configuration” section below.</li>
+</ul>
<h3><a id="Configuration">Configuration</a> <a href="#Configuration"><img
src="markbook-section-link.png"/></a></h3>
<p>Webshell is not turned on by default. To enable Webshell following
properties needs to be changed in <code>gateway-site.xml</code></p>
<pre><code>property>
Modified: knox/site/index.html
URL:
http://svn.apache.org/viewvc/knox/site/index.html?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Thu Jan 5 19:28:22 2023
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2022-12-23
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2023-01-05
| 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="20221223" />
+ <meta name="Date-Revision-yyyymmdd" content="20230105" />
<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-12-23</li>
+ <li id="publishDate">Last Published: 2023-01-05</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=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/issue-management.html (original)
+++ knox/site/issue-management.html Thu Jan 5 19:28:22 2023
@@ -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-12-23
+ | 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 2023-01-05
| 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="20221223" />
+ <meta name="Date-Revision-yyyymmdd" content="20230105" />
<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-12-23</li>
+ <li id="publishDate">Last Published: 2023-01-05</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/licenses.html
URL:
http://svn.apache.org/viewvc/knox/site/licenses.html?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/licenses.html (original)
+++ knox/site/licenses.html Thu Jan 5 19:28:22 2023
@@ -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-12-23
+ | 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
2023-01-05
| 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="20221223" />
+ <meta name="Date-Revision-yyyymmdd" content="20230105" />
<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-12-23</li>
+ <li id="publishDate">Last Published: 2023-01-05</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=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/mailing-lists.html (original)
+++ knox/site/mailing-lists.html Thu Jan 5 19:28:22 2023
@@ -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-12-23
+ | 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 2023-01-05
| 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="20221223" />
+ <meta name="Date-Revision-yyyymmdd" content="20230105" />
<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-12-23</li>
+ <li id="publishDate">Last Published: 2023-01-05</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=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Thu Jan 5 19:28:22 2023
@@ -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-12-23
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2023-01-05
| 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="20221223" />
+ <meta name="Date-Revision-yyyymmdd" content="20230105" />
<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-12-23</li>
+ <li id="publishDate">Last Published: 2023-01-05</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/team.html
URL:
http://svn.apache.org/viewvc/knox/site/team.html?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/site/team.html (original)
+++ knox/site/team.html Thu Jan 5 19:28:22 2023
@@ -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-12-23
+ | 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
2023-01-05
| 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="20221223" />
+ <meta name="Date-Revision-yyyymmdd" content="20230105" />
<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-12-23</li>
+ <li id="publishDate">Last Published: 2023-01-05</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/trunk/books/2.0.0/webshell.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/webshell.md?rev=1906411&r1=1906410&r2=1906411&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/webshell.md (original)
+++ knox/trunk/books/2.0.0/webshell.md Thu Jan 5 19:28:22 2023
@@ -20,6 +20,13 @@
### Introduction
This feature enables shell access to the machine running Apache Knox. Users
can SSO into Knox and then access shell using the Knox WebShell URL on knox
homepage. There are some out of band configuration changes that are required
for the feature to work.
+### Prerequisite ###
+This feature works only on *nix systems given it relies on sudoers file. Make
sure following prerequisite are met before turning on the feature.
+
+* Make sure Knox process user (user under which knox process runs) exists on
local machine.
+* Make sure the user used to login exists on local machine.
+* Make sure you have proper rights to create/update sudoers file descibed in
"Configuration" section below.
+
### Configuration ###
Webshell is not turned on by default. To enable Webshell following properties
needs to be changed in `gateway-site.xml`
