This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/master by this push:
new f224804 WIP.
f224804 is described below
commit f2248048c4a062063932e8b3b2b65667fae642e7
Author: Aaron Radzinski <[email protected]>
AuthorDate: Sun Sep 13 17:02:33 2020 -0700
WIP.
---
download.html | 9 ++++
getting-started.html | 2 +-
installation.html | 7 ++-
server-and-probe.html | 116 +++++++++++++++++++++++++-------------------------
4 files changed, 71 insertions(+), 63 deletions(-)
diff --git a/download.html b/download.html
index 71b5ac1..0a02c14 100644
--- a/download.html
+++ b/download.html
@@ -96,6 +96,15 @@ layout: interior
{% endfor %}
</tbody>
</table>
+ <div class="bq warn">
+ <p>
+ <b>NLPCraft v0.7.0+ requires JDK 11 or newer</b>
+ </p>
+ <p>
+ Starting with version <b>0.7.0</b> NLPCraft requires JDK
11+ to compile and run. All development
+ and testing is done on JDK 11. Prior versions only
supported JDK 8.
+ </p>
+ </div>
<div class="bq info">
<p>
Releases marked with <i class="fas fa-fw fa-bomb"></i> are
<b>NOT</b> backward compatible.
diff --git a/getting-started.html b/getting-started.html
index b00fcbf..364b54f 100644
--- a/getting-started.html
+++ b/getting-started.html
@@ -60,7 +60,7 @@ id: getting_started
$ java -jar
apache-nlpcraft-{{site.latest_version}}-all-deps.jar -server
</pre>
<p>
- You can can also start it via Docker:
+ Alternatively, you can can also start it via Docker:
</p>
<pre class="brush: plain">
$ docker run -m 8G -p 8081:8081 -p 8201:8201 -p 8202:8202
nlpcraftserver/server:{{site.latest_version}}
diff --git a/installation.html b/installation.html
index 6f5ae97..9b5a432 100644
--- a/installation.html
+++ b/installation.html
@@ -43,20 +43,19 @@ id: installation
On subsequent starts the NLPCraft will check for the updates and
will re-download these files only if they were changed.
</p>
<p>
- By default, this external configuration is hosted on GitHub
(master branch of NLPCraft project) from where it will
+ By default, this external configuration is hosted on GitHub
(<code>master</code> branch of NLPCraft project) from where it will
be automatically downloaded on the first start: <a target="github"
href="https://github.com/apache/incubator-nlpcraft/tree/master/external";>https://github.com/apache/incubator-nlpcraft/tree/master/external</a>.
You can change this location, e.g. move external configuration
behind your firewall, as well as change other parameters related to
auto-download of the external configuration
in <code>nlpcraft.conf</code> file (see
<code>nlpcraft.extConfig</code> property).
</p>
</section>
<section id="ignite">
- <h2 class="section-title">Apache Ignite 2.7 <span
class="amp">&</span> Java 9+</h2>
+ <h2 class="section-title">Apache Ignite 2.7 <span
class="amp">&</span> Java 11+</h2>
<p>
By default NLPCraft uses <a target=_
href="https://ignite.apache.org/";>Apache Ignite</a> project as its
underlying in-memory distributed storage and cluster computing
framework. If running with Apache Ignite 2.7 or
- earlier on Java 9/10/11 you need to follow these
+ earlier on Java 11 you need to follow these
<a target=_
href="https://apacheignite.readme.io/docs/getting-started#section-running-ignite-with-java-9-10-11";>instructions.</a>
- For Java 8 no additional parameters are required.
</p>
<div class="bq info">
<p>
diff --git a/server-and-probe.html b/server-and-probe.html
index 3bc2a66..14adb11 100644
--- a/server-and-probe.html
+++ b/server-and-probe.html
@@ -89,6 +89,7 @@ id: server_and_probe
<a class="nav-item nav-link active" data-toggle="tab"
href="#nav-srv-jar" role="tab" aria-controls="nav-home"
aria-selected="true">Executable JAR</a>
<a class="nav-item nav-link" data-toggle="tab"
href="#nav-srv-cmd" role="tab" aria-controls="nav-home"
aria-selected="true">Command Line</a>
<a class="nav-item nav-link" data-toggle="tab"
href="#nav-srv-ide" role="tab" aria-controls="nav-home"
aria-selected="true">IDE</a>
+ <a class="nav-item nav-link" data-toggle="tab"
href="#nav-srv-docker" role="tab" aria-controls="nav-home"
aria-selected="true"><i class="fab fa-docker"></i> Docker</a>
</div>
</nav>
<div class="tab-content">
@@ -112,6 +113,16 @@ id: server_and_probe
JAR file manifest.
</p>
</div>
+ <div class="tab-pane fade show" id="nav-srv-docker"
role="tabpanel">
+ <pre class="brush: plain">
+ $ docker run -m 8G -p 8081:8081 -p 8201:8201 -p 8202:8202
nlpcraftserver/server:{{site.latest_version}}
+ </pre>
+ <p>
+ By default, the Docker image runs with a default
configuration.
+ See <a href="#config">configuration</a> section on how to
provide custom configuration via environment variables for the REST
+ server running inside of Docker container.
+ </p>
+ </div>
</div>
Parameters:
<dl>
@@ -159,18 +170,6 @@ id: server_and_probe
insufficient JVM heap memory.
</p>
</div>
- <h3 class="section-title"><i class="fab fa-docker"></i> Docker</h3>
- <p>
- You can also run REST server inside of Docker container:
- </p>
- <pre class="brush: plain">
- $ docker run -m 8G -p 8081:8081 -p 8201:8201 -p 8202:8202
nlpcraftserver/server:{{site.latest_version}}
- </pre>
- <p>
- By default, the Docker image runs with a default configuration.
- See <a href="#config">configuration</a> section on how to provide
custom configuration via environment variables for the REST
- server running inside of Docker container.
- </p>
<p>
When the REST server successfully started you should see the log
output similar to this:
</p>
@@ -350,7 +349,11 @@ id: server_and_probe
<li>Both the server and the data probe come with default
configuration available in <code>build/<b>nlpcraft.conf</b></code> file.</li>
<li>Custom configuration or default overrides can be placed into a
file or provided via environment variables.</li>
<li>Configuration files use <a target=_
href="https://github.com/lightbend/config/blob/master/HOCON.md";>HOCON</a> file
format.</li>
- <li>Server and probe configuration can be placed in the same file
or kept in separate files. </li>
+ <li>
+ Server and probe configuration can be placed in the same file
(as it is shipped by default in <code>build/nlpcraft.conf</code> file)
+ or kept in separate files. When kept in separate files each
file would have either <code>nlpcraft.server</code>
+ or <code>nlpcraft.probe</code> sub-section.
+ </li>
</ul>
<p>
@@ -383,62 +386,58 @@ nlpcraft {
}
}
</pre>
-
-
- <div class="bq info">
- <b>Overriding Configuration</b>
- <p>
- There are two ways to provide your own configuration for the
server or the probe:
- </p>
- <ul>
- <li>
- Put your configuration into separate file and use
<code>-config=...</code> parameter to specify
- the path of your configuration file.
- </li>
- <li>
- Use environment variable to override specific single
property.
- </li>
- </ul>
- <p>
- During development and testing, or when running in a container
environment like Docker, it is more
- convenient to use environment variables to override just few
specific configuration properties:
- </p>
- <ol>
- <li>
- Set probe or server JVM system property
<code>-Dconfig.override_with_env_vars=true</code> which will instruct
- configuration framework to look for external overrides.
- </li>
- <li>For each configuration property <code>x.y.z</code> set the
overriding environment variable <code>CONFIG_FORCE_x_y_z=some_value</code></li>
- </ol>
- <p>
- Consider the following snippet of server configuration:
- </p>
- <pre class="brush: js">
+ </section>
+ <section id="override">
+ <h2 class="section-title">Override Configuration</h2>
+ <p>
+ While you can change configuration file or files for your own
configuration (using <code>-config=...</code>
+ parameter described above) it is frequently more convenient to use
the default configuration file and just
+ change one or two properties in it. You can accomplish this by
using standard
+ <a target=_
href="https://github.com/lightbend/config#optional-system-or-env-variable-overrides";>HOCON
overriding</a>
+ via environment variables:
+ </p>
+ <ol>
+ <li>
+ Set probe or server JVM system property
<code>-Dconfig.override_with_env_vars=true</code> which will instruct
+ configuration framework to look for external overrides.
+ </li>
+ <li>For each configuration property <code>x.y.z</code> set the
overriding environment variable <code>CONFIG_FORCE_x_y_z=some_value</code></li>
+ <li>See more details on <a target=_
href="https://github.com/lightbend/config#optional-system-or-env-variable-overrides";>HOCON
documentation</a>.</li>
+ </ol>
+ <p>
+ Consider the following snippet of server configuration:
+ </p>
+ <pre class="brush: js">
nlpcraft {
- server {
- ...
+ probe {
+ models = "com.nlp.MyModel"
+ }
- lifecycle = [
- "org.apache.nlpcraft.server.lifecycle.opencensus.NCJaegerExporter"
- ]
+ server {
+ lifecycle =
"org.apache.nlpcraft.server.lifecycle.opencensus.NCJaegerExporter"
rest {
host = "0.0.0.0"
port = 8081
apiImpl = "org.apache.nlpcraft.server.rest.NCBasicRestApi"
}
-
- ...
}
}
- </pre>
- <p>
- You can override these properties with the following
environment variables:
- </p>
+ </pre>
+ <p>
+ You can override these properties with the following environment
variables:
+ </p>
+ <p>
+
<code>CONFIG_FORCE_<b>nlpcraft_server_rest_host</b>=1.2.3.4</code><br>
+
<code>CONFIG_FORCE_<b>nlpcraft_server_lifecycle</b>="org.nlp.Lifecycle1,
org.nlp.Lifecycle1"</code><br>
+ <code>CONFIG_FORCE_<b>nlpcraft_probe_models</b>="com.nlp.MyModel,
com.nlp.AnotherModel"</code>
+ </p>
+ <div class="bq info">
+ <b>Examples</b>
<p>
- <code>CONFIG_FORCE_nlpcraft_server_rest_host=1.2.3.4</code><br>
-
<code>CONFIG_FORCE_nlpcraft_server_lifecycle.0=org.apache.nlpcraft.server.lifecycle.opencensus.NCStackdriverTraceExporter</code><br>
-
<code>CONFIG_FORCE_nlpcraft_server_lifecycle.1=org.apache.nlpcraft.server.lifecycle.opencensus.NCStackdriverStatsExporter</code>
+ Note that all examples use environment variable overriding
when running their data probes. They use
+ default <code>nlpcraft.conf</code> file and just override one
<code>nlpcraft.probe.models</code> property
+ (see above) to specify what model the data probe needs to
deploy.
</p>
</div>
</section>
@@ -449,6 +448,7 @@ nlpcraft {
<li><a href="#server">REST Server</a></li>
<li><a href="#probe">Data Probe</a></li>
<li><a href="#config">Configuration</a></li>
+ <li><a href="#override">Override Configuration</a></li>
{% include quick-links.html %}
</ul>
</div>
