diff options
| author |   Chengkai Yan <martin.c.yan@est.tech> | 2018-11-06 16:32:03 +0100 |
|---|---|---|
| committer | Chengkai Yan <martin.c.yan@est.tech> | 2018-11-06 17:45:54 +0100 |
| commit | 7f278e30bef4a7a7cc7a4744d4bd3b3beb4ea5c1 (patch) | |
| tree | bce49c2fa73c96a30dab6c3a56b0006d096b59a4 /docs/sections/services/dfc/administration.rst | |
| parent | 91e472c8640d9d6364c311474b15e9c9a95a0e9f (diff) | |
Update DFC documentation
Change-Id: I95befc4a6b597f67672797d44561de41af9c480d
Signed-off-by: Chengkai Yan <martin.c.yan@est.tech>
Issue-ID: DCAEGEN2-876
Diffstat (limited to 'docs/sections/services/dfc/administration.rst')
| -rw-r--r-- | docs/sections/services/dfc/administration.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/sections/services/dfc/administration.rst b/docs/sections/services/dfc/administration.rst new file mode 100644 index 00000000..43845a0e --- /dev/null +++ b/docs/sections/services/dfc/administration.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Administration +============== +DFC has a healthcheck functionality. The service can then be started and stopped through an API. One can also check the liveliness of the service. + +Main API Endpoints +"""""""""""""""""" +Running with dev-mode of DFC + - Heartbeat: **http://<container_address>:8100/heartbeat** or **https://<container_address>:8433/heartbeat** + - Start DFC: **http://<container_address>:8100/start** or **https://<container_address>:8433/start** + - Stop DFC: **http://<container_address>:8100/stopDatafile** or **https://<container_address>:8433/stopDatafile** + +The external port allocated for 8100 (http) is 30245. |