| ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame] | 1 | // |
| 2 | // ============LICENSE_START======================================================= |
| 3 | // Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 4 | // ================================================================================ |
| 5 | // This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 6 | // Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 7 | // |
| 8 | // SPDX-License-Identifier: CC-BY-4.0 |
| 9 | // ============LICENSE_END========================================================= |
| 10 | // |
| 11 | // @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 12 | // |
| 13 | |
| 14 | == The APEX Deployment Client |
| 15 | The standard way to use the APEX Deployment Client is via an installation of the __war__ file on a webserver. |
| 16 | However, the Deployment Client can also be started via command line. |
| 17 | This will start a Grizzly webserver with the __war__ deployed. |
| 18 | Access to the Deployment Client is then via the provided URL |
| 19 | |
| 20 | On UNIX and Cygwin systems use: |
| 21 | |
| 22 | - `apexApps.sh eng-deployment` - simply starts the webserver with the Deployment Client |
| 23 | |
| 24 | On Windows systems use: |
| 25 | |
| 26 | - `apexApps.bat eng-deployment` - simply starts the webserver with the Deployment Client |
| 27 | |
| 28 | |
| 29 | The option `-h` provides a help screen with all command line arguments. |
| 30 | |
| 31 | [source%nowrap,sh] |
| 32 | ---- |
| 33 | usage: org.onap.policy.apex.services.client.deployment.rest.ApexDeploymentRestMain [options...] |
| 34 | -h,--help outputs the usage of this command |
| 35 | -p,--port <PORT> port to use for the Apex Services REST calls |
| 36 | -t,--time-to-live <TIME_TO_LIVE> the amount of time in seconds that the server will run for before terminating |
| 37 | ---- |
| 38 | |
| 39 | If the Deployment Client is started without any arguments the final messages will look similar to this: |
| 40 | |
| 41 | [source%nowrap,sh] |
| 42 | ---- |
| 43 | INFO: [HttpServer] Started. |
| 44 | Apex Services REST endpoint (ApexDeploymentRestMain: Config=[ApexDeploymentRestParameters: URI=http://localhost:18989/apexservices/, TTL=-1sec], State=RUNNING) started at http://localhost:18989/apexservices/ |
| 45 | ---- |
| 46 | |
| 47 | The last line states the URL on which the Deployment Client can be accessed. |
| 48 | The example above stated `http://localhost:18989/apexservices`. |
| 49 | In a web browser use the URL `http://localhost:18989`. |
| 50 | |