docs/sections/services/mapper/installation-helm.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. _ves-mapper-installation-helm:
   4
   5
   6 Helm Installation
   7 =================
   8
   9 The Mapper microservice can be deployed using helm charts in the oom repository.
  10
  11
  12 Deployment steps
  13 ~~~~~~~~~~~~~~~~
  14
  15 - Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-ves-mapper/values.yaml.
  16
  17 - Make the chart and deploy using the following command:
  18
  19   .. code-block:: bash
  20
  21     cd oom/kubernetes/
  22     make dcaegen2-services
  23     helm install dev-dcaegen2-services dcaegen2-services --namespace <namespace> --set global.masterPassword=<password>
  24
  25 - To deploy only Mapper:
  26
  27   .. code-block:: bash
  28
  29     helm install dev-dcae-ves-mapper dcaegen2-services/components/dcae-ves-mapper --namespace <namespace> --set global.masterPassword=<password>
  30
  31 - To Uninstall
  32
  33   .. code-block:: bash
  34
  35     helm uninstall dev-dcae-ves-mapper
  36
  37 Application Configurations
  38 --------------------------
  39
  40 Supported configuration modifiable in HELM charts under **applicationConfig** section.
  41
  42 .. code-block:: yaml
  43
  44         applicationConfig:
  45           app_preferences:
  46             collectors:
  47             - identifier: notification-id
  48               mapping-files:
  49               - defaultMappingFile-rcc-notification: "<?xml version='1.0' encoding='UTF-8'?><smooks-resource-list
  50                 xmlns='http://www.milyn.org/xsd/smooks-1.1.xsd' xmlns:jb='http://www.milyn.org/xsd/smooks/javabean-1.4.xsd'
  51                 xmlns:json='http://www.milyn.org/xsd/smooks/json-1.1.xsd'><json:reader rootName='vesevent'
  52                 keyWhitspaceReplacement='-'><json:keyMap><json:key from='date&amp;time' to='date-and-time'
  53                 /></json:keyMap></json:reader><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.VesEvent'
  54                 beanId='vesEvent' createOnElement='vesevent'><jb:wiring property='event' beanIdRef='event'
  55                 /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.Event' beanId='event'
  56                 createOnElement='vesevent'><jb:wiring property='commonEventHeader' beanIdRef='commonEventHeader'
  57                 /><jb:wiring property='pnfRegistrationFields' beanIdRef='pnfRegistrationFields'
  58                 /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader'
  59                 beanId='commonEventHeader' createOnElement='vesevent'><jb:expression property='version'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Version._4_0_1</jb:expression><jb:expression
  60                 property='eventType'>'pnfRegistration'</jb:expression><jb:expression property='vesEventListenerVersion'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.VesEventListenerVersion._7_0_1</jb:expression><jb:expression
  61                 property='eventId' execOnElement='vesevent'>'registration_'+commonEventHeader.ts1</jb:expression><jb:expression
  62                 property='reportingEntityName'>'VESMapper'</jb:expression><jb:expression property='domain'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Domain.PNF_REGISTRATION</jb:expression><jb:expression
  63                 property='eventName' execOnElement='vesevent'>commonEventHeader.domain</jb:expression><jb:value
  64                 property='sequence' data='0' default='0' decoder='Long' /><jb:expression property='lastEpochMicrosec'
  65                 execOnElement='vesevent'>commonEventHeader.ts1</jb:expression><jb:expression
  66                 property='startEpochMicrosec' execOnElement='vesevent'>commonEventHeader.ts1</jb:expression><jb:expression
  67                 property='priority'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Priority.NORMAL</jb:expression><jb:expression
  68                 property='sourceName' execOnElement='vesevent'>pnfRegistrationFields.vendorName+'-'+pnfRegistrationFields.serialNumber</jb:expression></jb:bean><jb:bean
  69                 class='org.onap.dcaegen2.ves.domain.ves70.PnfRegistrationFields' beanId='pnfRegistrationFields'
  70                 createOnElement='vesevent'><jb:expression property='pnfRegistrationFieldsVersion'>org.onap.dcaegen2.ves.domain.ves70.PnfRegistrationFields.PnfRegistrationFieldsVersion._2_0</jb:expression><jb:value
  71                 property='serialNumber' data='pnfRegistration/serialNumber' /><jb:value property='lastServiceDate'
  72                 data='pnfRegistration/lastServiceDate' /><jb:value property='manufactureDate'
  73                 data='pnfRegistration/manufactureDate' /><jb:value property='modelNumber'
  74                 data='pnfRegistration/modelNumber' /><jb:value property='oamV4IpAddress' data='pnfRegistration/oamV4IpAddress'
  75                 /><jb:value property='oamV6IpAddress' data='pnfRegistration/oamV6IpAddress'
  76                 /><jb:value property='softwareVersion' data='pnfRegistration/softwareVersion'
  77                 /><jb:value property='unitFamily' data='pnfRegistration/unitFamily' /><jb:value
  78                 property='unitType' data='pnfRegistration/unitType' /><jb:value property='vendorName'
  79                 data='pnfRegistration/vendorName' /><jb:wiring property='additionalFields'
  80                 beanIdRef='alarmAdditionalInformation' /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.AlarmAdditionalInformation'
  81                 beanId='alarmAdditionalInformation' createOnElement='vesevent'><jb:wiring
  82                 property='additionalProperties' beanIdRef='additionalFields2' /></jb:bean><jb:bean
  83                 beanId='additionalFields2' class='java.util.HashMap' createOnElement='vesevent/pnfRegistration/additionalFields'><jb:value
  84                 data='pnfRegistration/additionalFields/*'/></jb:bean></smooks-resource-list>"
  85               stream_publisher: ves-pnfRegistration
  86               stream_subscriber: rcc-notification
  87             - identifier: notify OID
  88               mapping-files:
  89               - defaultMappingFile-snmp-notification: "<?xml version='1.0' encoding='UTF-8'?><smooks-resource-list
  90                 xmlns='http://www.milyn.org/xsd/smooks-1.1.xsd' xmlns:jb='http://www.milyn.org/xsd/smooks/javabean-1.4.xsd'
  91                 xmlns:json='http://www.milyn.org/xsd/smooks/json-1.1.xsd'><json:reader rootName='vesevent'
  92                 keyWhitspaceReplacement='-'><json:keyMap><json:key from='date&amp;time' to='date-and-time'
  93                 /></json:keyMap></json:reader><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.VesEvent'
  94                 beanId='vesEvent' createOnElement='vesevent'><jb:wiring property='event' beanIdRef='event'
  95                 /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.Event' beanId='event'
  96                 createOnElement='vesevent'><jb:wiring property='commonEventHeader' beanIdRef='commonEventHeader'
  97                 /><jb:wiring property='faultFields' beanIdRef='faultFields' /></jb:bean><jb:bean
  98                 class='org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader' beanId='commonEventHeader'
  99                 createOnElement='vesevent'><jb:expression property='version'>'3.0'</jb:expression><jb:expression
 100                 property='eventType'>'FaultField'</jb:expression><jb:expression property='eventId'
 101                 execOnElement='vesevent'>'XXXX'</jb:expression><jb:expression property='reportingEntityName'>'VESMapper'</jb:expression><jb:expression
 102                 property='domain'>org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader.Domain.FAULT</jb:expression><jb:expression
 103                 property='eventName' execOnElement='vesevent'>commonEventHeader.domain</jb:expression><jb:value
 104                 property='sequence' data='0' default='0' decoder='Long' /><jb:value property='lastEpochMicrosec'
 105                 data='#/time-received' /><jb:value property='startEpochMicrosec' data='#/time-received'
 106                 /><jb:expression property='priority'>org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader.Priority.NORMAL</jb:expression><jb:expression
 107                 property='sourceName'>'VesAdapter'</jb:expression></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.FaultFields'
 108                 beanId='faultFields' createOnElement='vesevent'><jb:value property='faultFieldsVersion'
 109                 data='2.0' default='2.0' decoder='Double' /><jb:value property='alarmCondition'
 110                 data='#/trap-category' /><jb:expression property='specificProblem'>'SNMP Fault'</jb:expression><jb:expression
 111                 property='vfStatus'>org.onap.dcaegen2.ves.domain.ves54.FaultFields.VfStatus.ACTIVE</jb:expression><jb:expression
 112                 property='eventSeverity'>org.onap.dcaegen2.ves.domain.ves54.FaultFields.EventSeverity.MINOR</jb:expression><jb:wiring
 113                 property='alarmAdditionalInformation' beanIdRef='alarmAdditionalInformationroot'
 114                 /></jb:bean><jb:bean class='java.util.ArrayList' beanId='alarmAdditionalInformationroot'
 115                 createOnElement='vesevent'><jb:wiring beanIdRef='alarmAdditionalInformation'
 116                 /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.AlarmAdditionalInformation'
 117                 beanId='alarmAdditionalInformation' createOnElement='varbinds/element'><jb:value
 118                 property='name' data='#/varbind_oid' /><jb:value property='value' data='#/varbind_value'
 119                 /></jb:bean></smooks-resource-list>"
 120               stream_publisher: ves-fault
 121               stream_subscriber: snmp-notification
 122           streams_publishes:
 123             ves-fault:
 124               dmaap_info:
 125                 topic_url: http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT
 126               type: message_router
 127             ves-pnfRegistration:
 128               dmaap_info:
 129                 topic_url: http://message-router:3904/events/unauthenticated.VES_PNFREG_OUTPUT
 130               type: message_router
 131           streams_subscribes:
 132             rcc-notification:
 133               dmaap_info:
 134                 topic_url: http://message-router:3904/events/unauthenticated.DCAE_RCC_OUTPUT
 135               type: message_router
 136             snmp-notification:
 137               dmaap_info:
 138                 topic_url: http://message-router:3904/events/unauthenticated.ONAP-COLLECTOR-SNMPTRAP
 139               type: message_router
 140
 141 The location of the configuration file should be set in ``CBS_CLIENT_CONFIG_PATH`` env, for example:
 142
 143     ``CBS_CLIENT_CONFIG_PATH: /app-config-input/application_config.yaml``