diff options
Diffstat (limited to 'models-interactions/model-yaml/README-v1.0.0.md')
| -rw-r--r-- | models-interactions/model-yaml/README-v1.0.0.md | 264 |
1 files changed, 264 insertions, 0 deletions
diff --git a/models-interactions/model-yaml/README-v1.0.0.md b/models-interactions/model-yaml/README-v1.0.0.md new file mode 100644 index 000000000..eea1cad99 --- /dev/null +++ b/models-interactions/model-yaml/README-v1.0.0.md @@ -0,0 +1,264 @@ +Copyright 2018 AT&T Intellectual Property. All rights reserved. +Modifications Copyright (C) 2019 Nordix Foundation. +This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +ONAP Control Loop Policy v1.0.0 + +A control loop policy is a YAML specification for creating and chaining policies for ControlLoop. + +Features of ONAP Control Loop Policy v1.0.0: + +* A single DCAE Closed Loop Event is the trigger for the overall Control Loop Policy +* APPC is the only Actor that Policy will interact with. The operations available are: RESTART, REBUILD, MIGRATE. +* An overall timeout for the Control Loop Policy must be provided +* The Control Loop Policy can contain zero or more Operational Policies each chained together via outcomes of each policy. +* If there are zero Operational Policies, i.e. no automated action is to be taken, then the policy is an Open Loop policy. +* Operational Policies can have retries and timeout's given to control how they are processed. + +This SDK helps build the YAML specification for ONAP Control Loop Policy v1.0.0. + +# Create Builder Object + +To begin with, the ControlLoopPolicyBuilder.Factory class has static methods that one should use to begin building a Control Loop Policy. It will return a [ControlLoopPolicyBuilder object](src/main/java/org/onap/policy/controlloop/policy/builder/ControlLoopPolicyBuilder.java) that can then be used to continue to build and define the Control Loop Policy. + +```java + ControlLoopPolicyBuilder builder = ControlLoopPolicyBuilder.Factory.buildControlLoop( + UUID.randomUUID().toString(), + 2400, + new Resource("sampleResource", ResourceType.VF), + new Service("sampleService") + ); +``` + +# Define the Trigger Policy + +After the name of the Control Loop and the resource and services have been defined, the next step would be to define the Operation Policy that is first to respond to an incoming DCAE Closed Loop Event. Use the setTriggerPolicy() method to do so. + +```java + Policy triggerPolicy = builder.setTriggerPolicy( + "Restart the VM", + "Upon getting the trigger event, restart the VM", + Actor.APPC, + Target.VM, + "Restart", + 2, + 300); +``` + +# Chain Operational Policies Together Using Operational Results + +Operational Policies are chained together using the results of each Operational Policy. The results are defined in [PolicyResult.java](src/main/java/org/onap/policy/controlloop/policy/PolicyResult.java). To create an Operational Policy that is tied to the result of another, use the +setPolicyForPolicyResult() method. + +```java + Policy onRestartFailurePolicy = builder.setPolicyForPolicyResult( + "Rebuild VM", + "If the restart fails, rebuild it.", + Actor.APPC, + Target.VM, + "Rebuild", + 1, + 600, + triggerPolicy.id, + PolicyResult.FAILURE, + PolicyResult.FAILURE_RETRIES, + PolicyResult.FAILURE_TIMEOUT); +``` + +An Operational Policy MUST have place to go for every one of its results. By default, each result type goes to a Final Result. Optionally, using the setPolicyForPolicyResult() method is what allows the chaining of policies. Be aware of creating loops and set the overall Control Loop timeout to reasonable value. All paths MUST lead to a Final Result. + +# Build the YAML Specification + +When finished defining the Policies, build the specification and analyze the [Results.java](src/main/java/org/onap/policy/controlloop/policy/builder/Results.java) + +```java + Results results = builder.buildSpecification(); + if (results.isValid()) { + System.out.println(results.getSpecification()); + } else { + System.err.println("Builder failed"); + for (Message message : results.getMessages()) { + System.err.println(message.getMessage()); + } + } +``` + + +# Use the YAML Specification to call the Create Policy API + +Now that you have a valid YAML specification, call the createPolicy API via the ONAP Policy Platform API. + +# YAML Specification + +The YAML specification has 2 sections to it: [controlLoop](#controlloop-object) and [policies](#policies-array). The [controlLoop section](#controlloop-object) section is simply a header defining the Control Loop Policy, what services its for, which resource its for, or if its for a pnf, the overall timeout, and which Operational Policy is triggered upon receiving the event. The [policies section](#policies-array) is simply an array of [Policy Objects](#policy-object). + +## controlLoop Object + +| Field Name | Type | Required | Description | +| ------------- |:-------------:| -----------| ------------:| +| controlLoopName | string | required | Unique ID for the control Loop | +| version | string | required | Value for this release if 1.0.0 | +| services | array of [service](#service-object) objects | optional | Zero or more services associated with this Control Loop | +| resources | array of [resource](#resource-object) object | required (If NOT a pnf control loop) | The resource's associated with this Control Loop. | +| pnf | [pnf](#pnf-object) object | required (If NOT a resource control loop) | The physical network function associated with this Control Loop. | +| trigger_policy | string | required | Either this is the ID of an Operation Policy (see policy object), or "Final_OpenLoop" indicating an Open Loop | +| timeout | int | required | This is the overall timeout for the Control Loop Policy. It can be 0 for an Open Loop, but otherwise should total more than the timeouts specified in any Operational Policies | + +### resource Object + +This object was derived via SDC Catalog API and SDC Data Dictionary (POC) in an attempt to use common naming conventions. + +| Field Name | Type | Required | Description | +| ------------- |:-------------:| -----------| ------------:| +| resourceInvariantUUID | string - UUID | optional | via SDC, the unique ID for the resource version | +| resourceName | string | required if NO resourceUUID available | Name of the resource, ideally from SDC catalog. But if not available, use well-known name. | +| resourceType | string | optional | Use values defined by SDC: VF, VFC, VL, CP. | +| resourceUUID | string - UUID | required IF available, else populate resourceName | Unique ID for the resource as assigned via SDC. +| resourceVersion | string | optional | string version of the resource via SDC catalog + +SDC catalog is not fully available and resources have not been defined yet, use resourceName. Eg. vFW + +### service Object + +This object was derived via SDC Catalog API and SDC Data Dictionary (POC) in an attempt to use common naming conventions. + +| Field Name | Type | Required | Description | +| ------------- |:-------------:| -----------| ------------:| +| serviceInvariantUUID | string - UUID | optional | via SDC catalog, the unique ID for the service version | +| serviceName | string | required if NO serviceUUID available | Name of the service, ideally from SDC catalog. But if not available, use well-known name. | +| serviceUUID | string - UUID | required IF available, else populate serviceName | Unique ID fort he service as assigned via SDC +| serviceVersion | string | optional | string version of the service via SDC catalog + +SDC catalog is not fully available and some services have not been defined yet, use serviceName. Eg. vLB. + +### pnf Object + +This object is used for a physical network function. Expect this object to change in the future when ONAP Policy fully integrates with A&AI. + +| Field Name | Type | Required | Description | +| ------------- |:-------------:| -----------| ------------:| +| PNFName | string | required | Name of the PNF. Should be supplied via A&AI. If not available use a well-known name. | +| PNFType | string | optional | Type of PNF if available. | + + +## policies array + +The policies section is an array of [Policy objects](#policy-object). + +### Policy Object + +This is an Operation Policy. It is used to instruct an actor (eg. APPC) to invoke a recipe (eg. "Restart") on a target entity (eg. a "VM"). An operation is simply defined as performing a recipe (or operation) on an actor. + +| Field Name | Type | Required | Description | +| ------------- |:-------------:| -----------| ------------:| +| id | string | required | Unique ID for the policy. +| name | string | required | Policy name | +| description | string | optional | Policy description | +| actor | string | required | Name of the actor for this operation: Example: APPC | +| recipe | string | required | Name of recipe to be performed. Example "Restart" | +| target | string | required | Entity being targeted. Example: VM | +| timeout | int | required | Timeout for the actor to perform the recipe. | +| retry | int | optional | Optional number of retries for ONAP Policy to invoke the recipe on the actor. | +| success | string | required | By default, this value should be FINAL_SUCCESS. Otherwise this can be the ID of the operational Policy (included in this specification) to invoke upon successfully completing the recipe on the actor. +| failure | string | required | By default, this value should be FINAL_FAILURE. Otherwise this can be the ID of the operational Policy (included in this specification) to invoke upon failure to perform the operation. | +| failure_exception | string | required | By default, this value should be FINAL_FAILURE_EXCEPTION. Otherwise this can be the ID of an Operational Policy (included in this specification) to invoke upon an exception occurring while attempting to perform the operation. | +| failure_retries | string | required | By default, this value should be the FINAL_FAILURE_RETRIES. Otherwise this can be the ID of an Operational Policy (included in this specification) to invoke upon maxing out on retries while attempting to perform the operation. | +| failure_timeout | string | required | By default, this value should be FINAL_FAILURE_TIMEOUT. Otherwise this can be the ID of the operational Policy (included in this specification) to invoke upon a timeout occuring while performing an operation. | + +Every Operational Policy MUST have a place to go for every possible result (success, failure, failure_retries, failure_timeout, failure_exception). By default, all the results are final results. + +## Examples of YAML Control Loops v1.0.0 + +[vService](src/test/resources/v1.0.0/policy_vService.yaml) +[Open-Loop](src/test/resources/v1.0.0/policy_OpenLoop.yaml) + + +### vService +``` +controlLoop: + version: 1.0.0 + controlLoopName: ControlLoop-vService-cbed919f-2212-4ef7-8051-fe6308da1bda + services: + - serviceName: service1 + resources: + - resourceName: resource1 + resourceType: VF + - resourceName: resource2 + resourceType: VF + - resourceName: resource3 + resourceType: VF + - resourceName: resource4 + resourceType: VF + - resourceName: resource5 + resourceType: VF + trigger_policy: unique-policy-id-1-restart + timeout: 1200 + +policies: + - id: unique-policy-id-1-restart + name: Restart Policy + description: + actor: APPC + recipe: Restart + target: VM + retry: 2 + timeout: 300 + success: final_success + failure: unique-policy-id-2-rebuild + failure_timeout: unique-policy-id-2-rebuild + failure_retries: unique-policy-id-2-rebuild + failure_exception: final_failure_exception + + - id: unique-policy-id-2-rebuild + name: Rebuild Policy + description: + actor: APPC + recipe: Rebuild + target: VM + retry: 0 + timeout: 600 + success: final_success + failure: unique-policy-id-3-migrate + failure_timeout: unique-policy-id-3-migrate + failure_retries: unique-policy-id-3-migrate + failure_exception: final_failure_exception + + - id: unique-policy-id-3-migrate + name: Migrate Policy + description: + actor: APPC + recipe: Migrate + target: VM + retry: 0 + timeout: 600 + success: final_success + failure: final_failure + failure_timeout: final_failure_timeout + failure_retries: final_failure_retries + failure_exception: final_failure_exception + +``` + +### Open Loop +``` +controlLoop: + version: 1.0.0 + controlLoopName: ControlLoop-Open-fac4ae3d-c3f5-4bab-8e54-0a8581ede132 + services: + - serviceName: service1 + resources: + - resourceType: VF + resourceName: resource1 + trigger_policy: final_openloop + timeout: 0 + +policies: +``` + + + +# Control Loop Final Results Explained + +A Control Loop Policy has the following set of final results, as defined in [FinalResult.java](src/main/java/org/onap/policy/controlloop/policy/FinalResult.java). A final result indicates when a Control Loop Policy has finished execution and is finished processing a Closed Loop Event. All paths must lead to a Final Result. + |