1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
# onap-dcae-dcaepolicy-lib - policy in dcae controller
- python-package to be used in cloudify plugins to maintain the policies lifecycle
## upload the python package to pypi server
```bash
python setup.py sdist upload
```
---
## usage in plugins
### **requirements.txt**
```python
onap-dcae-dcaepolicy-lib==2.4.1
```
### **tasks.py**
import
```python
from onap_dcae_dcaepolicy_lib import Policies
```
### examples of **@operation** with **@Policies.<>** decorator
### Usage:
import the dcaepolicy-node-type.yaml into your blueprint to use the dcae.nodes.type node
```yaml
imports:
- https://YOUR_NEXUS_RAW_SERVER/type_files/dcaepolicy/1.0.0/node-type.yaml
```
provide the value for policy_id property
```yaml
node_templates:
...
host_capacity_policy:
type: dcae.nodes.policy
properties:
policy_id: { get_input: host_capacity_policy_id }
```
Then the dcaepolicyplugin will bring the latest policy to the dcae.nodes.policy node during the install workflow of cloudify.
---
### cloudify.interfaces.lifecycle.**configure**
- gather policy data into runtime_properties of policy consumer node
```yaml
cloudify.interfaces.lifecycle:
configure:
implementation: dcae_policy_plugin.onap_dcae_dcaepolicy_lib.node_configure
```
```python
from onap_dcae_dcaepolicy_lib import Policies, POLICIES
from .discovery import DiscoveryClient
from .demo_app import DemoApp
APPLICATION_CONFIG = "application_config"
SERVICE_COMPONENT_NAME = "service_component_name"
@operation
@Policies.gather_policies_to_node()
def node_configure(**kwargs):
"""decorate with @Policies.gather_policies_to_node() on policy consumer node to
prepopulate runtime_properties[POLICIES]
"""
app_config = ctx.node.properties.get(APPLICATION_CONFIG)
ctx.instance.runtime_properties[APPLICATION_CONFIG] = app_config
ctx.logger.info("app_config: {0}".format(json.dumps(app_config)))
if SERVICE_COMPONENT_NAME in ctx.instance.runtime_properties:
ctx.logger.info("saving app_config({0}) to consul under key={1}" \
.format(json.dumps(app_config), \
ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME]))
DiscoveryClient.put_kv(ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME], app_config)
ctx.logger.info("deploying the demo component: {0}...".format(ctx.node.id))
demo_app = DemoApp(ctx.node.id)
demo_app.start()
ctx.logger.info("deployed the demo component: {0}".format(demo_app.container_id))
demo_app.get_logs()
```
---
### execute-operation **policy-update**
```yaml
dcae.interfaces.policy:
policy_update:
implementation: dcae_policy_plugin.onap_dcae_dcaepolicy_lib.policy_update
```
execute-operation **policy-update** that gets a list of changed policy-configs
```python
from .discovery import DiscoveryClient
from .demo_app import DemoApp
APPLICATION_CONFIG = "application_config"
SERVICE_COMPONENT_NAME = "service_component_name"
@operation
@Policies.update_policies_on_node()
def policy_update(updated_policies, removed_policies=None, policies=None, **kwargs):
"""decorate with @Policies.update_policies_on_node() to update runtime_properties[POLICIES]
:updated_policies: contains the list of changed policy-configs when configs_only=True (default).
Use configs_only=False to bring the full policy objects in :updated_policies:.
"""
# example how to notify the dockerized component about the policy change
notify_app_through_script = True
if notify_app_through_script:
ctx.logger.info("notify dockerized app about updated_policies {0} and app_config {1}"
.format(json.dumps(updated_policies), json.dumps(app_config)))
demo_app = DemoApp(ctx.node.id)
demo_app.notify_app_through_script(
"policies",
updated_policies=updated_policies,
removed_policies=removed_policies,
policies=policies
)
```
example of the **changed\_policies** with **configs_only=True**
- list of config objects (preparsed from json string)
- manual mess produced by mock_policy_updater
```json
[{
"policy_updated_from_ver": "2",
"policy_updated_to_ver": "3",
"updated_policy_id": "DCAE_alex.Config_db_client_policy_id_value",
"policy_hello": "world!",
"policy_updated_ts": "2017-08-17T21:49:39.279187Z"
}]
```
---
example of **policies** in runtime_properties **before policy-update**
```json
"runtime_properties": {
"execute_operation": "policy_update",
"service_component_name": "some-uuid.unknown.unknown.unknown.dcae.ecomp.company.com",
"application_config": {
"policy_hello": "world!",
"db": {
"type": "db",
"input_db_port": 5555,
"database_port": 5555
},
"policy_updated_from_ver": "1",
"intention": "policies are shallow merged to the copy of the application_config",
"updated_policy_id": "DCAE_alex.Config_db_client_policy_id_value",
"client": {
"client_version": "1.2.2",
"type": "client",
"client_policy_id": "DCAE_alex.Config_db_client_policy_id_value"
},
"policy_updated_ts": "2017-08-17T21:13:47.268782Z",
"policy_updated_to_ver": "2"
},
"exe_task": "node_configure",
"policies": {
"DCAE_alex.Config_db_client_policy_id_value": {
"policy_apply_mode": "script",
"policy_body": {
"policyName": "DCAE_alex.Config_db_client_policy_id_value.2.xml",
"policyConfigMessage": "Config Retrieved! ",
"responseAttributes": {
},
"policyConfigStatus": "CONFIG_RETRIEVED",
"matchingConditions": {
"ECOMPName": "DCAE",
"ConfigName": "alex_config_name"
},
"type": "OTHER",
"property": null,
"config": {
"policy_updated_from_ver": "1",
"policy_updated_to_ver": "2",
"updated_policy_id": "DCAE_alex.Config_db_client_policy_id_value",
"policy_hello": "world!",
"policy_updated_ts": "2017-08-17T21:13:47.268782Z"
},
"policyVersion": "2"
},
"policy_id": "DCAE_alex.Config_db_client_policy_id_value"
}
}
}
```
example of **policies** in runtime_properties **after policy-update**
```json
"runtime_properties": {
"execute_operation": "policy_update",
"service_component_name": "some-uuid.unknown.unknown.unknown.dcae.ecomp.company.com",
"application_config": {
"policy_hello": "world!",
"db": {
"input_db_port": 5555,
"type": "db",
"database_port": 5555
},
"policy_updated_ts": "2017-08-17T21:49:39.279187Z",
"policy_updated_from_ver": "2",
"intention": "policies are shallow merged to the copy of the application_config",
"client": {
"client_version": "1.2.2",
"type": "client",
"client_policy_id": "DCAE_alex.Config_db_client_policy_id_value"
},
"updated_policy_id": "DCAE_alex.Config_db_client_policy_id_value",
"policy_updated_to_ver": "3"
},
"exe_task": "node_configure",
"policies": {
"DCAE_alex.Config_db_client_policy_id_value": {
"policy_apply_mode": "script",
"policy_body": {
"policyName": "DCAE_alex.Config_db_client_policy_id_value.3.xml",
"policyConfigMessage": "Config Retrieved! ",
"responseAttributes": {
},
"policyConfigStatus": "CONFIG_RETRIEVED",
"matchingConditions": {
"ECOMPName": "DCAE",
"ConfigName": "alex_config_name"
},
"type": "OTHER",
"property": null,
"config": {
"policy_updated_from_ver": "2",
"policy_updated_to_ver": "3",
"updated_policy_id": "DCAE_alex.Config_db_client_policy_id_value",
"policy_hello": "world!",
"policy_updated_ts": "2017-08-17T21:49:39.279187Z"
},
"policyVersion": "3"
},
"policy_id": "DCAE_alex.Config_db_client_policy_id_value"
}
}
}
```
---
|
