Welcome to cloudify-plugin-common’s documentation!

This is the API reference to the cloudify-plugins-common module which is required when writing any cloudify plugin (and workflow).

Contents:

• Context
  • ContextCapabilities
  • DeploymentWorkdirMixin
  • CommonContext
  • BootstrapContext
  • EntityContext
  • BlueprintContext
  • DeploymentContext
  • NodeContext
  • NodeInstanceContext
  • RelationshipContext
  • RelationshipSubjectContext
  • CloudifyContext
  • OperationContext
  • CloudifyAgentContext
  • PluginContext
  • deployment_workdirs_sync_required()
• Decorators
  • operation()
  • workflow()
  • serial_operation()
• Exceptions
  • NonRecoverableError
  • RecoverableError
  • OperationRetry
  • CloudifySerializationRetry
  • HttpException
  • CommandExecutionError
  • CommandExecutionException
  • TimeoutException
  • ProcessKillCancelled
  • ClosedAMQPClientException
  • PluginInstallationError
  • StopAgent
  • WorkflowFailed
  • InvalidBlueprintImport
• Manager
  • NodeInstance
  • get_rest_client()
  • download_resource_from_manager()
  • download_resource()
  • get_resource_from_manager()
  • get_resource()
  • get_resource_directory_index()
  • get_node_instance()
  • update_node_instance()
  • get_node_instance_ip()
  • update_execution_status()
  • get_bootstrap_context()
  • get_provider_context()
• Mocks
  • MockRelationshipSubjectContext
  • MockRelationshipContext
  • MockNodeInstanceContext
  • MockNodeContext
  • MockContext
  • MockCloudifyContext
• Utils
  • ManagerVersion
  • format_exception()
  • get_daemon_name()
  • get_manager_name()
  • get_manager_file_server_scheme()
  • get_manager_file_server_url()
  • get_manager_file_server_root()
  • get_manager_rest_service_protocol()
  • get_manager_rest_service_host()
  • get_manager_rest_service_port()
  • get_broker_ssl_cert_path()
  • get_manager_ip()
  • get_local_rest_certificate()
  • get_execution_creator_username()
  • get_rest_token()
  • get_execution_token()
  • get_execution_id()
  • get_instances_of_node()
  • get_tenant()
  • get_tenant_name()
  • get_is_bypass_maintenance()
  • id_generator()
  • get_exec_tempdir()
  • exception_to_error_cause()
  • get_func()
  • get_kerberos_indication()
  • get_workflow_parameters()
  • get_local_resources_root()
  • LocalCommandRunner
  • CommandExecutionResponse
  • setup_default_logger()
  • Internal
  • is_management_environment()
  • extract_archive()
  • unzip()
  • untar()
  • generate_user_password()
  • get_admin_api_token()
  • extract_plugins_to_install()
  • extract_and_merge_plugins()
  • merge_plugins()
  • add_plugins_to_install()
  • add_plugins_to_uninstall()
  • wait_for()
  • OutputConsumer
  • get_executable_path()
  • get_python_path()
  • plugin_prefix()
  • target_plugin_prefix()
  • parse_utc_datetime()
  • parse_utc_datetime_relative()
  • parse_utc_datetime_absolute()
  • unpack_timedelta_string()
  • parse_and_apply_timedelta()
  • parse_schedule_datetime_string()
  • ipv6_url_compat()
  • uuid4()
  • keep_trying_http()
• Logs
  • message_context_from_cloudify_context()
  • message_context_from_workflow_context()
  • message_context_from_workflow_node_instance_context()
  • CloudifyBaseLoggingHandler
  • CloudifyPluginLoggingHandler
  • CloudifyWorkflowLoggingHandler
  • CloudifyWorkflowNodeLoggingHandler
  • CloudifyCtxLoggingHandler
  • init_cloudify_logger()
  • send_workflow_event()
  • send_workflow_node_event()
  • send_plugin_event()
  • send_task_event()
  • populate_base_item()
  • manager_event_out()
  • manager_log_out()
  • stdout_event_out()
  • stdout_log_out()
  • create_event_message_prefix()
  • setup_logger_base()
  • setup_subprocess_logger()
  • setup_agent_logger()
  • ExecutorNameFormatter
• Workflows
  • Workflow Tasks Graph
  • Workflow API
  • Workflow Context

Indices and tables

• Index

• Module Index

• Search Page