Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languageyml
titleSample: application.yaml
collapsetrue
#
# ============LICENSE_START=======================================================
# ONAP : ccsdk oran
# ================================================================================
# Copyright (C) 2020-2023 Nordix Foundation. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
#
spring:
  profiles:
    active: prod
  main:
    allow-bean-definition-overriding: true
  aop:
    auto: false
management:
  endpoints:
    web:
      exposure:
        # Enabling of springboot actuator features. See springboot documentation.
        include: "loggers,logfile,health,info,metrics,threaddump,heapdump,shutdown"
  endpoint:
    shutdown:
      enabled: true
lifecycle:
  timeout-per-shutdown-phase: "20s"
springdoc:
  show-actuator: true
logging:
  # Configuration of logging
  level:
    ROOT: ERROR
    org.springframework: ERROR
    org.springframework.data: ERROR
    org.springframework.web.reactive.function.client.ExchangeFunctions: ERROR
    org.springframework.web.servlet.DispatcherServlet: ERROR
    org.onap.ccsdk.oran.a1policymanagementservice: INFO
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger{20} - %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger{20} - %msg%n"
  file:
    name: /var/log/policy-agent/application.log
server:
   # Configuration of the HTTP/REST server. The parameters are defined and handeled by the springboot framework.
   # See springboot documentation.
   port : 8433
   http-port: 8081
   shutdown: "graceful"
   ssl:
      key-store-type: JKS
      key-store-password: policy_agent
      key-store: /opt/app/policy-agent/etc/cert/keystore.jks
      key-password: policy_agent
      key-alias: policy_agent
      # trust-store-password:
      # trust-store:
app:
  # Location of the component configuration file.
  filepath: /opt/app/policy-agent/data/application_configuration.json
  webclient:
    # Configuration of the trust store used for the HTTP client (outgoing requests)
    # The file location and the password for the truststore is only relevant if trust-store-used == true
    # Note that the same keystore as for the server is used.
    trust-store-used: false
    trust-store-password: policy_agent
    trust-store: /opt/app/policy-agent/etc/cert/truststore.jks
    # Configuration of usage of HTTP Proxy for the southbound accesses.
    # The HTTP proxy (if configured) will only be used for accessing NearRT RIC:sRICs (or A1 Adapter) southbound.
    # proxy-type can be either HTTP, SOCKS4 or SOCKS5
    http.proxy-host:
    http.proxy-port: 0
    http.proxy-type: HTTP
  # path where the service can store data. This parameter is not relevant if S3 Object store is configured.
  vardata-directory: /var/policy-management-service
  # the config-file-schema-path referres to a location in the jar file. If this property is empty or missing,
  # no schema validation will be executed.
  config-file-schema-path: /application_configuration_schema.json
  # A file containing an authorization token, which shall be inserted in each HTTP header (authorization).
  # If the file name is empty, no authorization token is sent.
  auth-token-file:
  # A URL to authorization provider such as OPA. Each time an A1 Policy is accessed, a call to this
  # authorization provider is done for access control. If this is empty, no fine grained access control is done.
  authorization-provider:
  # S3 object store usage is enabled by defining the bucket to use. This will override the vardata-directory parameter.
  s3:
    endpointOverride: http://localhost:9000
    accessKeyId: minio
    secretAccessKey: miniostorage
    bucket:

...

  • controller : Optional A1 Controller configuration, e.g. an SDNC instance (with A1-Adapter)
    • name : for use later in the configuration
    • baseUrl : the URL of the A1 controller (e.g. SDNC + A1 Adapter)
    • userName & password : to configure security parameters to access to the controller
    • The A1 Policy Management service can entirely by-pass the A1-Controller (SDNC + A1 Adapter) if desired - it is optional to access the near-RT-RIC through an A1-Controller.
      In the configuration the "controller" property is optional in the "ric" objects (below)
      If all configured rics bypass the A1-Controller (do not have "controller" values) then the "controller" object at the top of the configuration can be omitted.
      If all configured rics bypass the A1-Controller there is no need to start an A1-Controller.
      There is no functional gain in accessing the near-RT-RIC through an A1-Controller.
  • ric : One entry for each near-RT-RIC, which includes:
    • name : a friendly name to refer to the near-RT-RIC
    • baseUrl : The base URL of the A1 interface endpoint in the near-RT-RIC.
    • managedElementIds : A optional list of identifiers that near-RT-RIC is using. An application can query the A1 Policy Management Service to retrieve "RIC" instance associated with these identiefiers. (e.g. cells, sectors, locations, etc.) .
    • controller : 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.
    • customAdapterClass:
      • An optional java class name to be used for the southbound interface towards the near-RT-RIC. If this is not given the PMS will automatically discover the A1-P API version supported by the near-RT-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 A1-PMS can be extended to support any protocol towards the near-RT-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.
  • DMaaP configuration: Optional. Used if the A1 Policy Management Service is configured to send/receive API calls over a DMaaP topic:
    • streams_subscribes : Information on the DMaaP topic to receive API requests
    • streams_publishes : Information on the DMaaP topic to publish API responses
    • Note: Support for accessing the service using DMaaP is deprecated, and will be removed in future versions.

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

...