Author: krisden
Date: Thu Jul 25 20:22:43 2019
New Revision: 1863763
URL: http://svn.apache.org/viewvc?rev=1863763&view=rev
Log:
KNOX-1954 - Document KNOX-1285 - Create Apache Knox Dockerfile and image
Modified:
knox/site/books/knox-0-12-0/deployment-overview.png
knox/site/books/knox-0-12-0/deployment-provider.png
knox/site/books/knox-0-12-0/deployment-service.png
knox/site/books/knox-0-12-0/general_saml_flow.png
knox/site/books/knox-0-12-0/runtime-overview.png
knox/site/books/knox-0-12-0/runtime-request-processing.png
knox/site/books/knox-0-13-0/deployment-overview.png
knox/site/books/knox-0-13-0/deployment-provider.png
knox/site/books/knox-0-13-0/deployment-service.png
knox/site/books/knox-0-13-0/general_saml_flow.png
knox/site/books/knox-0-13-0/runtime-overview.png
knox/site/books/knox-0-13-0/runtime-request-processing.png
knox/site/books/knox-0-14-0/deployment-overview.png
knox/site/books/knox-0-14-0/deployment-provider.png
knox/site/books/knox-0-14-0/deployment-service.png
knox/site/books/knox-0-14-0/general_saml_flow.png
knox/site/books/knox-0-14-0/runtime-overview.png
knox/site/books/knox-0-14-0/runtime-request-processing.png
knox/site/books/knox-1-0-0/deployment-overview.png
knox/site/books/knox-1-0-0/deployment-provider.png
knox/site/books/knox-1-0-0/deployment-service.png
knox/site/books/knox-1-0-0/general_saml_flow.png
knox/site/books/knox-1-0-0/runtime-overview.png
knox/site/books/knox-1-0-0/runtime-request-processing.png
knox/site/books/knox-1-1-0/deployment-overview.png
knox/site/books/knox-1-1-0/deployment-provider.png
knox/site/books/knox-1-1-0/deployment-service.png
knox/site/books/knox-1-1-0/general_saml_flow.png
knox/site/books/knox-1-1-0/runtime-overview.png
knox/site/books/knox-1-1-0/runtime-request-processing.png
knox/site/books/knox-1-2-0/deployment-overview.png
knox/site/books/knox-1-2-0/deployment-provider.png
knox/site/books/knox-1-2-0/deployment-service.png
knox/site/books/knox-1-2-0/general_saml_flow.png
knox/site/books/knox-1-2-0/runtime-overview.png
knox/site/books/knox-1-2-0/runtime-request-processing.png
knox/site/books/knox-1-3-0/deployment-overview.png
knox/site/books/knox-1-3-0/deployment-provider.png
knox/site/books/knox-1-3-0/deployment-service.png
knox/site/books/knox-1-3-0/dev-guide.html
knox/site/books/knox-1-3-0/general_saml_flow.png
knox/site/books/knox-1-3-0/runtime-overview.png
knox/site/books/knox-1-3-0/runtime-request-processing.png
knox/site/books/knox-1-4-0/deployment-overview.png
knox/site/books/knox-1-4-0/deployment-provider.png
knox/site/books/knox-1-4-0/deployment-service.png
knox/site/books/knox-1-4-0/dev-guide.html
knox/site/books/knox-1-4-0/general_saml_flow.png
knox/site/books/knox-1-4-0/runtime-overview.png
knox/site/books/knox-1-4-0/runtime-request-processing.png
knox/trunk/books/1.3.0/dev-guide/book.md
knox/trunk/books/1.4.0/dev-guide/book.md
Modified: knox/site/books/knox-0-12-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-12-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-12-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-13-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-13-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-0-14-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-0-14-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-0-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-0-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-1-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-1-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-2-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-2-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/dev-guide.html
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/dev-guide.html?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
--- knox/site/books/knox-1-3-0/dev-guide.html (original)
+++ knox/site/books/knox-1-3-0/dev-guide.html Thu Jul 25 20:22:43 2019
@@ -24,6 +24,8 @@
<ul>
<li><a href="#Architecture+Overview">Architecture Overview</a></li>
<li><a href="#Project+Overview">Project Overview</a></li>
+ <li><a href="#Development+Processes">Development Processes</a></li>
+ <li><a href="#Docker+Image">Docker Image</a></li>
</ul>
</li>
<li><a href="#Behavior">Behavior</a>
@@ -35,11 +37,8 @@
<li><a href="#Extension+Logistics">Extension Logistics</a>
<ul>
<li><a href="#Providers">Providers</a></li>
- <li><a href="#Services">Services</a>
- <ul>
- <li><a href="#Service+Discovery">Service Discovery</a></li>
- </ul>
- </li>
+ <li><a href="#Services">Services</a></li>
+ <li><a href="#Service+Discovery">Service Discovery</a></li>
</ul>
</li>
<li><a href="#Standard+Providers">Standard Providers</a>
@@ -280,6 +279,24 @@ ant release
<p>So putting things together the following Ant command will build a release,
install it and start the servers ready for manual testing.</p>
<pre><code>ant release install-test-home start-test-servers
</code></pre>
+<h3><a id="Docker+Image">Docker Image</a> <a href="#Docker+Image"><img
src="markbook-section-link.png"/></a></h3>
+<p>Apache Knox ships with a <code>docker</code> Maven module that will build a
Docker image. To build the Knox Docker image, you must have Docker running on
your machine. The following Maven command will build Knox and package it into a
Docker image.</p>
+<pre><code>mvn -Ppackage,release,docker clean package
+</code></pre>
+<p>This will build 2 Docker images:</p>
+<ul>
+ <li><code>apache/knox:gateway-1.3.0-SNAPSHOT</code></li>
+ <li><code>apache/knox:ldap-1.3.0-SNAPSHOT</code></li>
+</ul>
+<p>The <code>gateway</code> image will use an entrypoint to start Knox
Gateway. The <code>ldap</code> image will use an entrypoint to start Knox Demo
LDAP.</p>
+<p>An example of using the Docker images would be the following:</p>
+<pre><code>docker run -d --name knox-ldap -p 33389:33389
apache/knox:ldap-1.3.0-SNAPSHOT
+docker run -d --name knox-gateway -p 8443:8443
apache/knox:gateway-1.3.0-SNAPSHOT
+</code></pre>
+<p>Using docker-compose that would look like this:</p>
+<pre><code>docker-compose -f
gateway-docker/src/main/resources/docker-compose.yml up
+</code></pre>
+<p>The images are designed to be a base that can be built on to add your own
providers, descriptors, and topologies as necessary.</p>
<h2><a id="Behavior">Behavior</a> <a href="#Behavior"><img
src="markbook-section-link.png"/></a></h2>
<p>There are two distinct phases in the behavior of the gateway. These are the
deployment and runtime phases. The deployment phase is responsible for
converting topology descriptors into an executable JEE style WAR. The runtime
phase is the processing of requests via WAR created during the deployment
phase.</p>
<p>The deployment phase is arguably the more complex of the two phases. This
is because runtime relies on well known JEE constructs while deployment
introduces new framework concepts. The base concept of the deployment framework
is that of a “contributor”. In the framework, contributors are
pluggable component responsible for generating JEE WAR artifacts from topology
files.</p>
Modified: knox/site/books/knox-1-3-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-3-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-3-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-provider.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-provider.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/deployment-service.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/deployment-service.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/dev-guide.html
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/dev-guide.html?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
--- knox/site/books/knox-1-4-0/dev-guide.html (original)
+++ knox/site/books/knox-1-4-0/dev-guide.html Thu Jul 25 20:22:43 2019
@@ -24,6 +24,8 @@
<ul>
<li><a href="#Architecture+Overview">Architecture Overview</a></li>
<li><a href="#Project+Overview">Project Overview</a></li>
+ <li><a href="#Development+Processes">Development Processes</a></li>
+ <li><a href="#Docker+Image">Docker Image</a></li>
</ul>
</li>
<li><a href="#Behavior">Behavior</a>
@@ -35,11 +37,8 @@
<li><a href="#Extension+Logistics">Extension Logistics</a>
<ul>
<li><a href="#Providers">Providers</a></li>
- <li><a href="#Services">Services</a>
- <ul>
- <li><a href="#Service+Discovery">Service Discovery</a></li>
- </ul>
- </li>
+ <li><a href="#Services">Services</a></li>
+ <li><a href="#Service+Discovery">Service Discovery</a></li>
</ul>
</li>
<li><a href="#Standard+Providers">Standard Providers</a>
@@ -280,6 +279,24 @@ ant release
<p>So putting things together the following Ant command will build a release,
install it and start the servers ready for manual testing.</p>
<pre><code>ant release install-test-home start-test-servers
</code></pre>
+<h3><a id="Docker+Image">Docker Image</a> <a href="#Docker+Image"><img
src="markbook-section-link.png"/></a></h3>
+<p>Apache Knox ships with a <code>docker</code> Maven module that will build a
Docker image. To build the Knox Docker image, you must have Docker running on
your machine. The following Maven command will build Knox and package it into a
Docker image.</p>
+<pre><code>mvn -Ppackage,release,docker clean package
+</code></pre>
+<p>This will build 2 Docker images:</p>
+<ul>
+ <li><code>apache/knox:gateway-1.4.0-SNAPSHOT</code></li>
+ <li><code>apache/knox:ldap-1.4.0-SNAPSHOT</code></li>
+</ul>
+<p>The <code>gateway</code> image will use an entrypoint to start Knox
Gateway. The <code>ldap</code> image will use an entrypoint to start Knox Demo
LDAP.</p>
+<p>An example of using the Docker images would be the following:</p>
+<pre><code>docker run -d --name knox-ldap -p 33389:33389
apache/knox:ldap-1.4.0-SNAPSHOT
+docker run -d --name knox-gateway -p 8443:8443
apache/knox:gateway-1.4.0-SNAPSHOT
+</code></pre>
+<p>Using docker-compose that would look like this:</p>
+<pre><code>docker-compose -f
gateway-docker/src/main/resources/docker-compose.yml up
+</code></pre>
+<p>The images are designed to be a base that can be built on to add your own
providers, descriptors, and topologies as necessary.</p>
<h2><a id="Behavior">Behavior</a> <a href="#Behavior"><img
src="markbook-section-link.png"/></a></h2>
<p>There are two distinct phases in the behavior of the gateway. These are the
deployment and runtime phases. The deployment phase is responsible for
converting topology descriptors into an executable JEE style WAR. The runtime
phase is the processing of requests via WAR created during the deployment
phase.</p>
<p>The deployment phase is arguably the more complex of the two phases. This
is because runtime relies on well known JEE constructs while deployment
introduces new framework concepts. The base concept of the deployment framework
is that of a “contributor”. In the framework, contributors are
pluggable component responsible for generating JEE WAR artifacts from topology
files.</p>
Modified: knox/site/books/knox-1-4-0/general_saml_flow.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/general_saml_flow.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/runtime-overview.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/runtime-overview.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/site/books/knox-1-4-0/runtime-request-processing.png
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-1-4-0/runtime-request-processing.png?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
Binary files - no diff available.
Modified: knox/trunk/books/1.3.0/dev-guide/book.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.3.0/dev-guide/book.md?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
--- knox/trunk/books/1.3.0/dev-guide/book.md (original)
+++ knox/trunk/books/1.3.0/dev-guide/book.md Thu Jul 25 20:22:43 2019
@@ -24,15 +24,17 @@
## Table Of Contents ##
* #[Overview]
- * #[Architecture Overview]
- * #[Project Overview]
+ * #[Architecture Overview]
+ * #[Project Overview]
+ * #[Development Processes]
+ * #[Docker Image]
* #[Behavior]
* #[Runtime Behavior]
* #[Deployment Behavior]
* #[Extension Logistics]
* #[Providers]
* #[Services]
- * #[Service Discovery]
+ * #[Service Discovery]
* #[Standard Providers]
* #[Rewrite Provider]
* #[Gateway Services]
@@ -183,6 +185,36 @@ So putting things together the following
ant release install-test-home start-test-servers
```
+### Docker Image ###
+
+Apache Knox ships with a `docker` Maven module that will build a Docker image.
To build the Knox Docker image, you must have Docker running on your machine.
The following Maven command will build Knox and package it into a Docker image.
+
+```
+mvn -Ppackage,release,docker clean package
+```
+
+This will build 2 Docker images:
+
+* `apache/knox:gateway-1.3.0-SNAPSHOT`
+* `apache/knox:ldap-1.3.0-SNAPSHOT`
+
+The `gateway` image will use an entrypoint to start Knox Gateway. The `ldap`
image will use an entrypoint to start Knox Demo LDAP.
+
+An example of using the Docker images would be the following:
+
+```
+docker run -d --name knox-ldap -p 33389:33389 apache/knox:ldap-1.3.0-SNAPSHOT
+docker run -d --name knox-gateway -p 8443:8443
apache/knox:gateway-1.3.0-SNAPSHOT
+```
+
+Using docker-compose that would look like this:
+
+```
+docker-compose -f gateway-docker/src/main/resources/docker-compose.yml up
+```
+
+The images are designed to be a base that can be built on to add your own
providers, descriptors, and topologies as necessary.
+
## Behavior ##
There are two distinct phases in the behavior of the gateway.
Modified: knox/trunk/books/1.4.0/dev-guide/book.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/1.4.0/dev-guide/book.md?rev=1863763&r1=1863762&r2=1863763&view=diff
==============================================================================
--- knox/trunk/books/1.4.0/dev-guide/book.md (original)
+++ knox/trunk/books/1.4.0/dev-guide/book.md Thu Jul 25 20:22:43 2019
@@ -24,15 +24,17 @@
## Table Of Contents ##
* #[Overview]
- * #[Architecture Overview]
- * #[Project Overview]
+ * #[Architecture Overview]
+ * #[Project Overview]
+ * #[Development Processes]
+ * #[Docker Image]
* #[Behavior]
* #[Runtime Behavior]
* #[Deployment Behavior]
* #[Extension Logistics]
* #[Providers]
* #[Services]
- * #[Service Discovery]
+ * #[Service Discovery]
* #[Standard Providers]
* #[Rewrite Provider]
* #[Gateway Services]
@@ -183,6 +185,36 @@ So putting things together the following
ant release install-test-home start-test-servers
```
+### Docker Image ###
+
+Apache Knox ships with a `docker` Maven module that will build a Docker image.
To build the Knox Docker image, you must have Docker running on your machine.
The following Maven command will build Knox and package it into a Docker image.
+
+```
+mvn -Ppackage,release,docker clean package
+```
+
+This will build 2 Docker images:
+
+* `apache/knox:gateway-1.4.0-SNAPSHOT`
+* `apache/knox:ldap-1.4.0-SNAPSHOT`
+
+The `gateway` image will use an entrypoint to start Knox Gateway. The `ldap`
image will use an entrypoint to start Knox Demo LDAP.
+
+An example of using the Docker images would be the following:
+
+```
+docker run -d --name knox-ldap -p 33389:33389 apache/knox:ldap-1.4.0-SNAPSHOT
+docker run -d --name knox-gateway -p 8443:8443
apache/knox:gateway-1.4.0-SNAPSHOT
+```
+
+Using docker-compose that would look like this:
+
+```
+docker-compose -f gateway-docker/src/main/resources/docker-compose.yml up
+```
+
+The images are designed to be a base that can be built on to add your own
providers, descriptors, and topologies as necessary.
+
## Behavior ##
There are two distinct phases in the behavior of the gateway.
