pallet.ssh.node-state.state-root documentation

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

->StateRootBackup

fn

[state-root]

Positional factory function for class pallet.ssh.nodestate.stateroot.StateRootBackup.

->StateRootChecksum

fn

[state-root]

Positional factory function for class pallet.ssh.nodestate.stateroot.StateRootChecksum.

->StateRootSetup

fn

[state-root]

Positional factory function for class pallet.ssh.nodestate.stateroot.StateRootSetup.

create-path-with-template

fn

[template-path new-path]

Create the /var/lib/pallet directory if required, ensuring correct permissions. Note this is not the final directory.

default-state-root

fn

[]

Provide a computed default for state-root if it isn't set.

map->StateRootBackup

fn

[m__5665__auto__]

Factory function for class pallet.ssh.nodestate.stateroot.StateRootBackup, taking a map of keywords to field values.

map->StateRootChecksum

fn

[m__5665__auto__]

Factory function for class pallet.ssh.nodestate.stateroot.StateRootChecksum, taking a map of keywords to field values.

map->StateRootSetup

fn

[m__5665__auto__]

Factory function for class pallet.ssh.nodestate.stateroot.StateRootSetup, taking a map of keywords to field values.

md5-path

fn

[state-path]

Return a path for the md5 file for state-path under state-root.

record

fn

[path state-path {:keys [max-versions no-versioning versioning], :or {max-versions 5, versioning :numbered}}]

Script to record a new (version of a) file in state-root

record-md5

fn

[path md5-path]

Script to record a file's md5

state-path

fn

[session state-root path]

Return a path under state-root for a given path.

state-path*

fn

[session state-root script-dir path]

Return a path under state-root for a given path.

state-root-backup

fn

[{:keys [state-root], :as options}]

Return a state-root backup instance that can keep backups.

state-root-checksum

fn

[{:keys [state-root], :as options}]

Return a state-root checksum instance that can verify md5 checksums.

state-root-setup

fn

[{:keys [state-root], :as options}]

Return a state-root-setup instance that can setup the state root.

verify

fn

[path state-path md5-path]

verify if the files at path and state-path are identical, and whether they match the md5-path.