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

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