diff options
Diffstat (limited to 'src/site-docs/adoc/fragments/howto-apex')
9 files changed, 49 insertions, 40 deletions
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. |