Liking cljdoc? Tell your friends :D

pallet.action

Actions are the primitives that are called by crate functions.

Actions can have multiple implementations, but by default most are implemented as script to be executed on the remote node.

An action has an :execution, which is one of :aggregated, :in-sequence, :collected, :delayed-crate-fn or :aggregated-crate-fn.

Calls to :aggregated actions will be grouped, and run before :in-sequence actions. Calls to :collected actions will be grouped, and run after :in-sequence actions.

Calls to :delayed-crate-fn and :aggregated-crate-fn actions are evaluated at action plan translation time, which provides a mechanism for calling crate functions after all other crate functions have been called.

Actions are the primitives that are called by crate functions.

Actions can have multiple implementations, but by default most are
implemented as script to be executed on the remote node.

An action has an :execution, which is one of :aggregated, :in-sequence,
:collected, :delayed-crate-fn or :aggregated-crate-fn.

Calls to :aggregated actions will be grouped, and run before
:in-sequence actions. Calls to :collected actions will be grouped, and run
after :in-sequence actions.

Calls to :delayed-crate-fn and :aggregated-crate-fn actions are evaluated
at action plan translation time, which provides a mechanism for calling
crate functions after all other crate functions have been called.
raw docstring

pallet.action-impl

Provides a data structure for pallet's actions. This is the internal representation of an action. User code should use pallet.action, where actions are represented via the functions that insert them into the session action plan.

Each action has a symbol associated with an action is used in error messages. The symbol does not have to resolve to a var.

The execution specifies the execution model for the action.

Precedence is stored as a map, with :always-before and :always-after keys.

Each implementation is represented as a map of metadata and function. The map is stored in a map in an atom on the ::impls key of the metadata of the action, keyed by the dispatch value. This allows for the implementation function to be an anonymous named function, while still having metadata associated with it.

Provides a data structure for pallet's actions. This is the internal
representation of an action. User code should use pallet.action, where actions
are represented via the functions that insert them into the session action
plan.

Each action has a symbol associated with an action is used in error messages.
The symbol does not have to resolve to a var.

The `execution` specifies the execution model for the action.

Precedence is stored as a map, with :always-before and :always-after keys.

Each implementation is represented as a map of metadata and function. The map
is stored in a map in an atom on the ::impls key of the metadata of the
action, keyed by the dispatch value. This allows for the implementation
function to be an anonymous named function, while still having metadata
associated with it.
raw docstring

pallet.action-plan

An action plan contains instances of actions (action maps) for execution.

The action plan is built by executing a phase function. Each phase function calls actions which insert themselves into the action plan.

The action plan is transformed to provide aggregated operations, run delayed crate functions, and to resolve precedence relations between actions.

A translated plan is executed by passing an executor, which is a function that will be passed each action map in the plan. The executor function is responsible for selecting the implementation of the action to be used, and calling the implementation with the action-map arguments.

Note this is an implementation namespace.

An action plan contains instances of actions (action maps) for execution.

The action plan is built by executing a phase function. Each phase function
calls actions which insert themselves into the action plan.

The action plan is transformed to provide aggregated operations, run delayed
crate functions, and to resolve precedence relations between actions.

A translated plan is executed by passing an executor, which is a function
that will be passed each action map in the plan.  The executor function is
responsible for selecting the implementation of the action to be used, and
calling the implementation with the action-map arguments.

Note this is an implementation namespace.
raw docstring

pallet.actions.direct

Direct execution action implementations

Direct execution action implementations
raw docstring

No vars found in this namespace.

pallet.actions.direct.conditional

Conditional action execution.

Conditional action execution.
raw docstring

No vars found in this namespace.

pallet.actions.direct.directory

A directory manipulation action, to create and remove directories with given ownership and mode.

A directory manipulation action, to create and remove directories
with given ownership and mode.
raw docstring

pallet.actions.direct.exec-script

Script execution. Script generation occurs with the correct script context.

Script execution. Script generation occurs with the correct script context.
raw docstring

No vars found in this namespace.

pallet.actions.direct.package

Package management action.

package is used to install or remove a package.

package-source is used to specify a non-standard source for packages.

Package management action.

`package` is used to install or remove a package.

`package-source` is used to specify a non-standard source for packages.
raw docstring

pallet.actions.direct.remote-directory

Action to specify the content of a remote directory. At present the content can come from a downloaded tar or zip file.

Action to specify the content of a remote directory.  At present the
content can come from a downloaded tar or zip file.
raw docstring

No vars found in this namespace.

pallet.actions.direct.retry

Provides an action that can be repeated if it fails

Provides an action that can be repeated if it fails
raw docstring

No vars found in this namespace.

pallet.actions.direct.service

Service control. Deprecated in favour of pallet.crate.service.

Service control. Deprecated in favour of pallet.crate.service.
raw docstring

pallet.actions.direct.settings

No vars found in this namespace.

pallet.actions.direct.user

User management action.

User management action.
raw docstring

pallet.argument

Arguments to actions. Adds capability of evaluating arguments at action application

Arguments to actions.  Adds capability of evaluating arguments at
action application
raw docstring

pallet.blobstore.url-blobstore

A url based blobstore implementation.

A url based blobstore implementation.
raw docstring

No vars found in this namespace.

pallet.command-line

Process command-line arguments according to a given cmdspec

Process command-line arguments according to a given cmdspec
raw docstring

pallet.compute.jvm

Information from local jvm

Information from local jvm
raw docstring

pallet.compute.localhost

Localhost provider service implementation.

This enables your localhost to masquerade as a node for any group.

run-nodes will set the group-name for the localhost node, but is otherwise a no-op. The localhost node is marked as bootstrapped to prevent bootstrap actions from occurring on group-name changes.

Node removal functions are no-ops.

Localhost provider service implementation.

This enables your localhost to masquerade as a node for any group.

`run-nodes` will set the group-name for the localhost node, but is otherwise a
no-op.  The localhost node is marked as bootstrapped to prevent bootstrap
actions from occurring on group-name changes.

Node removal functions are no-ops.
raw docstring

No vars found in this namespace.

pallet.compute.node-list

A simple node list provider.

The node-list provider enables pallet to work with a server rack or existing virtual machines. It works by maintaining a list of nodes. Each node minimally provides an IP address, a host name, a group name and an operating system. Nodes are constructed using make-node.

An instance of the node-list provider can be built using node-list-service.

(node-list-service
  [["host1" "fullstack" "192.168.1.101" :ubuntu]
   ["host2" "fullstack" "192.168.1.102" :ubuntu]])
A simple node list provider.

The node-list provider enables pallet to work with a server rack or existing
virtual machines. It works by maintaining a list of nodes. Each node
minimally provides an IP address, a host name, a group name and an operating
system. Nodes are constructed using `make-node`.

An instance of the node-list provider can be built using
`node-list-service`.

    (node-list-service
      [["host1" "fullstack" "192.168.1.101" :ubuntu]
       ["host2" "fullstack" "192.168.1.102" :ubuntu]])
raw docstring

pallet.config-file.format

Some standard file formating.

Some standard file formating.
raw docstring

pallet.configure

Pallet configuration using ~/.pallet/config.clj, the pallet.config namespace or from settings.xml.

config.clj should be in ~/.pallet or a directory specified by the PALLET_HOME environment variable.

service definitions can also be specified as clojure maps in ~/.pallet/services/*.clj

Pallet configuration using ~/.pallet/config.clj, the pallet.config namespace
or from settings.xml.

config.clj should be in ~/.pallet or a directory specified by the PALLET_HOME
environment variable.

service definitions can also be specified as clojure maps in
~/.pallet/services/*.clj
raw docstring

pallet.core.file-upload.protocols

Protocols for file upload

Protocols for file upload
raw docstring

pallet.core.file-upload.rsync-upload

Implementation of file upload using rsync.

Implementation of file upload using rsync.
raw docstring

pallet.core.plan-state

Functions to manipulate the plan-state map. The plan-state represents all the cumulative settings information on the nodes in an operation.

Functions to manipulate the plan-state map. The plan-state represents all the
cumulative settings information on the nodes in an operation.
raw docstring

pallet.core.thread-local

Provides a thread local place, using a dynamic var.

A thread local place can be given a value using with-thread-locals. It is an error to use with-thread-locals if the thread local already has a value.

The current value of the thread local is found with thread-local.

The current value of the thread local can be set with thread-local!. It is an error to set the value on a thread other than the one used to provide the initial value using with-thread-locals.

 (def ^:dynamic *tl*)

 (with-thread-locals [*t1* {}]
  (assert (= (thread-local *tl*) {}))
  (thread-local! *tl* {:a 1})
  (assert (= (thread-local *tl*) {:a 1})))
Provides a thread local place, using a dynamic var.

A thread local place can be given a value using `with-thread-locals`.  It is an
error to use `with-thread-locals` if the thread local already has a value.

The current value of the thread local is found with `thread-local`.

The current value of the thread local can be set with `thread-local!`.  It is an
error to set the value on a thread other than the one used to provide the
initial value using `with-thread-locals`.

     (def ^:dynamic *tl*)

     (with-thread-locals [*t1* {}]
      (assert (= (thread-local *tl*) {}))
      (thread-local! *tl* {:a 1})
      (assert (= (thread-local *tl*) {:a 1})))
raw docstring

pallet.crate-install

Install methods for crates

Install methods for crates
raw docstring

pallet.crate.environment

Set up the system environment.

Set up the system environment.
raw docstring

pallet.crate.etc-default

Generation and installation of /etc/default-style files.

Generation and installation of /etc/default-style files.
raw docstring

pallet.crate.initd

Provides service supervision via initd

Provides service supervision via initd
raw docstring

pallet.crate.limits-conf

Configure the /etc/security/limits.conf file.

Configure the /etc/security/limits.conf file.
raw docstring

pallet.crate.network-service

Crate for working with network services

Crate for working with network services
raw docstring

pallet.crate.nohup

Provides supervision via nohup. Note that this is very limited, and not really recommended for production use.

Provides supervision via nohup.  Note that this is very limited, and not
really recommended for production use.
raw docstring

pallet.crate.os

OS detection for pallet to determine os and version

OS detection for pallet to determine os and version
raw docstring

pallet.crate.package.centos

Actions for working with the centos repositories

Actions for working with the centos repositories
raw docstring

pallet.crate.package.debian-backports

Actions for working with the debian backports repository

Actions for working with the debian backports repository
raw docstring

pallet.crate.package.epel

Actions for working with the epel repository

Actions for working with the epel repository
raw docstring

pallet.crate.package.rpmforge

Actions for working with the rpmforge repository

Actions for working with the rpmforge repository
raw docstring

pallet.crate.service

Run services under supervision.

This crate provides a framework for a process under supervision. It can be extended by different supervision providers, by providing methods for the various multi-methods. A crate can provide configuration for use with a range of supervision providers.

To control a service, the service function is used.

To configure a job for a service, implement a supervisor-config-map for the facility and supervision service you wish to use. Ensure the server-spec for the supervision implementation is extended by your group-spec.

To create an implementation for a new service supervision provider, implement methods for service-supervisor-available?, service-supervisor and service-supervisor-config.

Run services under supervision.

This crate provides a framework for a process under supervision.  It can be
extended by different supervision providers, by providing methods for the
various multi-methods.  A crate can provide configuration for use with a range
of supervision providers.

To control a service, the `service` function is used.

To configure a job for a service, implement a supervisor-config-map for the
facility and supervision service you wish to use.  Ensure the `server-spec` for
the supervision implementation is extended by your group-spec.

To create an implementation for a new service supervision provider, implement
methods for `service-supervisor-available?`, `service-supervisor` and
`service-supervisor-config`.
raw docstring

pallet.debug

Helpers for debugging.

Helpers for debugging.
raw docstring

pallet.echo.execute

Action execution that just echos the action script

Action execution that just echos the action script
raw docstring

pallet.enlive

Wrappers for enlive to enable template specialisation and use xml.

Wrappers for enlive to enable template specialisation and use xml.
raw docstring

pallet.environment

The environments provide mechanisms for customising Pallet and Pallet crates according to externally determined criteria.

An environment can be specified at the global, service, invocation and tag scopes.

To provide a global default, specify an :environment key at the top level of defpallet in ~/.pallet/config.clj.

To provide a service specific default, specify an :environment key at the service level of defpallet in ~/.pallet/config.clj.

To provide a project specific default, define pallet.config/environment.

To provide a specific environment when invoking lift or converge, pass an environment map using the :environment key.

The merging of values between scopes is key specific, and is determined by merge-key-algorithm.

The environments provide mechanisms for customising Pallet and
Pallet crates according to externally determined criteria.

An environment can be specified at the global, service, invocation and tag
scopes.

To provide a global default, specify an `:environment` key at the top level
of `defpallet` in `~/.pallet/config.clj`.

To provide a service specific default, specify an `:environment` key at the
service level of `defpallet` in `~/.pallet/config.clj`.

To provide a project specific default, define `pallet.config/environment`.

To provide a specific environment when invoking `lift` or `converge`, pass an
environment map using the `:environment` key.

The merging of values between scopes is key specific, and is determined by
`merge-key-algorithm`.
raw docstring

pallet.environment-impl

Implementation namespace for the pallet environment.

Implementation namespace for the pallet environment.
raw docstring

pallet.event

Pallet events. Provides ability to hook into pallet event stream.

Pallet events. Provides ability to hook into pallet event stream.
raw docstring

pallet.executors

Action executors for pallet.

An action has a :action-type. Known types include :script and :fn/clojure.

An action has a :location, :origin for execution on the node running pallet, and :target for the target node.

The action-type determines how the action should be handled:

:script - action produces script for execution on remote machine :fn/clojure - action is a function for local execution :transfer/to-local - action is a function specifying remote source and local destination. :transfer/from-local - action is a function specifying local source and remote destination.

Action executors for pallet.

An action has a :action-type. Known types include :script
and :fn/clojure.

An action has a :location, :origin for execution on the node running
pallet, and :target for the target node.

The action-type determines how the action should be handled:

:script - action produces script for execution on remote machine
:fn/clojure  - action is a function for local execution
:transfer/to-local - action is a function specifying remote source
                     and local destination.
:transfer/from-local - action is a function specifying local source
                       and remote destination.
raw docstring

pallet.feature

Pallet feature recognition.

A feature is implemented as a function within the pallet.feature namespace

Pallet feature recognition.

A feature is implemented as a function within the pallet.feature namespace
raw docstring

pallet.futures

Keep track of operations started by pallet

Keep track of operations started by pallet
raw docstring

pallet.main-invoker

Invoke tasks requiring a compute service. This decouples main from anything pallet, jclouds or maven specific, and ensures compiling main doesn't compile the world.

Invoke tasks requiring a compute service.  This decouples main from anything
pallet, jclouds or maven specific, and ensures compiling main doesn't compile
the world.
raw docstring

pallet.node-value

A node value is a value that is retrieved from a node and can only be deref'd when after the value as been provided by an action.

The action may not be executed on the same pallet machine as the phase, so the actual value is in the session map, and the node-value contains a key into the session map's :node-values key.

A node value is a value that is retrieved from a node and can only be deref'd
when after the value as been provided by an action.

The action may not be executed on the same pallet machine as the phase, so
the actual value is in the session map, and the node-value contains a key
into the session map's :node-values key.
raw docstring

pallet.phase

A phase is a function of a single session argument, that contains calls to crate functions or actions. A phase has an implicitly defined pre and post phase.

A phase is a function of a single `session` argument, that contains
calls to crate functions or actions. A phase has an implicitly
defined pre and post phase.
raw docstring

pallet.project

Pallet projects are specified in a pallet.clj file.

The files are loaded by calling clojure.core/load in the pallet.project.load namespace. The defproject form in that file def's a pallet-project-map var, which is reset after loading.

defproject refers to pallet.project.loader/defproject.

Pallet projects are specified in a pallet.clj file.

The files are loaded by calling clojure.core/load in the pallet.project.load
namespace.  The defproject form in that file def's a `pallet-project-map` var,
which is reset after loading.

defproject refers to pallet.project.loader/defproject.
raw docstring

pallet.project.load

Namespace for loading pallet project files. Provides a default set of requires that are available to the pallet file.

Namespace for loading pallet project files.  Provides a default set of
requires that are available to the pallet file.
raw docstring

No vars found in this namespace.

pallet.project.loader

Functions and macros required to load a pallet project configuration file.

Functions and macros required to load a pallet project configuration file.
raw docstring

pallet.script-builder

Build scripts with prologues, epilogues, etc, and command lines for running them in different environments

Build scripts with prologues, epilogues, etc, and command lines for
running them in different environments
raw docstring

pallet.script-exec

Script execution for pallet. Abstracts over transport, script environment, and the script itself

Script execution for pallet.
Abstracts over transport, script environment, and the script itself
raw docstring

pallet.session.action-plan

Session specific action-plan functions.

Encapsulates the location of the action-plans in the session.

Session specific action-plan functions.

Encapsulates the location of the action-plans in the session.
raw docstring

pallet.ssh.content-files

Location of intermediate content files.

Location of intermediate content files.
raw docstring

pallet.ssh.content-files.protocols

Protocols for node state updates

Protocols for node state updates
raw docstring

pallet.ssh.credentials

Functions for working with ssh credentials.

Functions for working with ssh credentials.
raw docstring

pallet.ssh.file-upload.sftp-upload

Implementation of file upload using SFTP.

This assumes that chown/chgrp/chmod are all going to work.

Implementation of file upload using SFTP.

This assumes that chown/chgrp/chmod are all going to work.
raw docstring

pallet.ssh.node-state.no-state

A node-state implementation that maintains no node state

A node-state implementation that maintains no node state
raw docstring

pallet.ssh.node-state.protocols

Protocols for node state updates

Protocols for node state updates
raw docstring

pallet.ssh.node-state.state-root

A node-state implementation that maintains node state in a parallel directory tree.

A node-state implementation that maintains node state in a parallel directory
tree.
raw docstring

pallet.strint

Runtime string interpolation built on top of clojure.contrib.strint.

Runtime string interpolation built on top of clojure.contrib.strint.
raw docstring

pallet.task

Task helpers, that do not have any dependencies in pallet.

Task helpers, that do not have any dependencies in pallet.
raw docstring

pallet.task-utils

Task helpers that depend on pallet implementation

Task helpers that depend on pallet implementation
raw docstring

pallet.task.add-service

Add a service definition to pallet.

Add a service definition to pallet.
raw docstring

pallet.task.config

Create a pallet configuration file in ~/.pallet/config.clj

Create a pallet configuration file in ~/.pallet/config.clj
raw docstring

pallet.task.containers

List containers.

List containers.
raw docstring

pallet.task.converge

Adjust node counts.

Adjust node counts.
raw docstring

pallet.task.describe-node

Describe the node definition.

Describe the node definition.
raw docstring

pallet.task.down

Remove project nodes.

Remove project nodes.
raw docstring

pallet.task.help

Display a list of tasks or help for a given task.

Display a list of tasks or help for a given task.
raw docstring

pallet.task.images

List images.

List images.
raw docstring

pallet.task.lift

Apply configuration.

Apply configuration.
raw docstring

pallet.task.project-init

Initialise a project.

Initialise a project.
raw docstring

pallet.task.providers

Provide information on the supported and enabled providers.

Provide information on the supported and enabled providers.
raw docstring

pallet.task.version

Print Pallet's version to standard out.

Print Pallet's version to standard out.
raw docstring

pallet.template.properties

A template for writing properties style config files.

A template for writing properties style config files.
raw docstring

pallet.version-dispatch

Dispatch that is version aware.

A version is a dotted string, e.g. "1.0.3", which is represented as a vector [1 0 3].

A version specification is either a version vector, which matches a single version (and all point versions thereof), or a vector of two elements, specifying an inclusive version range. A nil in the version vector signifies an open end to the range.

The basic idea is that you wish to dispatch on hierarchy where the dispatched data may provide a version.

Dispatch that is version aware.

A version is a dotted string, e.g. "1.0.3", which is represented as a vector
`[1 0 3]`.

A version specification is either a version vector, which matches a single
version (and all point versions thereof), or a vector of two elements,
specifying an inclusive version range. A nil in the version vector signifies an
open end to the range.

The basic idea is that you wish to dispatch on hierarchy where the dispatched
data may provide a version.
raw docstring

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

× close