summaryrefslogtreecommitdiffstats
path: root/docs/sections/build.rst
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2022-05-06 13:01:08 -0400
committerVijay Venkatesh Kumar <vv770d@att.com>2022-05-09 18:33:33 -0400
commitacd42cd6397eb0461a9d26d5e2c291c69dc3f2d1 (patch)
tree8646302370e29df5a82865066d81421bdbb74c23 /docs/sections/build.rst
parent16842dadad04e6d2e0f44a3d3bbbae1137400269 (diff)
[DCAE] R10 misc doc updates
Change-Id: I42df794af1165bda7f8ddecaab35cb391ead15f0 Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Issue-ID: DCAEGEN2-2973 Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Diffstat (limited to 'docs/sections/build.rst')
-rw-r--r--docs/sections/build.rst71
1 files changed, 23 insertions, 48 deletions
diff --git a/docs/sections/build.rst b/docs/sections/build.rst
index 5323c3a0..eda50be7 100644
--- a/docs/sections/build.rst
+++ b/docs/sections/build.rst
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. _build:
@@ -21,76 +21,52 @@ Below is a list of the repositories and their sub-modules, and the language they
- docs (rst)
- platformdoc (mkdoc)
-* dcaegen2.analytics
-
-
* dcaegen2.analytics.tca-gen2
- dcae-analytics (Java)
- eelf-logger (Java)
-
-* dcaegen2.collectors
- - dcaegen2.collectors.snmptrap (Python)
- - dcaegen2.collectors.ves (Java)
- - dcaegen2.collectors.hv-ves (Kotlin)
- - dcaegen2.collectors.datafile (Java)
- - dcaegen2.collectors.restconf (Java)
+* dcaegen2.collectors.snmptrap (Python)
+
+* dcaegen2.collectors.ves (Java)
+
+* dcaegen2.collectors.hv-ves (Kotlin)
+
+* dcaegen2.collectors.datafile (Java)
+
+* dcaegen2.collectors.restconf (Java)
* dcaegen2.services
- - dcaegen2.services.heartbeat (Python)
- - dcaegen2.services.prh (Java)
- - dcaegen2.services.bbs-eventprocessor (Java)
- - dcaegen2.services.pm-mapper (Java)
- - dcaegen2.services.ves-mapper (Java)
- - dcaegen2.services.son-handler (Java)
- dcaegen2.services.kpi-ms (Java)
- dcaegen2.services.pmsh (Python)
- dcaegen2.services.datalake-handler (Java)
+ - dcaegen2.services.slice-analysis-ms (Java)
+
+* dcaegen2.services.heartbeat (Python)
+
+* dcaegen2.services.prh (Java)
+
+* dcaegen2.services.pm-mapper (Java)
+
+* dcaegen2.services.ves-mapper (Java)
* dcaegen2.services.son-handler (Java)
-
+
* dcaegen2.deployments
- scripts (bash, python)
- tls-init-container (bash)
- - k8s-bootstrap-container (bash)
- healthcheck-container (Node.js)
- - k8s-bootstrap-container (bash)
- - tca-cdap-container (bash)
- - multisite-init-container (python)
- - dcae-remote-site (helm chart)
* dcaegen2.platform
-* dcaegen2.platform.blueprints
-
- - blueprints (yaml)
- - input-templates (yaml)
-
* dcaegen2.platform.cli (Python)
- component-json-schemas (yaml)
- dcae-cli (Python)
-* dcaegen2.platform.configbinding (Python)
-
-* dcaegen2.platform.deployment-handler (NodeJS)
-
-* dcaegen2.platform.inventory-api (Java)
-
-* dcaegen2.platform.plugins
-
- - dcae-policy (Python)
- - relationships (Python)
- - k8splugin (Python)
-
-* dcaegen2.platform.policy-handler (Python)
-
-* dcaegen2.platform.servicechange-handler (Clojure)
-
* dcaegen2.platform.ves-openapi-manager (Java)
* dcaegen2.utils
@@ -101,10 +77,11 @@ Below is a list of the repositories and their sub-modules, and the language they
- python-dockering (Python)
- scripts (bash)
+* dcaegen2.services.sdk (Java)
Environment
-----------
-Building is conducted in a Linux environment that has the basic building tools such as JDK 8, Maven 3, Python 2.7 and 3.6, docker engine, etc.
+Building is conducted in a Linux environment that has the basic building tools such as JDK 11, Maven 3.6 or higher, Python 3.x, docker engine, etc.
Steps
@@ -114,7 +91,5 @@ Because of the uniform adoption of Maven framework, each project can be built by
Artifacts
---------
-Building of DCAE projects produce three different kinds of artifacts: Java jar files, raw file artifacts (including yaml files, scripts, wagon packages, etc), Pypi packages, and docker container images.
-
-
+Building of DCAE projects produce three different kinds of artifacts: Java jar files, raw file artifacts (including yaml files, scripts, wagon packages, etc), Pypi packages, and docker container images.