diff options
Diffstat (limited to 'src')
78 files changed, 538 insertions, 948 deletions
diff --git a/src/site-docs/.gitignore b/src/site-docs/.gitignore deleted file mode 100644 index 17d1abda7..000000000 --- a/src/site-docs/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -logos/ - diff --git a/src/site-docs/adoc/fragments/apex-intro/resources.adoc b/src/site-docs/adoc/fragments/apex-intro/resources.adoc index f4c8b947a..62ace92eb 100644 --- a/src/site-docs/adoc/fragments/apex-intro/resources.adoc +++ b/src/site-docs/adoc/fragments/apex-intro/resources.adoc @@ -14,6 +14,6 @@ == Resources * APEX Documentation hosted on Github: link:https://ericsson.github.io/apex-docs[] -* APEX source code repo hosted on Github: link:https://github.com/Ericsson/apex[] -* Issue Management (source and documentation): link:https://github.com/Ericsson/apex/issues[] +* APEX source code repository hosted by ONAP: link:https://gerrit.onap.org/r/#/admin/projects/policy/apex-pdp[] +* Issue Management (source and documentation, ONAP JIRA, requires a Linux Foundation ID): link:https://jira.onap.org/projects/POLICY/issues[] * List of APEX publications: link:https://ericsson.github.io/apex-docs/apex-publications.html[] diff --git a/src/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc b/src/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc index 973564df3..2f273a284 100644 --- a/src/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc @@ -47,7 +47,7 @@ usage: gen-model2cli For instance, running the tool with the __Sample Domain__ policy model as: [source%nowrap,sh] ---- -apexApps.sh tpl-event-json -m $APEX_HOME/examples/models/SampleDomain/SamplePolicyModelJAVA.json -t stimuli +apexApps.sh model-2-cli -m $APEX_HOME/examples/models/SampleDomain/SamplePolicyModelJAVA.json ---- will produce the following status messages: diff --git a/src/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc b/src/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc index bd31bedf9..74936061d 100644 --- a/src/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc @@ -38,6 +38,7 @@ The option `-h` provides a help screen. [source%nowrap,sh] ---- +gen-model2event v{release-version} - generates JSON templates for events generated from a policy model usage: gen-model2event -h,--help prints this help and usage screen -m,--model <MODEL-FILE> set the input policy model file diff --git a/src/site-docs/adoc/fragments/howto-apex/cli-editor.adoc b/src/site-docs/adoc/fragments/howto-apex/cli-editor.adoc index e677079f2..a129ca3a0 100644 --- a/src/site-docs/adoc/fragments/howto-apex/cli-editor.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/cli-editor.adoc @@ -58,7 +58,6 @@ The option `-h` provides a help screen with all command line arguments. ---- usage: org.onap.policy.apex.auth.clieditor.ApexCLIEditorMain [options...] options - -a,--model-props-file <MODEL_PROPS_FILE> name of the apex model properties file to use -c,--command-file <COMMAND_FILE> name of a file containing editor commands to run into the editor -h,--help outputs the usage of this command diff --git a/src/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc b/src/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc index 52836a783..fb19353b7 100644 --- a/src/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc @@ -30,16 +30,21 @@ The option `-h` provides a help screen with all command line arguments. [source%nowrap,sh] ---- -usage: org.onap.policy.apex.services.client.deployment.rest.ApexDeploymentRestMain [options...] --h,--help outputs the usage of this command --p,--port <PORT> port to use for the Apex Services REST calls --t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating +usage: org.onap.policy.apex.client.deployment.rest.ApexDeploymentRestMain [options...] +-h,--help outputs the usage of this command +-p,--port <PORT> port to use for the Apex Services REST calls +-t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating + ---- If the Deployment Client is started without any arguments the final messages will look similar to this: [source%nowrap,sh] ---- +Apex Services REST endpoint (ApexDeploymentRestMain: Config=[ApexDeploymentRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . . +Sep 05, 2018 11:27:09 PM org.glassfish.grizzly.http.server.NetworkListener start +INFO: Started listener bound to [localhost:18989] +Sep 05, 2018 11:27:09 PM org.glassfish.grizzly.http.server.HttpServer start INFO: [HttpServer] Started. Apex Services REST endpoint (ApexDeploymentRestMain: Config=[ApexDeploymentRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/ ---- diff --git a/src/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc b/src/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc index 960546d06..9b26d7562 100644 --- a/src/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc @@ -30,16 +30,20 @@ The option `-h` provides a help screen with all command line arguments. [source%nowrap,sh] ---- -usage: org.onap.policy.apex.services.client.monitoring.rest.ApexMonitoringRestMain [options...] --h,--help outputs the usage of this command --p,--port <PORT> port to use for the Apex Services REST calls --t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating +usage: org.onap.policy.apex.client.monitoring.rest.ApexMonitoringRestMain [options...] +-h,--help outputs the usage of this command +-p,--port <PORT> port to use for the Apex Services REST calls +-t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating ---- If the Monitoring Client is started without any arguments the final messages will look similar to this: [source%nowrap,sh] ---- +Apex Services REST endpoint (ApexMonitoringRestMain: Config=[ApexMonitoringRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . . +Sep 05, 2018 11:26:20 PM org.glassfish.grizzly.http.server.NetworkListener start +INFO: Started listener bound to [localhost:18989] +Sep 05, 2018 11:26:20 PM org.glassfish.grizzly.http.server.HttpServer start INFO: [HttpServer] Started. Apex Services REST endpoint (ApexMonitoringRestMain: Config=[ApexMonitoringRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/ ---- diff --git a/src/site-docs/adoc/fragments/howto-apex/engine.adoc b/src/site-docs/adoc/fragments/howto-apex/engine.adoc index 819c2ca87..79dfe20e9 100644 --- a/src/site-docs/adoc/fragments/howto-apex/engine.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/engine.adoc @@ -19,7 +19,7 @@ On UNIX and Cygwin systems use: - `apexEngine.sh` - this script will ** Test if `$APEX_USER` is set and if the user exists, terminate with an error otherwise - ** Test if `$APEX_HOME` is set. If not set, it will use the default setting as `/opt/ericsson/apex/apex`. + ** Test if `$APEX_HOME` is set. If not set, it will use the default setting as `/opt/app/policy/apex-pdp/apex-pdp`. Then the set directory is tested to exist, the script will terminate if not. ** When all tests are passed successfully, the script will call `apexApps.sh` with arguments to start the APEX engine. - `apexApps.sh engine` - this is the general APEX application launcher, which will @@ -59,13 +59,11 @@ The option `-h` prints a help screen. ---- usage: org.onap.policy.apex.service.engine.main.ApexMain [options...] options - -c,--config-file <CONFIG_FILE> the full path to the configuration file to use, - the configuration file must be a Json - file containing the Apex configuration parameters - -h,--help outputs the usage of this command - -m,--model-file <MODEL_FILE> the full path to the model file to use, - if set it overrides the model file set in the - configuration file - -v,--version outputs the version of Apex +-c,--config-file <CONFIG_FILE> the full path to the configuration file to use, the configuration file must be a Json file + containing the Apex configuration parameters +-h,--help outputs the usage of this command +-m,--model-file <MODEL_FILE> the full path to the model file to use, if set it overrides the model file set in the + configuration file +-v,--version outputs the version of Apex ---- diff --git a/src/site-docs/adoc/fragments/howto-apex/full-client.adoc b/src/site-docs/adoc/fragments/howto-apex/full-client.adoc index 97a18393b..4370d80ac 100644 --- a/src/site-docs/adoc/fragments/howto-apex/full-client.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/full-client.adoc @@ -31,16 +31,21 @@ The option `-h` provides a help screen with all command line arguments. [source%nowrap,sh] ---- -usage: org.onap.policy.apex.services.client.full.rest.ApexServicesRestMain [options...] --h,--help outputs the usage of this command --p,--port <PORT> port to use for the Apex Services REST calls --t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating +usage: org.onap.policy.apex.client.full.rest.ApexServicesRestMain [options...] +-h,--help outputs the usage of this command +-p,--port <PORT> port to use for the Apex Services REST calls +-t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating + ---- If the Full Client is started without any arguments the final messages will look similar to this: [source%nowrap,sh] ---- +Apex Editor REST endpoint (ApexServicesRestMain: Config=[ApexServicesRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . . +Sep 05, 2018 11:28:28 PM org.glassfish.grizzly.http.server.NetworkListener start +INFO: Started listener bound to [localhost:18989] +Sep 05, 2018 11:28:28 PM org.glassfish.grizzly.http.server.HttpServer start INFO: [HttpServer] Started. Apex Editor REST endpoint (ApexServicesRestMain: Config=[ApexServicesRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/ ---- diff --git a/src/site-docs/adoc/fragments/howto-apex/introduction.adoc b/src/site-docs/adoc/fragments/howto-apex/introduction.adoc index faa2f4949..a7d8ee695 100644 --- a/src/site-docs/adoc/fragments/howto-apex/introduction.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/introduction.adoc @@ -12,7 +12,7 @@ // == Introduction to APEX Engine and Applications -The core of APEX is the APEX Engine, also known as the APEX Policy Engine. +The core of APEX is the APEX Engine, also known as the APEX Policy Engine or the APEX PDP (since it is in fact a Policy Decision Point). Beside this engine, an APEX system comes with a few applications intended to help with policy authoring, deployment, and execution. The engine itself and most applications are started from the command line with command line arguments. @@ -20,17 +20,10 @@ This is called a Command Line Interface (CLI). Some applications require an installation on a webserver, as for instance the REST Editor. Those applications can be accessed via a web browser. -Starting with APEX version 0.5.6, we also provide plugins for Eclipse realizing a policy development environment. -Those plugins support the main APEX policy language. -Other, higher-level, policy languages will be added in future versions along with their Eclipse plugins. -Furthermore, we are planning to provide a backend supporting the Language Server Protocol (LSP). -This backend, run as a server, will allow to join any editor or IDE that is LSP-enabled to benefit from the APEX policy languages. - -Last not least, one can use the available APEX APIs and applications to develop other applications as required. +You can also use the available APEX APIs and applications to develop other applications as required. This includes policy languages (and associated parsers and compilers / interpreters), GUIs to access APEX or to define policies, clients to connect to APEX, etc. -Separate documentation will be available in APEX releases addressing this type of applications. -For this documentation, we assume an installation of APEX as a full system (i.e. not minimal) of version 0.5.6 or higher. +For this documentation, we assume an installation of APEX as a full system based on a current ONAP release. == CLI on Unix, Windows, and Cygwin A note on APEX CLI applications: all applications and the engine itself have been deployed and tested on different operating systems: Red Hat, Ubuntu, Debian, Mac OSX, Windows, Cygwin. @@ -38,7 +31,7 @@ Each operating system comes with its own way of configuring and executing Java. The main items here are: - For UNIX systems (RHL, Ubuntu, Debian, Mac OSX), the provided bash scripts work as expected - with absolute paths (e.g. `/opt/ericsson/apex/apex-{release-version}/examples`), + with absolute paths (e.g. `/opt/app/policy/apex-pdp/apex-pdp-{release-version}/examples`), indirect and linked paths (e.g. `../apex/apex`), and path substitutions using environment settings (e.g. `$APEX_HOME/bin/`) - For Windows systems, the provided batch files (`.bat`) work as expected with diff --git a/src/site-docs/adoc/fragments/howto-apex/rest-editor.adoc b/src/site-docs/adoc/fragments/howto-apex/rest-editor.adoc index 3be6f9f94..fafa65691 100644 --- a/src/site-docs/adoc/fragments/howto-apex/rest-editor.adoc +++ b/src/site-docs/adoc/fragments/howto-apex/rest-editor.adoc @@ -51,10 +51,10 @@ The option `-h` provides a help screen with all command line arguments. [source%nowrap,sh] ---- -usage: org.onap.policy.apex.auth.rest.ApexEditorMain [options...] +usage: org.onap.policy.apex.client.editor.rest.ApexEditorMain [options...] -h,--help outputs the usage of this command --l,--listen <ADDRESS> the IP address to listen on. Default value is 0.0.0.0 to listen on all available - addresses. Use value 'localhost' to restrict access to the local machine only. +-l,--listen <ADDRESS> the IP address to listen on. Default value is localhost to restrict access to the + local machine only. -p,--port <PORT> port to use for the Apex RESTful editor REST calls. -t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating. Default value is -1 to run indefinitely. @@ -64,11 +64,15 @@ If the REST Editor is started without any arguments the final messages will look [source%nowrap,sh] ---- +Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . . +Sep 05, 2018 11:24:30 PM org.glassfish.grizzly.http.server.NetworkListener start +INFO: Started listener bound to [localhost:18989] +Sep 05, 2018 11:24:30 PM org.glassfish.grizzly.http.server.HttpServer start INFO: [HttpServer] Started. -Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://0.0.0.0:18988/apex/, TTL=-1sec], State=RUNNING) started at http://0.0.0.0:18988/apex/ +Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/ ---- The last line states the URL on which the REST Editor can be accessed. -The example above stated `http://0.0.0.0:18988/apex/`. -In a web browser use the URL `http://localhost:18988` and the REST Editor will start. +The example above stated `http://0.0.0.0:18989/apex/`. +In a web browser use the URL `http://localhost:18989` and the REST Editor will start. diff --git a/src/site-docs/adoc/fragments/howto-build/introduction.adoc b/src/site-docs/adoc/fragments/howto-build/introduction.adoc index 02ba21fbd..546a769d7 100644 --- a/src/site-docs/adoc/fragments/howto-build/introduction.adoc +++ b/src/site-docs/adoc/fragments/howto-build/introduction.adoc @@ -34,6 +34,15 @@ The examples in this document assume that the APEX source repositories are clone - Windows: `C:\dev\apex` - Cygwin: `/cygdrive/c/dev/apex` + +[IMPORTANT] +.A Build requires ONAP Nexus +==== +APEX has a dependency to ONAP parent projects. +You might need to adjust your Maven M2 settings. +The most current settings can be found in the ONAP oparent repo: link:https://git.onap.org/oparent/plain/settings.xml[Settings]. +==== + [IMPORTANT] .A Build needs Space ==== diff --git a/src/site-docs/adoc/fragments/howto-build/site.adoc b/src/site-docs/adoc/fragments/howto-build/site.adoc index 42cbda525..6ec453c9e 100644 --- a/src/site-docs/adoc/fragments/howto-build/site.adoc +++ b/src/site-docs/adoc/fragments/howto-build/site.adoc @@ -18,9 +18,9 @@ Use Maven to build the APEX Site. Stage the APEX web site. The target folder for the staged site is -- Unix: `/usr/local/src/apex/target/gh-pages` -- Windows: `C:\dev\apex\target\gh-pages` -- Cygwin: `/cygdrive/c/dev/apex/target/gh-pages` +- Unix: `/usr/local/src/apex/target/ad-site` +- Windows: `C:\dev\apex\target\ad-site` +- Cygwin: `/cygdrive/c/dev/apex/target/ad-site` Once the web site is staged, copy the full site to a folder of choice or into a web server. @@ -45,20 +45,20 @@ Then go to the APEX packaging directory. [source%nowrap,sh] ---- cd /usr/local/src/apex -rm -fr target/gh-pages +rm -fr target/ad-site ---- | [source%nowrap,bat] ---- c: cd \dev\apex -rmdir /s /q target\gh-pages +rmdir /s /q target\ad-site ---- | [source%nowrap,sh] ---- cd /cygdrive/c/dev/apex -rm -fr target/gh-pages +rm -fr target/ad-site ---- |==================== diff --git a/src/site-docs/adoc/fragments/howto-build/standard.adoc b/src/site-docs/adoc/fragments/howto-build/standard.adoc index 76ebfc2bf..97013742b 100644 --- a/src/site-docs/adoc/fragments/howto-build/standard.adoc +++ b/src/site-docs/adoc/fragments/howto-build/standard.adoc @@ -33,7 +33,7 @@ Use Maven to for a standard build without any tests. ---- |==================== -The build takes 2-3 minutes on a standard development laptop. +The build takes about 6 minutes on a standard development laptop. It should run through without errors, but with a lot of messages from the build process. When Maven is finished with the build, the final screen should look similar to this (omitting some `success` lines): @@ -53,7 +53,7 @@ The following example show how to change to the target directory and how it shou | [source%nowrap,sh,numbered] ---- -# cd modules/apex-apps/apex-apps.uservice/apex-apps.uservice-packaging/apex-apps.uservice-package-full/target +# cd packages/apex-pdp-package-full/target # ls -l ---- @@ -72,7 +72,7 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/screens/target-ls-unix.txt[s | [source%nowrap,bat,numbered] ---- ->cd modules\apex-apps\apex-apps.uservice\apex-apps.uservice-packaging\apex-apps.uservice-package-full\target +>cd packages\apex-pdp-package-full\target >dir ---- diff --git a/src/site-docs/adoc/fragments/howto-build/with-tests.adoc b/src/site-docs/adoc/fragments/howto-build/with-tests.adoc index f8d300c45..e923ece60 100644 --- a/src/site-docs/adoc/fragments/howto-build/with-tests.adoc +++ b/src/site-docs/adoc/fragments/howto-build/with-tests.adoc @@ -41,17 +41,7 @@ If this happens, reduce the load on your build machine and restart the build. ---- |==================== -The build takes about 5-6 minutes with tests on a standard development laptop. +The build takes about 10 minutes with tests on a standard development laptop. It should run through without errors, but with a lot of messages from the build process. If build with tests (i.e. without `-DskipTests`), there will be error messages and stack trace prints from some tests. This is normal, as long as the build finishes successful. - -When Maven is finished with the build, the final screen should look similar to this (omitting some `success` lines): - -[source%nowrap,sh,numbered,subs="attributes+"] ----- -include::{adsite-main-dir}/site-docs/adoc/fragments/screens/mvn-install-skiptests.txt[mvn build, with tests] ----- - -The build will have created all artifacts required for an APEX installation. - diff --git a/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc b/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc index 776ad3448..2e8e4fb95 100644 --- a/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc +++ b/src/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc @@ -21,7 +21,6 @@ As long as the style of a particular block of code is understandable, consistent The JAutoDoc and Checkstyle Eclipse Plugins and tools are useful and remove a lot of the tedium from code documentation. Use them to check your code and please fix any issues they identify with your code. -The templates and examples on this page have been tested on a clean installation of Eclipse Oxygen Release (4.7.0) on Ubuntu Linux 16.04 LTS. - -The Apex settings referred to on this page are also available in the apex-model GIT repository in the APEX model repository in apex-model/apex-model.build-tools/src/main/resources/`. +Since APEX is part of ONAP, the general ONAP rules and guideliness for development do apply. +Please see link:https://wiki.onap.org/display/DW/Developing+ONAP[ONAP Wiki] for details. diff --git a/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc b/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc index a6a93bfa4..d8a55c37e 100644 --- a/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc +++ b/src/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc @@ -21,6 +21,8 @@ In Eclipse Help->Eclipse Marketplace... and type "Checkstyle". Select "Checkstyle Plug-in" when the search returns and install it. Note that "Checkstyle Plug-in" may not be the first result in the list of items returned. -You must configure Checkstyle in order to get the most out of it. -There are two built-in style templates in Checkstyle (from Oracle and Google) but user will almost certainly wish to tweak these. +For APEX, the ONAP checkstyle rules do apply. +The configuration is part of the ONAP parent. +See link:https://git.onap.org/oparent/plain/checkstyle/src/main/resources/onap-checkstyle/[ONAP Git] for details and updates. +All settings for checkstyle are already part of the code (POM files). diff --git a/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc b/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc index 2e6698fff..d59b424af 100644 --- a/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc +++ b/src/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc @@ -18,28 +18,7 @@ In order not to have to distribute style files for checkstyle into all Maven mod That module is then used as a dependency in the __POM__ for all other modules that wish to use that checkstyle style. For a full explanation see link:https://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html[the explanation of Checkstyle multi-module configuration]. -In Apex, the module `apex-model.build-tools` provides the Apex checkstyle style files as resources in `src/main/resources/checkstyle`. -This style is a slightly tweaked version of the standard Google checkstyle style that allows longer lines and has some other checks slightly relaxed. -Therefore, all modules that wish to use the Apex style must put the following build directive into their `pom.xml`. - -[source%nowrap,xml] ----- -<plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-checkstyle-plugin</artifactId> - <version>2.17</version> - <dependencies> - <dependency> - <groupId>org.onap.policy.apex.model</groupId> - <artifactId>apex-model.build-tools</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> - <configuration> - <configLocation>checkstyle/apex_style_checks.xml</configLocation> - <headerLocation>checkstyle/apex_header.txt</headerLocation> - </configuration> -</plugin> ----- - +For APEX, the ONAP checkstyle rules do apply. +The configuration is part of the ONAP parent. +See link:https://git.onap.org/oparent/plain/checkstyle/src/main/resources/onap-checkstyle/[ONAP Git] for details and updates. diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc deleted file mode 100644 index ce6367ef9..000000000 --- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-header.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -[source%nowrap,text,subs="attributes+"] ----- -include::{apex-main-dir}/checkstyle/apex_header.txt[] -----
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc deleted file mode 100644 index f67a01c0a..000000000 --- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-checkstyle-style-checks.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -[source%nowrap,xml,subs="attributes+"] ----- -include::{apex-main-dir}/checkstyle/apex_style_checks.xml[] -----
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc deleted file mode 100644 index 255855b43..000000000 --- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-checkstyle-settings.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -[source%nowrap,xml,subs="attributes+"] ----- -include::{apex-main-dir}/eclipse/ApexCheckstyleSettings.xml[] -----
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc deleted file mode 100644 index 638d33972..000000000 --- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-cleanup.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -[source%nowrap,xml,subs="attributes+"] ----- -include::{apex-main-dir}/eclipse/ApexCleanUpTemplate.xml[] -----
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc b/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc deleted file mode 100644 index dad270110..000000000 --- a/src/site-docs/adoc/fragments/howto-codestyle/99-tpl-eclipse-formatter-profile.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -[source%nowrap,xml,subs="attributes+"] ----- -include::{apex-main-dir}/eclipse/ApexFormatterProfile.xml[] -----
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc b/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc index 788894572..8f22cb498 100644 --- a/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc +++ b/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc @@ -13,52 +13,52 @@ == Example Configuration for Logging Logic -The following example shows a configuration that logs policy logic to standard out (__info__) and a file (__debug__) -All other APEX components are logging to a file (__debug__) and standard out (__error__). +The following example shows a configuration that logs policy logic to standard out and a file (__info__). +All other APEX components are logging to a file (__debug__).. This configuration an be used in a pre-production phase with the APEX engine still running in a separate terminal to monitor policy execution. -This logback configuration is in the APEX installation as `etc/logback-logic.xml` +This logback configuration is in the APEX installation as `etc/logback-logic.xml`. [source%nowrap,xml] ---- <configuration debug="false"> - <statusListener class="ch.qos.logback.core.status.NopStatusListener" /> + <statusListener class="ch.qos.logback.core.status.NopStatusListener" /> - <contextName>Apex</contextName> - <property name="VAR_LOG" value="/var/log/ericsson/apex/" /> + <contextName>Apex</contextName> + <property name="VAR_LOG" value="/var/log/onap/policy/apex-pdp/" /> - <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> - <encoder> - <Pattern>%d %contextName [%t] %level %logger{36} - %msg%n</Pattern> - </encoder> - </appender> + <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> + <encoder> + <Pattern>%d %contextName [%t] %level %logger{36} - %msg%n</Pattern> + </encoder> + </appender> - <appender name="FILE" class="ch.qos.logback.core.FileAppender"> - <file>${VAR_LOG}/apex.log</file> - <encoder> - <pattern> - %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} - </pattern> - </encoder> - </appender> + <appender name="FILE" class="ch.qos.logback.core.FileAppender"> + <file>${VAR_LOG}/apex.log</file> + <encoder> + <pattern> + %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} + </pattern> + </encoder> + </appender> - <appender name="POLICY_APPENDER_STDOUT" class="ch.qos.logback.core.ConsoleAppender"> - <encoder> - <pattern>policy: %msg\n</pattern> - </encoder> - </appender> + <appender name="POLICY_APPENDER_STDOUT" class="ch.qos.logback.core.ConsoleAppender"> + <encoder> + <pattern>policy: %msg\n</pattern> + </encoder> + </appender> - <root level="error"> - <appender-ref ref="STDOUT" /> - </root> + <root level="error"> + <appender-ref ref="STDOUT" /> + </root> -<logger name="org.onap.policy.apex" level="debug" additivity="false"> - <appender-ref ref="FILE" /> -</logger> + <logger name="org.onap.policy.apex" level="debug" additivity="false"> + <appender-ref ref="FILE" /> + </logger> - <logger name="org.onap.policy.apex.executionlogging" level="debug" additivity="false"> - <appender-ref ref="POLICY_APPENDER_STDOUT" /> - <appender-ref ref="FILE" /> - </logger> + <logger name="org.onap.policy.apex.executionlogging" level="info" additivity="false"> + <appender-ref ref="POLICY_APPENDER_STDOUT" /> + <appender-ref ref="FILE" /> + </logger> </configuration> ---- diff --git a/src/site-docs/adoc/fragments/howto-logging/example-server.adoc b/src/site-docs/adoc/fragments/howto-logging/example-server.adoc index b438bd4a7..8f40a4217 100644 --- a/src/site-docs/adoc/fragments/howto-logging/example-server.adoc +++ b/src/site-docs/adoc/fragments/howto-logging/example-server.adoc @@ -20,27 +20,27 @@ This logback configuration is in the APEX installation as `logback-server.xml` [source%nowrap,xml] ---- <configuration debug="false"> - <statusListener class="ch.qos.logback.core.status.NopStatusListener" /> - - <contextName>Apex</contextName> - <property name="VAR_LOG" value="/var/log/ericsson/apex/" /> - - <appender name="FILE" class="ch.qos.logback.core.FileAppender"> - <file>${VAR_LOG}/apex.log</file> - <encoder> - <pattern> - %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} - </pattern> - </encoder> - </appender> - - <root level="debug"> - <appender-ref ref="FILE" /> - </root> - - <logger name="org.onap.policy.apex.executionlogging" level="debug" additivity="false"> - <appender-ref ref="FILE" /> - </logger> + <statusListener class="ch.qos.logback.core.status.NopStatusListener" /> + + <contextName>Apex</contextName> + <property name="VAR_LOG" value="/var/log/onap/policy/apex-pdp/" /> + + <appender name="FILE" class="ch.qos.logback.core.FileAppender"> + <file>${VAR_LOG}/apex.log</file> + <encoder> + <pattern> + %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} + </pattern> + </encoder> + </appender> + + <root level="debug"> + <appender-ref ref="FILE" /> + </root> + + <logger name="org.onap.policy.apex.executionlogging" level="debug" additivity="false"> + <appender-ref ref="FILE" /> + </logger> </configuration> ---- diff --git a/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc b/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc index 779e45458..a0cc02591 100644 --- a/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc +++ b/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc @@ -17,9 +17,8 @@ The logging for the logic inside a policy (task logic, task selection logic, sta The logger for policy logic is `org.onap.policy.apex.executionlogging`. The following example defines -- a new appender for policy logic logging to standard out using a very simple pattern (simply the actual message) -- a logger for policy logic to standard out using the new appender -- a logger for policy logic to the standard `FILE` appender +- a new appender for standard out using a very simple pattern (simply the actual message) +- a logger for policy logic to standard out using the new appender and the already described file appender. [source%nowrap,xml] ---- @@ -29,12 +28,6 @@ The following example defines </encoder> </appender> -<appender name="POLICY_APPENDER_STDOUT" class="ch.qos.logback.core.ConsoleAppender"> - <encoder> - <pattern>policy: %msg\n</pattern> - </encoder> -</appender> - <logger name="org.onap.policy.apex.executionlogging" level="info" additivity="false"> <appender-ref ref="POLICY_APPENDER_STDOUT" /> <appender-ref ref="FILE" /> @@ -48,7 +41,7 @@ The following example defines a logger for task logic. [source%nowrap,xml] ---- <logger name="org.onap.policy.apex.executionlogging.TaskExecutionLogging" level="TRACE" additivity="false"> - <appender-ref ref="STDOUT" /> + <appender-ref ref="POLICY_APPENDER_STDOUT" /> </logger> ---- diff --git a/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc b/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc index a09b3d27e..4cd4b9b67 100644 --- a/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc +++ b/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc @@ -14,7 +14,7 @@ == Standard Logging Configuration The standard logging configuration defines a context __APEX__, which is used in the standard output pattern. -The location for log files is defined in the property `VAR_LOG` and set to `/var/log/apex`. +The location for log files is defined in the property `VAR_LOG` and set to `/var/log/onap/policy/apex-pdp`. The standard status listener is set to __NOP__ and the overall logback configuration is set to no debug. [source%nowrap,xml,numbered] @@ -23,7 +23,7 @@ The standard status listener is set to __NOP__ and the overall logback configura <statusListener class="ch.qos.logback.core.status.NopStatusListener" /> <contextName>Apex</contextName> - <property name="VAR_LOG" value="/var/log/ericsson/apex/" /> + <property name="VAR_LOG" value="/var/log/onap/policy/apex-pdp/" /> ...appenders ...loggers @@ -49,38 +49,35 @@ The root level logger then is set to the level __info__ using the standard out a </root> ---- -The first appender is called `FILE`. +The second appender is called `FILE`. It writes logs to a file `apex.log`. [source%nowrap,xml,numbered] ---- <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>${VAR_LOG}/apex.log</file> <encoder> - <pattern> - %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} - </pattern> + <pattern>%d %-5relative [procId=${processId}] [%thread] %-5level %logger{26} - %msg %n %ex{full}</pattern> </encoder> </appender> ---- -The first appender is called `CTXT_FILE`. +The third appender is called `CTXT_FILE`. It writes logs to a file `apex_ctxt.log`. [source%nowrap,xml,numbered] ---- <appender name="CTXT_FILE" class="ch.qos.logback.core.FileAppender"> <file>${VAR_LOG}/apex_ctxt.log</file> <encoder> - <pattern> - %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} - </pattern> + <pattern>%d %-5relative [procId=${processId}] [%thread] %-5level %logger{26} - %msg %n %ex{full}</pattern> </encoder> </appender> ---- The last definitions are for specific loggers. -The first logger captures all standard APEX classes, appends logs to `STDOUT` with the log level __info__. -The second logger capture all standard APEX classes, appends logs to `FILE` with log level __info__. -The third logger captures context monitoring classes, appends logs to `CTXT_FILE` with log level __trace__. +The first logger captures all standard APEX classes. +It is configured for log level __info__ and uses the standard output and file appenders. +The second logger captures APEX context classes responsible for context monitoring. +It is configured for log level __trace__ and uses the context file appender. [source%nowrap,xml,numbered] ---- diff --git a/src/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc b/src/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc index 77769dc31..cf582aa2e 100644 --- a/src/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc +++ b/src/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc @@ -18,7 +18,7 @@ It describes a sales problem, to which policy can be applied. The example details the policy background, shows how to use the REST Editor to create a policy, and provides details for running the policies. The documentation can be found: -* link:https://ericsson.github.io/apex-docs/modules/apex-domains/apex-domains.myfirstpolicy/MyFirstPolicyHowto.html[My-First-Policy on the APEX site] +* link:https://ericsson.github.io/apex-docs/modules/examples/examples-myfirstpolicy/MyFirstPolicyHowto.html[My-First-Policy on the APEX site] * link:https://ericsson.github.io/apex-docs/docs-apex/html/HowTo-MyFirstPolicy.html[Stand-alone HTML] * link:https://ericsson.github.io/apex-docs/docs-apex/pdf/HowTo-MyFirstPolicy.pdf[Stand-alone PDF] @@ -30,7 +30,7 @@ It also provides details for installing an actual testbed with off-the-shelve so The policy model here demonstrates virtually all APEX features: local context and policies controlling it, task selection logic and multiple tasks in a single state, AVRO schemas for context, AVOR schemas for events (trigger and local), and a CLI editor specification of the policy. The documentation can be found: -* link:https://ericsson.github.io/apex-docs/modules/apex-domains/apex-domains.pcvs/vpnsla/policy.html[VPN SLA Policy on the APEX site] +* link:https://ericsson.github.io/apex-docs/modules/examples/examples-pcvs/vpnsla/policy.html[VPN SLA Policy on the APEX site] == Decision Maker @@ -40,5 +40,5 @@ Interesting here is that the it creates a Docker image to run the policy and tha It also has local context to remember past decisions, and shows how to use that to no make the same decision twice in a row. The documentation can be found: -* link:https://ericsson.github.io/apex-docs/modules/apex-domains/apex-domains.decisionmaker/index.html[Decision Maker on APEX site] +* link:https://ericsson.github.io/apex-docs/modules/examples/examples-decisionmaker/index.html[Decision Maker on APEX site] diff --git a/src/site-docs/adoc/fragments/install-guide/build-apex.adoc b/src/site-docs/adoc/fragments/install-guide/build-apex.adoc index b773d97bd..8676d8f29 100644 --- a/src/site-docs/adoc/fragments/install-guide/build-apex.adoc +++ b/src/site-docs/adoc/fragments/install-guide/build-apex.adoc @@ -15,9 +15,17 @@ The examples in this document assume that the APEX source repositories are cloned to: -- Unix, Cygwin: `/usr/local/src/apex` -- Windows: `C:\dev\apex` -- Cygwin: `/cygdrive/c/dev/apex` +- Unix, Cygwin: `/usr/local/src/apex-pdp` +- Windows: `C:\dev\apex-pdp` +- Cygwin: `/cygdrive/c/dev/apex-pdp` + +[IMPORTANT] +.A Build requires ONAP Nexus +==== +APEX has a dependency to ONAP parent projects. +You might need to adjust your Maven M2 settings. +The most current settings can be found in the ONAP oparent repo: link:https://git.onap.org/oparent/plain/settings.xml[Settings]. +==== [IMPORTANT] .A Build needs Space @@ -47,14 +55,14 @@ Use Maven to for a standard build without any tests. | [source%nowrap,sh,numbered] ---- -# cd /usr/local/src/apex +# cd /usr/local/src/apex-pdp # mvn clean install -DskipTests ---- | [source%nowrap,bat,numbered] ---- >c: ->cd \dev\apex +>cd \dev\apex-pdp >mvn clean install -DskipTests ---- |==================== @@ -79,7 +87,7 @@ The following example show how to change to the target directory and how it shou | [source%nowrap,sh,numbered] ---- -# cd modules/apex-apps/apex-apps.uservice/apex-apps.uservice-packaging/apex-apps.uservice-package-full/target +# cd packages/apex-pdp-package-full/target # ls -l ---- @@ -98,7 +106,7 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/screens/target-ls-unix.txt[s | [source%nowrap,bat,numbered] ---- ->cd modules\apex-apps\apex-apps.uservice\apex-apps.uservice-packaging\apex-apps.uservice-package-full\target +>cd packages\apex-pdp-package-full\target >dir ---- diff --git a/src/site-docs/adoc/fragments/install-guide/configure.adoc b/src/site-docs/adoc/fragments/install-guide/configure.adoc index 77c63a29a..97388f8f7 100644 --- a/src/site-docs/adoc/fragments/install-guide/configure.adoc +++ b/src/site-docs/adoc/fragments/install-guide/configure.adoc @@ -56,14 +56,14 @@ The last row explains how to set those variables permanently. [source%nowrap,bash,numbered] ---- # export APEX_USER=apexuser -# cd /opt/ericsson/apex/apex +# cd /opt/app/policy/apex-pdp/apex-pdp # export APEX_HOME=`pwd` ---- [source%nowrap,tcsh,numbered] ---- # setenv APEX_USER apexuser -# cd /opt/ericsson/apex/apex +# cd /opt/app/policy/apex-pdp/apex-pdp # setenv APEX_HOME `pwd` ---- | @@ -77,7 +77,7 @@ The last row explains how to set those variables permanently. ---- # env \| grep APEX APEX_USER=apexuser -APEX_HOME=/opt/ericsson/apex/apex +APEX_HOME=/opt/app/policy/apex-pdp/apex-pdp ---- | [source%nowrap,bat,numbered,subs="attributes+"] @@ -125,7 +125,7 @@ Configure the APEX logging settings to your requirements, for instance: Edit the file `$APEX_HOME/etc/logback.xml` for any required changes. To change the log directory change the line -`<property name="VAR_LOG" value="/var/log/ericsson/apex/" />` +`<property name="VAR_LOG" value="/var/log/onap/policy/apex-pdp/" />` to @@ -148,8 +148,8 @@ This is important when APEX was installed manually or when the log directory was | [source%nowrap,sh,numbered] ---- -mkdir -p /var/log/ericsson/apex -chown -R apexuser:apexuser /var/log/ericsson/apex +mkdir -p /var/log/onap/policy/apex-pdp +chown -R apexuser:apexuser /var/log/onap/policy/apex-pdp ---- | [source%nowrap,bat,numbered,subs="attributes+"] diff --git a/src/site-docs/adoc/fragments/install-guide/docker.adoc b/src/site-docs/adoc/fragments/install-guide/docker.adoc index be5273a48..6f63956aa 100644 --- a/src/site-docs/adoc/fragments/install-guide/docker.adoc +++ b/src/site-docs/adoc/fragments/install-guide/docker.adoc @@ -13,248 +13,32 @@ == Running APEX in Docker -This section explains how to create a Docker image that contains the base APEX package and shows how to run APEX in Docker. -It also explains how to use the base APEX Docker image to create application docker images that contain both APEX and your application policies. +Since APEX is in ONAP, we provide a full virtualization environment for the engine. -We assume you have already installed Docker on your host. -For instructions on how to install Docker, see the link:https://www.docker.com/community-edition[Get Started with Docker] page on the Docker web site. +=== Run in ONAP -=== Create the APEX Base Docker Image +Running APEX from the ONAP docker repository only requires 2 commands: -You need only perform this task once to create an APEX base image that you can use as a base for your applications from then on. -This task sets up an Ubuntu Docker image and then installs Java and APEX on Ubuntu running in the Docker image. - -. Create an empty directory, here the directory is called `apex`, and change into that directory -+ -[source%nowrap,bash,numbered] ----- -# mkdir apex -# cd apex +. Log into the ONAP docker repo +[source%nowrap,sh,numbered] ---- -+ -. Copy the APEX Debian package from the APEX download site into the directory -. Open a text editor and create a file called `Dockerfile` in your directory -. Paste the following text into the editor that is editing `Dockerfile` -+ -[source%nowrap,bash,numbered,subs="attributes+"] +docker login -u docker -p docker nexus3.onap.org:10003 ---- -# -# Docker file to build an image that runs APEX on Java 8 in Ubuntu -# -FROM ubuntu:16.04 -MAINTAINER <YOUR> <NAME> <YOUR>.<NAME>@ericsson.com - -RUN apt-get update && \ - apt-get upgrade -y && \ - apt-get install -y software-properties-common && \ - add-apt-repository ppa:webupd8team/java -y && \ - apt-get update && \ - echo oracle-javax8-installer shared/accepted-oracle-license-v1-1 select true | /usr/bin/debconf-set-selections && \ - apt-get install -y oracle-java8-installer - -RUN mkdir /packages -COPY apex-apps.uservice-packages-{release-version}-full.deb /packages -RUN dpkg -i packages/apex-apps.uservice-packages-{release-version}-full.deb -RUN rm /packages/apex-apps.uservice-packages-{release-version}-full.deb - -ENV PATH /opt/ericsson/apex/apex/bin:$PATH - -RUN apt-get clean - -RUN chown -R apexuser:apexuser /home/apexuser/* -WORKDIR /home/apexuser - +. Run the APEX docker image +[source%nowrap,sh,numbered] ---- -+ -. Replace the fields <YOUR> and <NAME> above with your name and email address -. Save the `Dockerfile` -. An example working base `Dockerfile` appears below -+ -[source%nowrap,bash,numbered,subs="attributes+"] +docker run -it --rm nexus3.onap.org:10003/onap/policy-apex-pdp:latest ---- -# -# Docker file to build an image that runs APEX on Java 8 in Ubuntu -# -FROM ubuntu:16.04 -MAINTAINER Sean Citizen sean.citizen@ericsson.com -RUN apt-get update && \ - apt-get upgrade -y && \ - apt-get install -y software-properties-common && \ - add-apt-repository ppa:webupd8team/java -y && \ - apt-get update && \ - echo oracle-javax8-installer shared/accepted-oracle-license-v1-1 select true | /usr/bin/debconf-set-selections && \ - apt-get install -y oracle-java8-installer -RUN mkdir /packages -COPY apex-apps.uservice-packages-{release-version}-full.deb /packages -RUN dpkg -i packages/apex-apps.uservice-packages-{release-version}-full.deb -RUN rm /packages/apex-apps.uservice-packages-{release-version}-full.deb +=== Build a Docker Image -ENV PATH /opt/ericsson/apex/apex/bin:$PATH +Alternatively, one can use the Dockerfile defined in the Docker package to build an image. -RUN apt-get clean - -RUN chown -R apexuser:apexuser /home/apexuser/* -WORKDIR /home/apexuser ----- -+ -. Create and tag the base Docker image for APEX using this command -+ -[source%nowrap,bash,numbered] ----- -docker build -t apex/base . -docker tag apex/base apex/base:latest -docker tag apex/base apex/base:{release-version} ----- -+ -. Test the APEX Docker base image with the following command, APEX will start a sample policy: -+ -[source%nowrap,bash,numbered] ----- -docker run --name apex --user=apexuser:apexuser -it --rm -p 12345:12345 apex/base apexEngine.sh -c examples/config/SampleDomain/Stdin2StdoutJsonEventJavascript.json ----- -+ -. Paste the following event into the shell and the APEX Policy will process the event -+ -[source%nowrap,json,numbered] ----- -{ - "nameSpace": "org.onap.policy.apex.sample.events", - "name": "Event0000", - "version": "0.0.1", - "source": "test", - "target": "apex", - "TestSlogan": "Test slogan for External Event0", - "TestMatchCase": 0, - "TestTimestamp": 1469781869269, - "TestTemperature": 9080.866 -} ----- -+ -. APEX returns the following event -+ -[source%nowrap,json,numbered] ----- -{ - "nameSpace" : "org.onap.policy.apex..sample.events", - "name" : "Event0004", - "version" : "0.0.1", - "source" : "", - "target" : "", - "TestActCaseSelected" : 3, - "TestActStateTime" : 1481215910429, - "TestTemperature" : 9080.866, - "TestDecideCaseSelected" : 1, - "TestMatchCaseSelected" : 2, - "TestTimestamp" : 1469781869269, - "TestDecideStateTime" : 1481215910425, - "TestMatchCase" : 0, - "TestSlogan" : "Test slogan for External Event0", - "TestEstablishCaseSelected" : 0, - "TestEstablishStateTime" : 1481215910421, - "TestMatchStateTime" : 1481215910415 -} ----- -+ -. You now have built and tested an APEX base Docker image. - You can connect the APEX Deployment and Monitoring servlet to this APEX engine instance. For example, assuming the APEX Deployment and Monitoring servlet is deploying on the localhost computer on port 8080 you can use the following URL: -+ ----- -http://localhost:8080/apex-services.client-{release-version}/?hostname=0.0.0.0&port=12345 ----- - -=== Create an APEX Application Docker Image using the APEX Base Docker Image - -We assume you have created an APEX application, that you wish to use static deployment, and that you have APEX metadata to add to the base APEX Docker image. - -. 1.Create an empty directory for your application, here the directory is called `myApplication`, and change into that directory -+ -[source%nowrap,bash,numbered] ----- -mkdir myApplication -cd myApplication ----- -+ -. Copy the directories containing your application metadata into that directory, for example, if you have three directories called `myappDirectory0`, `myappDirectory1`, and `myappDirectoryn`, you will have the following directory structure -+ -[source%nowrap,bash,numbered] ----- -ls | cat -myappDirectory0 -myappDirectory1 -myappDirectoryn ----- -+ -. Open a text editor and create a file called `Dockerfile` in your application directory -. Paste the following text into the editor that is editing `Dockerfile` -+ -[source%nowrap,bash,numbered] ----- -# -# Docker file to build an image that runs APEX Applications on Java 8 in Ubuntu -# -FROM apex/base:{release-version} -MAINTAINER <YOUR> <NAME> <YOUR>.<NAME>@ericsson.com - -# Copy your application metadata -COPY <MY_APP_DIRECTORY_0> /home/apexuser/<MY_APP_DIRECTORY_0> -COPY <MY_APP_DIRECTORY_1> /home/apexuser/<MY_APP_DIRECTORY_1> -COPY <MY_APP_DIRECTORY_N> /home/apexuser/<MY_APP_DIRECTORY_N> - -run chown -R apexuser:apexuser /home/apexuser/* ----- -+ -. Edit the template fields - .. Replace the fields <YOUR> and <NAME> with your name and email address - .. Replace the <MY_APP_DIRECTORY_x> fields with the names of your actual application directory names, myappDirectoryx in our example here. Do this for all application directories you have. -. Save the `Dockerfile` -. An example working application `Dockerfile` appears below -+ -[source%nowrap,bash,numbered] ----- -# -# Docker file to build an image that runs APEX Applications on Java 8 in Ubuntu -# -FROM apex/base:{release-version} -MAINTAINER Sean Citizen sean.citizen@ericsson.com - -# Copy your application metadata -COPY myappDirectory0 /home/apexuser/myappDirectory0 -COPY myappDirectory1 /home/apexuser/myappDirectory1 -COPY myappDirectoryn /home/apexuser/myappDirectoryn - -run chown -R apexuser:apexuser /home/apexuser/* ----- -+ -. Create the Docker image for your APEX application using this command -+ -[source%nowrap,bash,numbered] ----- -docker build -t apex/myapplication . ----- -+ -. Test the APEX Docker base image with the following command, APEX will start to a bash shell in the `apexuser` home directory: -+ -[source%nowrap,bash,numbered] ----- -docker run --name myapplication -it --rm -p 12345:12345 apex/myapplication apexBash.sh ----- -+ -. Check that your application directories have been created, the command returns the directory list: -+ -[source%nowrap,bash,numbered] +.APEX Dockerfile +[source%nowrap,sh,numbered,subs="attributes+"] ---- -> pwd -/opt/ericsson -> ls -l -total 16 -drwxr-xr-x 8 apexuser apexuser 4096 Dec 9 13:28 examples -drwxr-xr-x 2 apexuser apexuser 4096 Dec 9 13:28 myappDirectory0 -drwxr-xr-x 2 apexuser apexuser 4096 Dec 9 13:28 myappDirectory1 -drwxr-xr-x 2 apexuser apexuser 4096 Dec 9 13:28 myappDirectoryn +include::{adsite-packages-docker-dir}/main/docker/Dockerfile[APEX Dockerfile] ---- -+ -. You now have built an APEX Application docker image and you can use the `apexEngine.sh` command to run your application using the appropriate configuration file for your application. diff --git a/src/site-docs/adoc/fragments/install-guide/get-source.adoc b/src/site-docs/adoc/fragments/install-guide/get-source.adoc index 11786da4e..0aa97db1e 100644 --- a/src/site-docs/adoc/fragments/install-guide/get-source.adoc +++ b/src/site-docs/adoc/fragments/install-guide/get-source.adoc @@ -12,16 +12,16 @@ // == Get the APEX Source Code -The APEX source code is hosted in as project on Github link:https://github.com/Ericsson/apex[Ericsson:apex]. + +The first APEX source code was hosted on Github in January 2018. +By the end of 2018, APEX was added as a project in the ONAP Policy Framework, released later in the ONAP Casablanca release. + +The APEX source code is hosted in ONAP as project APEX. The current stable version is in the master branch. -Simply clone the master branch from Github using either HTTPS (first example below) or SSH (second example below). +Simply clone the master branch from ONAP using HTTPS. [source%nowrap,sh,numbered] ---- -git clone https://github.com/Ericsson/apex.git +git clone https://gerrit.onap.org/r/policy/apex-pdp ---- -[source%nowrap,sh,numbered] ----- -git clone git@github.com:Ericsson/apex.git ----- diff --git a/src/site-docs/adoc/fragments/install-guide/install-monitoring.adoc b/src/site-docs/adoc/fragments/install-guide/install-monitoring.adoc deleted file mode 100644 index a8bf3d4f1..000000000 --- a/src/site-docs/adoc/fragments/install-guide/install-monitoring.adoc +++ /dev/null @@ -1,99 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Installing the Web Monitoring Application - -APEX comes with a deployment and monitoring application realized as a servlet. -This requires a _full_ installation of APEX. -This requires a web server that can execute `war` web archives. -We recommend to use link:https://tomcat.apache.org/[Apache Tomcat], however other web servers can be used as well. - -Install Apache Tomcat including the `Manager App`, see link:https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html#Configuring_Manager_Application_Access[V9.0 Docs] for details. -Start the Tomcat service, or make sure that Tomcat is running. -Locate the APEX monitoring application. - -[source%nowrap,sh,numbered,subs="attributes+"] ----- -$APEX_HOME/war/apex-services.client.monitoring-{release-version}.war ----- - -[source%nowrap,bat,numbered,subs="attributes+"] ----- -%APEX_HOME%\war\apex-services.client.monitoring-{release-version}.war ----- - -There are multiple ways to install the APEX monitoring application: - -- copy the `.war` file into the Tomcat `webapps` folder -- use the Tomcat `Manager App` to deploy via the web interface -- deploy using a REST call to Tomcat - -For details on how to install `war` files please consult the link:https://tomcat.apache.org/tomcat-9.0-doc/index.html[Tomcat Documentation] or the link:https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html[Manager App HOW-TO]. -Once you installed the APEX monitoring application (and wait for sufficient time for Tomcat to finalize the installation), open the `Manager App` in Tomcat. -You should see the APEX monitoring application being installed and running. - -image::install-guide/tomcat-installed.png[Tomcat Application Manager with APEX Monitoring Application] - -In case of errors, examine the log files in the Tomcat log directory. -In a conventional install, those log files are in the logs directory where Tomcat is installed. - -Once the APEX monitoring application is installed, start an APEX engine with the `SampleDomain` configuration as described above. -Wait until the engine is fully started. -Then open a browser (or a new tab) and use the following URL to connect to the APEX monitoring application. -Change the values for the Tomcat port (`10080` in the example), the APEX application version (`{release-version}` in the example), and the APEX management port (`12345` in the example, taken from the example configuration) to your local settings. -If your browser is not opened on the same host as the APEX engine runs, change `localhost` to the host name with the APEX engine. - -[source%nowrap,url,subs="attributes+"] ----- -http://localhost:10080/apex-services.client-{release-version}/?hostname=localhost&port=12345 ----- - -The browser will now show the APEX monitoring application. - -image::install-guide/monitoring-app.png[APEX Monitoring and Deployment Application] - -Now send some events to the APEX engine. -The configuration is for standard input, so simply paste the following event into the APEX engine console. - -[source%nowrap,json,numbered] ----- -{ - "nameSpace": "org.onap.policy.apex.sample.events", - "name": "Event0000", - "version": "0.0.1", - "source": "test", - "target": "apex", - "TestSlogan": "Test slogan for External Event0", - "TestMatchCase": 0, - "TestTimestamp": 1469781869269, - "TestTemperature": 9080.866 -} ----- - -When events are sent to APEX, the monitoring application will show all engine status changes. -The following screen shot show the engine status after passing several events into the engine. - -image::install-guide/monitoring-app-status.png[APEX Monitoring: status] - -To terminate this setting, first use `CTRL+C` in the engine console to terminate the engine. -Within a few seconds, the APEX monitoring application will terminate as well with a connection error: - ----- -Error connecting to Apex Engine Service at localhost:12345 -cound not handshake with server localhost:12345 -See detailed message in log ----- - -Terminate the browser now (or the tab with the application). -Finally, if you do not want to use Tomcat for any other applications, terminate the Tomcat server as well. - diff --git a/src/site-docs/adoc/fragments/install-guide/install-resteditor.adoc b/src/site-docs/adoc/fragments/install-guide/install-resteditor.adoc deleted file mode 100644 index 721ede0a9..000000000 --- a/src/site-docs/adoc/fragments/install-guide/install-resteditor.adoc +++ /dev/null @@ -1,60 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Installing the REST Editor - -APEX comes with a RESR Editor application realized as a servlett. -This requires a _full_ installation of APEX. -This requires a web server that can execute `war` web archives. -We recommend to use link:https://tomcat.apache.org/[Apache Tomcat], however other web servers can be used as well. - -Install Apache Tomcat including the `Manager App`, see link:https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html#Configuring_Manager_Application_Access[V9.0 Docs] for details. -Start the Tomcat service, or make sure that Tomcat is running. -Locate the APEX monitoring application in your local APEX installation. - -[source%nowrap,sh,numbered,subs="attributes+"] ----- -$APEX_HOME/war/apex-services.client-editor-{release-version}.war ----- - -[source%nowrap,bat,numbered,subs="attributes+"] ----- -%APEX_HOME%\war\apex-services.client-editor-{release-version}.war ----- - -There are multiple ways to install the APEX monitoring application: - -- copy the `.war` file into the Tomcat `webapps` folder -- use the Tomcat `Manager App` to deploy via the web interface -- deploy using a REST call to Tomcat - -For details on how to install `war` files please consult the link:https://tomcat.apache.org/tomcat-9.0-doc/index.html[Tomcat Documentation] or the link:https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html[Manager App HOW-TO]. -Once you installed the APEX monitoring application (and wait for sufficient time for Tomcat to finalize the installation), open the `Manager App` in Tomcat. -You should see the APEX REST Editor application being installed and running. - -In case of errors, examine the log files in the Tomcat log directory. -In a conventional install, those log files are in the logs directory where Tomcat is installed. - -Once the APEX REST Editor is installed, open a browser (or a new tab) and use the following URL to connect to the APEX monitoring application. -Change the values for the Tomcat port (`10080` in the example), the APEX REST EDITOR version (`{release-version}` in the example), and the APEX management port (`12345` in the example, taken from the example configuration) to your local settings. -If your browser is not opened on the same host as the APEX engine runs, change `localhost` to the host name with the APEX engine. - -[source%nowrap,url,subs="attributes+"] ----- -http://localhost:10080/apex%2Dauth.rest%2D{release-version}/ ----- - -The browser will now show the APEX REST Editor. - -Terminate the browser now (or the tab with the application). -Finally, if you do not want to use Tomcat for any other applications, terminate the Tomcat server as well. diff --git a/src/site-docs/adoc/fragments/install-guide/install-wars.adoc b/src/site-docs/adoc/fragments/install-guide/install-wars.adoc new file mode 100755 index 000000000..2de1e0b89 --- /dev/null +++ b/src/site-docs/adoc/fragments/install-guide/install-wars.adoc @@ -0,0 +1,46 @@ +// +// ============LICENSE_START======================================================= +// Copyright (C) 2016-2018 Ericsson. All rights reserved. +// ================================================================================ +// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +// +// SPDX-License-Identifier: CC-BY-4.0 +// ============LICENSE_END========================================================= +// +// @author Sven van der Meer (sven.van.der.meer@ericsson.com) +// + +== Installing WAR Applications +APEX comes with a set of WAR files. +These are complete applications that can be installed and run in an application server. +All of these applications are realized as servlets. +You can find the WAR applications in `$APEX_HOME/war` (UNIX, Cygwin) or `%APEX_HOME%\war` (Windows). + +Installing and using the WAR applications requires a web server that can execute `war` web archives. +We recommend to use link:https://tomcat.apache.org/[Apache Tomcat], however other web servers can be used as well. + +Install Apache Tomcat including the `Manager App`, see link:https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html#Configuring_Manager_Application_Access[V9.0 Docs] for details. +Start the Tomcat service, or make sure that Tomcat is running. + +There are multiple ways to install the APEX WAR applications: + +- copy the `.war` file into the Tomcat `webapps` folder +- use the Tomcat `Manager App` to deploy via the web interface +- deploy using a REST call to Tomcat + +For details on how to install `war` files please consult the link:https://tomcat.apache.org/tomcat-9.0-doc/index.html[Tomcat Documentation] or the link:https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html[Manager App HOW-TO]. +Once you installed an APEX WAR application (and wait for sufficient time for Tomcat to finalize the installation), open the `Manager App` in Tomcat. +You should see the APEX WAR application being installed and running. + +In case of errors, examine the log files in the Tomcat log directory. +In a conventional install, those log files are in the logs directory where Tomcat is installed. + +The current APEX version provides the following WAR applications: + +* client-deployment-{release-version}.war - a client to deploy new policy models to a running engine +* client-editor-{release-version}.war - the standard policy REST editor GUI +* client-monitoring-{release-version}.war - a client for monitoring a running APEX engine +* client-full-{release-version}.war - a full client with a one-stop-access to deployment, monitoring, and REST editor +* examples-servlet-{release-version}.war - an example APEX servlet + diff --git a/src/site-docs/adoc/fragments/install-guide/install.adoc b/src/site-docs/adoc/fragments/install-guide/install.adoc index a1e95347a..57d78739e 100644 --- a/src/site-docs/adoc/fragments/install-guide/install.adoc +++ b/src/site-docs/adoc/fragments/install-guide/install.adoc @@ -21,9 +21,9 @@ APEX can be installed in different ways: === Install with RPM and DPKG The install distributions of APEX automatically install the system. -The installation directory is `/opt/ericsson/apex`. -Log files are located in `/var/log/ericsson/apex`. -The latest APEX version will be available as `/opt/ericsson/apex/apex`. +The installation directory is `/opt/app/policy/apex-pdp`. +Log files are located in `/var/log/onap/policy/apex-pdp`. +The latest APEX version will be available as `/opt/app/policy/apex-pdp/apex-pdp`. For the installation, a new user `apexuser` and a new group `apexuser` will be created. This user owns the installation directories and the log file location. @@ -35,7 +35,7 @@ The user is also used by the standard APEX start scripts to run APEX with this u | [source%nowrap,sh,numbered,subs="attributes+"] ---- -# sudo rpm -i apex-apps.uservice-packages-{release-version}-full.rpm +# sudo rpm -i apex-pdp-package-full-{release-version}.rpm ********************preinst******************* arguments 1 ********************************************** @@ -54,10 +54,10 @@ arguments 1 | [source%nowrap,sh,numbered,subs="attributes+"] ---- -# sudo dpkg -i apex-apps.uservice-packages-{release-version}-full.deb +# sudo dpkg -i apex-pdp-package-full-{release-version}.deb Selecting previously unselected package apex-uservice. (Reading database ... 288458 files and directories currently installed.) -Preparing to unpack apex-apps.uservice-packages-{release-version}-full.deb ... +Preparing to unpack apex-pdp-package-full-{release-version}.deb ... ********************preinst******************* arguments install ********************************************** @@ -86,8 +86,8 @@ The following example shows how to install APEX in `/opt/apex` and create a link # mkdir apex # cd apex # mkdir apex-full-{release-version} -# tar xvfz ~/Downloads/apex-apps.uservice-packages-{release-version}-full.tar.gz -C apex-full-{release-version} -# ln -s apex apex-apps.uservice-packages-{release-version} +# tar xvfz ~/Downloads/apex-pdp-package-full-{release-version}.tar.gz -C apex-full-{release-version} +# ln -s apex apex-pdp-package-full-{release-version} ---- @@ -104,8 +104,6 @@ image::install-guide/win-extract-tar.png[Extract the APEX distribution] Inside the new APEX folder you see the main directories: `bin`, `etc`, `examples`, `lib`, and `war` -image::install-guide/win-extracted.png[Extracted APEX distribution] - Once extracted, please rename the created folder to `apex-full-{release-version}`. This will keep the directory name in line with the rest of this documentation. @@ -119,7 +117,7 @@ Assuming `7Zip` is installed in the standard folder, simply run the following co ---- >c: >cd \apex ->"\Program Files\7-Zip\7z.exe" x apex-apps.uservice-packages-{release-version}-full.tar.gz -so | "\Program Files\7-Zip\7z.exe" x -aoa -si -ttar -o"apex-full-{release-version}" +>"\Program Files\7-Zip\7z.exe" x apex-pdp-package-full-{release-version}.tar.gz -so | "\Program Files\7-Zip\7z.exe" x -aoa -si -ttar -o"apex-full-{release-version}" ---- APEX is now installed in the folder `C:\apex\apex-full-{release-version}`. @@ -188,7 +186,7 @@ The following example show how to change to the target directory and how it shou | [source%nowrap,sh,numbered] ---- -# cd modules/apex-apps/apex-apps.uservice/apex-apps.uservice-packaging/apex-apps.uservice-package-full/target +# cd packages/apex-pdp-package-full/target # ls -l ---- @@ -208,7 +206,7 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/screens/target-ls-unix.txt[s | [source%nowrap,bat,numbered] ---- ->cd modules\apex-apps\apex-apps.uservice\apex-apps.uservice-packaging\apex-apps.uservice-package-full\target +>cd packages\apex-pdp-package-full\target >dir ---- diff --git a/src/site-docs/adoc/fragments/install-guide/layout.adoc b/src/site-docs/adoc/fragments/install-guide/layout.adoc index ef3d1cf5b..bbb21021f 100644 --- a/src/site-docs/adoc/fragments/install-guide/layout.adoc +++ b/src/site-docs/adoc/fragments/install-guide/layout.adoc @@ -17,8 +17,8 @@ A full installation of APEX comes with the following layout. ---- $APEX_HOME - ├───bin <1> - ├───etc <2> + ├───bin <1> + ├───etc <2> │ ├───editor │ ├───hazelcast │ ├───infinispan @@ -27,11 +27,13 @@ $APEX_HOME │ ├───config <4> │ ├───docker <5> │ ├───events <6> - │ ├───models <7> - │ └───scripts <8> - ├───lib <9> - │ └───applications <10> - └───war <11> + │ ├───html <7> + │ ├───models <8> + │ └───scripts <9> + ├───lib <10> + │ └───applications <11> + └───war <12> + ---- <1> binaries, mainly scripts (bash and bat) to start the APEX engine and applications <2> configuration files, such as logback (logging) and third party library configurations @@ -39,9 +41,10 @@ $APEX_HOME <4> configurations for the examples (with sub directories for individual examples) <5> Docker files and additional Docker instructions for the exampples <6> example events for the examples (with sub directories for individual examples) -<7> the policy models, generated for each example (with sub directories for individual examples) -<8> additional scripts for the examples (with sub directories for individual examples) -<9> the library folder with all Java JAR files -<10> applications, also known as jar with dependencies (or fat jars), individually deployable -<11> WAR files for web applications +<7> HTML files for some examples, e.g. the Decisionmaker example +<8> the policy models, generated for each example (with sub directories for individual examples) +<9> additional scripts for the examples (with sub directories for individual examples) +<10> the library folder with all Java JAR files +<11> applications, also known as jar with dependencies (or fat jars), individually deployable +<12> WAR files for web applications diff --git a/src/site-docs/adoc/fragments/install-guide/verify.adoc b/src/site-docs/adoc/fragments/install-guide/verify.adoc index 782c2723e..6774a8489 100644 --- a/src/site-docs/adoc/fragments/install-guide/verify.adoc +++ b/src/site-docs/adoc/fragments/install-guide/verify.adoc @@ -14,13 +14,10 @@ == Verify the APEX Installation When APEX is installed and all settings are realized, the installation can be verified. -=== Verify a Minimal Installation -The minimal installation does not come with any configuration or policy model. -It is therefore not possible to test all APEX features, or an engine running with policies. - -However, one can verify that the engine starts up to the point where it tries to load a configuration. - +=== Verify Installation - run Engine +A simple verification of an APEX installation can be done by simply starting the APEX engine without any configuration. On Unix (or Cygwin) start the engine using `$APEX_HOME/bin/apexEngine.sh`. +On Windows start the engine using `%APEX_HOME%\bin\apexEngine.bat`. The engine will fail to fully start. However, if the output looks similar to the following line, the APEX installation is realized. @@ -28,22 +25,26 @@ However, if the output looks similar to the following line, the APEX installatio ---- Starting Apex service with parameters [] . . . start of Apex service failed: Apex configuration file was not specified as an argument -2017-07-28 13:18:44,266 Apex [main] ERROR c.e.a.service.engine.main.ApexMain - start of Apex service failed: ----- +2018-09-03 13:11:33,914 Apex [main] ERROR o.o.p.a.service.engine.main.ApexMain - start of Apex service failed +org.onap.policy.apex.model.basicmodel.concepts.ApexException: Apex configuration file was not specified as an argument + at org.onap.policy.apex.service.engine.main.ApexCommandLineArguments.validateReadableFile(ApexCommandLineArguments.java:267) + at org.onap.policy.apex.service.engine.main.ApexCommandLineArguments.validate(ApexCommandLineArguments.java:161) + at org.onap.policy.apex.service.engine.main.ApexMain.<init>(ApexMain.java:68) + at org.onap.policy.apex.service.engine.main.ApexMain.main(ApexMain.java:165) +usage: org.onap.policy.apex.service.engine.main.ApexMain [options...] +options +-c,--config-file <CONFIG_FILE>the full path to the configuration file to use, the configuration file must be a Json file + containing the Apex configuration parameters +-h,--help outputs the usage of this command +-m,--model-file <MODEL_FILE> the full path to the model file to use, if set it overrides the model file set in the + configuration file +-v,--version outputs the version of Apex -On Windows start the engine using `%APEX_HOME%\bin\apexEngine.bat`. -The engine will fail to fully start. -However, if the output looks similar to the following line, the APEX installation is realized. - -[source%nowrap,bat,numbered] ----- -Starting Apex service with parameters [] . . . -start of Apex service failed: Apex configuration file was not specified as an argument -2017-07-28 13:18:44,266 Apex [main] ERROR c.e.a.service.engine.main.ApexMain - start of Apex service failed: ---- -=== Verify a Full Installation - run an Example + +=== Verify Installation - run an Example A full APEX installation comes with several examples. Here, we can fully verify the installation by running one of the examples. @@ -55,7 +56,7 @@ Note: Cygwin executes scripts as Unix scripts but runs Java as a Windows applica ---- # $APEX_HOME/bin/apexEngine.sh -c $APEX_HOME/examples/config/SampleDomain/Stdin2StdoutJsonEventJava.json # <1> # $APEX_HOME/bin/apexEngine.sh -c C:/apex/apex-full-{release-version}/examples/config/SampleDomain/Stdin2StdoutJsonEventJava.json # <2> ->%APEX_HOME%\bin\apexEngine.bat -c %APEX_HOME%\examples\config\SampleDomain\Stdin2StdoutJsonEventJava.json @@ <3> +>%APEX_HOME%\bin\apexEngine.bat -c %APEX_HOME%\examples\config\SampleDomain\Stdin2StdoutJsonEventJava.json :: <3> ---- <1> UNIX <2> Cygwin @@ -67,12 +68,19 @@ Assuming the logging levels are not change (default level is `info`), the output [source%nowrap,sh,numbered] ---- -2017-07-28 13:20:54,673 Apex [main] INFO c.e.a.s.engine.runtime.EngineService - engine model SamplePolicyModelJAVA:0.0.1 added to the engine-AxArtifactKey:(name=MyApexEngine-3,version=0.0.1) -2017-07-28 13:20:54,675 Apex [Apex-apex-engine-service-0:0] INFO c.e.a.s.engine.runtime.EngineService - Engine AxArtifactKey:(name=MyApexEngine-0,version=0.0.1) processing ... -2017-07-28 13:20:54,677 Apex [Apex-apex-engine-service-0:1] INFO c.e.a.s.engine.runtime.EngineService - Engine AxArtifactKey:(name=MyApexEngine-1,version=0.0.1) processing ... -2017-07-28 13:20:54,677 Apex [Apex-apex-engine-service-0:2] INFO c.e.a.s.engine.runtime.EngineService - Engine AxArtifactKey:(name=MyApexEngine-2,version=0.0.1) processing ... -2017-07-28 13:20:54,677 Apex [Apex-apex-engine-service-0:3] INFO c.e.a.s.engine.runtime.EngineService - Engine AxArtifactKey:(name=MyApexEngine-3,version=0.0.1) processing ... -2017-07-28 13:20:54,680 Apex [main] INFO c.e.a.s.e.r.impl.EngineServiceImpl - Added the action listener to the engine +Starting Apex service with parameters [-c, v:/dev/ericsson/apex/onap/apex-pdp/packages/apex-pdp-package-full/target/install_hierarchy/examples/config/SampleDomain/Stdin2StdoutJsonEventJava.json] . . . +2018-09-05 15:16:42,800 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-0:0.0.1 . +2018-09-05 15:16:42,804 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-1:0.0.1 . +2018-09-05 15:16:42,804 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-2:0.0.1 . +2018-09-05 15:16:42,805 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-3:0.0.1 . +2018-09-05 15:16:42,805 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - APEX service created. +2018-09-05 15:16:43,962 Apex [main] INFO o.o.p.a.s.e.e.EngDepMessagingService - engine<-->deployment messaging starting . . . +2018-09-05 15:16:43,963 Apex [main] INFO o.o.p.a.s.e.e.EngDepMessagingService - engine<-->deployment messaging started +2018-09-05 15:16:44,987 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Registering apex model on engine MyApexEngine-0:0.0.1 +2018-09-05 15:16:45,112 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Registering apex model on engine MyApexEngine-1:0.0.1 +2018-09-05 15:16:45,113 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Registering apex model on engine MyApexEngine-2:0.0.1 +2018-09-05 15:16:45,113 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Registering apex model on engine MyApexEngine-3:0.0.1 +2018-09-05 15:16:45,120 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Added the action listener to the engine Started Apex service ---- @@ -107,23 +115,23 @@ Pasting the input event multiple times will produce output events with different [source%nowrap,json,numbered] ---- { - "nameSpace" : "org.onap.policy.apex.sample.events", - "name" : "Event0004", - "version" : "0.0.1", - "source" : "Act", - "target" : "Outside", - "TestActCaseSelected" : 1, - "TestActStateTime" : 1499280954832, - "TestTemperature" : 9080.866, - "TestDecideCaseSelected" : 2, - "TestMatchCaseSelected" : 2, - "TestTimestamp" : 1469781869269, - "TestDecideStateTime" : 1499280954831, - "TestMatchCase" : 0, - "TestSlogan" : "Test slogan for External Event0", - "TestEstablishCaseSelected" : 1, - "TestEstablishStateTime" : 1499280954831, - "TestMatchStateTime" : 1499280954828 + "name": "Event0004", + "version": "0.0.1", + "nameSpace": "org.onap.policy.apex.sample.events", + "source": "Act", + "target": "Outside", + "TestActCaseSelected": 2, + "TestActStateTime": 1536157104627, + "TestDecideCaseSelected": 0, + "TestDecideStateTime": 1536157104625, + "TestEstablishCaseSelected": 0, + "TestEstablishStateTime": 1536157104623, + "TestMatchCase": 0, + "TestMatchCaseSelected": 1, + "TestMatchStateTime": 1536157104620, + "TestSlogan": "Test slogan for External Event0", + "TestTemperature": 9080.866, + "TestTimestamp": 1469781869269 } ---- |==================== @@ -147,20 +155,20 @@ Start the REST editor as follows. ---- The script will start a simple web server (link:https://javaee.github.io/grizzly/[Grizzly]) and deploy a `war` web archive in it. -Once the editor is started, it will be available on `localhost:18988`. +Once the editor is started, it will be available on `localhost:18989`. The last few line of the messages should be: [source%nowrap,sh,numbered] ---- -Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://localhost:18988/apex/, TTL=-1sec], State=READY) starting at http://localhost:18988/apex/ . . . -Jul 28, 2017 1:22:15 PM org.glassfish.grizzly.http.server.NetworkListener start -INFO: Started listener bound to [localhost:18988] -Jul 28, 2017 1:22:15 PM org.glassfish.grizzly.http.server.HttpServer start +Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=READY) starting at http://localhost:18989/apexservices/ . . . +Sep 05, 2018 10:35:57 PM org.glassfish.grizzly.http.server.NetworkListener start +INFO: Started listener bound to [localhost:18989] +Sep 05, 2018 10:35:57 PM org.glassfish.grizzly.http.server.HttpServer start INFO: [HttpServer] Started. -Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://localhost:18988/apex/, TTL=-1sec], State=RUNNING) started at http://localhost:18988/apex/ +Apex Editor REST endpoint (ApexEditorMain: Config=[ApexEditorParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/ ---- -Now open a browser (Firefox, Chrome, Opera, Internet Explorer) and use the URL `http://localhost:18988/`. +Now open a browser (Firefox, Chrome, Opera, Internet Explorer) and use the URL `http://localhost:18989/`. This will connect the browser to the started REST editor. The start screen should be as follows. diff --git a/src/site-docs/adoc/fragments/reference-publications/5g-2015.adoc b/src/site-docs/adoc/fragments/reference-publications/5g-2015.adoc index 6013e7c98..2a954210a 100644 --- a/src/site-docs/adoc/fragments/reference-publications/5g-2015.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/5g-2015.adoc @@ -35,12 +35,12 @@ a| [source,bibtex] ---- @article{VanDerMeer2015b, - Author = {van der Meer, Sven}, - Journal = {IEEE First International 5G Summit}, - Month = {May}, - Title = {{5G \& Autonomic Networking - Challenges in closing the Loop}}, - Url = {https://ieeetv.ieee.org/mobile/video/princeton-5g-summit-sven-van-der-meer-keynote-automatic-automation}, - Year = {2015}, + Author = {van der Meer, Sven}, + Journal = {IEEE First International 5G Summit}, + Month = may, + Title = {{5G \& Autonomic Networking - Challenges in closing the Loop}}, + Year = {2015} +} ---- |=== diff --git a/src/site-docs/adoc/fragments/reference-publications/cnsm-2014.adoc b/src/site-docs/adoc/fragments/reference-publications/cnsm-2014.adoc index 27042a949..feb6e38ea 100644 --- a/src/site-docs/adoc/fragments/reference-publications/cnsm-2014.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/cnsm-2014.adoc @@ -33,19 +33,13 @@ a| [source,bibtex] ---- @inproceedings{DBLP:conf/cnsm/KeeneyMF14, - author = {John Keeney and - Sven van der Meer and - Liam Fallon}, - title = {Towards Real-time Management of - Virtualized Telecommunication Networks}, - booktitle = {10th International Conference on Network and Service Management, - {CNSM} 2014, Rio de Janeiro, Brazil, November 17-21, 2014}, + author = {John Keeney and Sven van der Meer and Liam Fallon}, + title = {Towards Real-time Management of Virtualized Telecommunication Networks}, + booktitle = {10th International Conference on Network and Service Management, {CNSM} 2014, Rio de Janeiro, Brazil, November 17-21, 2014}, pages = {388--393}, year = {2014}, crossref = {DBLP:conf/cnsm/2014}, - url = {https://doi.org/10.1109/CNSM.2014.7014200}, doi = {10.1109/CNSM.2014.7014200}, - timestamp = {Tue, 23 May 2017 01:11:56 +0200}, biburl = {http://dblp.org/rec/bib/conf/cnsm/KeeneyMF14}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/cnsm-2015.adoc b/src/site-docs/adoc/fragments/reference-publications/cnsm-2015.adoc index 01bd55d00..a90ea3351 100644 --- a/src/site-docs/adoc/fragments/reference-publications/cnsm-2015.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/cnsm-2015.adoc @@ -33,19 +33,13 @@ a| [source,bibtex] ---- @inproceedings{DBLP:conf/cnsm/MeerKF15, - author = {Sven van der Meer and - John Keeney and - Liam Fallon}, - title = {Dynamically Adaptive Policies for - Dynamically Adaptive Telecommunications Networks}, - booktitle = {11th International Conference on Network and Service Management, - {CNSM} 2015, Barcelona, Spain, November 9-13, 2015}, + author = {Sven van der Meer and John Keeney and Liam Fallon}, + title = {Dynamically Adaptive Policies for Dynamically Adaptive Telecommunications Networks}, + booktitle = {11th International Conference on Network and Service Management, {CNSM} 2015, Barcelona, Spain, November 9-13, 2015}, pages = {182--186}, year = {2015}, crossref = {DBLP:conf/cnsm/2015}, - url = {https://doi.org/10.1109/CNSM.2015.7367357}, doi = {10.1109/CNSM.2015.7367357}, - timestamp = {Tue, 23 May 2017 01:11:56 +0200}, biburl = {http://dblp.org/rec/bib/conf/cnsm/MeerKF15}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/im-2013.adoc b/src/site-docs/adoc/fragments/reference-publications/im-2013.adoc index 0c9000a02..dffe3217e 100644 --- a/src/site-docs/adoc/fragments/reference-publications/im-2013.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/im-2013.adoc @@ -33,19 +33,13 @@ a| [source,bibtex] ---- @inproceedings{DBLP:conf/im/KeeneyMH13, - author = {John Keeney and - Sven van der Meer and - Gabriel Hogan}, - title = {A Recommender-system for Telecommunications - Network Management Actions}, - booktitle = {2013 {IFIP/IEEE} International Symposium on Integrated - Network Management - {IM} 2013, Ghent, Belgium, May 27-31, 2013}, + author = {John Keeney and Sven van der Meer and Gabriel Hogan} + title = {A Recommender-system for Telecommunications Network Management Actions}, + booktitle = {2013 {IFIP/IEEE} International Symposium on Integrated Network Management {IM} 2013, Ghent, Belgium, May 27-31, 2013}, pages = {760--763}, year = {2013}, crossref = {DBLP:conf/im/2013}, url = {http://ieeexplore.ieee.org/document/6573072/}, - timestamp = {Sun, 30 Apr 2017 09:41:39 +0200}, biburl = {http://dblp.org/rec/bib/conf/im/KeeneyMH13}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/im-2017a.adoc b/src/site-docs/adoc/fragments/reference-publications/im-2017a.adoc index 0daeebbe2..634190b2d 100644 --- a/src/site-docs/adoc/fragments/reference-publications/im-2017a.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/im-2017a.adoc @@ -33,19 +33,13 @@ a| [source,bibtex] ---- @inproceedings{DBLP:conf/im/FallonKM17, - author = {Liam Fallon and - John Keeney and - Sven van der Meer}, + author = {Liam Fallon and John Keeney and Sven van der Meer}, title = {Distributed Management Information Models}, - booktitle = {2017 {IFIP/IEEE} International Symposium on Integrated - Network Management - {IM} 2017, Lisbon, Portugal, May 8-12, 2017}, + booktitle = {2017 {IFIP/IEEE} International Symposium on Integrated Network Management {IM} 2017, Lisbon, Portugal, May 8-12, 2017}, pages = {414--420}, year = {2017}, crossref = {DBLP:conf/im/2017}, - url = {https://doi.org/10.23919/INM.2017.7987306}, doi = {10.23919/INM.2017.7987306}, - timestamp = {Fri, 28 Jul 2017 12:12:57 +0200}, biburl = {http://dblp.org/rec/bib/conf/im/FallonKM17}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/im-2017b.adoc b/src/site-docs/adoc/fragments/reference-publications/im-2017b.adoc index 92a59bcd1..2294bb867 100644 --- a/src/site-docs/adoc/fragments/reference-publications/im-2017b.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/im-2017b.adoc @@ -33,22 +33,13 @@ a| [source,bibtex] ---- @inproceedings{DBLP:conf/im/FallonKMQM17, - author = {Liam Fallon and - John Keeney and - Mark McFadden and - John Quilty and - Sven van der Meer}, - title = {Using the {COMPA} Autonomous Architecture - for Mobile Network Security}, - booktitle = {2017 {IFIP/IEEE} International Symposium on Integrated - Network Management - {IM} 2017, Lisbon, Portugal, May 8-12, 2017}, + author = {Liam Fallon and John Keeney and Mark McFadden and John Quilty and Sven van der Meer}, + title = {Using the {COMPA} Autonomous Architecture for Mobile Network Security}, + booktitle = {2017 {IFIP/IEEE} International Symposium on Integrated Network Management {IM} 2017, Lisbon, Portugal, May 8-12, 2017}, pages = {747--753}, year = {2017}, crossref = {DBLP:conf/im/2017}, - url = {https://doi.org/10.23919/INM.2017.7987370}, doi = {10.23919/INM.2017.7987370}, - timestamp = {Fri, 28 Jul 2017 12:12:57 +0200}, biburl = {http://dblp.org/rec/bib/conf/im/FallonKMQM17}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/monami-2013.adoc b/src/site-docs/adoc/fragments/reference-publications/monami-2013.adoc index 157ed86dd..94a4d9104 100644 --- a/src/site-docs/adoc/fragments/reference-publications/monami-2013.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/monami-2013.adoc @@ -26,28 +26,20 @@ h| Abstract | The explosion in consumer devices has resulted in a significant increase in the number of mobile telecommunications nodes. As a result of increased device and node numbers, network operators have experienced a large increase in associated events. In such an environment, scalability and performance of event handling become important aspects for Operation Support Systems (OSS). A traditional approach has been to centralize monitoring and decision functions. The scale of events in a modern mobile telecommunications network means such centralized implementations are performance limited. What is required is a remodeling of Complex Event Processing (monitoring) and Policies (decision making) towards a distributed yet coordinated system. This paper describes an extensible architecture for such a distributed policy-based event processing system. Our approach provides a pluggable mechanism into which various event handling functionality can be integrated. In order to illustrate the applicability of our approach we evaluate the performance of 2 message queuing protocols, Advanced Message Queuing Protocol (AMQP) based RabbitMQ and Java Web Sockets. Our performance evaluation illustrates the ability of our architecture to transparently integrate alternative event processing technologies. h| Links -| ### +| link:https://www.researchgate.net/publication/259785930_Cloudifying_Mobile_Network_Management_Performance_Tests_of_Event_Distribution_and_Rule_Processing[ResarchGate] [accessed Aug 11, 2017] h| BibTeX a| [source,bibtex] ---- @inproceedings{DBLP:conf/monami/DawarMKFB13, - author = {Sumit Dawar and - Sven van der Meer and - John Keeney and - Enda Fallon and - Tom Bennet}, - title = {Cloudifying Mobile Network Management: Performance Tests - of Event Distribution and Rule Processing}, - booktitle = {Mobile Networks and Management - 5th International Conference, - {MONAMI} 2013, Cork, Ireland, September 23-25, 2013}, + author = {Sumit Dawar and Sven van der Meer and John Keeney and Enda Fallon and Tom Bennet}, + title = {Cloudifying Mobile Network Management: Performance Tests of Event Distribution and Rule Processing}, + booktitle = {Mobile Networks and Management - 5th International Conference, {MONAMI} 2013, Cork, Ireland, September 23-25, 2013}, pages = {94--107}, year = {2013}, crossref = {DBLP:conf/monami/2013}, - url = {https://doi.org/10.1007/978-3-319-04277-0_8}, doi = {10.1007/978-3-319-04277-0_8}, - timestamp = {Wed, 24 May 2017 08:27:31 +0200}, biburl = {http://dblp.org/rec/bib/conf/monami/DawarMKFB13}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/noms-2016.adoc b/src/site-docs/adoc/fragments/reference-publications/noms-2016.adoc index ee3dceea7..b38278d70 100644 --- a/src/site-docs/adoc/fragments/reference-publications/noms-2016.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/noms-2016.adoc @@ -33,18 +33,13 @@ a| [source,bibtex] ---- @inproceedings{DBLP:conf/noms/FallonMK16, - author = {Liam Fallon and - Sven van der Meer and - John Keeney}, + author = {Liam Fallon and Sven van der Meer and John Keeney}, title = {Apex: An Engine for Dynamic Adaptive Policy Execution}, - booktitle = {2016 {IEEE/IFIP} Network Operations and Management Symposium, - {NOMS} 2016, Istanbul, Turkey, April 25-29, 2016}, + booktitle = {2016 {IEEE/IFIP} Network Operations and Management Symposium, {NOMS} 2016, Istanbul, Turkey, April 25-29, 2016}, pages = {699--702}, year = {2016}, crossref = {DBLP:conf/noms/2016}, - url = {https://doi.org/10.1109/NOMS.2016.7502880}, doi = {10.1109/NOMS.2016.7502880}, - timestamp = {Fri, 19 May 2017 01:26:25 +0200}, biburl = {http://dblp.org/rec/bib/conf/noms/FallonMK16}, bibsource = {dblp computer science bibliography, http://dblp.org} } diff --git a/src/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc b/src/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc index b7558da4e..d580fb387 100644 --- a/src/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc @@ -23,37 +23,26 @@ h| Venue | IEEE NOMS, Taipei, April 2018 h| Abstract -| Since the 1970’s it has been acknowledged that a -complex system can be broken into (a) its invariant functional -parts (mechanism), and (b) the externalized choices for how the -system should behave (policy). Policy-based management’s main -objective is to separate and externalize the decisions required by a -system from the mechanisms provided by the system, and provide -a way to define and evaluate these decisions. A few decades later, -we have today a plethora of different policy models and even more -policy languages – plus tooling – offering policy-based solutions -for virtually any use case and scenario. However, policy-based -management as a standalone domain has never been evaluated -in terms of which parts are variant / invariant, i.e. which parts -of policy-based management can be domain-, model-, language-, -usecase-independent. In this paper, we introduce and define a -formal universal policy model that does exactly that. The result -is a model that can be used to design, implement, and deploy -immutable policy infrastructure (engine and executor) being able -to execute (virtually) any policy model. +| Since the 1970’s it has been acknowledged that a complex system can be broken into (a) its invariant functional parts (mechanism), and (b) the externalized choices for how the system should behave (policy). Policy-based management’s main objective is to separate and externalize the decisions required by a system from the mechanisms provided by the system, and provide a way to define and evaluate these decisions. A few decades later, we have today a plethora of different policy models and even more policy languages – plus tooling – offering policy-based solutions for virtually any use case and scenario. However, policy-based management as a standalone domain has never been evaluated in terms of which parts are variant / invariant, i.e. which parts of policy-based management can be domain-, model-, language-, usecase-independent. In this paper, we introduce and define a formal universal policy model that does exactly that. The result is a model that can be used to design, implement, and deploy immutable policy infrastructure (engine and executor) being able to execute (virtually) any policy model. + +h| Links +| link:https://www.researchgate.net/publication/325057975_Taming_Policy_Complexity_Model_to_Execution[Research Gate] [accessed Sep 4, 2018] h| BibTeX a| [source,bibtex] ---- -@inproceedings{noms/MeerMK18a, - author = {Sven van der Meer and - John Keeney and - Liam Fallon}, - title = {Taming Policy Complexity: Model to Execution}, - booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, - {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, - year = {2018} +@inproceedings{DBLP:conf/noms/MeerKF18, + author = {Sven van der Meer and John Keeney and Liam Fallon}, + title = {Taming policy complexity: Model to execution}, + booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, + pages = {1--8}, + year = {2018}, + crossref = {DBLP:conf/noms/2018}, + doi = {10.1109/NOMS.2018.8406172}, + biburl = {https://dblp.org/rec/bib/conf/noms/MeerKF18}, + bibsource = {dblp computer science bibliography, https://dblp.org} +} ---- |=== diff --git a/src/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc b/src/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc index 2500e70b1..2c22158fd 100644 --- a/src/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc @@ -23,33 +23,26 @@ h| Venue | IEEE NOMS, Taipei, April 2018 h| Abstract -| 5G networks will be the first real converged networks -supporting a plethora of different services, each with their -own requirements. A static best-effort approach is no longer -sufficient. Extreme flexibility and dynamicity is required, yet costs -must be drastically reduced. The only way that these conflicting -goals can be achieved is with vastly increased automation in the -provision and operation of our future 5G networks. In this paper -we briefly discuss the facilitators, goals and challenges for 5G -networks. We identify some of the places where automation is not -just helpful, but is in fact required for 5G to become a reality. -We go on to present a conceptual approach for modeling and -achieving autonomic operations and management in 5G networks -positioning modern policy-based management as a key enabler -for autonomic 5G network management. +| 5G networks will be the first real converged networks supporting a plethora of different services, each with their own requirements. A static best-effort approach is no longer sufficient. Extreme flexibility and dynamicity is required, yet costs must be drastically reduced. The only way that these conflicting goals can be achieved is with vastly increased automation in the provision and operation of our future 5G networks. In this paper we briefly discuss the facilitators, goals and challenges for 5G networks. We identify some of the places where automation is not just helpful, but is in fact required for 5G to become a reality. We go on to present a conceptual approach for modeling and achieving autonomic operations and management in 5G networks positioning modern policy-based management as a key enabler for autonomic 5G network management. + +h| Links +| link:https://www.researchgate.net/publication/325057790_5G_Networks_Must_Be_Autonomic?_iepl%5BgeneralViewId%5D=NFUJVNL9bfZcUhlhGPKG13VvHQDRMJhMCBbY&_iepl%5Bcontexts%5D%5B0%5D=searchReact&_iepl%5BviewId%5D=K8kQ3zeC2xUNNSJwMYtpD849IAOlx6jPYj2I&_iepl%5BsearchType%5D=publication&_iepl%5Bdata%5D%5BcountLessEqual20%5D=1&_iepl%5Bdata%5D%5BinteractedWithPosition1%5D=1&_iepl%5Bdata%5D%5BwithEnrichment%5D=1&_iepl%5Bposition%5D=1&_iepl%5BrgKey%5D=PB%3A325057790&_iepl%5BtargetEntityId%5D=PB%3A325057790&_iepl%5BinteractionType%5D=publicationTitle[Research Gate] [accessed Sep 4, 2018] h| BibTeX a| [source,bibtex] ---- -@inproceedings{noms/MeerMK18b, - author = {Sven van der Meer and - John Keeney and - Liam Fallon}, - title = {5G Networks Must Be Autonomic!}, - booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, - {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, - year = {2018} +@inproceedings{DBLP:conf/noms/MeerKF18a, + author = {Sven van der Meer and John Keeney and Liam Fallon}, + title = {5G networks must be autonomic!}, + booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, + pages = {1--5}, + year = {2018}, + crossref = {DBLP:conf/noms/2018}, + doi = {10.1109/NOMS.2018.8406185}, + biburl = {https://dblp.org/rec/bib/conf/noms/MeerKF18a}, + bibsource = {dblp computer science bibliography, https://dblp.org} +} ---- |=== diff --git a/src/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc b/src/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc index 96803d828..f3107c015 100644 --- a/src/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc +++ b/src/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc @@ -30,20 +30,23 @@ There is no substitute for seeing how a network management feature actually perf In this work we present our experiences of building a networking testbed that incorporates an emulated network, a production-grade network controller, an analytics function, and a policy execution environment. This allows users to develop policies for adaptive (closed loop) management of a realistic emulated network. We also present two scenarios where the testbed is used to emulate and mitigate against a temporary and prolonged failure occurring on a network. +h| Links +| link:https://www.researchgate.net/publication/325059988_A_Testbed_For_Policy_Driven_Closed_Loop_Network_Management[Research Gate] [accessed Sep 4, 2018] + h| BibTeX a| [source,bibtex] ---- -@inproceedings{noms/McNamaraMK18, - author = {Joseph McNamara and - John Keeney and - Liam Fallon and - Sven van der Meer and - Enda Fallon}, - title = {A Testbed For Policy Driven Closed Loop Network Management}, - booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, - {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, - year = {2018} +@inproceedings{DBLP:conf/noms/McNamaraKFMF18, + author = {Joseph McNamara and John Keeney and Liam Fallon and Sven van der Meer and Enda Fallon}, + title = {A testbed for policy driven closed loop network management}, + booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, + pages = {1--6}, + year = {2018}, + crossref = {DBLP:conf/noms/2018}, + doi = {10.1109/NOMS.2018.8406144}, + biburl = {https://dblp.org/rec/bib/conf/noms/McNamaraKFMF18}, + bibsource = {dblp computer science bibliography, https://dblp.org} } ---- diff --git a/src/site-docs/adoc/fragments/reference-publications/noms-2018d.adoc b/src/site-docs/adoc/fragments/reference-publications/noms-2018d.adoc new file mode 100755 index 000000000..2039de492 --- /dev/null +++ b/src/site-docs/adoc/fragments/reference-publications/noms-2018d.adoc @@ -0,0 +1,51 @@ +// +// ============LICENSE_START======================================================= +// Copyright (C) 2016-2018 Ericsson. All rights reserved. +// ================================================================================ +// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +// +// SPDX-License-Identifier: CC-BY-4.0 +// ============LICENSE_END========================================================= +// +// @author Sven van der Meer (sven.van.der.meer@ericsson.com) +// + +== APEX Demo (NOMS'18) + +[width="100%",cols="15%,90%"] +|=== + +h| Title +e| Demo: Adaptive policy execution (APEX) + +h| Venue +| IEEE NOMS, Taipei, April 2018 + +h| Abstract +| This demo focuses on demonstrating features of the Adaptive Policy Execution (APEX) system. APEX is a carrier-grade, production ready, scalable policy engine implementing, based on published theory, universal and immutable policy infrastructure. The demo will showcase the main APEX features, from authoring via deployment to runtime; with three demo use cases. All software and features are available on Github. + +h| Links +| link:https://www.researchgate.net/publication/325058016_Demo_Adaptive_Policy_Execution_APEX[Research Gate] [accessed Sep 4, 2018] + +h| BibTeX +a| +[source,bibtex] +---- +@inproceedings{DBLP:conf/noms/MeerKFM18, + author = {Sven van der Meer and John Keeney and Liam Fallon and Joseph McNamara}, + title = {Demo: Adaptive policy execution {(APEX)}}, + booktitle = {2018 {IEEE/IFIP} Network Operations and Management Symposium, {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, + pages = {1--2}, + year = {2018}, + crossref = {DBLP:conf/noms/2018}, + url = {https://doi.org/10.1109/NOMS.2018.8406117}, + doi = {10.1109/NOMS.2018.8406117}, + timestamp = {Tue, 10 Jul 2018 16:33:52 +0200}, + biburl = {https://dblp.org/rec/bib/conf/noms/MeerKFM18}, + bibsource = {dblp computer science bibliography, https://dblp.org} +} +---- + +|=== + diff --git a/src/site-docs/adoc/fragments/reference-publications/noms-2018e.adoc b/src/site-docs/adoc/fragments/reference-publications/noms-2018e.adoc new file mode 100755 index 000000000..00bd7b43c --- /dev/null +++ b/src/site-docs/adoc/fragments/reference-publications/noms-2018e.adoc @@ -0,0 +1,44 @@ +// +// ============LICENSE_START======================================================= +// Copyright (C) 2016-2018 Ericsson. All rights reserved. +// ================================================================================ +// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +// +// SPDX-License-Identifier: CC-BY-4.0 +// ============LICENSE_END========================================================= +// +// @author Sven van der Meer (sven.van.der.meer@ericsson.com) +// + +== NOMS 2018, Keynote #6 + +[width="100%",cols="15%,90%"] +|=== + +h| Title +e| What do we actually manage in 5G? - And what is missing? + +h| Venue +| IEEE NOMS, Taipei, April 2018 + +h| Abstract +| We are at the crossroads of yet another technology shift. Networks evolved continuously from TDM to IP, legacy to SDN, PNF to VNF as part of virtualization and now microservices/containers/K8s. All these technologies play a vital role in the evolution of 5G and the future networks will deliver services to many vertical industries. Distributed cloud is key to deliver services that require low latency and high bandwidth. Orchestration and adaptive Policy decisions will be key for automation in 5G networks. In this keynote, we will discuss the requirements and challenges for managing this – massive scale, dynamic, and complex – new environment. We will see what efforts are underway and planned for 5 G management, including open source initiatives such as ONAP. Finally, we will explore what is missing today to tame the 5G management complexity. + +h| Links +| link:http://noms2018.ieee-noms.org/content/keynotes[Event], link:https://www.researchgate.net/publication/325057988_What_do_we_actually_manage_in_5G_And_what_is_missing[Research Gate] [accessed Sep 4, 2018] + +h| BibTeX +a| +[source,bibtex] +---- +@online{vandermeer-noms2018-e, + author = {Sven van der Meer}, + title = {What do we actually manage in 5G? - And what is missing?}, + howpublished = {Keynote, 2018 {IEEE/IFIP} Network Operations and Management Symposium, {NOMS} 2018, Taipei, Taiwan, April 23-27, 2018}, + year = {2018} +} +---- + +|=== + diff --git a/src/site-docs/adoc/fragments/screens/mvn-install-skiptests.txt b/src/site-docs/adoc/fragments/screens/mvn-install-skiptests.txt index eaf1c1351..a85af55b6 100644 --- a/src/site-docs/adoc/fragments/screens/mvn-install-skiptests.txt +++ b/src/site-docs/adoc/fragments/screens/mvn-install-skiptests.txt @@ -1,13 +1,13 @@ -[INFO] apex-apps.uservice ................................. SUCCESS [ 0.054 s] -[INFO] apex-apps.uservice-packaging ....................... SUCCESS [ 0.058 s] -[INFO] apex-apps.uservice-package-minimal ................. SUCCESS [ 7.138 s] -[INFO] apex-apps.uservice-package-full .................... SUCCESS [ 58.960 s] -[INFO] apex-apps.uservice-packages ........................ SUCCESS [ 1.781 s] -[INFO] apex-apps.servlet .................................. SUCCESS [ 3.465 s] +[INFO] tools .............................................. SUCCESS [ 0.248 s] +[INFO] tools-common ....................................... SUCCESS [ 0.784 s] +[INFO] simple-wsclient .................................... SUCCESS [ 3.303 s] +[INFO] model-generator .................................... SUCCESS [ 0.644 s] +[INFO] packages ........................................... SUCCESS [ 0.336 s] +[INFO] apex-pdp-package-full .............................. SUCCESS [01:10 min] +[INFO] Policy APEX PDP - Docker build 2.0.0-SNAPSHOT ...... SUCCESS [ 10.307 s] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ -[INFO] Total time: 02:48 min -[INFO] Finished at: 2018-01-04T12:20:45+00:00 -[INFO] Final Memory: 164M/1648M +[INFO] Total time: 03:43 min +[INFO] Finished at: 2018-09-03T11:56:01+01:00 [INFO] ------------------------------------------------------------------------
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/screens/mvn-install.txt b/src/site-docs/adoc/fragments/screens/mvn-install.txt deleted file mode 100644 index 6e5f9c1e9..000000000 --- a/src/site-docs/adoc/fragments/screens/mvn-install.txt +++ /dev/null @@ -1,13 +0,0 @@ -[INFO] apex-apps.uservice ................................. SUCCESS [ 0.027 s] -[INFO] apex-apps.uservice-packaging ....................... SUCCESS [ 0.008 s] -[INFO] apex-apps.uservice-package-minimal ................. SUCCESS [ 6.934 s] -[INFO] apex-apps.uservice-package-full .................... SUCCESS [ 55.667 s] -[INFO] apex-apps.uservice-packages ........................ SUCCESS [ 1.833 s] -[INFO] apex-apps.servlet .................................. SUCCESS [ 2.383 s] -[INFO] ------------------------------------------------------------------------ -[INFO] BUILD SUCCESS -[INFO] ------------------------------------------------------------------------ -[INFO] Total time: 05:34 min -[INFO] Finished at: 2018-01-04T13:49:16+00:00 -[INFO] Final Memory: 164M/1595M -[INFO] ------------------------------------------------------------------------
\ No newline at end of file diff --git a/src/site-docs/adoc/fragments/screens/target-ls-unix.txt b/src/site-docs/adoc/fragments/screens/target-ls-unix.txt index 99973f795..1e1d4ecc6 100644 --- a/src/site-docs/adoc/fragments/screens/target-ls-unix.txt +++ b/src/site-docs/adoc/fragments/screens/target-ls-unix.txt @@ -1,12 +1,15 @@ --rwxrwx---+ 1 esvevan Domain Users 706 Jan 4 10:44 apex-apps.uservice-package-full_0.7.0_all.changes --rwxrwx---+ 1 esvevan Domain Users 32694 Jan 4 10:43 apex-apps.uservice-package-full-0.7.0.jar --rwxrwx---+ 1 esvevan Domain Users 255629634 Jan 4 10:44 apex-uservice-full-0.7.0.deb --rwxrwx---+ 1 esvevan Domain Users 255613724 Jan 4 10:43 apex-uservice-full-0.7.0-tarball.tar.gz -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 archive-tmp/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 classes/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 dependency-maven-plugin-markers/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 etc/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 examples/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 install_hierarchy/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 lib/ -drwxrwx---+ 1 esvevan Domain Users 0 Jan 4 10:43 maven-archiver/
\ No newline at end of file +-rwxrwx---+ 1 esvevan Domain Users 772 Sep 3 11:55 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes* +-rwxrwx---+ 1 esvevan Domain Users 146328082 Sep 3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT.deb* +-rwxrwx---+ 1 esvevan Domain Users 15633 Sep 3 11:54 apex-pdp-package-full-2.0.0-SNAPSHOT.jar* +-rwxrwx---+ 1 esvevan Domain Users 146296819 Sep 3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz* +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:54 archive-tmp/ +-rwxrwx---+ 1 esvevan Domain Users 89 Sep 3 11:54 checkstyle-cachefile* +-rwxrwx---+ 1 esvevan Domain Users 10621 Sep 3 11:54 checkstyle-checker.xml* +-rwxrwx---+ 1 esvevan Domain Users 584 Sep 3 11:54 checkstyle-header.txt* +-rwxrwx---+ 1 esvevan Domain Users 86 Sep 3 11:54 checkstyle-result.xml* +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:54 classes/ +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:54 dependency-maven-plugin-markers/ +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:54 etc/ +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:54 examples/ +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:55 install_hierarchy/ +drwxrwx---+ 1 esvevan Domain Users 0 Sep 3 11:54 maven-archiver/ diff --git a/src/site-docs/adoc/fragments/screens/target-ls-win.txt b/src/site-docs/adoc/fragments/screens/target-ls-win.txt index 7a78d07dd..1addb2920 100644 --- a/src/site-docs/adoc/fragments/screens/target-ls-win.txt +++ b/src/site-docs/adoc/fragments/screens/target-ls-win.txt @@ -1,16 +1,19 @@ -04/01/2018 11:51 <DIR> . -04/01/2018 11:51 <DIR> .. -04/01/2018 10:43 32,694 apex-apps.uservice-package-full-0.7.0.jar -04/01/2018 10:44 706 apex-apps.uservice-package-full_0.7.0_all.changes -04/01/2018 10:43 255,613,724 apex-uservice-full-0.7.0-tarball.tar.gz -04/01/2018 10:44 255,629,634 apex-uservice-full-0.7.0.deb -04/01/2018 10:43 <DIR> archive-tmp -04/01/2018 10:43 <DIR> classes -04/01/2018 10:43 <DIR> dependency-maven-plugin-markers -04/01/2018 10:43 <DIR> etc -04/01/2018 10:43 <DIR> examples -04/01/2018 10:43 <DIR> install_hierarchy -04/01/2018 10:43 <DIR> lib -04/01/2018 10:43 <DIR> maven-archiver - 4 File(s) 511,276,758 bytes - 10 Dir(s) 6,230,409,216 bytes free
\ No newline at end of file +03/09/2018 11:55 <DIR> . +03/09/2018 11:55 <DIR> .. +03/09/2018 11:55 146,296,819 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz +03/09/2018 11:55 146,328,082 apex-pdp-package-full-2.0.0-SNAPSHOT.deb +03/09/2018 11:54 15,633 apex-pdp-package-full-2.0.0-SNAPSHOT.jar +03/09/2018 11:55 772 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes +03/09/2018 11:54 <DIR> archive-tmp +03/09/2018 11:54 89 checkstyle-cachefile +03/09/2018 11:54 10,621 checkstyle-checker.xml +03/09/2018 11:54 584 checkstyle-header.txt +03/09/2018 11:54 86 checkstyle-result.xml +03/09/2018 11:54 <DIR> classes +03/09/2018 11:54 <DIR> dependency-maven-plugin-markers +03/09/2018 11:54 <DIR> etc +03/09/2018 11:54 <DIR> examples +03/09/2018 11:55 <DIR> install_hierarchy +03/09/2018 11:54 <DIR> maven-archiver + 8 File(s) 292,652,686 bytes + 9 Dir(s) 14,138,720,256 bytes free
\ No newline at end of file diff --git a/src/site-docs/adoc/guides/APEX-Install-Guide.adoc b/src/site-docs/adoc/guides/APEX-Install-Guide.adoc index e3a9891b0..f9afb77c6 100644 --- a/src/site-docs/adoc/guides/APEX-Install-Guide.adoc +++ b/src/site-docs/adoc/guides/APEX-Install-Guide.adoc @@ -45,8 +45,6 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/configure.adoc include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/verify.adoc[] -include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-monitoring.adoc[] - -include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-resteditor.adoc[] +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-wars.adoc[] include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/docker.adoc[] diff --git a/src/site-docs/adoc/guides/APEX-User-Manual.adoc b/src/site-docs/adoc/guides/APEX-User-Manual.adoc index f732c4397..7a390361d 100644 --- a/src/site-docs/adoc/guides/APEX-User-Manual.adoc +++ b/src/site-docs/adoc/guides/APEX-User-Manual.adoc @@ -49,9 +49,7 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/configure.adoc include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/verify.adoc[leveloffset=+1] -include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-monitoring.adoc[leveloffset=+1] - -include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-resteditor.adoc[leveloffset=+1] +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-wars.adoc[leveloffset=+1] include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/docker.adoc[leveloffset=+1] diff --git a/src/site-docs/adoc/guides/HowTo-Codestyle.adoc b/src/site-docs/adoc/guides/HowTo-Codestyle.adoc index f84a64662..3dd8cc382 100644 --- a/src/site-docs/adoc/guides/HowTo-Codestyle.adoc +++ b/src/site-docs/adoc/guides/HowTo-Codestyle.adoc @@ -62,4 +62,3 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/42-using-che include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/50-disable-eclispe-formatting.adoc[] include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/51-supress-checkstyle.adoc[] -
\ No newline at end of file diff --git a/src/site-docs/adoc/resources/images/install-guide/monitoring-app-status.png b/src/site-docs/adoc/resources/images/install-guide/monitoring-app-status.png Binary files differdeleted file mode 100644 index 421edd350..000000000 --- a/src/site-docs/adoc/resources/images/install-guide/monitoring-app-status.png +++ /dev/null diff --git a/src/site-docs/adoc/resources/images/install-guide/monitoring-app.png b/src/site-docs/adoc/resources/images/install-guide/monitoring-app.png Binary files differdeleted file mode 100644 index c18c3c877..000000000 --- a/src/site-docs/adoc/resources/images/install-guide/monitoring-app.png +++ /dev/null diff --git a/src/site-docs/adoc/resources/images/install-guide/rest-loaded.png b/src/site-docs/adoc/resources/images/install-guide/rest-loaded.png Binary files differindex 7b4b9e5d6..3d0056618 100644 --- a/src/site-docs/adoc/resources/images/install-guide/rest-loaded.png +++ b/src/site-docs/adoc/resources/images/install-guide/rest-loaded.png diff --git a/src/site-docs/adoc/resources/images/install-guide/rest-start.png b/src/site-docs/adoc/resources/images/install-guide/rest-start.png Binary files differindex c76f0c1ca..dd515c6a8 100644 --- a/src/site-docs/adoc/resources/images/install-guide/rest-start.png +++ b/src/site-docs/adoc/resources/images/install-guide/rest-start.png diff --git a/src/site-docs/adoc/resources/images/install-guide/tomcat-installed.png b/src/site-docs/adoc/resources/images/install-guide/tomcat-installed.png Binary files differdeleted file mode 100644 index f50e9278e..000000000 --- a/src/site-docs/adoc/resources/images/install-guide/tomcat-installed.png +++ /dev/null diff --git a/src/site-docs/adoc/resources/images/install-guide/win-extract-tar-gz.png b/src/site-docs/adoc/resources/images/install-guide/win-extract-tar-gz.png Binary files differindex 00d5e3557..55d7e7dd5 100644 --- a/src/site-docs/adoc/resources/images/install-guide/win-extract-tar-gz.png +++ b/src/site-docs/adoc/resources/images/install-guide/win-extract-tar-gz.png diff --git a/src/site-docs/adoc/resources/images/install-guide/win-extract-tar.png b/src/site-docs/adoc/resources/images/install-guide/win-extract-tar.png Binary files differindex c69960cac..ba76fa338 100644 --- a/src/site-docs/adoc/resources/images/install-guide/win-extract-tar.png +++ b/src/site-docs/adoc/resources/images/install-guide/win-extract-tar.png diff --git a/src/site-docs/adoc/resources/images/install-guide/win-extracted.png b/src/site-docs/adoc/resources/images/install-guide/win-extracted.png Binary files differdeleted file mode 100644 index 7b5ba841e..000000000 --- a/src/site-docs/adoc/resources/images/install-guide/win-extracted.png +++ /dev/null diff --git a/src/site-docs/logos/ApexLogo.png b/src/site-docs/logos/ApexLogo.png Binary files differnew file mode 100755 index 000000000..c1936b399 --- /dev/null +++ b/src/site-docs/logos/ApexLogo.png diff --git a/src/site-docs/logos/ApexLogo_s.png b/src/site-docs/logos/ApexLogo_s.png Binary files differnew file mode 100755 index 000000000..22372675d --- /dev/null +++ b/src/site-docs/logos/ApexLogo_s.png diff --git a/src/site-docs/logos/NMLabLogo.png b/src/site-docs/logos/NMLabLogo.png Binary files differnew file mode 100755 index 000000000..efc964560 --- /dev/null +++ b/src/site-docs/logos/NMLabLogo.png diff --git a/src/site-docs/logos/NMLabLogo_s.png b/src/site-docs/logos/NMLabLogo_s.png Binary files differnew file mode 100755 index 000000000..749503707 --- /dev/null +++ b/src/site-docs/logos/NMLabLogo_s.png diff --git a/src/site-docs/logos/Onaplogo.png b/src/site-docs/logos/Onaplogo.png Binary files differnew file mode 100755 index 000000000..36ee1f51c --- /dev/null +++ b/src/site-docs/logos/Onaplogo.png diff --git a/src/site-docs/logos/Onaplogo_s.png b/src/site-docs/logos/Onaplogo_s.png Binary files differnew file mode 100755 index 000000000..ed03003d4 --- /dev/null +++ b/src/site-docs/logos/Onaplogo_s.png diff --git a/src/site-docs/logos/logos.svgz b/src/site-docs/logos/logos.svgz Binary files differnew file mode 100755 index 000000000..75ad854fd --- /dev/null +++ b/src/site-docs/logos/logos.svgz diff --git a/src/site/asciidoc/apex-publications.adoc b/src/site/asciidoc/apex-publications.adoc index dbf5ce8eb..6c030aeb4 100644 --- a/src/site/asciidoc/apex-publications.adoc +++ b/src/site/asciidoc/apex-publications.adoc @@ -25,6 +25,8 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-20 include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc[leveloffset=+1] +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018d.adoc[leveloffset=+1] + include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc[leveloffset=+1] @@ -43,3 +45,4 @@ include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/5g-20 include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc[leveloffset=+1] +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018e.adoc[leveloffset=+1] diff --git a/src/site/asciidoc/user-manual/install/um-install-resteditor.adoc b/src/site/asciidoc/user-manual/install/um-install-resteditor.adoc deleted file mode 100644 index 1d2741ab5..000000000 --- a/src/site/asciidoc/user-manual/install/um-install-resteditor.adoc +++ /dev/null @@ -1,14 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-resteditor.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-monitoring.adoc b/src/site/asciidoc/user-manual/install/um-install-wars.adoc index 79889ec97..1640bc957 100644 --- a/src/site/asciidoc/user-manual/install/um-install-monitoring.adoc +++ b/src/site/asciidoc/user-manual/install/um-install-wars.adoc @@ -11,4 +11,4 @@ // @author Sven van der Meer (sven.van.der.meer@ericsson.com) // -include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-monitoring.adoc[] +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-wars.adoc[] diff --git a/src/site/site.xml b/src/site/site.xml index 20d77ae4e..11ae2c15a 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -36,8 +36,7 @@ <item href="user-manual/install/um-install-layout.html" name="Final Layout" /> <item href="user-manual/install/um-install-configure.html" name="System Configuration" /> <item href="user-manual/install/um-install-verify.html" name="Verify Installation" /> - <item href="user-manual/install/um-install-monitoring.html" name="Install Monitoring" /> - <item href="user-manual/install/um-install-resteditor.html" name="Install REST Editor" /> + <item href="user-manual/install/um-install-wars.html" name="Install WARs" /> <item href="user-manual/install/um-install-docker.html" name="APEX in Docker" /> </item> diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index fe215c5dc..a18539b3c 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -140,7 +140,7 @@ <li><a href="modules/examples/examples-pcvs/index.html">examples-pcvs</a> - An example policy for managing customers and link failures showing video streaming for a simple VPN scenario</li> <li><a href="modules/examples/examples-onap-vcpe/index.html">examples-onap-vcpe</a> - An example policy for managing vCPE's in ONAP</li> <li><a href="modules/examples/examples-periodic/index.html">examples-periodic</a> - An example periodic policy</li> - <li><a href="modules/examples/examples-servlet/index.html">examples-aadm</a> - An APEX Servlet Example</li> + <li><a href="modules/examples/examples-servlet/index.html">examples-servlet</a> - An APEX Servlet Example</li> <li><a href="modules/examples/examples-adaptive/index.html">examples-adaptive</a> - A simple adaptive policy</li> <li><a href="modules/examples/examples-aadm/index.html">examples-aadm</a> - A policy realizing a complex scenario for Autonomic Anomaly Detection and Mitigation (AADM)</li> </ul> @@ -307,9 +307,10 @@ </td> </tr> <tr> - <td><a href="https://github.com/Ericsson/apex/issues">APEX Issue Management (Github)</a></td> + <td><a href="https://jira.onap.org/projects/POLICY/issues">APEX Issue Management (ONAP, JIRA)</a></td> <td> Issues with the APEX software and integrated documentation are managed here. + This link requires a Linux Foundation ID. </td> </tr> </table> |
