Liking cljdoc? Tell your friends :D

pallet.crate

# Pallet Crate Writing API
raw docstring

add-plan-method-to-multiclj

(add-plan-method-to-multi multifn dispatch-val f)
source

admin-groupclj

(admin-group)

User that remote commands are run under

User that remote commands are run under
sourceraw docstring

admin-userclj

(admin-user)

Id of the target-node.

Id of the target-node.
sourceraw docstring

assoc-settingsclj

(assoc-settings facility kv-pairs)
(assoc-settings facility kv-pairs {:keys [instance-id] :as options})

Set the settings for the specified host facility. The instance-id allows the specification of specific instance of the facility.

Set the settings for the specified host facility. The instance-id allows
the specification of specific instance of the facility.
sourceraw docstring

blobstoreclj

(blobstore)

Returns the current blobstore.

Returns the current blobstore.
sourceraw docstring

compute-serviceclj

(compute-service)

Returns the current compute service

Returns the current compute service
sourceraw docstring

def-aggregate-plan-fncljmacro

(def-aggregate-plan-fn name doc-string? attr-map? [params*] f)

Define a crate function where arguments on successive calls are conjoined, and passed to the function specified in the body.

Define a crate function where arguments on successive calls are conjoined,
and passed to the function specified in the body.
sourceraw docstring

def-collect-plan-fncljmacro

(def-collect-plan-fn name doc-string? attr-map? [params*] f)

Define a crate function where arguments on successive calls are conjoined, and passed to the function specified in the body.

Define a crate function where arguments on successive calls are conjoined,
and passed to the function specified in the body.
sourceraw docstring

defmethod-plancljmacro

(defmethod-plan multifn dispatch-val args & body)
source

defmulti-plancljmacro

(defmulti-plan name
               docstring?
               attr-map?
               dispatch-fn
               &
               {:keys [hierarchy] :as options})

Declare a multimethod for plan functions

Declare a multimethod for plan functions
sourceraw docstring

defplancljmacro

(defplan name doc-string? attr-map? [params*] body)

Define a crate function.

Define a crate function.
sourceraw docstring

final-fn-sym?clj

(final-fn-sym? sym form)

Predicate to match the final function symbol in a form.

Predicate to match the final function symbol in a form.
sourceraw docstring

get-node-settingsclj

(get-node-settings node facility)
(get-node-settings node facility {:keys [instance-id default] :as options})

Retrieve the settings for the facility on the node. The instance-id allows the specification of specific instance of the facility.

Retrieve the settings for the `facility` on the `node`. The instance-id
allows the specification of specific instance of the facility.
sourceraw docstring

get-settingsclj

(get-settings facility)
(get-settings facility {:keys [instance-id default] :as options})

Retrieve the settings for the specified host facility. The instance-id allows the specification of specific instance of the facility.

Retrieve the settings for the specified host facility. The instance-id allows
the specification of specific instance of the facility.
sourceraw docstring

group-nameclj

(group-name)

Group-Name of the target-node.

Group-Name of the target-node.
sourceraw docstring

groups-with-roleclj

(groups-with-role role)

All target groups with the specified role.

All target groups with the specified role.
sourceraw docstring

is-64bit?clj

(is-64bit?)

Predicate for a 64 bit target

Predicate for a 64 bit target
sourceraw docstring

nodes-in-groupclj

(nodes-in-group)
(nodes-in-group group-name)

All nodesin the same tag as the target-node, or with the specified group-name.

All nodesin the same tag as the target-node, or with the specified
group-name.
sourceraw docstring

nodes-with-roleclj

(nodes-with-role role)

All target nodes with the specified role.

All target nodes with the specified role.
sourceraw docstring

os-familyclj

(os-family)

OS-Family of the target-node.

OS-Family of the target-node.
sourceraw docstring

os-versionclj

(os-version)

OS-Family of the target-node.

OS-Family of the target-node.
sourceraw docstring

packagerclj

(packager)
source

phase-contextcljmacro

(phase-context pipeline-name event & args)

Defines a block with a context that is automatically added.

Defines a block with a context that is automatically added.
sourceraw docstring

role->nodes-mapclj

(role->nodes-map)

A map from role to nodes.

A map from role to nodes.
sourceraw docstring

service-phasesclj

(service-phases facility
                options
                service-f
                &
                {:keys [actions] :or {actions [:start :stop :restart :status]}})

Return a map of service phases for the specified facility, options and service function. Optionally, specify :actions with a sequence of keywords for the actions you wish to generate service control phases for.

Return a map of service phases for the specified facility, options and
service function.  Optionally, specify :actions with a sequence of keywords
for the actions you wish to generate service control phases for.
sourceraw docstring

session-peek-fncljmacro

(session-peek-fn [sym] & body)

Create a state-m monadic value function that examines the session, and returns nil.

Create a state-m monadic value function that examines the session, and
returns nil.
sourceraw docstring

targetclj

(target)

The target-node map.

The target-node map.
sourceraw docstring

target-flag-valueclj

(target-flag-value flag)
source

target-flag?clj

(target-flag? flag)

Returns a DelayedFunction that is a predicate for whether the flag is set

Returns a DelayedFunction that is a predicate for whether the flag is set
sourceraw docstring

target-idclj

(target-id)

Id of the target-node (unique for provider).

Id of the target-node (unique for provider).
sourceraw docstring

target-nameclj

(target-name)

Name of the target-node.

Name of the target-node.
sourceraw docstring

target-nodeclj

(target-node)

The target-node instance (the :node in the target-node map).

The target-node instance (the :node in the target-node map).
sourceraw docstring

target-nodesclj

(target-nodes)

All target-nodes.

All target-nodes.
sourceraw docstring

targetsclj

(targets)

All targets.

All targets.
sourceraw docstring

targets-in-groupclj

(targets-in-group)
(targets-in-group group-name)

All targets in the same tag as the target-node, or with the specified group-name.

All targets in the same tag as the target-node, or with the
specified group-name.
sourceraw docstring

targets-with-roleclj

(targets-with-role role)

All targets with the specified role.

All targets with the specified role.
sourceraw docstring

update-settingsclj

(update-settings facility f & args)
(update-settings facility options f & args)

Update the settings for the specified host facility. The instance-id allows the specification of specific instance of the facility (the default is :default).

Update the settings for the specified host facility. The instance-id allows
the specification of specific instance of the facility (the default is
:default).
sourceraw docstring

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

× close