./dev_run.sh build
./dev_run.sh upload
requirements.txt
--extra-index-url https://YOUR_NEXUS_PYPI_SERVER/simple dcaepolicy
tasks.py
from dcaepolicy import Policies
import the dcaepolicy-node-type.yaml into your blueprint to use the dcae.nodes.type node
imports: - https://YOUR_NEXUS_RAW_SERVER/type_files/dcaepolicy/1.0.0/node-type.yaml
provide the value for policy_id property
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: implementation: dcae_policy_plugin.dcaepolicy.node_configure
from dcaepolicy 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 = None if APPLICATION_CONFIG in ctx.node.properties: # dockerized blueprint puts the app config into property application_config app_config = ctx.node.properties.get(APPLICATION_CONFIG) else: # CDAP components expect that in property app_config app_config = ctx.node.properties.get("app_config") app_config = Policies.shallow_merge_policies_into(app_config) ctx.instance.runtime_properties[APPLICATION_CONFIG] = app_config ctx.logger.info("example: applied policy_configs to property 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) # alternative 1 - use the list of policy configs from policies in runtime_properties policy_configs = Policies.get_policy_configs() if policy_configs: ctx.logger.warn("TBD: apply policy_configs: {0}".format(json.dumps(policy_configs))) # alternative 2 - use the policies dict by policy_id from runtime_properties if POLICIES in ctx.instance.runtime_properties: policies = ctx.instance.runtime_properties[POLICIES] ctx.logger.warn("TBD: apply policies: {0}".format(json.dumps(policies))) 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()
dcae.interfaces.policy: policy_update: implementation: dcae_policy_plugin.dcaepolicy.policy_update
execute-operation policy-update that gets a list of changed policy-configs
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(configs_only=True) def policy_update(updated_policies, **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:. """ app_config = DiscoveryClient.get_value(ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME]) # This is how to merge the policies into app_config object app_config = Policies.shallow_merge_policies_into(app_config) ctx.logger.info("merged updated_policies {0} into app_config {1}" .format(json.dumps(updated_policies), json.dumps(app_config))) ctx.instance.runtime_properties[APPLICATION_CONFIG] = app_config DiscoveryClient.put_kv(ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME], app_config) # 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( POLICY_MESSAGE_TYPE, updated_policies=updated_policies, application_config=app_config )
example of the changed_policies with configs_only=True
[{ "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
"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
"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" } } }