Liking cljdoc? Tell your friends :D

pallet.core.api

Base level API for pallet

Base level API for pallet
raw docstring

action-planclj

(action-plan service-state environment plan-fn args target-map)

Build the action plan for the specified plan-fn on the given node, within the context of the service-state. The plan-state contains all the settings, etc, for all groups. target-map is a map for the session describing the target.

Build the action plan for the specified `plan-fn` on the given `node`, within
the context of the `service-state`. The `plan-state` contains all the
settings, etc, for all groups. `target-map` is a map for the session
describing the target.
sourceraw docstring

action-plansclj

(action-plans service-state plan-state environment phase targets)
source

create-nodesclj

(create-nodes compute-service environment group count)

Create count nodes for a group.

Create `count` nodes for a `group`.
sourceraw docstring

environment-execution-settingsclj

(environment-execution-settings)

Returns execution settings based purely on the environment

Returns execution settings based purely on the environment
sourceraw docstring

environment-image-execution-settingsclj

(environment-image-execution-settings)

Returns execution settings based on the environment and the image user.

Returns execution settings based on the environment and the image user.
sourceraw docstring

execute-action-plancljmultimethod

Execute the action-plan on the target.

Execute the `action-plan` on the `target`.
sourceraw docstring

execute-action-plan*clj

(execute-action-plan* session
                      executor
                      execute-status-fn
                      {:keys [action-plan phase target-type target]})

Execute the action-plan on the target.

Execute the `action-plan` on the `target`.
sourceraw docstring

group-deltaclj

(group-delta targets group)

Calculate actual and required counts for a group

Calculate actual and required counts for a group
sourceraw docstring

group-deltasclj

(group-deltas targets groups)

Calculate actual and required counts for a sequence of groups. Returns a map from group to a map with :actual and :target counts.

Calculate actual and required counts for a sequence of groups. Returns a map
from group to a map with :actual and :target counts.
sourceraw docstring

groups-to-createclj

(groups-to-create group-deltas compute-service)

Return a sequence of groups that currently have no nodes, but will have nodes added.

Return a sequence of groups that currently have no nodes, but will have nodes
added.
sourceraw docstring

groups-to-removeclj

(groups-to-remove group-deltas compute-service)

Return a sequence of groups that have nodes, but will have all nodes removed.

Return a sequence of groups that have nodes, but will have all nodes
removed.
sourceraw docstring

has-state-flag?clj

(has-state-flag? state-name)

Return a predicate to test for a state-flag having been set.

Return a predicate to test for a state-flag having been set.
sourceraw docstring

nodes-to-addclj

(nodes-to-add group-deltas)

Finds the specified number of nodes to be added to the given groups. Returns a map from group to a count of servers to add

Finds the specified number of nodes to be added to the given groups.
Returns a map from group to a count of servers to add
sourceraw docstring

nodes-to-removeclj

(nodes-to-remove targets group-deltas)

Finds the specified number of nodes to be removed from the given groups. Nodes are selected at random. Returns a map from group to a map with :servers and :all, where :servers is a sequence of severs to remove, and :all is a boolean that is true if all nodes are being removed.

Finds the specified number of nodes to be removed from the given groups.
Nodes are selected at random. Returns a map from group to a map with
:servers and :all, where :servers is a sequence of severs to remove, and :all
is a boolean that is true if all nodes are being removed.
sourceraw docstring

phase-argsclj

(phase-args phase)
source

phase-error-exceptionsclj

(phase-error-exceptions result)

Return a sequence of exceptions from phase errors for an operation.

Return a sequence of exceptions from phase errors for an operation. 
sourceraw docstring

phase-errorsclj

(phase-errors result)

Return a sequence of phase errors for an operation. Each element in the sequence represents a failed action, and is a map, with :target, :error, :context and all the return value keys for the return value of the failed action.

Return a sequence of phase errors for an operation.
Each element in the sequence represents a failed action, and is a map,
with :target, :error, :context and all the return value keys for the return
value of the failed action.
sourceraw docstring

read-or-empty-mapclj

(read-or-empty-map s)
source

remove-nodesclj

(remove-nodes compute-service group {:keys [nodes all]})

Removes nodes from group. If all is true, then all nodes for the group are being removed.

Removes `nodes` from `group`. If `all` is true, then all nodes for the group
are being removed.
sourceraw docstring

service-stateclj

(service-state compute-service groups)

Query the available nodes in a compute-service, filtering for nodes in the specified groups. Returns a sequence that contains a node-map for each matching node.

Query the available nodes in a `compute-service`, filtering for nodes in the
specified `groups`. Returns a sequence that contains a node-map for each
matching node.
sourceraw docstring

set-state-for-nodeclj

(set-state-for-node state-name node)

Sets the boolean state-name flag on node.

Sets the boolean `state-name` flag on `node`.
sourceraw docstring

state-tag-nameclj

source

target-action-plancljmultimethod

Build action plans for the specified phase on all nodes or groups in the given target, within the context of the service-state. The plan-state contains all the settings, etc, for all groups.

Build action plans for the specified `phase` on all nodes or groups in the
given `target`, within the context of the `service-state`. The `plan-state`
contains all the settings, etc, for all groups.
sourceraw docstring

target-phaseclj

(target-phase target phase)
source

throw-phase-errorsclj

(throw-phase-errors result)
source

versionclj

(version)

Returns the pallet version.

Returns the pallet version.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close