; Wed, 6 Sep 2017 18:19:01 +0000 (UTC) Received: (qmail 74114 invoked by uid 99); 6 Sep 2017 18:19:00 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Sep 2017 18:19:00 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 41672F55AA; Wed, 6 Sep 2017 18:19:00 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: arthurberezin@apache.org To: commits@ariatosca.incubator.apache.org Date: Wed, 06 Sep 2017 18:19:01 -0000 Message-Id: <82f44a59b93c497688b13228442de290@git.apache.org> In-Reply-To: <6ab41ea18086443688c896fdecfea410@git.apache.org> References: <6ab41ea18086443688c896fdecfea410@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [02/51] [partial] incubator-ariatosca-website git commit: Fixing docs archived-at: Wed, 06 Sep 2017 18:19:38 -0000 http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/4c010d53/docs/html/aria.orchestrator.execution_plugin.ssh.html ---------------------------------------------------------------------- diff --git a/docs/html/aria.orchestrator.execution_plugin.ssh.html b/docs/html/aria.orchestrator.execution_plugin.ssh.html deleted file mode 100644 index 835e887..0000000 --- a/docs/html/aria.orchestrator.execution_plugin.ssh.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - - - - - - aria.orchestrator.execution_plugin.ssh — ARIA TOSCA 0.1.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - - -

- - - - - - -

- - - - - - - - - - - - - - - - - -

- -

`aria.orchestrator.execution_plugin.ssh`¶

Remote execution of operations over SSH.

`aria.orchestrator.execution_plugin.ssh.operations`¶

Utilities for running commands remotely over SSH.

-aria.orchestrator.execution_plugin.ssh.operations.run_commands(ctx, commands, fabric_env, use_sudo, hide_output, **_)¶

Runs the provider ‘commands’ in sequence

- --- - - - -

Parameters:	- commands – a list of commands to run - fabric_env – fabric configuration - -

- -

-aria.orchestrator.execution_plugin.ssh.operations.run_script(ctx, script_path, fabric_env, process, use_sudo, hide_output, **kwargs)¶

- -

`aria.orchestrator.execution_plugin.ssh.tunnel`¶

-aria.orchestrator.execution_plugin.ssh.tunnel.remote(*args, **kwds)¶: Create a tunnel forwarding a locally-visible port to the remote target.
-

- -

- - -

- -

- - -

- -

- - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/4c010d53/docs/html/aria.orchestrator.html ---------------------------------------------------------------------- diff --git a/docs/html/aria.orchestrator.html b/docs/html/aria.orchestrator.html deleted file mode 100644 index f596b68..0000000 --- a/docs/html/aria.orchestrator.html +++ /dev/null @@ -1,474 +0,0 @@ - - - - - - - - - - - aria.orchestrator — ARIA TOSCA 0.1.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - - -

- - - - - - -

- - - - - - - - - - - - - - - - - -

- -

`aria.orchestrator`¶

Orchestrator package.

`aria.orchestrator.decorators`¶

Workflow and operation decorators.

-aria.orchestrator.decorators.operation(func=None, toolbelt=False, suffix_template='', logging_handlers=None)¶: Operation decorator.
-

- -

-aria.orchestrator.decorators.workflow(func=None, suffix_template='')¶: Workflow decorator.
-

- -

`aria.orchestrator.events`¶

Orchestrator events.

`aria.orchestrator.exceptions`¶

Orchestrator exceptions.

-exception aria.orchestrator.exceptions.ActiveExecutionsError¶

Bases: aria.exceptions.AriaError

Raised when attempting to execute a workflow on a service which already has an active execution

- -

-exception aria.orchestrator.exceptions.InvalidPluginError¶

Bases: aria.exceptions.AriaError

Raised when an invalid plugin is validated unsuccessfully

- -

-exception aria.orchestrator.exceptions.InvalidWorkflowRunnerParams¶

Bases: aria.exceptions.AriaError

Raised when invalid combination of arguments is passed to the workflow runner

- -

-exception aria.orchestrator.exceptions.OrchestratorError¶

Bases: aria.exceptions.AriaError

Orchestrator based exception

- -

-exception aria.orchestrator.exceptions.PluginAlreadyExistsError¶

Bases: aria.exceptions.AriaError

Raised when a plugin with the same package name and package version already exists

- -

-exception aria.orchestrator.exceptions.TaskAbortException¶

Bases: exceptions.RuntimeError

Used internally when ctx.task.abort is called

- -

-exception aria.orchestrator.exceptions.TaskRetryException(message, retry_interval=None)¶

Bases: exceptions.RuntimeError

Used internally when ctx.task.retry is called

- -

-exception aria.orchestrator.exceptions.UndeclaredWorkflowError¶

Bases: aria.exceptions.AriaError

Raised when attempting to execute an undeclared workflow

- -

-exception aria.orchestrator.exceptions.WorkflowImplementationNotFoundError¶

Bases: aria.exceptions.AriaError

Raised when attempting to import a workflow’s code but the implementation is not found

- -

`aria.orchestrator.plugin`¶

Plugin management.

-class aria.orchestrator.plugin.PluginManager(model, plugins_dir)¶

Bases: object

- --- - - - -

Parameters:	plugins_dir – root directory in which to install plugins

-get_plugin_dir(plugin)¶

- -

-install(source)¶: Install a wagon plugin.
-

- -

-load_plugin(plugin, env=None)¶

Load the plugin into an environment.

Loading the plugin means the plugin’s code and binaries paths will be appended to the -environment’s PATH and PYTHONPATH, thereby allowing usage of the plugin.

- --- - - - -

Parameters:	- plugin – plugin to load - env – environment to load the plugin into; If `None`, `os.environ` will be -used - -

- -

-static validate_plugin(source)¶

Validate a plugin archive.

A valid plugin is a wagon in the zip format -(suffix may also be .wgn).

- -

`aria.orchestrator.workflow_runner`¶

Running workflows.

-class aria.orchestrator.workflow_runner.WorkflowRunner(model_storage, resource_storage, plugin_manager, execution_id=None, service_id=None, workflow_name=None, inputs=None, executor=None, task_max_attempts=30, task_retry_interval=30)¶

Bases: object

Manages a single workflow execution on a given service.

- --- - - - -

Parameters:

Parameters:	- workflow_name – workflow name - service_id – service ID - inputs – key-value dict of inputs for the execution - model_storage – model storage API (“MAPI”) - resource_storage – resource storage API (“RAPI”) - plugin_manager – plugin manager - executor – executor for tasks; defaults to a -`ProcessExecutor` instance - task_max_attempts – maximum attempts of repeating each failing task - task_retry_interval – retry interval between retry attempts of a failing task - -

workflow_name – workflow name
service_id – service ID
inputs – key-value dict of inputs for the execution
model_storage – model storage API (“MAPI”)
resource_storage – resource storage API (“RAPI”)
plugin_manager – plugin manager
executor – executor for tasks; defaults to a -ProcessExecutor instance
task_max_attempts – maximum attempts of repeating each failing task
task_retry_interval – retry interval between retry attempts of a failing task

-cancel()¶

- -

-execute()¶

- -

-execution¶

- -

-execution_id¶

- -

-service¶

- -

- - -

- -

- - -

- -

- - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/4c010d53/docs/html/aria.orchestrator.workflows.api.html ---------------------------------------------------------------------- diff --git a/docs/html/aria.orchestrator.workflows.api.html b/docs/html/aria.orchestrator.workflows.api.html deleted file mode 100644 index 9353c5a..0000000 --- a/docs/html/aria.orchestrator.workflows.api.html +++ /dev/null @@ -1,652 +0,0 @@ - - - - - - - - - - - aria.orchestrator.workflows.api — ARIA TOSCA 0.1.1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - - -

- - - - - - -

- - - - - - - - - - - - - - - - - -

- -

`aria.orchestrator.workflows.api`¶

Workflow API.

`aria.orchestrator.workflows.api.task_graph`¶

Task graph.

-class aria.orchestrator.workflows.api.task_graph.TaskGraph(name)¶

Bases: object

Task graph builder.

-add_dependency(dependent, dependency)¶

Adds a dependency for one item (task, sequence or parallel) on another.

The dependent will only be executed after the dependency terminates. If either of the items -is either a sequence or a parallel, multiple dependencies may be added.

- --- - - - - - - - - - -

Parameters:	- dependent – dependent (task, sequence or parallel) - dependency – dependency (task, sequence or parallel) - -
Returns:	`True` if the dependency between the two hadn’t already existed, otherwise -`False` -
Return type:	bool -
Raises:	TaskNotInGraphError – if either the -dependent or dependency are tasks which are not in the graph -

- -

-add_tasks(task, *tasks, **kwargs)¶

- -

-get_dependencies(dependent_task)¶

Iterates over the task’s dependencies.

- --- - - - - - -

Parameters:	dependent_task – task whose dependencies are requested
Raises:	TaskNotInGraphError – if -`dependent_task` is not in the graph

- -

-get_dependents(dependency_task)¶

Iterates over the task’s dependents.

- --- - - - - - -

Parameters:	dependency_task – task whose dependents are requested
Raises:	TaskNotInGraphError – if -`dependency_task` is not in the graph

- -

-get_task(task_id)¶

Get a task instance that’s been inserted to the graph by the task’s ID.

- --- - - - - - -

Parameters:	task_id (basestring) – task ID
Raises:	TaskNotInGraphError – if no task found in -the graph with the given ID

- -

-has_dependency(dependent, dependency)¶

Checks whether one item (task, sequence or parallel) depends on another.

Note that if either of the items is either a sequence or a parallel, and some of the -dependencies exist in the graph but not all of them, this method will return False.

- --- - - - - - - - - - -

Parameters:	- dependent – dependent (task, sequence or parallel) - dependency – dependency (task, sequence or parallel) - -
Returns:	`True` if the dependency between the two exists, otherwise `False` -
Return type:	bool -
Raises:	TaskNotInGraphError – if either the -dependent or dependency are tasks which are not in the graph -

- -

-has_tasks(task, *tasks, **kwargs)¶

- -

-id¶: ID of the graph
-

- -

-remove_dependency(dependent, dependency)¶

Removes a dependency for one item (task, sequence or parallel) on another.

Note that if either of the items is either a sequence or a parallel, and some of the -dependencies exist in the graph but not all of them, this method will not remove any of the -dependencies and return False.

- --- - - - - - - - - - -

Parameters:	- dependent – dependent (task, sequence or parallel) - dependency – dependency (task, sequence or parallel) - -
Returns:	`False` if the dependency between the two hadn’t existed, otherwise `True` -
Return type:	bool -
Raises:	TaskNotInGraphError – if either the -dependent or dependency are tasks which are not in the graph -

- -

-remove_tasks(task, *tasks, **kwargs)¶

- -

-sequence(task, *tasks, **kwargs)¶

- -

-tasks¶: Iterator over tasks in the graph.
-

- -

-topological_order(reverse=False)¶

Topological sort of the graph.

- --- - - - - - -

Parameters:	reverse – whether to reverse the sort
Returns:	list which represents the topological sort

- -

-exception aria.orchestrator.workflows.api.task_graph.TaskNotInGraphError¶

Bases: exceptions.Exception

An error representing a scenario where a given task is not in the graph as expected.

- -

`aria.orchestrator.workflows.api.task`¶

Provides the tasks to be entered into the task graph

-class aria.orchestrator.workflows.api.task.BaseTask(ctx=None, **kwargs)¶

Bases: object

Base class for tasks.

-id¶: UUID4 ID.
-

- -

-workflow_context¶: Context of the current workflow.
-

- -

-class aria.orchestrator.workflows.api.task.OperationTask(actor, interface_name, operation_name, arguments=None, ignore_failure=None, max_attempts=None, retry_interval=None)¶

Bases: aria.orchestrator.workflows.api.task.BaseTask

Executes an operation.

- --- - - - - - - - -

Variables:	- name (basestring) – formatted name (includes actor type, actor name, and interface/operation names) - actor (`Node` or -`Relationship`) – node or relationship - interface_name (basestring) – interface name on actor - operation_name (basestring) – operation name on interface - plugin (`Plugin`) – plugin (or None for default plugin) - function (basestring) – path to Python function - arguments ({`basestring`: `Argument`}) – arguments to send to Python function - ignore_failure (bool) – whether to ignore failures - max_attempts (int) – maximum number of attempts allowed in case of failure - retry_interval (float) – interval between retries (in seconds) - -
Parameters:	- actor (`Node` or -`Relationship`) – node or relationship - interface_name (basestring) – interface name on actor - operation_name (basestring) – operation name on interface - arguments ({`basestring`: object}) – override argument values - ignore_failure (bool) – override whether to ignore failures - max_attempts (int) – override maximum number of attempts allowed in case of failure - retry_interval (float) – override interval between retries (in seconds) - -
Raises:	OperationNotFoundException – if -`interface_name` and `operation_name` do not refer to an operation on the actor -

-NAME_FORMAT = '{interface}:{operation}@{type}:{name}'¶

- -

-class aria.orchestrator.workflows.api.task.StubTask(ctx=None, **kwargs)¶

Bases: aria.orchestrator.workflows.api.task.BaseTask

Enables creating empty tasks.

- -

-class aria.orchestrator.workflows.api.task.WorkflowTask(workflow_func, **kwargs)¶

Bases: aria.orchestrator.workflows.api.task.BaseTask

Executes a complete workflow.

- --- - - - -

Parameters:	- workflow_func – function to run - kwargs – kwargs that would be passed to the workflow_func - -

-graph¶: Graph constructed by the sub workflow.
-

- -

-aria.orchestrator.workflows.api.task.create_relationship_tasks(relationship, interface_name, source_operation_name=None, target_operation_name=None, **kwargs)¶

Creates a relationship task (source and target).

- --- - - - -

Parameters:	- relationship – relationship instance itself - source_operation_name – - target_operation_name – - -

- -

-aria.orchestrator.workflows.api.task.create_relationships_tasks(node, interface_name, source_operation_name=None, target_operation_name=None, **kwargs)¶

Creates a relationship task (source and target) for all of a node relationships.

- --- - - - -

Parameters:	- source_operation_name (basestring) – relationship operation name - interface_name (basestring) – name of the interface - source_operation_name – - target_operation_name – - node – source node - -

- -

-aria.orchestrator.workflows.api.task.create_task(actor, interface_name, operation_name, **kwargs)¶

Helper function that enables safe creation of OperationTask. If the supplied interface -or operation do not exist, None is returned.

- --- - - - - - -

Parameters:	- actor – actor for this task - interface_name – name of the interface - operation_name – name of the operation - kwargs – any additional kwargs to be passed to the OperationTask - -
Returns:	OperationTask or None (if the interface/operation does not exists) -

- -

-aria.orchestrator.workflows.api.task.has_operation(actor, interface_name, operation_name)¶

- -

- - -

- -

- - -

- -

- - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file