blob: 37e7911de3c183d74bd5975acccce9e7d64b2f61 [file] [log] [blame]
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
sangeeta.bellara7dcdb642023-04-29 15:15:12 +05303
Lusheng Ji72c4fba2017-10-10 18:12:22 +00004
5Configuration
6=============
7
sangeeta.bellara7dcdb642023-04-29 15:15:12 +05308DCAEGEN2 is deployed via helm charts. The configuration are maintained as on values.yaml and can be updated for deployment if necessary.
Lusheng Ji72c4fba2017-10-10 18:12:22 +00009
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040010The helm charts for each component can be controlled via a separate override file under its respective component under ``oom/kubernetes/dcaegen2-services/components``
Lusheng Jif82a6c42017-10-13 17:56:38 +000011
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040012Below is a list of DCAE Services and the corresponding helm chart override location.
Vijay VK6b0fa462019-05-20 16:06:11 +010013
14.. csv-table::
15 :header: "Component", "Charts"
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040016 :widths: 25,100
Vijay VK6b0fa462019-05-20 16:06:11 +010017
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040018 "DataFileCollector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datafile-collector"
19 "DL AdminUI", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datalake-admin-ui"
20 "DL DES", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datalake-des"
21 "DL Feeder", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datalake-feeder"
22 "Heartbeat mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-heartbeat"
23 "HV-VES Collector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-hv-ves-collector"
24 "KPI mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-kpi-ms"
25 "Healthcheck mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ms-healthcheck"
26 "PM-Mapper", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-pm-mapper"
27 "PMSH", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-pmsh"
28 "PRH", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-prh"
29 "RestConf Collector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-restconf-collector"
30 "SliceAnalysis mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-slice-analysis-ms"
31 "SNMPTrap Collector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-snmptrap-collector"
32 "SON-Handler mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-son-handler"
33 "TCAgen2", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-tcagen2"
34 "VESCollector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ves-collector"
35 "VESMapper", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ves-mapper"
36 "VES-OpenAPIManager", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ves-openapi-manager"
37
Vijay VK6b0fa462019-05-20 16:06:11 +010038
Vijay VKf9e43442019-05-22 22:10:29 +010039
40Deployment time configuration of DCAE components are defined in several places.
41
42 * Helm Chart templates:
43 * Helm/Kubernetes template files can contain static values for configuration parameters;
44 * Helm Chart resources:
45 * Helm/Kubernetes resources files can contain static values for configuration parameters;
46 * Helm values.yaml files:
47 * The values.yaml files supply the values that Helm templating engine uses to expand any templates defined in Helm templates;
48 * In a Helm chart hierarchy, values defined in values.yaml files in higher level supersedes values defined in values.yaml files in lower level;
49 * Helm command line supplied values supersedes values defined in any values.yaml files.
50
Vijay VKf9e43442019-05-22 22:10:29 +010051
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040052All DCAE Service components are deployed only via Helm. Instructions for deployment and configuration are documented under https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html
Vijay VKf9e43442019-05-22 22:10:29 +010053
54
Zebek Bogumil6c14cde2021-03-18 07:37:04 +010055Config maps
56-----------
57
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040058During the installation of the DCAEGEN2-SERVICES module, two config maps are installed by default: dcae-external-repo-configmap-schema-map and dcae-external-repo-configmap-sa88-rel16.
Zebek Bogumil6c14cde2021-03-18 07:37:04 +010059
60Config maps are used by DCAEGEN VES and VES OPEN API components.
61
Vijay Venkatesh Kumaracd42cd2022-05-06 13:01:08 -040062Instruction how to generate the content of config maps is described in `README <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=blob_plain;f=external-schema-repo-generator/README.md;hb=refs/heads/master>`_ file.