Configuring SDC ONAP Observer jobs

You configure SDC (Service Design and Creation) ONAP (Open Network Automation Platform) Observer jobs to dynamically load data from the SDC REST interface.

Before you begin

Important: The SDC ONAP Observer supports the SDC release 8.0.0.

Ensure you have the SDC ONAP service details to hand, such as username, password, hostname and port.

To obtain SDC ONAP system details:

  1. To get port

    kubectl describe svc --selector=app.kubernetes.io/name=sdc-be | grep NodePort

  2. To get message bus port

    kubectl describe svc --selector=app.kubernetes.io/name=message-router | grep NodePort

  3. To copy trust store

    kubectl cp <onap-sdc-be-*>:/var/lib/jetty/chef-solo/environments/org.onap.sdc.trust.jks ./org.onap.sdc.trust.jks

    Or

    kubectl cp <onap-sdc-be-*>:/app/jetty/chef-solo/environments/org.onap.sdc.trust.jks ./org.onap.sdc.trust.jks

  4. To get trust store password

    kubectl exec -it <onap-sdc-be-*> -- sh -c "cat /var/lib/jetty/chef-solo/environments/AUTO.json | grep truststore_pwd"

    Or

    kubectl exec -it <onap-sdc-be-*> -- sh -c "cat /app/jetty/chef-solo/environments/AUTO.json | grep truststore_pwd"

About this task

The SDC ONAP Observer job retrieves the service design data from the SDC server through REST. The observer loads and updates the resources and their relationships within the Agile Service Manager core topology service.

SDC manages two levels of assets:

Resource

A fundamental capability, implemented either entirely in software, or as software that interacts with a hardware device. Each Resource is a combination of one or more Virtual Function Components (VFCs), along with all the information necessary to instantiate, update, delete, and manage the Resource. A Resource also includes license-related information.

There are three kinds of resource:

  • Infrastructure: Cloud resources, such as Compute, Storage, etc
  • Network: Network connectivity functions & elements, for example a Virtual Network Function (VNF)
  • Application: Features and capabilities of a software application, for example a load-balancing function=

Service

A well-formed object comprising one or more resources.

Service designers create services from resources, and include all of the information about the service needed to instantiate, update, delete, and manage the service.

You define and start the following jobs:

Load job

Run this job whenever you need SDC ONAP topology data refreshed.

By default, these jobs are one-off, transient jobs that perform a full upload of all requested topology data as soon as they are triggered.

You can also run these jobs (again) manually from the Observer UI, or schedule them to run at set times when configuring them.

Listen job

A long-running job that consumes relevant messages from the SDC DMaaP broker continually until it is explicitly stopped, or until the observer is stopped.

You should run this job after a load job has been completed.

Procedure

Define or edit the following parameters, then click Run job to save and run the job.

Encryption requirement: See the Configuring observer jobs security topic for more information.

Load job parameters

Parameter Action Details
Unique ID Enter a unique name for the job Required
SDC Distribution Engine host Specify the host name of the SDC Distribution Engine Required
SDC Distribution Engine port Specify the port number of the SDC Distribution Engine Required
SDC username Specify the user name to use when connecting to the SDC Required
SDC password Specify the password to use when connecting to the SDC Required. Plain text password can be entered.
Target system Key Store file name Specify the key store name that contains either the CA certificate or the SDC's public key Required. For information on encrypting the contents of the key store file, see step 2 of the Configuring observer jobs security topic.
Target system Key Store password Specify the password to access the key store file Required. Plain text password can be entered.
Optional provider name Auto-generated if not specified Optional. Warning: Do not change to avoid resource duplication.
Access scope Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. Optional. Tip: You can define access scope for locations, project names, namespaces, etc.
Generate debug support file Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. Optional
Observer job description Enter additional information to describe the job Optional
Job schedule Specify when the job runs Optional. Load jobs only.

Listen job parameters

Parameter Action Details
Unique ID Enter a unique name for the job Required
SDC Distribution Engine host Specify the host name of the SDC Distribution Engine Required
SDC Distribution Engine port Specify the port number of the SDC Distribution Engine Required
SDC username Specify the user name to use when connecting to the SDC Required
SDC password Specify the password to use when connecting to the SDC Required. Plain text password can be entered.
SDC environment name Specify the environment name configured on the SDC, for example TEST, PROD, AUTO, etc Required
DMaaP message-router address Specify the DMaaP message bus addresses on which to listen for distribution events Required
DMaaP message-router port Specify the DMaaP message bus port on which to listen for distribution events Required
Target system Key Store file name Specify the key store name that contains either the CA certificate or the SDC's public key Required. For information on encrypting the contents of the service account key file, see step 2 of the Configuring observer jobs security topic.
Target system Key Store password Specify the password to access the key store file Required. Plain text password can be entered.
DMaaP polling interval (in seconds) Specify how often (in seconds) to poll the DMaaP cluster for new model events Optional. The default is 20s.
DMaaP polling timeout (in seconds) Specify the timeout value (in seconds) when polling DMaaP for new model events Optional. The default is 20s.
Optional provider name Auto-generated if not specified Optional. Warning: Do not change to avoid resource duplication.
Access scope Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. Optional. Tip: You can define access scope for locations, project names, namespaces, etc.
Generate debug support file Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. Optional
Observer job description Enter additional information to describe the job Optional
Job schedule Specify when the job runs Optional. Load jobs only.