controlloop/common/policy-yaml/README-v1.0.0.md

   1 Copyright 2018 AT&T Intellectual Property. All rights reserved.
   2 This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
   3 Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
   4
   5 ONAP Control Loop Policy v1.0.0
   6
   7 A control loop policy is a YAML specification for creating and chaining policies for ControlLoop.
   8
   9 Features of ONAP Control Loop Policy v1.0.0:
  10
  11 * A single DCAE Closed Loop Event is the trigger for the overall Control Loop Policy
  12 * APPC is the only Actor that Policy will interact with. The operations available are: RESTART, REBUILD, MIGRATE.
  13 * An overall timeout for the Control Loop Policy must be provided
  14 * The Control Loop Policy can contain zero or more Operational Policies each chained together via outcomes of each policy.
  15 * If there are zero Operational Policies, i.e. no automated action is to be taken, then the policy is an Open Loop policy.
  16 * Operational Policies can have retries and timeout's given to control how they are processed.
  17
  18 This SDK helps build the YAML specification for ONAP Control Loop Policy v1.0.0.
  19
  20 # Create Builder Object
  21
  22 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.
  23
  24 ```java
  25                 ControlLoopPolicyBuilder builder = ControlLoopPolicyBuilder.Factory.buildControlLoop(
  26                                 UUID.randomUUID().toString(),
  27                                 2400,
  28                                 new Resource("sampleResource", ResourceType.VF),
  29                                 new Service("sampleService")
  30                                 );
  31 ```
  32
  33 # Define the Trigger Policy
  34
  35 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.
  36
  37 ```java
  38                 Policy triggerPolicy = builder.setTriggerPolicy(
  39                                 "Restart the VM",
  40                                 "Upon getting the trigger event, restart the VM",
  41                                 Actor.APPC,
  42                                 Target.VM,
  43                                 "Restart",
  44                                 2,
  45                                 300);
  46 ```
  47
  48 # Chain Operational Policies Together Using Operational Results
  49
  50 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
  51 setPolicyForPolicyResult() method.
  52
  53 ```java
  54                 Policy onRestartFailurePolicy = builder.setPolicyForPolicyResult(
  55                                 "Rebuild VM",
  56                                 "If the restart fails, rebuild it.",
  57                                 Actor.APPC,
  58                                 Target.VM,
  59                                 "Rebuild",
  60                                 1,
  61                                 600,
  62                                 triggerPolicy.id,
  63                                 PolicyResult.FAILURE,
  64                                 PolicyResult.FAILURE_RETRIES,
  65                                 PolicyResult.FAILURE_TIMEOUT);
  66 ```
  67
  68 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.
  69
  70 # Build the YAML Specification
  71
  72 When finished defining the Policies, build the specification and analyze the [Results.java](src/main/java/org/onap/policy/controlloop/policy/builder/Results.java)
  73
  74 ```java
  75                 Results results = builder.buildSpecification();
  76                 if (results.isValid()) {
  77                         System.out.println(results.getSpecification());
  78                 } else {
  79                         System.err.println("Builder failed");
  80                         for (Message message : results.getMessages()) {
  81                                 System.err.println(message.getMessage());
  82                         }
  83                 }
  84 ```
  85
  86
  87 # Use the YAML Specification to call the Create Policy API
  88
  89 Now that you have a valid YAML specification, call the createPolicy API via the ONAP Policy Platform API.
  90
  91 # YAML Specification
  92
  93 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).
  94
  95 ## controlLoop Object
  96
  97 | Field Name      | Type          | Required   | Description  |
  98 | -------------   |:-------------:| -----------| ------------:|
  99 | controlLoopName | string        | required | Unique ID for the control Loop |
 100 | version         | string        | required | Value for this release if 1.0.0 |
 101 | services        | array of [service](#service-object) objects | optional | Zero or more services associated with this Control Loop |
 102 | resources        | array of [resource](#resource-object) object | required (If NOT a pnf control loop) | The resource's associated with this Control Loop. |
 103 | pnf             | [pnf](#pnf-object) object | required (If NOT a resource control loop) | The physical network function associated with this Control Loop. |
 104 | trigger_policy  | string     | required | Either this is the ID of an Operation Policy (see policy object), or "Final_OpenLoop" indicating an Open Loop |
 105 | 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 |
 106
 107 ### resource Object
 108
 109 This object was derived via SDC Catalog API and SDC Data Dictionary (POC) in an attempt to use common naming conventions.
 110
 111 | Field Name      | Type          | Required   | Description  |
 112 | -------------   |:-------------:| -----------| ------------:|
 113 | resourceInvariantUUID | string - UUID | optional | via SDC, the unique ID for the resource version |
 114 | resourceName | string | required if NO resourceUUID available | Name of the resource, ideally from SDC catalog. But if not available, use well-known name. |
 115 | resourceType | string | optional | Use values defined by SDC: VF, VFC, VL, CP. |
 116 | resourceUUID | string - UUID | required IF available, else populate resourceName | Unique ID for the resource as assigned via SDC.
 117 | resourceVersion | string | optional | string version of the resource via SDC catalog
 118
 119 SDC catalog is not fully available and resources have not been defined yet, use resourceName. Eg. vFW
 120
 121 ### service Object
 122
 123 This object was derived via SDC Catalog API and SDC Data Dictionary (POC) in an attempt to use common naming conventions.
 124
 125 | Field Name      | Type          | Required   | Description  |
 126 | -------------   |:-------------:| -----------| ------------:|
 127 | serviceInvariantUUID | string - UUID | optional | via SDC catalog, the unique ID for the service version |
 128 | serviceName | string | required if NO serviceUUID available | Name of the service, ideally from SDC catalog. But if not available, use well-known name. |
 129 | serviceUUID | string - UUID | required IF available, else populate serviceName | Unique ID fort he service as assigned via SDC
 130 | serviceVersion | string | optional | string version of the service via SDC catalog
 131
 132 SDC catalog is not fully available and some services have not been defined yet, use serviceName. Eg. vLB.
 133
 134 ### pnf Object
 135
 136 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.
 137
 138 | Field Name      | Type          | Required   | Description  |
 139 | -------------   |:-------------:| -----------| ------------:|
 140 | PNFName         | string        | required   | Name of the PNF. Should be supplied via A&AI. If not available use a well-known name. |
 141 | PNFType         | string        | optional   | Type of PNF if available. |
 142
 143
 144 ## policies array
 145
 146 The policies section is an array of [Policy objects](#policy-object).
 147
 148 ### Policy Object
 149
 150 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.
 151
 152 | Field Name      | Type          | Required   | Description  |
 153 | -------------   |:-------------:| -----------| ------------:|
 154 | id              | string        | required   | Unique ID for the policy.
 155 | name            | string        | required   | Policy name |
 156 | description     | string        | optional   | Policy description |
 157 | actor           | string        | required   | Name of the actor for this operation: Example: APPC |
 158 | recipe          | string        | required   | Name of recipe to be performed. Example "Restart" |
 159 | target          | string        | required   | Entity being targeted. Example: VM |
 160 | timeout         | int           | required   | Timeout for the actor to perform the recipe. |
 161 | retry           | int           | optional   | Optional number of retries for ONAP Policy to invoke the recipe on the actor. |
 162 | 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.
 163 | 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. |
 164 | 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. |
 165 | 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. |
 166 | 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. |
 167
 168 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.
 169
 170 ## Examples of YAML Control Loops v1.0.0
 171
 172 [vService](src/test/resources/v1.0.0/policy_vService.yaml)
 173 [Open-Loop](src/test/resources/v1.0.0/policy_OpenLoop.yaml)
 174
 175
 176 ### vService
 177 ```
 178 controlLoop:
 179   version: 1.0.0
 180   controlLoopName: ControlLoop-vService-cbed919f-2212-4ef7-8051-fe6308da1bda
 181   services:
 182     - serviceName: service1
 183   resources:
 184     - resourceName: resource1
 185       resourceType: VF
 186     - resourceName: resource2
 187       resourceType: VF
 188     - resourceName: resource3
 189       resourceType: VF
 190     - resourceName: resource4
 191       resourceType: VF
 192     - resourceName: resource5
 193       resourceType: VF
 194   trigger_policy: unique-policy-id-1-restart
 195   timeout: 1200
 196
 197 policies:
 198   - id: unique-policy-id-1-restart
 199     name: Restart Policy
 200     description:
 201     actor: APPC
 202     recipe: Restart
 203     target: VM
 204     retry: 2
 205     timeout: 300
 206     success: final_success
 207     failure: unique-policy-id-2-rebuild
 208     failure_timeout: unique-policy-id-2-rebuild
 209     failure_retries: unique-policy-id-2-rebuild
 210     failure_exception: final_failure_exception
 211
 212   - id: unique-policy-id-2-rebuild
 213     name: Rebuild Policy
 214     description:
 215     actor: APPC
 216     recipe: Rebuild
 217     target: VM
 218     retry: 0
 219     timeout: 600
 220     success: final_success
 221     failure: unique-policy-id-3-migrate
 222     failure_timeout: unique-policy-id-3-migrate
 223     failure_retries: unique-policy-id-3-migrate
 224     failure_exception: final_failure_exception
 225
 226   - id: unique-policy-id-3-migrate
 227     name: Migrate Policy
 228     description:
 229     actor: APPC
 230     recipe: Migrate
 231     target: VM
 232     retry: 0
 233     timeout: 600
 234     success: final_success
 235     failure: final_failure
 236     failure_timeout: final_failure_timeout
 237     failure_retries: final_failure_retries
 238     failure_exception: final_failure_exception
 239
 240 ```
 241
 242 ### Open Loop
 243 ```
 244 controlLoop:
 245   version: 1.0.0
 246   controlLoopName: ControlLoop-Open-fac4ae3d-c3f5-4bab-8e54-0a8581ede132
 247   services:
 248     - serviceName: service1
 249   resources:
 250     - resourceType: VF
 251       resourceName: resource1
 252   trigger_policy: final_openloop
 253   timeout: 0
 254
 255 policies:
 256 ```
 257
 258
 259
 260 # Control Loop Final Results Explained
 261
 262 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.
 263