summaryrefslogtreecommitdiffstats
path: root/docs/sections/services
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2018-11-20 15:25:22 +0000
committerGerrit Code Review <gerrit@onap.org>2018-11-20 15:25:22 +0000
commit4392680e1da068818787cef962585aa5e031da21 (patch)
tree8e635243359efd4f0007b2d56872b1bd3e1e5bab /docs/sections/services
parent290488ddc4acc0e216e5325ea3f445be8301d5d9 (diff)
parente284409662fd311bd78fa88b92a5ca8945481ac1 (diff)
Merge "Restore proto schemas in docs"
Diffstat (limited to 'docs/sections/services')
-rw-r--r--docs/sections/services/ves-hv/authorization.rst2
-rw-r--r--docs/sections/services/ves-hv/configuration.rst31
-rw-r--r--docs/sections/services/ves-hv/delivery.rst9
-rw-r--r--docs/sections/services/ves-hv/index.rst20
-rw-r--r--docs/sections/services/ves-hv/installation.rst27
-rw-r--r--docs/sections/services/ves-hv/troubleshooting.rst2
6 files changed, 11 insertions, 80 deletions
diff --git a/docs/sections/services/ves-hv/authorization.rst b/docs/sections/services/ves-hv/authorization.rst
index 27efdf49..054f7b33 100644
--- a/docs/sections/services/ves-hv/authorization.rst
+++ b/docs/sections/services/ves-hv/authorization.rst
@@ -1,6 +1,6 @@
**WARNING: SSL/TLS authorization is a part of an experimental feature for ONAP Casablanca release and thus should be treated as unstable and subject to change in future releases.**
-.. _authorization:
+.. _ssl_tls_authorization:
SSL/TLS authorization
=====================
diff --git a/docs/sections/services/ves-hv/configuration.rst b/docs/sections/services/ves-hv/configuration.rst
deleted file mode 100644
index f2b726f4..00000000
--- a/docs/sections/services/ves-hv/configuration.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Configuration
-=============
-
-HV-VES expects to be able to fetch configuration directly from consul service in following JSON format:
-
-.. code-block:: json
-
- {
- "dmaap.kafkaBootstrapServers": "kafka-host:9093",
- "collector.routing": [
- {
- "fromDomain": "PERF3GPP",
- "toTopic": "topic-1"
- },
- {
- "fromDomain": "HEARTBEAT",
- "toTopic": "topic-2"
- },
- ...
- ]
- }
-
-
-During ONAP OOM/Kubernetes deployment this configuration is created from HV-VES cloudify blueprint.
-
-Endpoint on which HV-VES seeks configuration can be configured during deployment as described in installation_.
-
-.. _installation: ./installation.html \ No newline at end of file
diff --git a/docs/sections/services/ves-hv/delivery.rst b/docs/sections/services/ves-hv/delivery.rst
deleted file mode 100644
index 74db3c05..00000000
--- a/docs/sections/services/ves-hv/delivery.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Delivery
-========
-
-**HV-VES** is delivered as a docker container and published in ONAP Nexus repository following image naming convention.
-
-Full image name is `onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main`. \ No newline at end of file
diff --git a/docs/sections/services/ves-hv/index.rst b/docs/sections/services/ves-hv/index.rst
index 8dec5693..5cfaed3f 100644
--- a/docs/sections/services/ves-hv/index.rst
+++ b/docs/sections/services/ves-hv/index.rst
@@ -27,14 +27,12 @@ High Volume VES Collector overview and functions
.. toctree::
:maxdepth: 1
- ./architecture
- ./design
- ./run-time-configuration
- ./repositories
- ./deployment
- ./troubleshooting
- `Offered APIs`_
- ./authorization
- ./example-event
-
-.. _`Offered APIs`: ../../apis/ves-hv
+ architecture
+ design
+ run-time-configuration
+ repositories
+ deployment
+ troubleshooting
+ HV-VES Offered APIs <../../apis/ves-hv/index>
+ authorization
+ example-event
diff --git a/docs/sections/services/ves-hv/installation.rst b/docs/sections/services/ves-hv/installation.rst
deleted file mode 100644
index 7dafeaed..00000000
--- a/docs/sections/services/ves-hv/installation.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Installation
-============
-
-To run HV-VES Collector container you need to specify required parameters:
-
-- listen-port - the port on which HV-VES will listen internally
-- config-url - URL of HV-VES configuration on consul
-
-There are also optional configuration parameters:
-
-- health-check-api-port - Health check rest api listen port
-- first-request-delay - Delay of first request to consul in seconds
-- request-interval - Interval of consul configuration requests in seconds
-- ssl-disable - Disable SSL encryption
-- key-store - Key store in PKCS12 format path
-- key-store-password - Key store password
-- trust-store - File with trusted certificate bundle in PKCS12 format path
-- trust-store-password - Trust store password
-- idle-timeout-sec - Idle timeout for remote hosts. After given time without any data exchange the connection might be closed
-
-
-These parameters can be configured either by passing command line option during `docker run` call or
-by specifying environment variables named after command line option name
-rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix e.g. `VESHV_LISTEN_PORT`. \ No newline at end of file
diff --git a/docs/sections/services/ves-hv/troubleshooting.rst b/docs/sections/services/ves-hv/troubleshooting.rst
index 49037738..722e64c3 100644
--- a/docs/sections/services/ves-hv/troubleshooting.rst
+++ b/docs/sections/services/ves-hv/troubleshooting.rst
@@ -388,7 +388,7 @@ Authorization related errors
----------------------------
**WARNING: SSL/TLS authorization is a part of an experimental feature for ONAP Casablanca release and should be treated as unstable and subject to change in future releases.**
-**For more information, see** :ref:`authorization`.
+**For more information, see** :ref:`ssl_tls_authorization`.
**Key or trust store missing**