There are two configuration files for A1 Policy Management Service, config/application_configuration.json and config/application.yaml
The first (config/application_configuration.json) contains configuration needed by the application, such as which near-RT-RICs, controller, or DMaaP topic to use.
The second (config/application.yaml) contains logging and security configurations.

Static configuration - Settings that cannot be changed at runtime (application.yaml)

The file ./config/application.yaml is read by the application at startup. It provides the following configurable features:

server; configuration for the WEB server
- used port for HTTP/HTTPS, this is however not the port numbers visible outside the container
- SSL parameters for setting up using of key store and trust store databases.
webclient; configuration parameters for a web client used by the component
- SSL parameters for setting up using of key store and trust store databases.
- Usage of HTTP Proxy; if configured, the proxy will be used for accessing the near-RT-RICs
logging; setting of of which information that is logged.
filepath; the local path to a file used for dynamic configuration (if used). See next chapter.

For details about the parameters in this file, see documentation in the file.
Sample: application.yaml Expand source

Dynamic configuration - Settings that can be changed at runtime (application_configuration.json or REST or Consul or ConfigMap)

The component has configuration that can be updated in runtime. This configuration can either be loaded from a file (accessible from the container), or from a CBS/Consul database (Cloudify), or using the Configuration REST API. The configuration is re-read and refreshed at regular intervals.

The configuration includes:

Optional Controller configuration, e.g. an SDNC instance (with A1-Adapter)
One entry for each near-RT-RIC, which includes:
- The base URL of the near-RT-RIC
- A optional list of O1 identifiers that near-RT-RIC is controlling. An application can query this service which near-RT-RIC should be addressed for which component (e.g. cells, sectors, locations, etc.) .
- An optional reference to the controller to use, or excluded if the near-RT-RIC can be accessed directly from this A1 Policy Management Service.
- An optional java class name to be used for the southbound interface towards the NearRT RIC. If this is not given the PMS will automatically discover the A1-P API version supported by the NearRT-RIC.
  This parameter can be used for explicitly defining a class to be used. See the example below using the "customAdapterClass" property. The class used has to be in the class path of the built container.
  This means that the PMS can be extended to support any protocol towards the NearRT RIC without changing its implementation. On how to implement such an adapter class, see the source code and the actual class referred to in the configuration example below.
Optional configuration for using of DMAAP. There can be one stream for requests to the component and an other stream for responses.

For details about the syntax of the file, there is an example in source code repository/config/application_configuration.json. This file is also included in the docker container /opt/app/policy-agent/data/application_configuration.json_example.

Sample JSON Configuration

A sample configuration is included below.

application_configuration.json

{
  "description": "Application configuration",
  "config": {    
    "controller": [
      {
        "name": "controller1",
        "baseUrl": "http://sdnc_controller:8181",
        "userName": "admin",
        "password": "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U"
      }
    ],
    "ric": [
      {
        "name": "ric1",
        "baseUrl": "http://ric1:8085/", 
        "managedElementIds": [
          "kista_1",
          "kista_2"         ]
      },
      {
        "name": "ric2",
        "baseUrl": "http://ric2:8085/",
        "customAdapterClass": "org.onap.ccsdk.oran.a1policymanagementservice.clients.StdA1ClientVersion2$Factory",   
        "managedElementIds": [
          "kista_3",
          "kista_4"
        ]
      },
       {
        "name": "ric3",
        "baseUrl": "http://ric3:8085/",
        "controller": "controller1", 
        "managedElementIds": [
          "kista_5",
          "kista_6"
        ]
      },
       {
        "name": "ric4",
        "baseUrl": "http://ric4:8085/",
        "controller": "controller1", 
        "managedElementIds": [
          "kista_7",
          "kista_8",
          "kista_9",
          "kista_10",
          "kista_11"
         ]
      }
    ]
  }
}

JSON Schema for the application configuration

The configuration must comply to the following JSON schema. There are several tools on internet where it is possible to validate JSON against a schema.

application_configuration_schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "//description": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "controller": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "baseUrl": {
                  "type": "string"
                },customAdapterClass                 "userName": {
                  "type": "string"
                },
                "password": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "baseUrl",
                "userName",
                "password"
              ],
              "additionalProperties": false
            }
          ]
        },
        "ric": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "baseUrl": {
                  "type": "string"
                },
                "controller": {
                  "type": "string"
                }, 
                "customAdapterClass" : {
                  "type": "string"
                },
                "managedElementIds": {
                  "type": "array",
                  "items": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "string"
                    }
                  ]
                }
              },
              "required": [
                "name",
                "baseUrl",
                "managedElementIds"
              ],
              "additionalProperties": false
            }
          ]
        },
        "streams_publishes": {
          "type": "object",
          "properties": {
            "dmaap_publisher": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "dmaap_info": {
                  "type": "object",
                  "properties": {
                    "topic_url": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "topic_url"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "type",
                "dmaap_info"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "dmaap_publisher"
          ],
           "additionalProperties": false
        },
        "streams_subscribes": {
          "type": "object",
          "properties": {
            "dmaap_subscriber": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "dmaap_info": {
                  "type": "object",
                  "properties": {
                    "topic_url": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "topic_url"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "type",
                "dmaap_info"
              ],
               "additionalProperties": false
            }
          },
          "required": [
            "dmaap_subscriber"
          ],
           "additionalProperties": false
        }
      },
      "required": [
        "ric"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "config"
  ],
  "additionalProperties": false
}

Jakarta - Component configuration

Static configuration - Settings that cannot be changed at runtime (application.yaml)

Dynamic configuration - Settings that can be changed at runtime (application_configuration.json or REST or Consul or ConfigMap)

Sample JSON Configuration

JSON Schema for the application configuration