ConfigFile possibly incomplete for ES clients

[kmohr-soprasteria]

Problem:
The interface.yaml of p1ResolveEsAddress contains an output attribute for the service-records-policy.
This is to be filled from the es-client specified in the variables file.

interface.yaml:
------------------
service-records-policy:
  type: string
  description: >
    'Service records policy
    from [/resolve-es-address/es-client/logical-termination-point/layer-protocol=0/elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac/elasticsearch-client-interface-configuration/service-records-policy]'

variables.yaml:
------------------
es-client:
  type: object
  description: >
    'ElasticSearch client LTP object
    from [/resolve-es-address/config-file/core-model-1-4:control-construct/logical-termination-point=es-client-uuid]'

In the configFile the service-records-policy attribute seems to be missing, see e.g.:

{
  "uuid": "dpmdp-1-0-0-es-c-es-1-0-0-007",
  "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK",
  "client-ltp": [],
  "server-ltp": [
    "dpmdp-1-0-0-http-c-es-1-0-0-000"
  ],
  "layer-protocol": [
    {
      "local-id": "0",
      "layer-protocol-name": "elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER",
      "elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac": {
        "elasticsearch-client-interface-configuration": {
          "auth": {
            "api-key": "API key not yet defined."
          },
          "index-alias": "7"
        },
        "elasticsearch-client-interface-status": {
          "operational-state": "elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED",
          "life-cycle-state": "elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED"
        }
      }
    }
  ]
},

Solution:
The configFile is generated by a configFile generator tool. This tool should also cover the missing service-records-policy attribute.

[openBackhaul]

The serviceRecordsPolicy attribute is included in the ElasticSearchClient definition in the ApplicationPattern, but not in the configFiles of ApplicationPattern or MicroWaveDeviceInventory.
It is unclear, whether it is required and where the values are coming from.

Moreover, the datatype of the serviceRecordsPolicy attribute is wrongly stated in the p1ResolveEsAddress :: interface.yaml file.
It is of datatype object, instead of string.

Proposed changes:

• remove from list of required
• change datatype from string to object
• remove error message for missing serviceRecordsPolicy attribute

[kmohr-soprasteria]

Info from Prathiba:

As per the decision we made in the issue openBackhaul/ApplicationPattern#235 (comment) , service-record-policy is an optional entity.
Since ApplicationPattern(OAS) has this capabilities included already , if DPMDP application requires this , then this shall be included in the configuration file.
But , we have to check whether the implementation of the application pattern supports this. @Karthikeyan Vadivelu (External) , could you please kindly look and share whether implementation supports the “service-record-policy”.
Many thanks.

On a side note , as of now , configFileGenerator don’t have this capability and needs to be enhanced. Also , the required attributes shall be included to the the services.yaml which will be the input to configFileGenerator.

[kmohr-soprasteria]

Info from Karthikeyan: