The consfigurator Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The consfigurator Reference Manual

This is the consfigurator Reference Manual, version 0.5.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:45:31 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Introduction
============

Consfigurator is a system for declarative configuration management using
Common Lisp.  You can use it to configure hosts as root, deploy services as
unprivileged users, build and deploy containers, and produce disc images.

Consfigurator's design gives you a great deal of flexibility about how to
control the hosts you want to configure.  If there is a command you can run
which will obtain input and output streams attached to an interactive POSIX sh
running on the target host/container, then with a little glue code, you can
use much of Consfigurator's functionality to configure that host/container.
But if it is possible to get an implementation of Common Lisp started up on
the host, then Configurator can transparently execute your deployment code
over on the remote side, rather than exchanging information via POSIX sh.
This lets you use the full power of Common Lisp to deploy your configuration.

Configurator has convenient abstractions for combining these different ways to
execute your configuration on hosts with different ways of connecting to them.
Connections can be arbitrarily nested.  For example, to combine SSHing to a
Debian machine as an unprivileged user, using sudo to become root, and then
starting up a Lisp image to execute your deployment code, you would just
evaluate::

  (deploy (:ssh (:sudo :as "spwhitton@athena.example.com") :sbcl) athena.example.com)

Declarative configuration management systems like Consfigurator and Propellor_
share a number of goals with projects like the `GNU Guix System`_ and
`NixOS`_.  However, tools like Consfigurator and Propellor try to layer the
power of declarative and reproducible configuration on top of traditional,
battle-tested unix system administration infrastructure like apt, dpkg, yum,
and distro package archives, rather than seeking to replace any of those.
Let's get as much as we can out of all that existing distro policy-compliant
work!

*Some features described in the foregoing are not yet implemented, but
Consfigurator's design permits them to be.*

.. _Propellor: https://propellor.branchable.com/
.. _GNU Guix System: https://guix.gnu.org/
.. _NixOS: https://nixos.org/

About the name
--------------

``CONS`` is a fundamental operator in Lisp.  Consfigurator is so named because
we hope to enable configuration management workflows which take advantage of
some of the unique properties of the activity of programming in Lisp.

For example, using Lisp's interactivity, it's easy to test a new property
you're working on without having to plumb it into your main deployments, which
might be large and relatively slow to run.  Hit ``C-c C-c`` on your
``DEFPROP`` form in Emacs, switch to the repl, and then use ``DEPLOY-THESE``
to run just that property against localhost or a local container, until it
does what it should.

For this purpose you can use whatever connection type is most convenient --
perhaps you normally deploy using Consfigurator's support for starting up
remote Lisp images, but you can swap in a simple, lighter-weight connection
type for testing.  Another respect in which this is useful is that interactive
debugging is not possible with connection types which start up remote Lisp
images.

We have a few nice macros defined, too.

Installation and usage
======================

Please see the `user's manual`_ which includes a tutorial/quick start guide.

.. _user's manual: https://spwhitton.name/doc/consfigurator/

Bug reports, patches etc.
=========================

Please see CONTRIBUTING.rst, included in the source tree, for information
regarding the reporting of bugs and submission of patches/pull requests.

License
=======

Copyright (C) 2020-2021  Sean Whitton

Consfigurator is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

Consfigurator is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
details.

You should have received a copy of the GNU General Public License along with
Consfigurator.  If not, see .


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 consfigurator

Author

Sean Whitton <spwhitton@spwhitton.name>

License

GPL-3+

Description

Lisp declarative configuration management system

Version

0.5.0

Dependencies
Source

consfigurator.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 consfigurator.asd

Location

consfigurator.asd

Systems

consfigurator (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 consfigurator/src/package.lisp

Parent

consfigurator (system)

Location

src/package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 consfigurator/src/reader.lisp

Dependency

src/package.lisp (file)

Parent

consfigurator (system)

Location

src/reader.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 consfigurator/src/util.lisp

Dependency

src/reader.lisp (file)

Parent

consfigurator (system)

Location

src/util.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 consfigurator/src/connection.lisp

Dependency

src/util.lisp (file)

Parent

consfigurator (system)

Location

src/connection.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 consfigurator/src/property.lisp

Dependency

src/connection.lisp (file)

Parent

consfigurator (system)

Location

src/property.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 consfigurator/src/propspec.lisp

Dependency

src/property.lisp (file)

Parent

consfigurator (system)

Location

src/propspec.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 consfigurator/src/host.lisp

Dependency

src/propspec.lisp (file)

Parent

consfigurator (system)

Location

src/host.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 consfigurator/src/combinator.lisp

Dependency

src/host.lisp (file)

Parent

consfigurator (system)

Location

src/combinator.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 consfigurator/src/deployment.lisp

Dependency

src/combinator.lisp (file)

Parent

consfigurator (system)

Location

src/deployment.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.11 consfigurator/src/connection/local.lisp

Dependency

src/deployment.lisp (file)

Parent

consfigurator (system)

Location

src/connection/local.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.12 consfigurator/src/data.lisp

Dependency

src/connection/local.lisp (file)

Parent

consfigurator (system)

Location

src/data.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.13 consfigurator/src/property/cmd.lisp

Dependency

src/data.lisp (file)

Parent

consfigurator (system)

Location

src/property/cmd.lisp

Exported Definitions

single (function)

Internal Definitions

single. (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.14 consfigurator/src/property/file.lisp

Dependency

src/property/cmd.lisp (file)

Parent

consfigurator (system)

Location

src/property/file.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.15 consfigurator/src/property/os.lisp

Dependency

src/property/file.lisp (file)

Parent

consfigurator (system)

Location

src/property/os.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.16 consfigurator/src/property/service.lisp

Dependency

src/property/os.lisp (file)

Parent

consfigurator (system)

Location

src/property/service.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.17 consfigurator/src/property/apt.lisp

Dependency

src/property/service.lisp (file)

Parent

consfigurator (system)

Location

src/property/apt.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.18 consfigurator/src/property/chroot.lisp

Dependency

src/property/apt.lisp (file)

Parent

consfigurator (system)

Location

src/property/chroot.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.19 consfigurator/src/property/user.lisp

Dependency

src/property/chroot.lisp (file)

Parent

consfigurator (system)

Location

src/property/user.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.20 consfigurator/src/property/git.lisp

Dependency

src/property/user.lisp (file)

Parent

consfigurator (system)

Location

src/property/git.lisp

Exported Definitions

snapshot-extracted (function)

Internal Definitions

snapshot-extracted. (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.21 consfigurator/src/property/gnupg.lisp

Dependency

src/property/git.lisp (file)

Parent

consfigurator (system)

Location

src/property/gnupg.lisp

Exported Definitions

public-key-imported (function)

Internal Definitions

public-key-imported. (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.22 consfigurator/src/property/ssh.lisp

Dependency

src/property/gnupg.lisp (file)

Parent

consfigurator (system)

Location

src/property/ssh.lisp

Exported Definitions

authorized-keys (function)

Internal Definitions

authorized-keys. (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.23 consfigurator/src/property/sshd.lisp

Dependency

src/property/ssh.lisp (file)

Parent

consfigurator (system)

Location

src/property/sshd.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.24 consfigurator/src/property/locale.lisp

Dependency

src/property/sshd.lisp (file)

Parent

consfigurator (system)

Location

src/property/locale.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.25 consfigurator/src/connection/shell-wrap.lisp

Dependency

src/property/locale.lisp (file)

Parent

consfigurator (system)

Location

src/connection/shell-wrap.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.26 consfigurator/src/connection/fork.lisp

Dependency

src/connection/shell-wrap.lisp (file)

Parent

consfigurator (system)

Location

src/connection/fork.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.27 consfigurator/src/connection/rehome.lisp

Dependency

src/connection/fork.lisp (file)

Parent

consfigurator (system)

Location

src/connection/rehome.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.28 consfigurator/src/connection/ssh.lisp

Dependency

src/connection/rehome.lisp (file)

Parent

consfigurator (system)

Location

src/connection/ssh.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.29 consfigurator/src/connection/sudo.lisp

Dependency

src/connection/ssh.lisp (file)

Parent

consfigurator (system)

Location

src/connection/sudo.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.30 consfigurator/src/connection/su.lisp

Dependency

src/connection/sudo.lisp (file)

Parent

consfigurator (system)

Location

src/connection/su.lisp

Exported Definitions
Internal Definitions

su-connection (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.31 consfigurator/src/connection/sbcl.lisp

Dependency

src/connection/su.lisp (file)

Parent

consfigurator (system)

Location

src/connection/sbcl.lisp

Exported Definitions

establish-connection (method)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.32 consfigurator/src/connection/chroot.lisp

Dependency

src/connection/sbcl.lisp (file)

Parent

consfigurator (system)

Location

src/connection/chroot.lisp

Exported Definitions

establish-connection (method)

Internal Definitions

can-chroot (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.33 consfigurator/src/connection/chroot/fork.lisp

Dependency

src/connection/chroot.lisp (file)

Parent

consfigurator (system)

Location

src/connection/chroot/fork.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.34 consfigurator/src/connection/chroot/shell.lisp

Dependency

src/connection/chroot/fork.lisp (file)

Parent

consfigurator (system)

Location

src/connection/chroot/shell.lisp

Exported Definitions
Internal Definitions

shell-chroot-connection (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.35 consfigurator/src/connection/setuid.lisp

Dependency

src/connection/chroot/shell.lisp (file)

Parent

consfigurator (system)

Location

src/connection/setuid.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.36 consfigurator/src/connection/as.lisp

Dependency

src/connection/setuid.lisp (file)

Parent

consfigurator (system)

Location

src/connection/as.lisp

Exported Definitions

establish-connection (method)

Internal Definitions

can-setuid (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.37 consfigurator/src/data/asdf.lisp

Dependency

src/connection/as.lisp (file)

Parent

consfigurator (system)

Location

src/data/asdf.lisp

Exported Definitions

register-data-source (method)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.38 consfigurator/src/data/pgp.lisp

Dependency

src/data/asdf.lisp (file)

Parent

consfigurator (system)

Location

src/data/pgp.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.39 consfigurator/src/data/git-snapshot.lisp

Dependency

src/data/pgp.lisp (file)

Parent

consfigurator (system)

Location

src/data/git-snapshot.lisp

Exported Definitions

register-data-source (method)

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.40 consfigurator/src/data/gpgpubkeys.lisp

Dependency

src/data/git-snapshot.lisp (file)

Parent

consfigurator (system)

Location

src/data/gpgpubkeys.lisp

Exported Definitions

register-data-source (method)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 consfigurator.connection.sbcl

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 consfigurator.property.locale

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.3 consfigurator.property.ssh

Source

src/package.lisp (file)

Use List
Exported Definitions

authorized-keys (function)

Internal Definitions

authorized-keys. (macro)


Next: , Previous: , Up: Packages   [Contents][Index]

4.4 consfigurator.connection.as

Source

src/package.lisp (file)

Use List
Internal Definitions

can-setuid (function)


Next: , Previous: , Up: Packages   [Contents][Index]

4.5 consfigurator.property.cmd

Source

src/package.lisp (file)

Use List
Exported Definitions

single (function)

Internal Definitions

single. (macro)


Next: , Previous: , Up: Packages   [Contents][Index]

4.6 consfigurator.data.git-snapshot

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.7 consfigurator.connection.chroot.fork

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.8 consfigurator.connection.local

Source

src/package.lisp (file)

Use List
Exported Definitions

local-connection (class)


Next: , Previous: , Up: Packages   [Contents][Index]

4.9 consfigurator.property.sshd

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.10 consfigurator

Source

src/package.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.11 consfigurator.property.service

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.12 consfigurator.property.git

Source

src/package.lisp (file)

Use List
Exported Definitions

snapshot-extracted (function)

Internal Definitions

snapshot-extracted. (macro)


Next: , Previous: , Up: Packages   [Contents][Index]

4.13 consfigurator.property.os

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.14 consfigurator.property.file

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.15 consfigurator.data.asdf

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.16 consfigurator.connection.shell-wrap

Source

src/package.lisp (file)

Use List
Used By List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.17 consfigurator.property.gnupg

Source

src/package.lisp (file)

Use List
Exported Definitions

public-key-imported (function)

Internal Definitions

public-key-imported. (macro)


Next: , Previous: , Up: Packages   [Contents][Index]

4.18 consfigurator.connection.sudo

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.19 consfigurator.data.gpgpubkeys

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.20 consfigurator.connection.su

Source

src/package.lisp (file)

Use List
Internal Definitions

su-connection (class)


Next: , Previous: , Up: Packages   [Contents][Index]

4.21 consfigurator.property.apt

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.22 consfigurator.connection.fork

Source

src/package.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.23 consfigurator.connection.chroot.shell

Source

src/package.lisp (file)

Use List
Internal Definitions

shell-chroot-connection (class)


Next: , Previous: , Up: Packages   [Contents][Index]

4.24 consfigurator.connection.setuid

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.25 consfigurator.property.chroot

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.26 consfigurator.connection.rehome

Source

src/package.lisp (file)

Use List
Used By List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.27 consfigurator.data.pgp

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.28 consfigurator.connection.ssh

Source

src/package.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.29 consfigurator.connection.chroot

Source

src/package.lisp (file)

Use List
Internal Definitions

can-chroot (function)


Previous: , Up: Packages   [Contents][Index]

4.30 consfigurator.property.user

Source

src/package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *consfigurator-debug-level*

Integer. Higher values mean be more verbose during deploys.

Package

consfigurator

Source

src/util.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: as USER &body PROPERTIES

Apply PROPERTIES as USER by reconnecting with the :AS connection type. Note that the :AS connection type requires root, so as a special case, this macro just expands to ESEQPROPS if USER is the literal string "root" (without evaluation). This makes it possible to use this macro to annotate applications of properties which are normally applied by non-root, to make it explicit that in this case they’re being applied as root, e.g. that they will affect /root and not /home.

Package

consfigurator

Source

src/combinator.lisp (file)

Macro: defdeploy NAME (CONNECTIONS HOST) &body ADDITIONAL-PROPERTIES

Define a function which does (DEPLOY CONNECTIONS HOST ADDITIONAL-PROPERTIES). You can then eval (NAME) to execute this deployment.

Package

consfigurator

Source

src/deployment.lisp (file)

Macro: defdeploy-these NAME (CONNECTIONS HOST) &body PROPERTIES

Define a function which does (DEPLOY-THESE CONNECTIONS HOST PROPERTIES). You can then eval (NAME) to execute this deployment.

Package

consfigurator

Source

src/deployment.lisp (file)

Macro: defhost HOSTNAME (&key DEPLOY) &body PROPERTIES

Define a host with hostname HOSTNAME and properties PROPERTIES.
HOSTNAME can be a string or a symbol. In either case, the host will get a static informational property with its hostname as a string, and the symbol whose name is the hostname will be bound to the host object.

DEPLOY represents the usual way you’ll connect to the host to deploy properties, and if specified, a function named HOSTNAME will be defined to deploy the host using that connection chain. This is an optional convenience feature; you can always use DEPLOY and DEPLOY-THESE to apply properties to the host using an arbitrary chain of connections.

If the first entry in PROPERTIES is a string, it will be considered a human-readable description of the host. Otherwise, PROPERTIES is an unevaluated property application specification. Recall that for atomic entries (PROPERTY . ARGS), PROPERTY refers to the property that symbol names in the global environment, not whatever it may name in the current dynamic and/or lexical environments. Property application specifications cannot close over globally anonymous properties.

The order of PROPERTIES matters: deployments will apply properties to the host in the order specified here, so later properties implicitly depend on earlier ones. In addition, static informational attributes set by later properties are allowed to override any attributes with the same name set by earlier entries.

Package

consfigurator

Source

src/host.lisp (file)

Macro: define-function-property-combinator NAME ARGS &body BODY
Package

consfigurator

Source

src/combinator.lisp (file)

Macro: defprop NAME0 TYPE LAMBDA &body BODY1

Define a property by providing code for its subroutines.

Package

consfigurator

Source

src/property.lisp (file)

Macro: defproplist NAME TYPE LAMBDA &body PROPERTIES

Like DEFPROPSPEC, but define the function which yields the propspec using the unevaluated property application specification PROPERTIES, where the implicit surrounding combinator is ESEQPROPS.

If the first element of PROPERTIES is a string, it will be considered a docstring for the resulting property. If the first element of PROPERTIES after any such string is a list beginning with :DESC, the remainder will be used as the :DESC subroutine for the resulting property, like DEFPROP. Supplying a :CHECK subroutine in the same way is also supported.

Otherwise, the body should not contain any references to variables other than those in LAMBDA. LAMBDA is an ordinary lambda list, so you can use &AUX variables to compute intermediate values. The evaluation of arguments to propapps in PROPERTIES, and the evaluation of any &AUX variables in LAMBDA, will happen at :HOSTATTRS-time for the host to which the resulting property is to be applied, so you can retrieve static informational attributes set by other properties applied to the host (unlike with unevaluated property application specifications appearing in DEFHOST forms). The evaluation should otherwise be purely functional.

You will usually be able to use DEFPROPLIST instead of DEFPROPSPEC. However, sometimes you will need to fall back on DEFPROPSPEC. For example, an unevaluated property application specification cannot express passing values other than constant values and propapps to property combinators.

Package

consfigurator

Source

src/property.lisp (file)

Macro: defpropspec NAME0 TYPE LAMBDA &body BODY1

Define a property which constructs, evaluates and applies a propspec.

This is how you can define a property which works by calling other properties, in accordance with property combinators.

Except in very simple cases, it is usually better to use this macro (or DEFPROPLIST) to combine several smaller properties rather than writing a property using DEFPROP which programmatically calls other properties. This is because using this macro takes care of calling property :HOSTATTRS subroutines at the right time.

If the first element of the body is a string, it will be considered a docstring for the resulting property. If the first element of the body after any such string is a list beginning with :DESC, the remainder will be used as the :DESC subroutine for the resulting property, like DEFPROP. Supplying a :CHECK subroutine in the same way is also supported. Otherwise, the body defines a function of the arguments specified by the lambda list which returns the property application specification expression to be evaluated and applied. It should be a pure function aside from retrieving hostattrs (as set by other properties applied to the hosts to which the resulting property is applied, not as set by the properties in the returned propspec).

You can usually use DEFPROPLIST instead of DEFPROPSPEC, which see.

Package

consfigurator

Source

src/property.lisp (file)

Macro: deploy CONNECTIONS HOST &body ADDITIONAL-PROPERTIES

Establish CONNECTIONS to HOST, and apply each of the host’s usual properties, followed by specified by ADDITIONAL-PROPERTIES, an unevaluated property application specification.

CONNECTION is a keyword identifying a connection type, a list beginning with such a keyword and followed by keyword arguments required to establish the connection, or a list of such lists.

Then HOST has all its usual static informational attributes, plus any set by ADDITIONAL-PROPERTIES. Static informational attributes set by ADDITIONAL-PROPERTIES can override the host’s usual static informational attributes, in the same way that later entries in the list of properties specified in DEFHOST forms can override earlier entries (see DEFHOST’s docstring).

The evaluation of ADDITIONAL-PROPERTIES to produce a property application specification may retrieve existing hostattrs, but should not set any new ones (not to be confused with how the :HOSTATTRS subroutines of properties in ADDITIONAL-PROPERTIES may set additional hostattrs).

Package

consfigurator

Source

src/deployment.lisp (file)

Macro: deploy-these CONNECTIONS HOST &body PROPERTIES

Like DEPLOY, except apply each of the properties specified by PROPERTIES, and not the host’s usual properties, unless they also appear in PROPERTIES. PROPERTIES is an unevaluated property application specification.

This function is useful to apply one or two properties to a host right now, e.g. at the REPL when when testing new property definitions. If HOST is usually deployed using a Lisp-type connection, and the property you are testing is :POSIX, you might use a connection type like :SSH so that you can quickly alternate between redefining your work-in-progress property and seeing what happens when you apply it to HOST.

HOST has all its usual static informational attributes, as set by its usual properties, plus any set by PROPERTIES. Static informational attributes set by PROPERTIES can override the host’s usual static informational attributes, in the same way that later entries in the list of properties specified in DEFHOST forms can override earlier entries (see DEFHOST’s docstring).

The evaluation of PROPERTIES to produce a property application specification may retrieve existing hostattrs, but should not set any new ones (not to be confused with how the :HOSTATTRS subroutines of properties in PROPERTIES may set additional hostattrs).

Package

consfigurator

Source

src/deployment.lisp (file)

Macro: deploys-these. CONNECTIONS HOST &rest PROPERTIES
Package

consfigurator

Source

src/deployment.lisp (file)

Macro: deploys. CONNECTIONS HOST &rest ADDITIONAL-PROPERTIES
Package

consfigurator

Source

src/deployment.lisp (file)

Macro: etypecase &body CASES
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Macro: host-etypecase HOST &body CASES
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Macro: ignoring-hostattrs FORM

Where FORM is a programmatic call to a property which has a :HOSTATTRS subroutine, muffle warnings about calling a property with a :HOSTATTRS subroutine programmatically. Use this only when you know that the :HOSTATTRS subroutine does not push any new hostattrs.

Package

consfigurator

Source

src/property.lisp (file)

Macro: in-consfig SYSTEMS

Sets the variable *CONSFIG* in the current package to SYSTEMS, or (SYSTEMS) if SYSTEMS is an atom. Used at the top of your consfig, right after IN-PACKAGE.

This is used to record a list of the names of the ASDF systems in which you define your hosts, site-specific properties and deployments. These systems should depend on the "consfigurator" system.

SYSTEMS should satisfy the following condition: in normal usage of Consfigurator, evaluating
(mapc #’asdf:load-system (if (atom SYSTEMS) (list SYSTEMS) SYSTEMS) should be sufficient to define all the properties you intend to apply to hosts and property combinators you intend to use in specifying propspecs.

Consfigurator uses this information when starting up remote Lisp images to effect deployments: it sends over the ASDF systems specified by SYSTEMS.

Package

consfigurator

Source

src/propspec.lisp (file)

Macro: on-change PROPAPP &body ON-CHANGE

If applying PROPAPP makes a change, also apply each of of the propapps ON-CHANGE in order.

Package

consfigurator

Source

src/combinator.lisp (file)

Macro: os-bootstrapped. OPTIONS ROOT &rest PROPERTIES
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Macro: symbol-named NAME SYMBOL
Package

consfigurator

Source

src/util.lisp (file)

Macro: with-change-if-changes-file (FILE) &body FORMS

Execute FORMS and yield :NO-CHANGE if FILE does not change.
Since stat(1) is not POSIX, this is implemented by calling ‘ls -dlL’ and cksum(1), and seeing if any of the information reported there, except for the number of links, has changed. Thus, you should not use this macro to detect changes in properties which will change the file but not the output of ‘ls -dlL’ and cksum(1).

Package

consfigurator

Source

src/property.lisp (file)

Macro: with-change-if-changes-file-content (FILE) &body FORMS

Execute FORMS and yield :NO-CHANGE if FILE has the same content afterwards.

Package

consfigurator

Source

src/property.lisp (file)

Macro: with-data-stream (S IDEN1 IDEN2) &body BODY
Package

consfigurator

Source

src/data.lisp (file)

Macro: with-indented-inform &body FORMS
Package

consfigurator

Source

src/util.lisp (file)

Macro: with-local-connection &body FORMS

Execute FORMS as though a :LOCAL connection had been established.
This is for testing purposes at the REPL and in Consfigurator’s test suite. FORMS is typically the programmatic application of one or more properties.

Package

consfigurator

Source

src/connection.lisp (file)

Macro: with-local-temporary-directory (DIR) &body FORMS

Execute FORMS with a local temporary directory’s pathname in DIR. Currently assumes GNU mktemp(1).

There is no WITH-REMOTE-TEMPORARY-DIRECTORY because POSIX doesn’t have a way to create temporary directories. If you need a remote temporary directory, one solution is to convert your property to a :LISP property.

Package

consfigurator

Source

src/util.lisp (file)

Macro: with-preserve-hostattrs &body FORMS

Evaluate FORMS then throw away any newly added hostattrs.
Useful in property combinators when you need to run some :HOSTATTRS subroutines but ignore any new hostattrs they may push. Shouldn’t be used in properties.

Package

consfigurator

Source

src/host.lisp (file)

Macro: with-remote-current-directory (DIR) &body FORMS

Execute FORMS with the current working directory DIR.
This affects the working directory for commands run using RUN and MRUN, and the resolution of relative pathnames passed as the first argument of READFILE and WRITEFILE. For Lisp-type connections, it additionally temporarily sets the working directory of the Lisp process using UIOP:WITH-CURRENT-DIRECTORY.

Package

consfigurator

Source

src/connection.lisp (file)

Macro: with-remote-temporary-file (FILE &key CONNECTION DIRECTORY) &body BODY

Execute BODY with FILE containing the path to a freshly created remote file, which will be cleaned up when BODY is finished.

Package

consfigurator

Source

src/connection.lisp (file)

Macro: with-requirements PROPAPP &body REQUIREMENTS

Apply PROPAPP only after applying each dependency in REQUIREMENTS.
Each item in REQUIREMENTS implicitly depends on the one preceding it, i.e., we apply the elements of REQUIREMENTS in reverse order.

Package

consfigurator

Source

src/combinator.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: assert-connection-supports TYPE
Package

consfigurator

Source

src/property.lisp (file)

Function: assert-euid-root ()

Assert that the remote user has uid 0 (root)

Package

consfigurator

Source

src/property.lisp (file)

Function: authorized-keys &rest KEYS
Package

consfigurator.property.ssh

Source

src/property/ssh.lisp (file)

Function: available LOCALE
Package

consfigurator.property.locale

Source

src/property/locale.lisp (file)

Function: call-with-os F &rest ARGS
Package

consfigurator

Source

src/property.lisp (file)

Function: can-probably-fork ()

Return nil if we can detect other running threads, and the Lisp implementation is known not to support forking when there are other threads. A return value other than nil indicates only that we couldn’t detect circumstances in which it is known that we cannot fork, not that we are sure we can fork – a thread might be only partly initialised at the time we check, for example, such that we don’t see it.

Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)

Function: collapse-types &rest LISTS
Package

consfigurator

Source

src/property.lisp (file)

Function: configured &rest PAIRS
Package

consfigurator.property.sshd

Source

src/property/sshd.lisp (file)

Function: contains-conf-equals FILE &rest PAIRS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: contains-conf-shell FILE &rest PAIRS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: contains-conf-space FILE &rest PAIRS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: contains-ini-settings FILE &rest TRIPLES
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: contains-lines PATH &rest LINES
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: continue-deploy* REMAINING-CONNECTIONS

Complete the work of an enclosing call to DEPLOY* or DEPLOY-THESE*.

Used by implementations of ESTABLISH-CONNECTION which need to do something like fork(2) and then return to Consfigurator’s primary loop in the child.

Package

consfigurator

Source

src/deployment.lisp (file)

Function: continue-deploy*-program REMAINING-CONNECTIONS

Return a program to complete the work of an enclosing call to DEPLOY*.

Implementations of ESTABLISH-CONNECTION which start up remote Lisp images call this function, instead of CONTINUE-DEPLOY*, and use the result to instruct the newly started image.

Will query the remote cache for paths to Lisp systems, so a connection to the host which will run the Lisp image must already be established.

The program returned is a single string consisting of a number of sexps separated by newlines. Each sexp must be evaluated by the remote Lisp image before the following sexp is offered to its reader. Usually this can be achieved by sending the return value of this function into a REPL’s stdin.

Package

consfigurator

Source

src/data.lisp (file)

Function: data-pathname ROOT &rest SEGMENTS
Package

consfigurator

Source

src/data.lisp (file)

Function: data-source-providing-p IDEN1 IDEN2

Is there a data source which can provide the item of prerequisite data identified by IDEN1 and IDEN2?

This function is for implementation of REGISTER-DATA-SOURCE to check for clashes. It should not be called by properties.

Package

consfigurator

Source

src/data.lisp (file)

Function: data-uploaded IDEN1 IDEN2 DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: delete-remote-tree &rest PATHS

Recursively delete each of PATHS.

Package

consfigurator

Source

src/connection.lisp (file)

Function: deploy* CONNECTIONS HOST &optional ADDITIONAL-PROPERTIES

Execute the deployment which is defined by the pair (CONNECTIONS . HOST), except possibly with the property application specification ADDITIONAL-PROPERTIES also applied to HOST.

This is the entry point to Consfigurator’s primary loop. Typically users use DEPLOY, DEPLOY-THESE, and the function definitions established by DEFDEPLOY, DEFDEPLOY-THESE, etc., rather than calling this function directly. However, code which programmatically constructs deployments will need to call this.

Package

consfigurator

Source

src/deployment.lisp (file)

Function: deploy-these* CONNECTIONS HOST PROPERTIES

Like DEPLOY*, but replace the properties of HOST with PROPERTIES.

HOST has all its usual static informational attributes, as set by its usual properties, plus any set by PROPERTIES. Static informational attributes set by PROPERTIES can override the host’s usual static informational attributes, in the same way that later entries in the list of properties specified in DEFHOST forms can override earlier entries (see DEFHOST’s docstring).

Package

consfigurator

Source

src/deployment.lisp (file)

Function: deploys CONNECTIONS HOST &optional ADDITIONAL-PROPERTIES
Package

consfigurator

Source

src/deployment.lisp (file)

Function: deploys-these CONNECTIONS HOST PROPERTIES
Package

consfigurator

Source

src/deployment.lisp (file)

Function: directory-exists DIR
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: does-not-exist &rest PATHS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: eseqprops &rest PROPAPPS
Package

consfigurator

Source

src/combinator.lisp (file)

Function: failed-change MESSAGE &rest ARGS

Signal problems with the connection and errors while actually attempting to apply or unapply properties.

Package

consfigurator

Source

src/property.lisp (file)

Function: filename->string S
Package

consfigurator

Source

src/util.lisp (file)

Function: get-data LOCATION IDEN1 IDEN2

Fetch a piece of prerequisite data.

Useful at the REPL.

Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: get-data-protected-string IDEN1 IDEN2

Like GET-DATA-STRING, but wrap the content in an object which is unprintable by default. Intended for code which fetches passwords and wants to lessen the chance of those passwords showing up in the clear in the Lisp debugger.

Package

consfigurator

Source

src/data.lisp (file)

Function: get-data-stream IDEN1 IDEN2

Return a stream which will produce the content of an item of prerequisite data. The elements of the stream are always octets. If the item of prerequisite data was provided by the prerequisite data source as a string, it will be encoded in UTF-8.

This function is called by property :APPLY and :UNAPPLY subroutines.

Package

consfigurator

Source

src/data.lisp (file)

Function: get-data-string IDEN1 IDEN2

Return the content of an item of prerequisite data as a string.

This function is called by property :APPLY and :UNAPPLY subroutines.

Package

consfigurator

Source

src/data.lisp (file)

Function: get-highest-local-cached-prerequisite-data IDEN1 IDEN2

Get the highest version of prerequisite data identified by IDEN1 and IDEN2 available in the local cache.

This is exported for use by prerequisite data sources which work by generating new files and need somewhere to store them. It should not be used by properties, or data sources which return objects referencing existing files.

Package

consfigurator

Source

src/data.lisp (file)

Function: get-hostattrs K

Retrieve the list of static informational attributes of type KEY.

Called by property :HOSTATTRS, :APPLY and :UNAPPLY subroutines.

Package

consfigurator

Source

src/property.lisp (file)

Function: get-hostattrs-car K
Package

consfigurator

Source

src/property.lisp (file)

Function: get-hostname ()

Get the hostname of the host to which properties are being applied.

Called by property subroutines.

Package

consfigurator

Source

src/property.lisp (file)

Function: get-local-cached-prerequisite-data &optional WHERE

Scan a local cache of prerequisite data at WHERE, and return a list of items of prerequisite data where each entry is of the form

’(iden1 iden2 version).

This is exported for use by implementations of CONNECTION-UPLOAD, which should always supply a value for WHERE.

Package

consfigurator

Source

src/data.lisp (file)

Function: get-parent-hostattrs K
Package

consfigurator

Source

src/property.lisp (file)

Function: get-parent-hostattrs-car K
Package

consfigurator

Source

src/property.lisp (file)

Function: get-user ()

Get the remote username.

Package

consfigurator

Source

src/property.lisp (file)

Function: has-account USERNAME
Package

consfigurator.property.user

Source

src/property/user.lisp (file)

Function: has-content PATH CONTENT
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: has-login-shell USERNAME SHELL
Package

consfigurator.property.user

Source

src/property/user.lisp (file)

Function: has-mode PATH MODE
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: host-data-uploaded DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: host-secret-uploaded DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: inapplicable-property MESSAGE &rest ARGS

Signal, in a :HOSTATTRS subroutine, that the host’s hostattrs indicate that this property cannot be applied to this host. E.g. the property will try to install an apt package but the host is FreeBSD.

Package

consfigurator

Source

src/property.lisp (file)

Function: inform LEVEL OUTPUT &key STRIP-EMPTY FRESH-LINE

Print something to the user during deploys.

Package

consfigurator

Source

src/util.lisp (file)

Function: informat LEVEL CONTROL-STRING &rest FORMAT-ARGUMENTS

Print something to the user during deploys using FORMAT.
Be sure to begin CONTROL-STRING with ~& unless you want to continue from previous output.

Package

consfigurator

Source

src/util.lisp (file)

Function: installed ()
Package

consfigurator.property.sshd

Source

src/property/sshd.lisp (file)

Function: installed &rest PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: lacks-lines PATH &rest LINES
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: lines TEXT
Package

consfigurator

Source

src/util.lisp (file)

Function: lisp-connection-p ()
Package

consfigurator

Source

src/connection.lisp (file)

Function: list-data LOCATION

List all prerequisite data in the PGP store at LOCATION.

Useful at the REPL.

Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: local-data-pathname &optional IDEN1 IDEN2 VERSION

Get a pathname where an item of prerequisite data may be cached, ensuring that parent directories exist.
This is exported for use by prerequisite data sources which work by generating new files and need somewhere to store them. It should not be used by properties, or data sources which return objects referencing existing files.

Note that since prerequisite data sources are queried only in the root Lisp, but items of prerequisite data are never uploaded to the root Lisp, there is no risk of clashes between fresly generated files and cached copies of files.

Package

consfigurator

Source

src/data.lisp (file)

Function: make-child-host &key HOSTATTRS PROPSPEC

Make a host object to represent a chroot, container or the like.
Called by properties which set up such subhosts, like CHROOT:OS-BOOTSTRAPPED.

Package

consfigurator

Source

src/host.lisp (file)

Function: make-host &key HOSTATTRS PROPSPEC
Package

consfigurator

Source

src/host.lisp (file)

Function: make-passphrase PASSPHRASE

Make an object which is unprintable by default to contain a passphrase.

Package

consfigurator

Source

src/data.lisp (file)

Function: make-propspec &key SYSTEMS PROPSPEC

Convert a property application specification expression into a property application specification proper by associating it with a list of ASDF systems.

Package

consfigurator

Source

src/propspec.lisp (file)

Function: map-file-lines FILE FUNCTION

Apply FUNCTION to the lines of FILE. Safe to use in a :POSIX property.

For efficiency, a :LISP property might want to use streams, but there’s no point in doing that here because WRITEFILE is synchronous.

Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: memstring= STRING LIST
Package

consfigurator

Source

src/util.lisp (file)

Function: missing-data-source MESSAGE &rest ARGS
Package

consfigurator

Source

src/data.lisp (file)

Function: mrun &rest ARGS

Like RUN but don’t separate stdout and stderr ("m" for "merged"; note that this might mean interleaved or simply concatenated, depending on the connection chain).

Some (but not all) connection types will want to use this when implementing ESTABLISH-CONNECTION, CONNECTION-RUN, CONNECTION-WRITEFILE etc. to avoid the overhead of splitting the output streams only to immediately recombine them.

Some :POSIX properties which want to run a lot of commands and don’t need to separate the streams might want to use this too, but usually it is best to start with RUN.

Package

consfigurator

Source

src/connection.lisp (file)

Function: no-passwords ()
Package

consfigurator.property.sshd

Source

src/property/sshd.lisp (file)

Function: no-services ()
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Function: noop &rest ARGS

Accept any arguments and do nothing.

Package

consfigurator

Source

src/util.lisp (file)

Function: os-bootstrapped OPTIONS ROOT PROPERTIES
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Function: passwd-entry N USERNAME-OR-UID
Package

consfigurator.property.user

Source

src/property/user.lisp (file)

Function: plist-to-cmd-args PLIST &aux ARGS
Package

consfigurator

Source

src/util.lisp (file)

Function: propappapply PROPAPP
Package

consfigurator

Source

src/property.lisp (file)

Function: propappattrs PROPAPP
Package

consfigurator

Source

src/property.lisp (file)

Function: propappcheck PROPAPP
Package

consfigurator

Source

src/property.lisp (file)

Function: propappdesc PROPAPP
Package

consfigurator

Source

src/property.lisp (file)

Function: propapptype PROPAPP
Package

consfigurator

Source

src/property.lisp (file)

Function: propappunapply PROPAPP
Package

consfigurator

Source

src/property.lisp (file)

Function: propattrs PROP &rest ARGS
Package

consfigurator

Source

src/property.lisp (file)

Function: propunapply PROP &rest ARGS
Package

consfigurator

Source

src/property.lisp (file)

Function: proxy URI
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: public-key-imported FINGERPRINT
Package

consfigurator.property.gnupg

Source

src/property/gnupg.lisp (file)

Function: push-hostattrs K &rest VS

Push new static informational attributes VS of type KEY.

Called by property :HOSTATTRS subroutines.

Package

consfigurator

Source

src/property.lisp (file)

Function: pushnew-hostattrs K &rest VS

Push new static informational attributes VS of type KEY.

Called by property :HOSTATTRS subroutines.

Package

consfigurator

Source

src/property.lisp (file)

Function: readfile PATH
Package

consfigurator

Source

src/connection.lisp (file)

Function: regex-replaced-lines FILE REGEX REPLACE
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: remote-data-pathname &rest ARGS
Package

consfigurator

Source

src/data.lisp (file)

Function: remote-exists-p &rest PATHS

Does each of PATHS exists?
PATH may be any kind of file, including directories.

Package

consfigurator

Source

src/connection.lisp (file)

Function: removed &rest PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: request-lisp-systems ()

Request that all Lisp systems required by the host currently being deployed are uploaded to the remote cache of the currently established connection.

Called by connections which start up remote Lisp images.

Package

consfigurator

Source

src/data.lisp (file)

Function: require-data IDEN1 IDEN2

Wrapper around PUSH-HOSTATTRS to indicate that a piece of prerequisite data is needed to deploy a property.

Called by property :HOSTATTRS subroutines.

Package

consfigurator

Source

src/property.lisp (file)

Function: required TYPE

Error out if the OS of the host being deployed is not of type TYPE.

Used in property :HOSTATTRS subroutines.

Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Function: reset-data-sources ()

Forget all data sources registered in this Lisp image. This function is typically called at the REPL.

Package

consfigurator

Source

src/data.lisp (file)

Function: reset-remote-home ()

Clear the cache of the remote user’s home directory, uid and name.
Used by implementations of ESTABLISH-CONNECTION which will invalidate the cached values, such as a connection which forks and then SETUIDs to another user. Should not be called by properties.

Package

consfigurator

Source

src/connection.lisp (file)

Function: run &rest ARGS

Synchronous execution of shell commands using the current connection. ARGS can contain keyword-value pairs (and singular keywords) to specify aspects of this function’s behaviour, and remaining elements of ARGS are the shell command and its parameters, or, as a special case, a single string specifying the shell command, with any necessary escaping already performed. It is recommended that all keywords and corresponding values come first, followed by argument(s) specifying the shell command to execute.

You can additionally supply lists of arguments and these will be spliced into the resulting list of arguments to be passed to the command. I.e.
(run "a" (list "b" "c")) is equivalent to (run "a" "b" "c").

Keyword arguments accepted:

- :FOR-EXIT / :MAY-FAIL – don’t signal an error condition if the command does not exit nonzero, usually because it is being called partly or only for its exit code

- :INFORM – send a copy of the output to *STANDARD-OUTPUT*

- :INPUT INPUT – pass the content of the string or stream INPUT on stdin

- :ENV ENVIRONMENT – where ENVIRONMENT is a plist specifying environment variable names and values, use env(1) to set these variables when running the command.

Returns command’s stdout, stderr and exit code, unless :FOR-EXIT, in which case return only the exit code.

Package

consfigurator

Source

src/connection.lisp (file)

Function: runlines &rest ARGS
Package

consfigurator

Source

src/connection.lisp (file)

Function: running SERVICE
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Function: secret-uploaded IDEN1 IDEN2 DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: selected-for LOCALE &rest LOCALE-VARIABLES
Package

consfigurator.property.locale

Source

src/property/locale.lisp (file)

Function: seqprops &rest PROPAPPS
Package

consfigurator

Source

src/combinator.lisp (file)

Function: service-installed-running PACKAGE
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: set-data LOCATION IDEN1 IDEN2 VAL

Set a piece of prerequisite data.

Useful at the REPL.

Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: set-data-from-file LOCATION IDEN1 IDEN2 FILE

Set a piece of prerequisite data from the contents of a file.

Useful at the REPL.

Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: silent-seqprops &rest PROPAPPS
Package

consfigurator

Source

src/combinator.lisp (file)

Function: single &rest ARGS
Package

consfigurator.property.cmd

Source

src/property/cmd.lisp (file)

Function: skip-data-source C
Package

consfigurator

Source

src/data.lisp (file)

Function: snapshot-extracted DIRECTORY SNAPSHOT-NAME &key (REPLACE REPLACE)
Package

consfigurator.property.git

Source

src/property/git.lisp (file)

Function: standard-sources.list ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: string->filename S
Package

consfigurator

Source

src/util.lisp (file)

Function: supports-arch-p OS ARCH

Can binaries of type ARCH run on OS?

Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Function: test &rest ARGS
Package

consfigurator

Source

src/connection.lisp (file)

Function: try-register-data-source &rest ARGS

Register sources of prerequisite data.
This function is typically called in consfigs. Any relative pathnames in ARGS will be resolved as paths under the home directory of the user Lisp is running as, before being passed to implementations of REGISTER-DATA-SOURCE.

Package

consfigurator

Source

src/data.lisp (file)

Function: unapply PROPAPP
Package

consfigurator

Source

src/combinator.lisp (file)

Function: unlines LINES
Package

consfigurator

Source

src/util.lisp (file)

Function: upload-all-prerequisite-data &key UPLOAD-STRING-DATA CONNECTION

Upload all prerequisite data required by the current deployment to the remote cache of the current connection hop, or to the remote cache of CONNECTION.

If UPLOAD-STRING-DATA is false, don’t upload items of string data, but retrieve them from data sources and keep in memory. This is for connection types which will do something like fork after calling this function.

This is called by implementations of ESTABLISH-CONNECTION which call CONTINUE-DEPLOY* or CONTINUE-DEPLOY*-PROGRAM.

Package

consfigurator

Source

src/data.lisp (file)

Function: uses-local-cacher ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: uses-parent-mirror ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: uses-parent-proxy ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: version< X Y
Package

consfigurator

Source

src/util.lisp (file)

Function: version<= X Y
Package

consfigurator

Source

src/util.lisp (file)

Function: version> X Y
Package

consfigurator

Source

src/util.lisp (file)

Function: version>= X Y
Package

consfigurator

Source

src/util.lisp (file)

Function: without-starting-services &rest PROPAPPS

Apply PROPAPPS with SERVICE:NO-SERVICES temporarily in effect.

Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Function: writefile PATH CONTENT &key MODE &aux PATHNAME NAMESTRING
Package

consfigurator

Source

src/connection.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: append-propspecs FIRST SECOND
Package

consfigurator

Methods
Method: append-propspecs (FIRST unpreprocessed-propspec) (SECOND unpreprocessed-propspec)
Source

src/propspec.lisp (file)

Generic Function: connection-clear-data-cache CONNECTION IDEN1 IDEN2

Delete all versions of the data identified by IDEN1 and IDEN2 from the remote cache of CONNECTION. Called by UPLOAD-ALL-PREREQUISITE-DATA before uploading new versions of data, to avoid them piling up.

Package

consfigurator

Source

src/data.lisp (file)

Methods
Method: connection-clear-data-cache (CONNECTION rehome-connection) IDEN1 IDEN2
Source

src/connection/rehome.lisp (file)

Method: connection-clear-data-cache (CONNECTION connection) IDEN1 IDEN2
Generic Function: connection-parent OBJECT
Package

consfigurator

Methods
Method: connection-parent (CONNECTION connection)

The value of *CONNECTION* at the time this connection was established.

Source

src/connection.lisp (file)

Generic Function: connection-readfile CONNECTION PATH

Subroutine to read the contents of files on the host.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: connection-readfile (C shell-wrap-connection) PATH
Source

src/connection/shell-wrap.lisp (file)

Method: connection-readfile (CONNECTION local-connection) PATH
Source

src/connection/local.lisp (file)

Method: connection-readfile (CONNECTION connection) PATH around
Generic Function: connection-run CONNECTION CMD INPUT

Subroutine to run shell commands on the host.

INPUT is a string to send to the shell command’s stdin, or a stream which will be emptied into the shell command’s stdin.

Implementations can specialise on both the CONNECTION and INPUT arguments, if they need to handle streams and strings differently.

Returns (values OUT EXIT) where OUT is either merged stdout and stderr or stderr followed by stdout, and EXIT is the exit code. Should not signal any error condition just because EXIT is non-zero.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: connection-run (CONNECTION sudo-connection) CMD (INPUT stream)
Source

src/connection/sudo.lisp (file)

Method: connection-run (C sudo-connection) CMD (INPUT string)
Source

src/connection/sudo.lisp (file)

Method: connection-run (C sudo-connection) CMD (INPUT null)
Source

src/connection/sudo.lisp (file)

Method: connection-run (C shell-wrap-connection) CMD INPUT
Source

src/connection/shell-wrap.lisp (file)

Method: connection-run (CONNECTION local-connection) SHELL-CMD INPUT
Source

src/connection/local.lisp (file)

Method: connection-run (C local-connection) CMD (S string)
Source

src/connection/local.lisp (file)

Method: connection-run (C local-connection) CMD (S stream)
Source

src/connection/local.lisp (file)

Method: connection-run (CONNECTION connection) CMD INPUT around
Generic Function: connection-shell-wrap CONNECTION CMD
Package

consfigurator.connection.shell-wrap

Source

src/connection/shell-wrap.lisp (file)

Methods
Method: connection-shell-wrap (CONNECTION shell-chroot-connection) CMD
Source

src/connection/chroot/shell.lisp (file)

Method: connection-shell-wrap (CONNECTION su-connection) CMD
Source

src/connection/su.lisp (file)

Method: connection-shell-wrap (CONNECTION sudo-connection) CMD
Source

src/connection/sudo.lisp (file)

Method: connection-shell-wrap (CONNECTION ssh-connection) CMD
Source

src/connection/ssh.lisp (file)

Generic Function: connection-teardown CONNECTION

Subroutine to disconnect from the host.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: connection-teardown (CONNECTION connection)
Method: connection-teardown (CONNECTION connection) around
Generic Function: connection-upload CONNECTION DATA

Subroutine to upload an item of prerequisite data to the remote cache. The default implementation will work for any connection which implements CONNECTION-WRITEFILE and CONNECTION-RUN, but connection types which work by calling CONTINUE-DEPLOY* or CONTINUE-DEPLOY*-PROGRAM will need their own implementation.

Package

consfigurator

Source

src/data.lisp (file)

Methods
Method: connection-upload (CONNECTION rehome-connection) (DATA file-data)
Source

src/connection/rehome.lisp (file)

Method: connection-upload (CONNECTION connection) (DATA data) after
Method: connection-upload (CONNECTION connection) (DATA data)
Generic Function: connection-writefile CONNECTION PATH CONTENT MODE

Subroutine to replace/create the contents of files on the host.

CONTENT is the new contents of the file or a stream which will produce it.

MODE is the numeric mode that the file should have by the time this function returns. Implementations should ensure that CONTENT is not stored on disk with a mode greater than MODE, and also that if CONTENT is stored on disk outside of (UIOP:PATHNAME-DIRECTORY-PATHNAME PATH), then it does not have a mode greater than 700. It is recommended that implementations write CONTENT to a temporary file in (UIOP:PATHNAME-DIRECTORY-PATHNAME PATH), change the mode of that file to MODE, and then rename to PATH. WITH-REMOTE-TEMPORARY-FILE can be used to do this.

Implementations can specialise on both the CONNECTION and CONTENT arguments, if they need to handle streams and strings differently.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: connection-writefile (CONN shell-wrap-connection) PATH CONTENT MODE
Source

src/connection/shell-wrap.lisp (file)

Method: connection-writefile (CONNECTION local-connection) PATH CONTENT MODE
Source

src/connection/local.lisp (file)

Method: connection-writefile (CONNECTION connection) PATH CONTENT MODE around
Generic Function: continue-connection CONNECTION REMAINING

Called by implementations of ESTABLISH-CONNECTION which return nil. Calls CONTINUE-DEPLOY* or CONTINUE-DEPLOY*-PROGRAM.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: continue-connection (CONNECTION fork-connection) REMAINING
Source

src/connection/fork.lisp (file)

Generic Function: data-file OBJECT
Package

consfigurator

Methods
Method: data-file (FILE-DATA file-data)

automatically generated reader method

Source

src/data.lisp (file)

Generic Function: data-mime OBJECT
Generic Function: (setf data-mime) NEW-VALUE OBJECT
Package

consfigurator

Methods
Method: data-mime (DATA data)
Method: (setf data-mime) NEW-VALUE (DATA data)

The MIME type of the data, if known.

Source

src/data.lisp (file)

Generic Function: data-string OBJECT
Package

consfigurator

Methods
Method: data-string (STRING-DATA string-data)

automatically generated reader method

Source

src/data.lisp (file)

Generic Function: data-version OBJECT
Package

consfigurator

Methods
Method: data-version (DATA data)

automatically generated reader method

Source

src/data.lisp (file)

Generic Function: datadir OBJECT
Package

consfigurator.connection.rehome

Methods
Method: datadir (REHOME-CONNECTION rehome-connection)

Where Consfigurator would cache items of prerequisite data in the new HOME.

Source

src/connection/rehome.lisp (file)

Generic Function: debian-architecture OS
Package

consfigurator.property.os

Methods
Method: debian-architecture (OS linux)

Return a string representing the architecture of OS as used by Debian.

Source

src/property/os.lisp (file)

Generic Function: debian-suite OBJECT
Package

consfigurator.property.os

Methods
Method: debian-suite (DEBIAN debian)

automatically generated reader method

Source

src/property/os.lisp (file)

Generic Function: establish-connection TYPE REMAINING &key TO INTO USER PASSWORD HOP

Within the context of the current connection, connect to HOST by establishing a new connection of type TYPE.
Either returns an object suitable to be the value of *CONNECTION*, or calls either CONTINUE-DEPLOY* or CONTINUE-DEPLOY*-PROGRAM and returns nil.

Any implementation which calls CONTINUE-DEPLOY*-PROGRAM will need to call UPLOAD-ALL-PREREQUISITE-DATA.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: establish-connection (TYPE (eql as)) REMAINING &key TO

Establish a :SETUID or :SU connection to another user account, depending on whether it is possible to establish a :SETUID connection.

Note that both these connection types require root.

Source

src/connection/as.lisp (file)

Method: establish-connection (TYPE (eql setuid)) REMAINING &key TO
Source

src/connection/setuid.lisp (file)

Method: establish-connection (TYPE (eql chroot.shell)) REMAINING &key INTO
Source

src/connection/chroot/shell.lisp (file)

Method: establish-connection (TYPE (eql chroot.fork)) REMAINING &key INTO
Source

src/connection/chroot/fork.lisp (file)

Method: establish-connection (TYPE (eql chroot)) REMAINING &key INTO
Source

src/connection/chroot.lisp (file)

Method: establish-connection (TYPE (eql sbcl)) REMAINING &key
Source

src/connection/sbcl.lisp (file)

Method: establish-connection (TYPE (eql su)) REMAINING &key TO
Source

src/connection/su.lisp (file)

Method: establish-connection (TYPE (eql sudo)) REMAINING &key USER PASSWORD
Source

src/connection/sudo.lisp (file)

Method: establish-connection (TYPE (eql ssh)) REMAINING &key HOP USER
Source

src/connection/ssh.lisp (file)

Method: establish-connection (TYPE (eql local)) HOST &key
Source

src/connection/local.lisp (file)

Generic Function: get-remote-cached-prerequisite-data CONNECTION

Return a list of items of prerequisite data in the cache on the remote side of CONNECTION, where each entry is of the form

’(iden1 iden2 version).

Package

consfigurator

Source

src/data.lisp (file)

Methods
Method: get-remote-cached-prerequisite-data (CONNECTION rehome-connection)
Source

src/connection/rehome.lisp (file)

Method: get-remote-cached-prerequisite-data (CONNECTION connection)
Generic Function: hostattrs OBJECT
Package

consfigurator

Methods
Method: hostattrs (HOST host)

Plist of the host’s static informational attributes.

Source

src/host.lisp (file)

Generic Function: iden1 OBJECT
Package

consfigurator

Methods
Method: iden1 (DATA data)

automatically generated reader method

Source

src/data.lisp (file)

Generic Function: iden2 OBJECT
Package

consfigurator

Methods
Method: iden2 (DATA data)

automatically generated reader method

Source

src/data.lisp (file)

Generic Function: linux-architecture OBJECT
Package

consfigurator.property.os

Methods
Method: linux-architecture (LINUX linux)

Keyword whose name is Debian’s name for this architecture, e.g. :AMD64

Source

src/property/os.lisp (file)

Generic Function: passphrase OBJECT
Package

consfigurator

Methods
Method: passphrase (PASSPHRASE passphrase)

automatically generated reader method

Source

src/data.lisp (file)

Generic Function: post-fork CONNECTION

Code to execute after forking but before calling CONTINUE-DEPLOY*.

Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)

Methods
Method: post-fork (CONNECTION setuid-connection)
Source

src/connection/setuid.lisp (file)

Method: post-fork (CONNECTION chroot.fork-connection)
Source

src/connection/chroot/fork.lisp (file)

Method: post-fork (CONNECTION rehome-connection) before
Source

src/connection/rehome.lisp (file)

Generic Function: preprocess-connection-args TYPE &key AS TO &allow-other-keys

Hook to allow connection types to do work in the root Lisp before Consfigurator begins the attempt to establish the connection chain. The return value is used as replacement keyword arguments to the connection.

For an example of usage, see the :SUDO connection type.

Package

consfigurator

Source

src/connection.lisp (file)

Methods
Method: preprocess-connection-args (TYPE (eql sudo)) &key AS TO
Source

src/connection/sudo.lisp (file)

Method: preprocess-connection-args (TYPE symbol) &rest ARGS &key &allow-other-keys
Generic Function: preprocess-host HOST

Convert a host into a fresh preprocessed host if necessary, and unconditionally perform a shallow copy of the plist of static information attributes, so that implementations of ESTABLISH-CONNECTION can push new attributes (typically to request prerequisite data) without disturbing host values higher up the call stack.

Package

consfigurator

Source

src/host.lisp (file)

Methods
Method: preprocess-host (HOST unpreprocessed-host)
Method: preprocess-host (HOST preprocessed-host)
Generic Function: propspec-props OBJECT
Package

consfigurator

Methods
Method: propspec-props (UNPREPROCESSED-PROPSPEC unpreprocessed-propspec)

automatically generated reader method

Source

src/propspec.lisp (file)

Generic Function: propspec-systems OBJECT
Package

consfigurator

Methods
Method: propspec-systems (PROPSPEC propspec)

List of names of ASDF systems, the loading of all of which is sufficient to evaluate and to deploy this propspec.

Source

src/propspec.lisp (file)

Generic Function: register-data-source TYPE &key KEYRING TRY-RECV-KEY NAME REPO DEPTH BRANCH LOCATION

Initialise and register a source of prerequisite data in this Lisp image. Registered data sources are available to all deployments executed from the root Lisp, regardless of the consfig which defines the host to which properties are to be applied. (This could only cause problems if you have different consfigs with prerequisite data which is identified by the same two strings, in which case you will need to wrap your deployments with registering and unregistering data sources. Usually items of prerequisite data are identified using things like hostnames, so this shouldn’t be necessary.)

Implementations of this function return a pair of functions.

Signals a condition MISSING-DATA-SOURCE when unable to access the data source (e.g. because can’t decrypt it). This condition is captured and ignored in all new Lisp images started up by Consfigurator, since prerequisite data sources are not expected to be available outside of the root Lisp.

Package

consfigurator

Source

src/data.lisp (file)

Methods
Method: register-data-source (TYPE (eql gpgpubkeys)) &key KEYRING TRY-RECV-KEY

Obtain ASCII-armoured PGP public keys by querying local gpg keyring KEYRING. If TRY-RECV-KEY, try to add any missing keys to KEYRING by querying keyservers configured in dirmngr.conf.

Source

src/data/gpgpubkeys.lisp (file)

Method: register-data-source (TYPE (eql git-snapshot)) &key NAME REPO DEPTH BRANCH

Provide tarball snapshots of a branch of a local git repository. Provides prerequisite data identified by "–git-snapshot", "NAME".

Rather than using git-bundle(1) or git-archive(1), we create a (possibly shallow) clone and tar it up. That way, it’s still a git repo on the remote side, but we don’t require git to be installed on the remote side to get a copy of the working tree over there.

Source

src/data/git-snapshot.lisp (file)

Method: register-data-source (TYPE (eql pgp)) &key LOCATION
Source

src/data/pgp.lisp (file)

Method: register-data-source (TYPE (eql asdf)) &key
Source

src/data/asdf.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: failed-change ()

Signal problems with the connection and errors while actually attempting to apply or unapply properties.

Package

consfigurator

Source

src/property.lisp (file)

Direct superclasses

simple-error (condition)

Condition: inapplicable-property ()

Signal, in a :HOSTATTRS subroutine, that the host’s hostattrs indicate that this property cannot be applied to this host. E.g. the property will try to install an apt package but the host is FreeBSD.

Package

consfigurator

Source

src/property.lisp (file)

Direct superclasses

simple-error (condition)

Condition: missing-data-source ()
Package

consfigurator

Source

src/data.lisp (file)

Direct superclasses

simple-error (condition)

Condition: run-failed ()
Package

consfigurator

Source

src/connection.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: cmd
Initargs

:cmd

Readers

failed-cmd (generic function)

Slot: stdout
Initargs

:stdout

Readers

failed-stdout (generic function)

Slot: stderr
Initargs

:stderr

Readers

failed-stderr (generic function)

Slot: exit-code
Initargs

:exit-code

Readers

failed-exit-code (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: connection ()
Package

consfigurator

Source

src/connection.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: parent

The value of *CONNECTION* at the time this connection was established.

Initform

consfigurator::*connection*

Readers

connection-parent (generic function)

Slot: cached-data

Items of prerequisite data known to be cached on the remote side.

Slot: remote-home

The remote user’s home directory.

Slot: current-directory

The current working directory for RUN, MRUN, READFILE and WRITEFILE.

Slot: remote-uid

Effective user-id of the remote (deploying) user

Slot: remote-user

The name of the remote user.

Class: data ()

An item of prerequisite data as provided by a registered prerequisite data source, or, outside of the root Lisp, as fished out of a local cache of prerequisite data.

Package

consfigurator

Source

src/data.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: iden1
Initargs

:iden1

Readers

iden1 (generic function)

Slot: iden2
Initargs

:iden2

Readers

iden2 (generic function)

Slot: data-version
Initargs

:version

Readers

data-version (generic function)

Slot: data-mime

The MIME type of the data, if known.

Initargs

:mime

Readers

data-mime (generic function)

Writers

(setf data-mime) (generic function)

Class: debian ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

debianlike (class)

Direct subclasses
Direct methods
Direct slots
Slot: suite
Initargs

:suite

Initform

(error "must provide suite")

Readers

debian-suite (generic function)

Class: debian-stable ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

debian (class)

Class: debian-testing ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

debian (class)

Direct slots
Slot: suite
Initform

"testing"

Class: debian-unstable ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

debian (class)

Direct slots
Slot: suite
Initform

"unstable"

Class: debianlike ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

linux (class)

Direct subclasses

debian (class)

Class: file-data ()

An item of prerequisite data accessible via the filesystem.

Package

consfigurator

Source

src/data.lisp (file)

Direct superclasses

data (class)

Direct methods
Direct slots
Slot: data-file
Initargs

:file

Readers

data-file (generic function)

Class: fork-connection ()
Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)

Direct superclasses

lisp-connection (class)

Direct subclasses
Direct methods

continue-connection (method)

Class: host ()

Abstract superclass for hosts. Do not instantiate.

Package

consfigurator

Source

src/host.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: hostattrs

Plist of the host’s static informational attributes.

Initargs

:hostattrs

Readers

hostattrs (generic function)

Slot: propspec

Propspec of the properties to be applied to the host.

Initargs

:propspec

Readers

host-propspec (generic function)

Class: linux ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

unixlike (class)

Direct subclasses

debianlike (class)

Direct methods
Direct slots
Slot: architecture

Keyword whose name is Debian’s name for this architecture, e.g. :AMD64

Initargs

:arch

Readers

linux-architecture (generic function)

Class: lisp-connection ()
Package

consfigurator

Source

src/connection.lisp (file)

Direct superclasses

connection (class)

Direct subclasses
Class: local-connection ()

The root deployment: applying properties to the machine the root Lisp is running on, as the root Lisp’s uid.

Package

consfigurator.connection.local

Source

src/connection/local.lisp (file)

Direct superclasses

lisp-connection (class)

Direct methods
Class: passphrase ()
Package

consfigurator

Source

src/data.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: passphrase
Initargs

:passphrase

Readers

passphrase (generic function)

Class: posix-connection ()
Package

consfigurator

Source

src/connection.lisp (file)

Direct superclasses

connection (class)

Direct subclasses

shell-wrap-connection (class)

Class: rehome-connection ()

A connection which works by switching to a new HOME on the same host.

Package

consfigurator.connection.rehome

Source

src/connection/rehome.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: datadir

Where Consfigurator would cache items of prerequisite data in the new HOME.

Type

:string

Initargs

:datadir

Readers

datadir (generic function)

Class: shell-wrap-connection ()
Package

consfigurator.connection.shell-wrap

Source

src/connection/shell-wrap.lisp (file)

Direct superclasses

posix-connection (class)

Direct subclasses
Direct methods
Class: string-data ()

An item of prerequisite data directly accessible to Lisp.

Package

consfigurator

Source

src/data.lisp (file)

Direct superclasses

data (class)

Direct methods
Direct slots
Slot: data-string
Initargs

:string

Readers

data-string (generic function)

Class: unixlike ()
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

linux (class)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +policyrcd+
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Constant: +sections+
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Constant: apt-cache-policy-installed
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *allow-printing-passphrases*
Package

consfigurator

Source

src/data.lisp (file)

Special Variable: *connection*

Object representing the currently active connection.
Deployments dynamically bind this variable and then apply properties.

Package

consfigurator

Source

src/connection.lisp (file)

Special Variable: *data-source-registrations*

Successful attempts to register data sources, which need not be repeated.

Package

consfigurator

Source

src/data.lisp (file)

Special Variable: *data-sources*

Known sources of prerequisite data.

Package

consfigurator

Source

src/data.lisp (file)

Special Variable: *host*

Object representing the host at the end of the current connection chain. Deployments bind this variable. Its global value should remain nil.

The main point of this is to allow properties to access the context in which they’re being applied.

Package

consfigurator

Source

src/connection.lisp (file)

Special Variable: *inform-prefix*
Package

consfigurator

Source

src/util.lisp (file)

Special Variable: *known-properties*

All properties whose definitions have been loaded.

Package

consfigurator

Source

src/property.lisp (file)

Special Variable: *known-property-macrolets*

Macro definitions for all known properties as used in MAP-PROPSPEC-PROPAPPS.

This variable exists just to avoid consing these forms over and over again; see MAP-PROPSPEC-PROPAPPS for how they are used.

Package

consfigurator

Source

src/property.lisp (file)

Special Variable: *no-data-sources*

If t, silently fail to register any data sources.

Package

consfigurator

Source

src/data.lisp (file)

Special Variable: *replaced-propapps*

Internal dynamic variable used in MAP-PROPSPEC-PROPAPPS.

Package

consfigurator

Source

src/propspec.lisp (file)

Special Variable: *string-data*

Items of STRING-DATA obtained from data sources by this Lisp image.

Package

consfigurator

Source

src/data.lisp (file)

Special Variable: continue-deploy*-program-implementation-specific
Package

consfigurator

Source

src/data.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: %available. &rest LOCALE
Package

consfigurator.property.locale

Source

src/property/locale.lisp (file)

Macro: %debootstrapped. ROOT HOST &rest OPTIONS
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Macro: %no-services. &rest ()
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Macro: %os-bootstrapped. OPTIONS ROOT &rest HOST
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Macro: %os-bootstrapper-installed. &rest HOST
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Macro: %policy-rc.d. &rest ()
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Macro: %process-run-args &body FORMS
Package

consfigurator

Source

src/connection.lisp (file)

Macro: authorized-keys. &rest KEYS
Package

consfigurator.property.ssh

Source

src/property/ssh.lisp (file)

Macro: available. &rest LOCALE
Package

consfigurator.property.locale

Source

src/property/locale.lisp (file)

Macro: configured. &rest PAIRS
Package

consfigurator.property.sshd

Source

src/property/sshd.lisp (file)

Macro: contains-conf-equals. FILE &rest PAIRS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: contains-conf-shell. FILE &rest PAIRS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: contains-conf-space. FILE &rest PAIRS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: contains-ini-settings. FILE &rest TRIPLES
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: contains-lines. PATH &rest LINES
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: data-uploaded. IDEN1 IDEN2 &rest DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: debian-stable. SUITE &rest ARCHITECTURE
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Macro: debian-testing. &rest ARCHITECTURE
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Macro: debian-unstable. &rest ARCHITECTURE
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Macro: define-dotted-property-macro NAME ARGS

Affix a period to the end of NAME and define a macro expanding into a propapp calling the original NAME after applying the dotted propapp rules, to the extent that doing so makes sense given the structure of ARGS.

For most properties this is a dummy definition which will not be exported. However, for properties where someone might like to use the dotted propapp rules in unevaluated propspecs containing calls to the property, export the dotted name alongside NAME.

Package

consfigurator

Source

src/property.lisp (file)

Macro: define-property-defining-macro MNAME (TYPEV LAMBDAV SLOTSV FORMSV) &body MBODY

Define macro MNAME which be used to define properties, and which works by parsing FORMSV and pushing SETPROP keyword argument pairs to plist SLOTSV.

Package

consfigurator

Source

src/property.lisp (file)

Macro: define-simple-error NAME &optional DOCSTRING
Package

consfigurator

Source

src/util.lisp (file)

Macro: defun-with-args NAME ARGSYM LAMBDA-LIST &body FORMS
Package

consfigurator

Source

src/util.lisp (file)

Macro: directory-exists. &rest DIR
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: does-not-exist. &rest PATHS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: form-beginning-with SYM FORM
Package

consfigurator

Source

src/util.lisp (file)

Macro: has-account. &rest USERNAME
Package

consfigurator.property.user

Source

src/property/user.lisp (file)

Macro: has-content. PATH &rest CONTENT
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: has-login-shell. USERNAME &rest SHELL
Package

consfigurator.property.user

Source

src/property/user.lisp (file)

Macro: has-mode. PATH &rest MODE
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: host-data-uploaded. &rest DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: host-secret-uploaded. &rest DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: installed. &rest ()
Package

consfigurator.property.sshd

Source

src/property/sshd.lisp (file)

Macro: installed. &rest PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: lacks-lines. PATH &rest LINES
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: mirror. &rest URI
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: no-passwords. &rest ()
Package

consfigurator.property.sshd

Source

src/property/sshd.lisp (file)

Macro: no-services. &rest ()
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Macro: props COMBINATOR &rest FORMS

Apply variadic COMBINATOR to FORMS and convert from an unevaluated property application specification expression to a property application specification expression.

Package

consfigurator

Source

src/propspec.lisp (file)

Macro: proxy. &rest URI
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: public-key-imported. &rest FINGERPRINT
Package

consfigurator.property.gnupg

Source

src/property/gnupg.lisp (file)

Macro: reconnects. CONNECTIONS &rest PROPERTIES
Package

consfigurator

Source

src/deployment.lisp (file)

Macro: regex-replaced-lines. FILE REGEX &rest REPLACE
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: removed. &rest PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: running. &rest SERVICE
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Macro: sbcl-available. &rest ()
Package

consfigurator.connection.sbcl

Source

src/connection/sbcl.lisp (file)

Macro: secret-uploaded. IDEN1 IDEN2 &rest DESTINATION
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Macro: selected-for. LOCALE &rest LOCALE-VARIABLES
Package

consfigurator.property.locale

Source

src/property/locale.lisp (file)

Macro: service-installed-running. &rest PACKAGE
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: single. &rest ARGS
Package

consfigurator.property.cmd

Source

src/property/cmd.lisp (file)

Macro: snapshot-extracted. DIRECTORY SNAPSHOT-NAME &key REPLACE
Package

consfigurator.property.git

Source

src/property/git.lisp (file)

Macro: standard-sources.list. &rest ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: uses-local-cacher. &rest ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: uses-parent-mirror. &rest ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: uses-parent-proxy. &rest ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: with-maybe-update FORM
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Macro: with-skip-failed-changes &body FORMS
Package

consfigurator

Source

src/combinator.lisp (file)

Macro: with-some-errors-are-failed-change &body FORMS
Package

consfigurator

Source

src/property.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: %available LOCALE
Package

consfigurator.property.locale

Source

src/property/locale.lisp (file)

Function: %consfigure CONNECTIONS HOST

Consfigurator’s primary loop, recursively binding *CONNECTION* and *HOST*.

Assumes arguments to connections in CONNECTIONS have been both normalised and preprocessed.

Package

consfigurator

Source

src/deployment.lisp (file)

Function: %debootstrapped ROOT HOST &rest OPTIONS
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Function: %get-data IDEN1 IDEN2
Package

consfigurator

Source

src/data.lisp (file)

Function: %os-bootstrapped OPTIONS ROOT HOST
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Function: %os-bootstrapper-installed HOST
Package

consfigurator.property.chroot

Source

src/property/chroot.lisp (file)

Function: %policy-rc.d ()
Package

consfigurator.property.service

Source

src/property/service.lisp (file)

Function: %propagate-hostattrs HOST
Package

consfigurator

Source

src/deployment.lisp (file)

Function: all-installed-p PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: apply-and-print PROPAPPS &optional UNAPPLY
Package

consfigurator

Source

src/combinator.lisp (file)

Function: apt-cache-policy PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: apt-get &rest ARGS
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: asdf-data-source-check IDEN1 SYSTEM
Package

consfigurator.data.asdf

Source

src/data/asdf.lisp (file)

Function: assert-ordinary-ll-member ARG

Assert that ARG is not an implementation-specific lambda list keyword or a lambda list keyword which is not permitted in ordinary lambda lists.

Consfigurator’s property-writing macros do not support lambda list keywords which fail this assertion.

Package

consfigurator

Source

src/util.lisp (file)

Function: can-chroot ()
Package

consfigurator.connection.chroot

Source

src/connection/chroot.lisp (file)

Function: can-setuid ()
Package

consfigurator.connection.as

Source

src/connection/as.lisp (file)

Function: chroot PATH
Package

consfigurator.connection.chroot.fork

Source

src/connection/chroot/fork.lisp (file)

Function: cksum FILE
Package

consfigurator

Source

src/property.lisp (file)

Function: config-file-map &key PARSE-COMMENT NEW-COMMENT PARSE-SECTION NEW-SECTION PARSE-KV NEW-KV MAP

Return a function suitable for passing to FILE:MAP-FILE-LINES, to modify the lines of a config file using MAP. MAP is a function from a list of config file lines to a list of config file lines, except that lines which set values in the original file will be replaced by lists of the form (COMMENTED SECTION KEY VALUE), where

- COMMENTED is a boolean indicating whether the line was commented
- SECTION is the section of the config file in which the line appears

and KEY and VALUE are the key and value. MAP may return lists of this form and they will be converted back into strings.

Other arguments:

- PARSE-COMMENT is a CL-PPCRE regular expression which, when matched at the beginning of a line, indicates a comment. It is assumed that it can be repeated and may be followed by whitespace.

- NEW-COMMENT is a string to be prepended to lines to comment them out.

- PARSE-SECTION is a function which returns the name of the section if passed a line which begins a section of the config file, or nil if the line does not start a section. It can also be a CL-PPCRE regexp, which should extract the section name as the first capture group. Lines will be passed to this function (or matched against this regexp) uncommented.

- NEW-SECTION is a function which takes a section name and returns a line (without trailing newline) beginning a new section with that name.

- PARSE-KV is a function which returns as a cons the key and value set by a line of the config file, or nil if the line is something else. It can also be a CL-PPCRE regexp, which should extract the key and value as the first and second capture groups, respectively. Lines will be passed to this function (or matched against this regexp) uncommented.

- NEW-KV is a function of two arguments, a key and a value, which returns an uncommented line setting the key and value.

Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: data-assoc IDEN1 IDEN2 DATA
Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: dpkg-version-compare X R Y
Package

consfigurator

Source

src/util.lisp (file)

Function: dump-properties-for-emacs FROM TO
Package

consfigurator

Source

src/property.lisp (file)

Function: fork ()
Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)

Function: get-branch-tip REPO BRANCH
Package

consfigurator.data.git-snapshot

Source

src/data/git-snapshot.lisp (file)

Function: get-local-data-cache-dir ()
Package

consfigurator

Source

src/data.lisp (file)

Function: get-mirrors ()
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: get-path-to-concatenated-system IDEN1 SYSTEM

Try to concatenate all the source code for SYSTEM, store it somewhere and return the filename.

Package

consfigurator.data.asdf

Source

src/data/asdf.lisp (file)

Function: get-remote-data-cache-dir ()
Package

consfigurator

Source

src/data.lisp (file)

Function: getkey KEYRING FINGERPRINT TRY-RECV-KEY
Package

consfigurator.data.gpgpubkeys

Source

src/data/gpgpubkeys.lisp (file)

Function: isprop PROP
Package

consfigurator

Source

src/property.lisp (file)

Function: local-getkey KEYRING FINGERPRINT
Package

consfigurator.data.gpgpubkeys

Source

src/data/gpgpubkeys.lisp (file)

Function: ls-cksum FILE
Package

consfigurator

Source

src/property.lisp (file)

Function: make-snapshot NAME REPO DEPTH BRANCH OUTPUT
Package

consfigurator.data.git-snapshot

Source

src/data/git-snapshot.lisp (file)

Function: map-propspec-propapps FUNCTION PROPSPEC &optional RECONSTRUCT ENV &aux *REPLACED-PROPAPPS*

Map FUNCTION over each propapp occurring in PROPSPEC after macroexpansion. FUNCTION designates a pure function from propapps to propapps. PROPSPEC is a property application specification expression.

RECONSTRUCT is a boolean flag indicating whether to return code which will evaluate to the resultant propspec rather than that propspec itself; if t, FUNCTION too should return code which will evaluate to propapps rather than propapps themselves. This is useful for when this function is called by macros. ENV is the ENV argument to be passed along to MACROEXPAND-ALL.

Note that this implementation will fail to map propapps appearing within the arguments to properties in propapps, but that should not be needed.

Package

consfigurator

Source

src/propspec.lisp (file)

Function: mktemp &key CONNECTION DIRECTORY

Make a temporary file on the remote side, in DIRECTORY, defaulting to /tmp.

Package

consfigurator

Source

src/connection.lisp (file)

Function: none-installed-p PACKAGES
Package

consfigurator.property.apt

Source

src/property/apt.lisp (file)

Function: normalise-system SYSTEM
Package

consfigurator

Source

src/util.lisp (file)

Function: on-change* PROPAPP &rest PROPAPPS
Package

consfigurator

Source

src/combinator.lisp (file)

Function: ordinary-ll-variable-names LL
Package

consfigurator

Source

src/util.lisp (file)

Function: ordinary-ll-without-&aux LL
Package

consfigurator

Source

src/util.lisp (file)

Function: os-etypecase* HOST &rest CASES
Package

consfigurator.property.os

Source

src/property/os.lisp (file)

Function: pathname-file PATHNAME

Like PATHNAME-NAME but include any file extension.

Package

consfigurator

Source

src/util.lisp (file)

Function: preprocess-connections CONNECTIONS
Package

consfigurator

Source

src/deployment.lisp (file)

Function: programmatic-apply-hostattrs ()
Package

consfigurator

Source

src/property.lisp (file)

Function: propapply PROP &rest ARGS
Package

consfigurator

Source

src/property.lisp (file)

Function: propcheck PROP &rest ARGS
Package

consfigurator

Source

src/property.lisp (file)

Function: propdesc PROP &rest ARGS
Package

consfigurator

Source

src/property.lisp (file)

Function: proplambda PROP
Package

consfigurator

Source

src/property.lisp (file)

Function: proppp PROP
Package

consfigurator

Source

src/property.lisp (file)

Function: proptype PROP
Package

consfigurator

Source

src/property.lisp (file)

Function: put-store LOCATION DATA
Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: pwd ()
Package

consfigurator

Source

src/connection.lisp (file)

Function: query-data-sources IDEN1 IDEN2
Package

consfigurator

Source

src/data.lisp (file)

Function: read-store LOCATION
Package

consfigurator.data.pgp

Source

src/data/pgp.lisp (file)

Function: reconnects CONNECTIONS PROPERTIES
Package

consfigurator

Source

src/deployment.lisp (file)

Function: record-known-property PSYM
Package

consfigurator

Source

src/property.lisp (file)

Function: sbcl-available ()
Package

consfigurator.connection.sbcl

Source

src/connection/sbcl.lisp (file)

Function: setgid GID
Package

consfigurator.connection.setuid

Source

src/connection/setuid.lisp (file)

Function: setprop SYM &key TYPE LAMBDA DESC PREPROCESS HOSTATTRS CHECK APPLY UNAPPLY
Package

consfigurator

Source

src/property.lisp (file)

Function: setuid UID
Package

consfigurator.connection.setuid

Source

src/connection/setuid.lisp (file)

Function: simple-conf-update FILE PAIRS &rest ARGS
Package

consfigurator.property.file

Source

src/property/file.lisp (file)

Function: sort-prerequisite-data-cache CACHE
Package

consfigurator

Source

src/data.lisp (file)

Function: ssh-host CONNECTION
Package

consfigurator.connection.ssh

Source

src/connection/ssh.lisp (file)

Function: store-indentation-info-for-emacs SYM ARGS &optional INFO
Package

consfigurator

Source

src/property.lisp (file)

Function: strip-declarations FORMS
Package

consfigurator

Source

src/util.lisp (file)

Function: try-get-file-mime-type FILE
Package

consfigurator

Source

src/data.lisp (file)

Function: user-exists USERNAME
Package

consfigurator.property.user

Source

src/property/user.lisp (file)

Function: waitpid PID OPTIONS
Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)

Function: wexitstatus STATUS
Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)

Function: wifexited STATUS
Package

consfigurator.connection.fork

Source

src/connection/fork.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: %get-data-stream DATA
Package

consfigurator

Methods
Method: %get-data-stream (DATA file-data)
Source

src/data.lisp (file)

Method: %get-data-stream (DATA string-data)
Source

src/data.lisp (file)

Generic Function: %get-data-string DATA
Package

consfigurator

Methods
Method: %get-data-string (DATA file-data)
Source

src/data.lisp (file)

Method: %get-data-string (DATA string-data)
Source

src/data.lisp (file)

Generic Function: broken-propspec CONDITION
Package

consfigurator

Methods
Method: broken-propspec (CONDITION invalid-or-ambiguous-propspec)
Source

src/propspec.lisp (file)

Generic Function: eval-propspec PROPSPEC
Package

consfigurator

Methods
Method: eval-propspec (PROPSPEC preprocessed-propspec)
Source

src/propspec.lisp (file)

Generic Function: failed-cmd CONDITION
Package

consfigurator

Methods
Method: failed-cmd (CONDITION run-failed)
Source

src/connection.lisp (file)

Generic Function: failed-exit-code CONDITION
Package

consfigurator

Methods
Method: failed-exit-code (CONDITION run-failed)
Source

src/connection.lisp (file)

Generic Function: failed-stderr CONDITION
Package

consfigurator

Methods
Method: failed-stderr (CONDITION run-failed)
Source

src/connection.lisp (file)

Generic Function: failed-stdout CONDITION
Package

consfigurator

Methods
Method: failed-stdout (CONDITION run-failed)
Source

src/connection.lisp (file)

Generic Function: get-default-mirrors OS
Package

consfigurator.property.apt

Methods
Method: get-default-mirrors (OS debian)
Source

src/property/apt.lisp (file)

Generic Function: get-sudo-password CONNECTION
Package

consfigurator.connection.sudo

Methods
Method: get-sudo-password (CONNECTION sudo-connection)
Source

src/connection/sudo.lisp (file)

Generic Function: host-propspec OBJECT
Package

consfigurator

Methods
Method: host-propspec (HOST host)

Propspec of the properties to be applied to the host.

Source

src/host.lisp (file)

Generic Function: missing-iden1 CONDITION
Package

consfigurator

Methods
Method: missing-iden1 (CONDITION missing-data)
Source

src/data.lisp (file)

Generic Function: missing-iden2 CONDITION
Package

consfigurator

Methods
Method: missing-iden2 (CONDITION missing-data)
Source

src/data.lisp (file)

Generic Function: preprocess-propspec PROPSPEC

Quote all propapps in PROPSPEC, after calling :PREPROCESS subroutines.

Package

consfigurator

Source

src/propspec.lisp (file)

Methods
Method: preprocess-propspec (PROPSPEC unpreprocessed-propspec)
Generic Function: replace-propspec-into-host HOST PROPSPEC
Package

consfigurator

Methods
Method: replace-propspec-into-host (HOST unpreprocessed-host) (PROPSPEC unpreprocessed-propspec)
Source

src/host.lisp (file)

Generic Function: shallow-copy-host HOST
Package

consfigurator

Methods
Method: shallow-copy-host (HOST host)
Source

src/host.lisp (file)

Generic Function: standard-sources-for OS
Package

consfigurator.property.apt

Methods
Method: standard-sources-for (OS debian)
Source

src/property/apt.lisp (file)

Generic Function: union-propspec-into-host HOST PROPSPEC
Package

consfigurator

Methods
Method: union-propspec-into-host (HOST unpreprocessed-host) (PROPSPEC propspec)
Source

src/host.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Conditions

Condition: ambiguous-propspec ()
Package

consfigurator

Source

src/propspec.lisp (file)

Direct superclasses

undefined-function (condition)

Direct subclasses

ambiguous-unevaluated-propspec (condition)

Condition: ambiguous-unevaluated-propspec ()
Package

consfigurator

Source

src/propspec.lisp (file)

Direct superclasses

ambiguous-propspec (condition)

Condition: invalid-or-ambiguous-propspec ()
Package

consfigurator

Source

src/propspec.lisp (file)

Direct superclasses

error (condition)

Direct methods

broken-propspec (method)

Direct slots
Slot: broken-propspec
Initargs

:propspec

Readers

broken-propspec (generic function)

Condition: missing-data ()
Package

consfigurator

Source

src/data.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: iden1
Initargs

:iden1

Readers

missing-iden1 (generic function)

Slot: iden2
Initargs

:iden2

Readers

missing-iden2 (generic function)

Condition: programmatic-apply-hostattrs ()
Package

consfigurator

Source

src/property.lisp (file)

Direct superclasses

simple-warning (condition)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.7 Classes

Class: chroot.fork-connection ()
Package

consfigurator.connection.chroot.fork

Source

src/connection/chroot/fork.lisp (file)

Direct superclasses
Direct methods

post-fork (method)

Direct slots
Slot: into
Type

:string

Initargs

:into

Class: preprocessed-host ()

A host whose :PREPROCESS and :HOSTATTRS subroutines have been run.

Package

consfigurator

Source

src/host.lisp (file)

Direct superclasses

host (class)

Direct methods

preprocess-host (method)

Direct slots
Slot: propspec
Type

consfigurator::preprocessed-propspec

Class: preprocessed-propspec ()

A propspec which has been preprocessed. The only valid methods operating directly on instances of this class are PROPSPEC-SYSTEMS, EVAL-PROPSPEC and PRINT-OBJECT.

Package

consfigurator

Source

src/propspec.lisp (file)

Direct superclasses

propspec (class)

Direct methods
Direct slots
Slot: preprocessed-propspec-expression

Preprocessed propspec corresponding to the propspec represented by this object. A preprocessed propspec is not itself a valid propspec, so the value of this slot should be considered opaque.

Initargs

:propspec

Class: propspec ()

Abstract superclass for propspecs. Do not instantiate.

Package

consfigurator

Source

src/propspec.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: systems

List of names of ASDF systems, the loading of all of which is sufficient to evaluate and to deploy this propspec.

Initargs

:systems

Initform

(or (symbol-value (find-symbol "*consfig*")) (error "looks like *consfig* is not set; please call in-consfig"))

Readers

propspec-systems (generic function)

Class: setuid-connection ()
Package

consfigurator.connection.setuid

Source

src/connection/setuid.lisp (file)

Direct superclasses
Direct methods

post-fork (method)

Direct slots
Slot: uid
Type

:integer

Initargs

:uid

Slot: gid
Type

:integer

Initargs

:gid

Slot: home
Type

:string

Initargs

:home

Class: shell-chroot-connection ()
Package

consfigurator.connection.chroot.shell

Source

src/connection/chroot/shell.lisp (file)

Direct superclasses

shell-wrap-connection (class)

Direct methods

connection-shell-wrap (method)

Direct slots
Slot: root
Initargs

:root

Class: ssh-connection ()

Deploy properties using non-interactive SSH.

Package

consfigurator.connection.ssh

Source

src/connection/ssh.lisp (file)

Direct superclasses

shell-wrap-connection (class)

Direct methods

connection-shell-wrap (method)

Direct slots
Slot: hostname

Hostname to SSH to.

Initargs

:hostname

Slot: user

User to log in as.

Initargs

:user

Class: su-connection ()
Package

consfigurator.connection.su

Source

src/connection/su.lisp (file)

Direct superclasses

shell-wrap-connection (class)

Direct methods

connection-shell-wrap (method)

Direct slots
Slot: user
Initargs

:user

Class: sudo-connection ()
Package

consfigurator.connection.sudo

Source

src/connection/sudo.lisp (file)

Direct superclasses

shell-wrap-connection (class)

Direct methods
Direct slots
Slot: user
Initargs

:user

Slot: password
Initargs

:password

Class: unpreprocessed-host ()

A host whose :PREPROCESS and :HOSTATTRS subroutines have not been run.

Package

consfigurator

Source

src/host.lisp (file)

Direct superclasses

host (class)

Direct methods
Direct slots
Slot: propspec
Type

consfigurator::unpreprocessed-propspec

Class: unpreprocessed-propspec ()
Package

consfigurator

Source

src/propspec.lisp (file)

Direct superclasses

propspec (class)

Direct methods
Direct slots
Slot: propspec-expression
Initargs

:propspec

Readers

propspec-props (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
consfigurator.asd: The consfigurator․asd file
consfigurator/src/combinator.lisp: The consfigurator/src/combinator․lisp file
consfigurator/src/connection.lisp: The consfigurator/src/connection․lisp file
consfigurator/src/connection/as.lisp: The consfigurator/src/connection/as․lisp file
consfigurator/src/connection/chroot.lisp: The consfigurator/src/connection/chroot․lisp file
consfigurator/src/connection/chroot/fork.lisp: The consfigurator/src/connection/chroot/fork․lisp file
consfigurator/src/connection/chroot/shell.lisp: The consfigurator/src/connection/chroot/shell․lisp file
consfigurator/src/connection/fork.lisp: The consfigurator/src/connection/fork․lisp file
consfigurator/src/connection/local.lisp: The consfigurator/src/connection/local․lisp file
consfigurator/src/connection/rehome.lisp: The consfigurator/src/connection/rehome․lisp file
consfigurator/src/connection/sbcl.lisp: The consfigurator/src/connection/sbcl․lisp file
consfigurator/src/connection/setuid.lisp: The consfigurator/src/connection/setuid․lisp file
consfigurator/src/connection/shell-wrap.lisp: The consfigurator/src/connection/shell-wrap․lisp file
consfigurator/src/connection/ssh.lisp: The consfigurator/src/connection/ssh․lisp file
consfigurator/src/connection/su.lisp: The consfigurator/src/connection/su․lisp file
consfigurator/src/connection/sudo.lisp: The consfigurator/src/connection/sudo․lisp file
consfigurator/src/data.lisp: The consfigurator/src/data․lisp file
consfigurator/src/data/asdf.lisp: The consfigurator/src/data/asdf․lisp file
consfigurator/src/data/git-snapshot.lisp: The consfigurator/src/data/git-snapshot․lisp file
consfigurator/src/data/gpgpubkeys.lisp: The consfigurator/src/data/gpgpubkeys․lisp file
consfigurator/src/data/pgp.lisp: The consfigurator/src/data/pgp․lisp file
consfigurator/src/deployment.lisp: The consfigurator/src/deployment․lisp file
consfigurator/src/host.lisp: The consfigurator/src/host․lisp file
consfigurator/src/package.lisp: The consfigurator/src/package․lisp file
consfigurator/src/property.lisp: The consfigurator/src/property․lisp file
consfigurator/src/property/apt.lisp: The consfigurator/src/property/apt․lisp file
consfigurator/src/property/chroot.lisp: The consfigurator/src/property/chroot․lisp file
consfigurator/src/property/cmd.lisp: The consfigurator/src/property/cmd․lisp file
consfigurator/src/property/file.lisp: The consfigurator/src/property/file․lisp file
consfigurator/src/property/git.lisp: The consfigurator/src/property/git․lisp file
consfigurator/src/property/gnupg.lisp: The consfigurator/src/property/gnupg․lisp file
consfigurator/src/property/locale.lisp: The consfigurator/src/property/locale․lisp file
consfigurator/src/property/os.lisp: The consfigurator/src/property/os․lisp file
consfigurator/src/property/service.lisp: The consfigurator/src/property/service․lisp file
consfigurator/src/property/ssh.lisp: The consfigurator/src/property/ssh․lisp file
consfigurator/src/property/sshd.lisp: The consfigurator/src/property/sshd․lisp file
consfigurator/src/property/user.lisp: The consfigurator/src/property/user․lisp file
consfigurator/src/propspec.lisp: The consfigurator/src/propspec․lisp file
consfigurator/src/reader.lisp: The consfigurator/src/reader․lisp file
consfigurator/src/util.lisp: The consfigurator/src/util․lisp file

F
File, Lisp, consfigurator.asd: The consfigurator․asd file
File, Lisp, consfigurator/src/combinator.lisp: The consfigurator/src/combinator․lisp file
File, Lisp, consfigurator/src/connection.lisp: The consfigurator/src/connection․lisp file
File, Lisp, consfigurator/src/connection/as.lisp: The consfigurator/src/connection/as․lisp file
File, Lisp, consfigurator/src/connection/chroot.lisp: The consfigurator/src/connection/chroot․lisp file
File, Lisp, consfigurator/src/connection/chroot/fork.lisp: The consfigurator/src/connection/chroot/fork․lisp file
File, Lisp, consfigurator/src/connection/chroot/shell.lisp: The consfigurator/src/connection/chroot/shell․lisp file
File, Lisp, consfigurator/src/connection/fork.lisp: The consfigurator/src/connection/fork․lisp file
File, Lisp, consfigurator/src/connection/local.lisp: The consfigurator/src/connection/local․lisp file
File, Lisp, consfigurator/src/connection/rehome.lisp: The consfigurator/src/connection/rehome․lisp file
File, Lisp, consfigurator/src/connection/sbcl.lisp: The consfigurator/src/connection/sbcl․lisp file
File, Lisp, consfigurator/src/connection/setuid.lisp: The consfigurator/src/connection/setuid․lisp file
File, Lisp, consfigurator/src/connection/shell-wrap.lisp: The consfigurator/src/connection/shell-wrap․lisp file
File, Lisp, consfigurator/src/connection/ssh.lisp: The consfigurator/src/connection/ssh․lisp file
File, Lisp, consfigurator/src/connection/su.lisp: The consfigurator/src/connection/su․lisp file
File, Lisp, consfigurator/src/connection/sudo.lisp: The consfigurator/src/connection/sudo․lisp file
File, Lisp, consfigurator/src/data.lisp: The consfigurator/src/data․lisp file
File, Lisp, consfigurator/src/data/asdf.lisp: The consfigurator/src/data/asdf․lisp file
File, Lisp, consfigurator/src/data/git-snapshot.lisp: The consfigurator/src/data/git-snapshot․lisp file
File, Lisp, consfigurator/src/data/gpgpubkeys.lisp: The consfigurator/src/data/gpgpubkeys․lisp file
File, Lisp, consfigurator/src/data/pgp.lisp: The consfigurator/src/data/pgp․lisp file
File, Lisp, consfigurator/src/deployment.lisp: The consfigurator/src/deployment․lisp file
File, Lisp, consfigurator/src/host.lisp: The consfigurator/src/host․lisp file
File, Lisp, consfigurator/src/package.lisp: The consfigurator/src/package․lisp file
File, Lisp, consfigurator/src/property.lisp: The consfigurator/src/property․lisp file
File, Lisp, consfigurator/src/property/apt.lisp: The consfigurator/src/property/apt․lisp file
File, Lisp, consfigurator/src/property/chroot.lisp: The consfigurator/src/property/chroot․lisp file
File, Lisp, consfigurator/src/property/cmd.lisp: The consfigurator/src/property/cmd․lisp file
File, Lisp, consfigurator/src/property/file.lisp: The consfigurator/src/property/file․lisp file
File, Lisp, consfigurator/src/property/git.lisp: The consfigurator/src/property/git․lisp file
File, Lisp, consfigurator/src/property/gnupg.lisp: The consfigurator/src/property/gnupg․lisp file
File, Lisp, consfigurator/src/property/locale.lisp: The consfigurator/src/property/locale․lisp file
File, Lisp, consfigurator/src/property/os.lisp: The consfigurator/src/property/os․lisp file
File, Lisp, consfigurator/src/property/service.lisp: The consfigurator/src/property/service․lisp file
File, Lisp, consfigurator/src/property/ssh.lisp: The consfigurator/src/property/ssh․lisp file
File, Lisp, consfigurator/src/property/sshd.lisp: The consfigurator/src/property/sshd․lisp file
File, Lisp, consfigurator/src/property/user.lisp: The consfigurator/src/property/user․lisp file
File, Lisp, consfigurator/src/propspec.lisp: The consfigurator/src/propspec․lisp file
File, Lisp, consfigurator/src/reader.lisp: The consfigurator/src/reader․lisp file
File, Lisp, consfigurator/src/util.lisp: The consfigurator/src/util․lisp file

L
Lisp File, consfigurator.asd: The consfigurator․asd file
Lisp File, consfigurator/src/combinator.lisp: The consfigurator/src/combinator․lisp file
Lisp File, consfigurator/src/connection.lisp: The consfigurator/src/connection․lisp file
Lisp File, consfigurator/src/connection/as.lisp: The consfigurator/src/connection/as․lisp file
Lisp File, consfigurator/src/connection/chroot.lisp: The consfigurator/src/connection/chroot․lisp file
Lisp File, consfigurator/src/connection/chroot/fork.lisp: The consfigurator/src/connection/chroot/fork․lisp file
Lisp File, consfigurator/src/connection/chroot/shell.lisp: The consfigurator/src/connection/chroot/shell․lisp file
Lisp File, consfigurator/src/connection/fork.lisp: The consfigurator/src/connection/fork․lisp file
Lisp File, consfigurator/src/connection/local.lisp: The consfigurator/src/connection/local․lisp file
Lisp File, consfigurator/src/connection/rehome.lisp: The consfigurator/src/connection/rehome․lisp file
Lisp File, consfigurator/src/connection/sbcl.lisp: The consfigurator/src/connection/sbcl․lisp file
Lisp File, consfigurator/src/connection/setuid.lisp: The consfigurator/src/connection/setuid․lisp file
Lisp File, consfigurator/src/connection/shell-wrap.lisp: The consfigurator/src/connection/shell-wrap․lisp file
Lisp File, consfigurator/src/connection/ssh.lisp: The consfigurator/src/connection/ssh․lisp file
Lisp File, consfigurator/src/connection/su.lisp: The consfigurator/src/connection/su․lisp file
Lisp File, consfigurator/src/connection/sudo.lisp: The consfigurator/src/connection/sudo․lisp file
Lisp File, consfigurator/src/data.lisp: The consfigurator/src/data․lisp file
Lisp File, consfigurator/src/data/asdf.lisp: The consfigurator/src/data/asdf․lisp file
Lisp File, consfigurator/src/data/git-snapshot.lisp: The consfigurator/src/data/git-snapshot․lisp file
Lisp File, consfigurator/src/data/gpgpubkeys.lisp: The consfigurator/src/data/gpgpubkeys․lisp file
Lisp File, consfigurator/src/data/pgp.lisp: The consfigurator/src/data/pgp․lisp file
Lisp File, consfigurator/src/deployment.lisp: The consfigurator/src/deployment․lisp file
Lisp File, consfigurator/src/host.lisp: The consfigurator/src/host․lisp file
Lisp File, consfigurator/src/package.lisp: The consfigurator/src/package․lisp file
Lisp File, consfigurator/src/property.lisp: The consfigurator/src/property․lisp file
Lisp File, consfigurator/src/property/apt.lisp: The consfigurator/src/property/apt․lisp file
Lisp File, consfigurator/src/property/chroot.lisp: The consfigurator/src/property/chroot․lisp file
Lisp File, consfigurator/src/property/cmd.lisp: The consfigurator/src/property/cmd․lisp file
Lisp File, consfigurator/src/property/file.lisp: The consfigurator/src/property/file․lisp file
Lisp File, consfigurator/src/property/git.lisp: The consfigurator/src/property/git․lisp file
Lisp File, consfigurator/src/property/gnupg.lisp: The consfigurator/src/property/gnupg․lisp file
Lisp File, consfigurator/src/property/locale.lisp: The consfigurator/src/property/locale․lisp file
Lisp File, consfigurator/src/property/os.lisp: The consfigurator/src/property/os․lisp file
Lisp File, consfigurator/src/property/service.lisp: The consfigurator/src/property/service․lisp file
Lisp File, consfigurator/src/property/ssh.lisp: The consfigurator/src/property/ssh․lisp file
Lisp File, consfigurator/src/property/sshd.lisp: The consfigurator/src/property/sshd․lisp file
Lisp File, consfigurator/src/property/user.lisp: The consfigurator/src/property/user․lisp file
Lisp File, consfigurator/src/propspec.lisp: The consfigurator/src/propspec․lisp file
Lisp File, consfigurator/src/reader.lisp: The consfigurator/src/reader․lisp file
Lisp File, consfigurator/src/util.lisp: The consfigurator/src/util․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   V   W  
Index Entry  Section

%
%available: Internal functions
%available.: Internal macros
%consfigure: Internal functions
%debootstrapped: Internal functions
%debootstrapped.: Internal macros
%get-data: Internal functions
%get-data-stream: Internal generic functions
%get-data-stream: Internal generic functions
%get-data-stream: Internal generic functions
%get-data-string: Internal generic functions
%get-data-string: Internal generic functions
%get-data-string: Internal generic functions
%no-services.: Internal macros
%os-bootstrapped: Internal functions
%os-bootstrapped.: Internal macros
%os-bootstrapper-installed: Internal functions
%os-bootstrapper-installed.: Internal macros
%policy-rc.d: Internal functions
%policy-rc.d.: Internal macros
%process-run-args: Internal macros
%propagate-hostattrs: Internal functions

(
(setf data-mime): Exported generic functions
(setf data-mime): Exported generic functions

A
all-installed-p: Internal functions
append-propspecs: Exported generic functions
append-propspecs: Exported generic functions
apply-and-print: Internal functions
apt-cache-policy: Internal functions
apt-get: Internal functions
as: Exported macros
asdf-data-source-check: Internal functions
assert-connection-supports: Exported functions
assert-euid-root: Exported functions
assert-ordinary-ll-member: Internal functions
authorized-keys: Exported functions
authorized-keys.: Internal macros
available: Exported functions
available.: Internal macros

B
broken-propspec: Internal generic functions
broken-propspec: Internal generic functions

C
call-with-os: Exported functions
can-chroot: Internal functions
can-probably-fork: Exported functions
can-setuid: Internal functions
chroot: Internal functions
cksum: Internal functions
collapse-types: Exported functions
config-file-map: Internal functions
configured: Exported functions
configured.: Internal macros
connection-clear-data-cache: Exported generic functions
connection-clear-data-cache: Exported generic functions
connection-clear-data-cache: Exported generic functions
connection-parent: Exported generic functions
connection-parent: Exported generic functions
connection-readfile: Exported generic functions
connection-readfile: Exported generic functions
connection-readfile: Exported generic functions
connection-readfile: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-run: Exported generic functions
connection-shell-wrap: Exported generic functions
connection-shell-wrap: Exported generic functions
connection-shell-wrap: Exported generic functions
connection-shell-wrap: Exported generic functions
connection-shell-wrap: Exported generic functions
connection-teardown: Exported generic functions
connection-teardown: Exported generic functions
connection-teardown: Exported generic functions
connection-upload: Exported generic functions
connection-upload: Exported generic functions
connection-upload: Exported generic functions
connection-upload: Exported generic functions
connection-writefile: Exported generic functions
connection-writefile: Exported generic functions
connection-writefile: Exported generic functions
connection-writefile: Exported generic functions
contains-conf-equals: Exported functions
contains-conf-equals.: Internal macros
contains-conf-shell: Exported functions
contains-conf-shell.: Internal macros
contains-conf-space: Exported functions
contains-conf-space.: Internal macros
contains-ini-settings: Exported functions
contains-ini-settings.: Internal macros
contains-lines: Exported functions
contains-lines.: Internal macros
continue-connection: Exported generic functions
continue-connection: Exported generic functions
continue-deploy*: Exported functions
continue-deploy*-program: Exported functions

D
data-assoc: Internal functions
data-file: Exported generic functions
data-file: Exported generic functions
data-mime: Exported generic functions
data-mime: Exported generic functions
data-pathname: Exported functions
data-source-providing-p: Exported functions
data-string: Exported generic functions
data-string: Exported generic functions
data-uploaded: Exported functions
data-uploaded.: Internal macros
data-version: Exported generic functions
data-version: Exported generic functions
datadir: Exported generic functions
datadir: Exported generic functions
debian-architecture: Exported generic functions
debian-architecture: Exported generic functions
debian-stable.: Internal macros
debian-suite: Exported generic functions
debian-suite: Exported generic functions
debian-testing.: Internal macros
debian-unstable.: Internal macros
defdeploy: Exported macros
defdeploy-these: Exported macros
defhost: Exported macros
define-dotted-property-macro: Internal macros
define-function-property-combinator: Exported macros
define-property-defining-macro: Internal macros
define-simple-error: Internal macros
defprop: Exported macros
defproplist: Exported macros
defpropspec: Exported macros
defun-with-args: Internal macros
delete-remote-tree: Exported functions
deploy: Exported macros
deploy*: Exported functions
deploy-these: Exported macros
deploy-these*: Exported functions
deploys: Exported functions
deploys-these: Exported functions
deploys-these.: Exported macros
deploys.: Exported macros
directory-exists: Exported functions
directory-exists.: Internal macros
does-not-exist: Exported functions
does-not-exist.: Internal macros
dpkg-version-compare: Internal functions
dump-properties-for-emacs: Internal functions

E
eseqprops: Exported functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
establish-connection: Exported generic functions
etypecase: Exported macros
eval-propspec: Internal generic functions
eval-propspec: Internal generic functions

F
failed-change: Exported functions
failed-cmd: Internal generic functions
failed-cmd: Internal generic functions
failed-exit-code: Internal generic functions
failed-exit-code: Internal generic functions
failed-stderr: Internal generic functions
failed-stderr: Internal generic functions
failed-stdout: Internal generic functions
failed-stdout: Internal generic functions
filename->string: Exported functions
fork: Internal functions
form-beginning-with: Internal macros
Function, %available: Internal functions
Function, %consfigure: Internal functions
Function, %debootstrapped: Internal functions
Function, %get-data: Internal functions
Function, %os-bootstrapped: Internal functions
Function, %os-bootstrapper-installed: Internal functions
Function, %policy-rc.d: Internal functions
Function, %propagate-hostattrs: Internal functions
Function, all-installed-p: Internal functions
Function, apply-and-print: Internal functions
Function, apt-cache-policy: Internal functions
Function, apt-get: Internal functions
Function, asdf-data-source-check: Internal functions
Function, assert-connection-supports: Exported functions
Function, assert-euid-root: Exported functions
Function, assert-ordinary-ll-member: Internal functions
Function, authorized-keys: Exported functions
Function, available: Exported functions
Function, call-with-os: Exported functions
Function, can-chroot: Internal functions
Function, can-probably-fork: Exported functions
Function, can-setuid: Internal functions
Function, chroot: Internal functions
Function, cksum: Internal functions
Function, collapse-types: Exported functions
Function, config-file-map: Internal functions
Function, configured: Exported functions
Function, contains-conf-equals: Exported functions
Function, contains-conf-shell: Exported functions
Function, contains-conf-space: Exported functions
Function, contains-ini-settings: Exported functions
Function, contains-lines: Exported functions
Function, continue-deploy*: Exported functions
Function, continue-deploy*-program: Exported functions
Function, data-assoc: Internal functions
Function, data-pathname: Exported functions
Function, data-source-providing-p: Exported functions
Function, data-uploaded: Exported functions
Function, delete-remote-tree: Exported functions
Function, deploy*: Exported functions
Function, deploy-these*: Exported functions
Function, deploys: Exported functions
Function, deploys-these: Exported functions
Function, directory-exists: Exported functions
Function, does-not-exist: Exported functions
Function, dpkg-version-compare: Internal functions
Function, dump-properties-for-emacs: Internal functions
Function, eseqprops: Exported functions
Function, failed-change: Exported functions
Function, filename->string: Exported functions
Function, fork: Internal functions
Function, get-branch-tip: Internal functions
Function, get-data: Exported functions
Function, get-data-protected-string: Exported functions
Function, get-data-stream: Exported functions
Function, get-data-string: Exported functions
Function, get-highest-local-cached-prerequisite-data: Exported functions
Function, get-hostattrs: Exported functions
Function, get-hostattrs-car: Exported functions
Function, get-hostname: Exported functions
Function, get-local-cached-prerequisite-data: Exported functions
Function, get-local-data-cache-dir: Internal functions
Function, get-mirrors: Internal functions
Function, get-parent-hostattrs: Exported functions
Function, get-parent-hostattrs-car: Exported functions
Function, get-path-to-concatenated-system: Internal functions
Function, get-remote-data-cache-dir: Internal functions
Function, get-user: Exported functions
Function, getkey: Internal functions
Function, has-account: Exported functions
Function, has-content: Exported functions
Function, has-login-shell: Exported functions
Function, has-mode: Exported functions
Function, host-data-uploaded: Exported functions
Function, host-secret-uploaded: Exported functions
Function, inapplicable-property: Exported functions
Function, inform: Exported functions
Function, informat: Exported functions
Function, installed: Exported functions
Function, installed: Exported functions
Function, isprop: Internal functions
Function, lacks-lines: Exported functions
Function, lines: Exported functions
Function, lisp-connection-p: Exported functions
Function, list-data: Exported functions
Function, local-data-pathname: Exported functions
Function, local-getkey: Internal functions
Function, ls-cksum: Internal functions
Function, make-child-host: Exported functions
Function, make-host: Exported functions
Function, make-passphrase: Exported functions
Function, make-propspec: Exported functions
Function, make-snapshot: Internal functions
Function, map-file-lines: Exported functions
Function, map-propspec-propapps: Internal functions
Function, memstring=: Exported functions
Function, missing-data-source: Exported functions
Function, mktemp: Internal functions
Function, mrun: Exported functions
Function, no-passwords: Exported functions
Function, no-services: Exported functions
Function, none-installed-p: Internal functions
Function, noop: Exported functions
Function, normalise-system: Internal functions
Function, on-change*: Internal functions
Function, ordinary-ll-variable-names: Internal functions
Function, ordinary-ll-without-&aux: Internal functions
Function, os-bootstrapped: Exported functions
Function, os-etypecase*: Internal functions
Function, passwd-entry: Exported functions
Function, pathname-file: Internal functions
Function, plist-to-cmd-args: Exported functions
Function, preprocess-connections: Internal functions
Function, programmatic-apply-hostattrs: Internal functions
Function, propappapply: Exported functions
Function, propappattrs: Exported functions
Function, propappcheck: Exported functions
Function, propappdesc: Exported functions
Function, propapply: Internal functions
Function, propapptype: Exported functions
Function, propappunapply: Exported functions
Function, propattrs: Exported functions
Function, propcheck: Internal functions
Function, propdesc: Internal functions
Function, proplambda: Internal functions
Function, proppp: Internal functions
Function, proptype: Internal functions
Function, propunapply: Exported functions
Function, proxy: Exported functions
Function, public-key-imported: Exported functions
Function, push-hostattrs: Exported functions
Function, pushnew-hostattrs: Exported functions
Function, put-store: Internal functions
Function, pwd: Internal functions
Function, query-data-sources: Internal functions
Function, read-store: Internal functions
Function, readfile: Exported functions
Function, reconnects: Internal functions
Function, record-known-property: Internal functions
Function, regex-replaced-lines: Exported functions
Function, remote-data-pathname: Exported functions
Function, remote-exists-p: Exported functions
Function, removed: Exported functions
Function, request-lisp-systems: Exported functions
Function, require-data: Exported functions
Function, required: Exported functions
Function, reset-data-sources: Exported functions
Function, reset-remote-home: Exported functions
Function, run: Exported functions
Function, runlines: Exported functions
Function, running: Exported functions
Function, sbcl-available: Internal functions
Function, secret-uploaded: Exported functions
Function, selected-for: Exported functions
Function, seqprops: Exported functions
Function, service-installed-running: Exported functions
Function, set-data: Exported functions
Function, set-data-from-file: Exported functions
Function, setgid: Internal functions
Function, setprop: Internal functions
Function, setuid: Internal functions
Function, silent-seqprops: Exported functions
Function, simple-conf-update: Internal functions
Function, single: Exported functions
Function, skip-data-source: Exported functions
Function, snapshot-extracted: Exported functions
Function, sort-prerequisite-data-cache: Internal functions
Function, ssh-host: Internal functions
Function, standard-sources.list: Exported functions
Function, store-indentation-info-for-emacs: Internal functions
Function, string->filename: Exported functions
Function, strip-declarations: Internal functions
Function, supports-arch-p: Exported functions
Function, test: Exported functions
Function, try-get-file-mime-type: Internal functions
Function, try-register-data-source: Exported functions
Function, unapply: Exported functions
Function, unlines: Exported functions
Function, upload-all-prerequisite-data: Exported functions
Function, user-exists: Internal functions
Function, uses-local-cacher: Exported functions
Function, uses-parent-mirror: Exported functions
Function, uses-parent-proxy: Exported functions
Function, version<: Exported functions
Function, version<=: Exported functions
Function, version>: Exported functions
Function, version>=: Exported functions
Function, waitpid: Internal functions
Function, wexitstatus: Internal functions
Function, wifexited: Internal functions
Function, without-starting-services: Exported functions
Function, writefile: Exported functions

G
Generic Function, %get-data-stream: Internal generic functions
Generic Function, %get-data-string: Internal generic functions
Generic Function, (setf data-mime): Exported generic functions
Generic Function, append-propspecs: Exported generic functions
Generic Function, broken-propspec: Internal generic functions
Generic Function, connection-clear-data-cache: Exported generic functions
Generic Function, connection-parent: Exported generic functions
Generic Function, connection-readfile: Exported generic functions
Generic Function, connection-run: Exported generic functions
Generic Function, connection-shell-wrap: Exported generic functions
Generic Function, connection-teardown: Exported generic functions
Generic Function, connection-upload: Exported generic functions
Generic Function, connection-writefile: Exported generic functions
Generic Function, continue-connection: Exported generic functions
Generic Function, data-file: Exported generic functions
Generic Function, data-mime: Exported generic functions
Generic Function, data-string: Exported generic functions
Generic Function, data-version: Exported generic functions
Generic Function, datadir: Exported generic functions
Generic Function, debian-architecture: Exported generic functions
Generic Function, debian-suite: Exported generic functions
Generic Function, establish-connection: Exported generic functions
Generic Function, eval-propspec: Internal generic functions
Generic Function, failed-cmd: Internal generic functions
Generic Function, failed-exit-code: Internal generic functions
Generic Function, failed-stderr: Internal generic functions
Generic Function, failed-stdout: Internal generic functions
Generic Function, get-default-mirrors: Internal generic functions
Generic Function, get-remote-cached-prerequisite-data: Exported generic functions
Generic Function, get-sudo-password: Internal generic functions
Generic Function, host-propspec: Internal generic functions
Generic Function, hostattrs: Exported generic functions
Generic Function, iden1: Exported generic functions
Generic Function, iden2: Exported generic functions
Generic Function, linux-architecture: Exported generic functions
Generic Function, missing-iden1: Internal generic functions
Generic Function, missing-iden2: Internal generic functions
Generic Function, passphrase: Exported generic functions
Generic Function, post-fork: Exported generic functions
Generic Function, preprocess-connection-args: Exported generic functions
Generic Function, preprocess-host: Exported generic functions
Generic Function, preprocess-propspec: Internal generic functions
Generic Function, propspec-props: Exported generic functions
Generic Function, propspec-systems: Exported generic functions
Generic Function, register-data-source: Exported generic functions
Generic Function, replace-propspec-into-host: Internal generic functions
Generic Function, shallow-copy-host: Internal generic functions
Generic Function, standard-sources-for: Internal generic functions
Generic Function, union-propspec-into-host: Internal generic functions
get-branch-tip: Internal functions
get-data: Exported functions
get-data-protected-string: Exported functions
get-data-stream: Exported functions
get-data-string: Exported functions
get-default-mirrors: Internal generic functions
get-default-mirrors: Internal generic functions
get-highest-local-cached-prerequisite-data: Exported functions
get-hostattrs: Exported functions
get-hostattrs-car: Exported functions
get-hostname: Exported functions
get-local-cached-prerequisite-data: Exported functions
get-local-data-cache-dir: Internal functions
get-mirrors: Internal functions
get-parent-hostattrs: Exported functions
get-parent-hostattrs-car: Exported functions
get-path-to-concatenated-system: Internal functions
get-remote-cached-prerequisite-data: Exported generic functions
get-remote-cached-prerequisite-data: Exported generic functions
get-remote-cached-prerequisite-data: Exported generic functions
get-remote-data-cache-dir: Internal functions
get-sudo-password: Internal generic functions
get-sudo-password: Internal generic functions
get-user: Exported functions
getkey: Internal functions

H
has-account: Exported functions
has-account.: Internal macros
has-content: Exported functions
has-content.: Internal macros
has-login-shell: Exported functions
has-login-shell.: Internal macros
has-mode: Exported functions
has-mode.: Internal macros
host-data-uploaded: Exported functions
host-data-uploaded.: Internal macros
host-etypecase: Exported macros
host-propspec: Internal generic functions
host-propspec: Internal generic functions
host-secret-uploaded: Exported functions
host-secret-uploaded.: Internal macros
hostattrs: Exported generic functions
hostattrs: Exported generic functions

I
iden1: Exported generic functions
iden1: Exported generic functions
iden2: Exported generic functions
iden2: Exported generic functions
ignoring-hostattrs: Exported macros
in-consfig: Exported macros
inapplicable-property: Exported functions
inform: Exported functions
informat: Exported functions
installed: Exported functions
installed: Exported functions
installed.: Internal macros
installed.: Internal macros
isprop: Internal functions

L
lacks-lines: Exported functions
lacks-lines.: Internal macros
lines: Exported functions
linux-architecture: Exported generic functions
linux-architecture: Exported generic functions
lisp-connection-p: Exported functions
list-data: Exported functions
local-data-pathname: Exported functions
local-getkey: Internal functions
ls-cksum: Internal functions

M
Macro, %available.: Internal macros
Macro, %debootstrapped.: Internal macros
Macro, %no-services.: Internal macros
Macro, %os-bootstrapped.: Internal macros
Macro, %os-bootstrapper-installed.: Internal macros
Macro, %policy-rc.d.: Internal macros
Macro, %process-run-args: Internal macros
Macro, as: Exported macros
Macro, authorized-keys.: Internal macros
Macro, available.: Internal macros
Macro, configured.: Internal macros
Macro, contains-conf-equals.: Internal macros
Macro, contains-conf-shell.: Internal macros
Macro, contains-conf-space.: Internal macros
Macro, contains-ini-settings.: Internal macros
Macro, contains-lines.: Internal macros
Macro, data-uploaded.: Internal macros
Macro, debian-stable.: Internal macros
Macro, debian-testing.: Internal macros
Macro, debian-unstable.: Internal macros
Macro, defdeploy: Exported macros
Macro, defdeploy-these: Exported macros
Macro, defhost: Exported macros
Macro, define-dotted-property-macro: Internal macros
Macro, define-function-property-combinator: Exported macros
Macro, define-property-defining-macro: Internal macros
Macro, define-simple-error: Internal macros
Macro, defprop: Exported macros
Macro, defproplist: Exported macros
Macro, defpropspec: Exported macros
Macro, defun-with-args: Internal macros
Macro, deploy: Exported macros
Macro, deploy-these: Exported macros
Macro, deploys-these.: Exported macros
Macro, deploys.: Exported macros
Macro, directory-exists.: Internal macros
Macro, does-not-exist.: Internal macros
Macro, etypecase: Exported macros
Macro, form-beginning-with: Internal macros
Macro, has-account.: Internal macros
Macro, has-content.: Internal macros
Macro, has-login-shell.: Internal macros
Macro, has-mode.: Internal macros
Macro, host-data-uploaded.: Internal macros
Macro, host-etypecase: Exported macros
Macro, host-secret-uploaded.: Internal macros
Macro, ignoring-hostattrs: Exported macros
Macro, in-consfig: Exported macros
Macro, installed.: Internal macros
Macro, installed.: Internal macros
Macro, lacks-lines.: Internal macros
Macro, mirror.: Internal macros
Macro, no-passwords.: Internal macros
Macro, no-services.: Internal macros
Macro, on-change: Exported macros
Macro, os-bootstrapped.: Exported macros
Macro, props: Internal macros
Macro, proxy.: Internal macros
Macro, public-key-imported.: Internal macros
Macro, reconnects.: Internal macros
Macro, regex-replaced-lines.: Internal macros
Macro, removed.: Internal macros
Macro, running.: Internal macros
Macro, sbcl-available.: Internal macros
Macro, secret-uploaded.: Internal macros
Macro, selected-for.: Internal macros
Macro, service-installed-running.: Internal macros
Macro, single.: Internal macros
Macro, snapshot-extracted.: Internal macros
Macro, standard-sources.list.: Internal macros
Macro, symbol-named: Exported macros
Macro, uses-local-cacher.: Internal macros
Macro, uses-parent-mirror.: Internal macros
Macro, uses-parent-proxy.: Internal macros
Macro, with-change-if-changes-file: Exported macros
Macro, with-change-if-changes-file-content: Exported macros
Macro, with-data-stream: Exported macros
Macro, with-indented-inform: Exported macros
Macro, with-local-connection: Exported macros
Macro, with-local-temporary-directory: Exported macros
Macro, with-maybe-update: Internal macros
Macro, with-preserve-hostattrs: Exported macros
Macro, with-remote-current-directory: Exported macros
Macro, with-remote-temporary-file: Exported macros
Macro, with-requirements: Exported macros
Macro, with-skip-failed-changes: Internal macros
Macro, with-some-errors-are-failed-change: Internal macros
make-child-host: Exported functions
make-host: Exported functions
make-passphrase: Exported functions
make-propspec: Exported functions
make-snapshot: Internal functions
map-file-lines: Exported functions
map-propspec-propapps: Internal functions
memstring=: Exported functions
Method, %get-data-stream: Internal generic functions
Method, %get-data-stream: Internal generic functions
Method, %get-data-string: Internal generic functions
Method, %get-data-string: Internal generic functions
Method, (setf data-mime): Exported generic functions
Method, append-propspecs: Exported generic functions
Method, broken-propspec: Internal generic functions
Method, connection-clear-data-cache: Exported generic functions
Method, connection-clear-data-cache: Exported generic functions
Method, connection-parent: Exported generic functions
Method, connection-readfile: Exported generic functions
Method, connection-readfile: Exported generic functions
Method, connection-readfile: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-run: Exported generic functions
Method, connection-shell-wrap: Exported generic functions
Method, connection-shell-wrap: Exported generic functions
Method, connection-shell-wrap: Exported generic functions
Method, connection-shell-wrap: Exported generic functions
Method, connection-teardown: Exported generic functions
Method, connection-teardown: Exported generic functions
Method, connection-upload: Exported generic functions
Method, connection-upload: Exported generic functions
Method, connection-upload: Exported generic functions
Method, connection-writefile: Exported generic functions
Method, connection-writefile: Exported generic functions
Method, connection-writefile: Exported generic functions
Method, continue-connection: Exported generic functions
Method, data-file: Exported generic functions
Method, data-mime: Exported generic functions
Method, data-string: Exported generic functions
Method, data-version: Exported generic functions
Method, datadir: Exported generic functions
Method, debian-architecture: Exported generic functions
Method, debian-suite: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, establish-connection: Exported generic functions
Method, eval-propspec: Internal generic functions
Method, failed-cmd: Internal generic functions
Method, failed-exit-code: Internal generic functions
Method, failed-stderr: Internal generic functions
Method, failed-stdout: Internal generic functions
Method, get-default-mirrors: Internal generic functions
Method, get-remote-cached-prerequisite-data: Exported generic functions
Method, get-remote-cached-prerequisite-data: Exported generic functions
Method, get-sudo-password: Internal generic functions
Method, host-propspec: Internal generic functions
Method, hostattrs: Exported generic functions
Method, iden1: Exported generic functions
Method, iden2: Exported generic functions
Method, linux-architecture: Exported generic functions
Method, missing-iden1: Internal generic functions
Method, missing-iden2: Internal generic functions
Method, passphrase: Exported generic functions
Method, post-fork: Exported generic functions
Method, post-fork: Exported generic functions
Method, post-fork: Exported generic functions
Method, preprocess-connection-args: Exported generic functions
Method, preprocess-connection-args: Exported generic functions
Method, preprocess-host: Exported generic functions
Method, preprocess-host: Exported generic functions
Method, preprocess-propspec: Internal generic functions
Method, propspec-props: Exported generic functions
Method, propspec-systems: Exported generic functions
Method, register-data-source: Exported generic functions
Method, register-data-source: Exported generic functions
Method, register-data-source: Exported generic functions
Method, register-data-source: Exported generic functions
Method, replace-propspec-into-host: Internal generic functions
Method, shallow-copy-host: Internal generic functions
Method, standard-sources-for: Internal generic functions
Method, union-propspec-into-host: Internal generic functions
mirror.: Internal macros
missing-data-source: Exported functions
missing-iden1: Internal generic functions
missing-iden1: Internal generic functions
missing-iden2: Internal generic functions
missing-iden2: Internal generic functions
mktemp: Internal functions
mrun: Exported functions

N
no-passwords: Exported functions
no-passwords.: Internal macros
no-services: Exported functions
no-services.: Internal macros
none-installed-p: Internal functions
noop: Exported functions
normalise-system: Internal functions

O
on-change: Exported macros
on-change*: Internal functions
ordinary-ll-variable-names: Internal functions
ordinary-ll-without-&aux: Internal functions
os-bootstrapped: Exported functions
os-bootstrapped.: Exported macros
os-etypecase*: Internal functions

P
passphrase: Exported generic functions
passphrase: Exported generic functions
passwd-entry: Exported functions
pathname-file: Internal functions
plist-to-cmd-args: Exported functions
post-fork: Exported generic functions
post-fork: Exported generic functions
post-fork: Exported generic functions
post-fork: Exported generic functions
preprocess-connection-args: Exported generic functions
preprocess-connection-args: Exported generic functions
preprocess-connection-args: Exported generic functions
preprocess-connections: Internal functions
preprocess-host: Exported generic functions
preprocess-host: Exported generic functions
preprocess-host: Exported generic functions
preprocess-propspec: Internal generic functions
preprocess-propspec: Internal generic functions
programmatic-apply-hostattrs: Internal functions
propappapply: Exported functions
propappattrs: Exported functions
propappcheck: Exported functions
propappdesc: Exported functions
propapply: Internal functions
propapptype: Exported functions
propappunapply: Exported functions
propattrs: Exported functions
propcheck: Internal functions
propdesc: Internal functions
proplambda: Internal functions
proppp: Internal functions
props: Internal macros
propspec-props: Exported generic functions
propspec-props: Exported generic functions
propspec-systems: Exported generic functions
propspec-systems: Exported generic functions
proptype: Internal functions
propunapply: Exported functions
proxy: Exported functions
proxy.: Internal macros
public-key-imported: Exported functions
public-key-imported.: Internal macros
push-hostattrs: Exported functions
pushnew-hostattrs: Exported functions
put-store: Internal functions
pwd: Internal functions

Q
query-data-sources: Internal functions

R
read-store: Internal functions
readfile: Exported functions
reconnects: Internal functions
reconnects.: Internal macros
record-known-property: Internal functions
regex-replaced-lines: Exported functions
regex-replaced-lines.: Internal macros
register-data-source: Exported generic functions
register-data-source: Exported generic functions
register-data-source: Exported generic functions
register-data-source: Exported generic functions
register-data-source: Exported generic functions
remote-data-pathname: Exported functions
remote-exists-p: Exported functions
removed: Exported functions
removed.: Internal macros
replace-propspec-into-host: Internal generic functions
replace-propspec-into-host: Internal generic functions
request-lisp-systems: Exported functions
require-data: Exported functions
required: Exported functions
reset-data-sources: Exported functions
reset-remote-home: Exported functions
run: Exported functions
runlines: Exported functions
running: Exported functions
running.: Internal macros

S
sbcl-available: Internal functions
sbcl-available.: Internal macros
secret-uploaded: Exported functions
secret-uploaded.: Internal macros
selected-for: Exported functions
selected-for.: Internal macros
seqprops: Exported functions
service-installed-running: Exported functions
service-installed-running.: Internal macros
set-data: Exported functions
set-data-from-file: Exported functions
setgid: Internal functions
setprop: Internal functions
setuid: Internal functions
shallow-copy-host: Internal generic functions
shallow-copy-host: Internal generic functions
silent-seqprops: Exported functions
simple-conf-update: Internal functions
single: Exported functions
single.: Internal macros
skip-data-source: Exported functions
snapshot-extracted: Exported functions
snapshot-extracted.: Internal macros
sort-prerequisite-data-cache: Internal functions
ssh-host: Internal functions
standard-sources-for: Internal generic functions
standard-sources-for: Internal generic functions
standard-sources.list: Exported functions
standard-sources.list.: Internal macros
store-indentation-info-for-emacs: Internal functions
string->filename: Exported functions
strip-declarations: Internal functions
supports-arch-p: Exported functions
symbol-named: Exported macros

T
test: Exported functions
try-get-file-mime-type: Internal functions
try-register-data-source: Exported functions

U
unapply: Exported functions
union-propspec-into-host: Internal generic functions
union-propspec-into-host: Internal generic functions
unlines: Exported functions
upload-all-prerequisite-data: Exported functions
user-exists: Internal functions
uses-local-cacher: Exported functions
uses-local-cacher.: Internal macros
uses-parent-mirror: Exported functions
uses-parent-mirror.: Internal macros
uses-parent-proxy: Exported functions
uses-parent-proxy.: Internal macros

V
version<: Exported functions
version<=: Exported functions
version>: Exported functions
version>=: Exported functions

W
waitpid: Internal functions
wexitstatus: Internal functions
wifexited: Internal functions
with-change-if-changes-file: Exported macros
with-change-if-changes-file-content: Exported macros
with-data-stream: Exported macros
with-indented-inform: Exported macros
with-local-connection: Exported macros
with-local-temporary-directory: Exported macros
with-maybe-update: Internal macros
with-preserve-hostattrs: Exported macros
with-remote-current-directory: Exported macros
with-remote-temporary-file: Exported macros
with-requirements: Exported macros
with-skip-failed-changes: Internal macros
with-some-errors-are-failed-change: Internal macros
without-starting-services: Exported functions
writefile: Exported functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
A   B   C   D   E   G   H   I   P   R   S   U  
Index Entry  Section

*
*allow-printing-passphrases*: Internal special variables
*connection*: Internal special variables
*consfigurator-debug-level*: Exported special variables
*data-source-registrations*: Internal special variables
*data-sources*: Internal special variables
*host*: Internal special variables
*inform-prefix*: Internal special variables
*known-properties*: Internal special variables
*known-property-macrolets*: Internal special variables
*no-data-sources*: Internal special variables
*replaced-propapps*: Internal special variables
*string-data*: Internal special variables

+
+policyrcd+: Internal constants
+sections+: Internal constants

A
apt-cache-policy-installed: Internal constants
architecture: Exported classes

B
broken-propspec: Internal conditions

C
cached-data: Exported classes
cmd: Exported conditions
Constant, +policyrcd+: Internal constants
Constant, +sections+: Internal constants
Constant, apt-cache-policy-installed: Internal constants
continue-deploy*-program-implementation-specific: Internal special variables
current-directory: Exported classes

D
data-file: Exported classes
data-mime: Exported classes
data-string: Exported classes
data-version: Exported classes
datadir: Exported classes

E
exit-code: Exported conditions

G
gid: Internal classes

H
home: Internal classes
hostattrs: Exported classes
hostname: Internal classes

I
iden1: Exported classes
iden1: Internal conditions
iden2: Exported classes
iden2: Internal conditions
into: Internal classes

P
parent: Exported classes
passphrase: Exported classes
password: Internal classes
preprocessed-propspec-expression: Internal classes
propspec: Exported classes
propspec: Internal classes
propspec: Internal classes
propspec-expression: Internal classes

R
remote-home: Exported classes
remote-uid: Exported classes
remote-user: Exported classes
root: Internal classes

S
Slot, architecture: Exported classes
Slot, broken-propspec: Internal conditions
Slot, cached-data: Exported classes
Slot, cmd: Exported conditions
Slot, current-directory: Exported classes
Slot, data-file: Exported classes
Slot, data-mime: Exported classes
Slot, data-string: Exported classes
Slot, data-version: Exported classes
Slot, datadir: Exported classes
Slot, exit-code: Exported conditions
Slot, gid: Internal classes
Slot, home: Internal classes
Slot, hostattrs: Exported classes
Slot, hostname: Internal classes
Slot, iden1: Exported classes
Slot, iden1: Internal conditions
Slot, iden2: Exported classes
Slot, iden2: Internal conditions
Slot, into: Internal classes
Slot, parent: Exported classes
Slot, passphrase: Exported classes
Slot, password: Internal classes
Slot, preprocessed-propspec-expression: Internal classes
Slot, propspec: Exported classes
Slot, propspec: Internal classes
Slot, propspec: Internal classes
Slot, propspec-expression: Internal classes
Slot, remote-home: Exported classes
Slot, remote-uid: Exported classes
Slot, remote-user: Exported classes
Slot, root: Internal classes
Slot, stderr: Exported conditions
Slot, stdout: Exported conditions
Slot, suite: Exported classes
Slot, suite: Exported classes
Slot, suite: Exported classes
Slot, systems: Internal classes
Slot, uid: Internal classes
Slot, user: Internal classes
Slot, user: Internal classes
Slot, user: Internal classes
Special Variable, *allow-printing-passphrases*: Internal special variables
Special Variable, *connection*: Internal special variables
Special Variable, *consfigurator-debug-level*: Exported special variables
Special Variable, *data-source-registrations*: Internal special variables
Special Variable, *data-sources*: Internal special variables
Special Variable, *host*: Internal special variables
Special Variable, *inform-prefix*: Internal special variables
Special Variable, *known-properties*: Internal special variables
Special Variable, *known-property-macrolets*: Internal special variables
Special Variable, *no-data-sources*: Internal special variables
Special Variable, *replaced-propapps*: Internal special variables
Special Variable, *string-data*: Internal special variables
Special Variable, continue-deploy*-program-implementation-specific: Internal special variables
stderr: Exported conditions
stdout: Exported conditions
suite: Exported classes
suite: Exported classes
suite: Exported classes
systems: Internal classes

U
uid: Internal classes
user: Internal classes
user: Internal classes
user: Internal classes

Jump to:   *   +  
A   B   C   D   E   G   H   I   P   R   S   U  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   D   F   H   I   L   M   P   R   S   U  
Index Entry  Section

A
ambiguous-propspec: Internal conditions
ambiguous-unevaluated-propspec: Internal conditions

C
chroot.fork-connection: Internal classes
Class, chroot.fork-connection: Internal classes
Class, connection: Exported classes
Class, data: Exported classes
Class, debian: Exported classes
Class, debian-stable: Exported classes
Class, debian-testing: Exported classes
Class, debian-unstable: Exported classes
Class, debianlike: Exported classes
Class, file-data: Exported classes
Class, fork-connection: Exported classes
Class, host: Exported classes
Class, linux: Exported classes
Class, lisp-connection: Exported classes
Class, local-connection: Exported classes
Class, passphrase: Exported classes
Class, posix-connection: Exported classes
Class, preprocessed-host: Internal classes
Class, preprocessed-propspec: Internal classes
Class, propspec: Internal classes
Class, rehome-connection: Exported classes
Class, setuid-connection: Internal classes
Class, shell-chroot-connection: Internal classes
Class, shell-wrap-connection: Exported classes
Class, ssh-connection: Internal classes
Class, string-data: Exported classes
Class, su-connection: Internal classes
Class, sudo-connection: Internal classes
Class, unixlike: Exported classes
Class, unpreprocessed-host: Internal classes
Class, unpreprocessed-propspec: Internal classes
Condition, ambiguous-propspec: Internal conditions
Condition, ambiguous-unevaluated-propspec: Internal conditions
Condition, failed-change: Exported conditions
Condition, inapplicable-property: Exported conditions
Condition, invalid-or-ambiguous-propspec: Internal conditions
Condition, missing-data: Internal conditions
Condition, missing-data-source: Exported conditions
Condition, programmatic-apply-hostattrs: Internal conditions
Condition, run-failed: Exported conditions
connection: Exported classes
consfigurator: The consfigurator system
consfigurator: The consfigurator package
consfigurator.connection.as: The consfigurator․connection․as package
consfigurator.connection.chroot: The consfigurator․connection․chroot package
consfigurator.connection.chroot.fork: The consfigurator․connection․chroot․fork package
consfigurator.connection.chroot.shell: The consfigurator․connection․chroot․shell package
consfigurator.connection.fork: The consfigurator․connection․fork package
consfigurator.connection.local: The consfigurator․connection․local package
consfigurator.connection.rehome: The consfigurator․connection․rehome package
consfigurator.connection.sbcl: The consfigurator․connection․sbcl package
consfigurator.connection.setuid: The consfigurator․connection․setuid package
consfigurator.connection.shell-wrap: The consfigurator․connection․shell-wrap package
consfigurator.connection.ssh: The consfigurator․connection․ssh package
consfigurator.connection.su: The consfigurator․connection․su package
consfigurator.connection.sudo: The consfigurator․connection․sudo package
consfigurator.data.asdf: The consfigurator․data․asdf package
consfigurator.data.git-snapshot: The consfigurator․data․git-snapshot package
consfigurator.data.gpgpubkeys: The consfigurator․data․gpgpubkeys package
consfigurator.data.pgp: The consfigurator․data․pgp package
consfigurator.property.apt: The consfigurator․property․apt package
consfigurator.property.chroot: The consfigurator․property․chroot package
consfigurator.property.cmd: The consfigurator․property․cmd package
consfigurator.property.file: The consfigurator․property․file package
consfigurator.property.git: The consfigurator․property․git package
consfigurator.property.gnupg: The consfigurator․property․gnupg package
consfigurator.property.locale: The consfigurator․property․locale package
consfigurator.property.os: The consfigurator․property․os package
consfigurator.property.service: The consfigurator․property․service package
consfigurator.property.ssh: The consfigurator․property․ssh package
consfigurator.property.sshd: The consfigurator․property․sshd package
consfigurator.property.user: The consfigurator․property․user package

D
data: Exported classes
debian: Exported classes
debian-stable: Exported classes
debian-testing: Exported classes
debian-unstable: Exported classes
debianlike: Exported classes

F
failed-change: Exported conditions
file-data: Exported classes
fork-connection: Exported classes

H
host: Exported classes

I
inapplicable-property: Exported conditions
invalid-or-ambiguous-propspec: Internal conditions

L
linux: Exported classes
lisp-connection: Exported classes
local-connection: Exported classes

M
missing-data: Internal conditions
missing-data-source: Exported conditions

P
Package, consfigurator: The consfigurator package
Package, consfigurator.connection.as: The consfigurator․connection․as package
Package, consfigurator.connection.chroot: The consfigurator․connection․chroot package
Package, consfigurator.connection.chroot.fork: The consfigurator․connection․chroot․fork package
Package, consfigurator.connection.chroot.shell: The consfigurator․connection․chroot․shell package
Package, consfigurator.connection.fork: The consfigurator․connection․fork package
Package, consfigurator.connection.local: The consfigurator․connection․local package
Package, consfigurator.connection.rehome: The consfigurator․connection․rehome package
Package, consfigurator.connection.sbcl: The consfigurator․connection․sbcl package
Package, consfigurator.connection.setuid: The consfigurator․connection․setuid package
Package, consfigurator.connection.shell-wrap: The consfigurator․connection․shell-wrap package
Package, consfigurator.connection.ssh: The consfigurator․connection․ssh package
Package, consfigurator.connection.su: The consfigurator․connection․su package
Package, consfigurator.connection.sudo: The consfigurator․connection․sudo package
Package, consfigurator.data.asdf: The consfigurator․data․asdf package
Package, consfigurator.data.git-snapshot: The consfigurator․data․git-snapshot package
Package, consfigurator.data.gpgpubkeys: The consfigurator․data․gpgpubkeys package
Package, consfigurator.data.pgp: The consfigurator․data․pgp package
Package, consfigurator.property.apt: The consfigurator․property․apt package
Package, consfigurator.property.chroot: The consfigurator․property․chroot package
Package, consfigurator.property.cmd: The consfigurator․property․cmd package
Package, consfigurator.property.file: The consfigurator․property․file package
Package, consfigurator.property.git: The consfigurator․property․git package
Package, consfigurator.property.gnupg: The consfigurator․property․gnupg package
Package, consfigurator.property.locale: The consfigurator․property․locale package
Package, consfigurator.property.os: The consfigurator․property․os package
Package, consfigurator.property.service: The consfigurator․property․service package
Package, consfigurator.property.ssh: The consfigurator․property․ssh package
Package, consfigurator.property.sshd: The consfigurator․property․sshd package
Package, consfigurator.property.user: The consfigurator․property․user package
passphrase: Exported classes
posix-connection: Exported classes
preprocessed-host: Internal classes
preprocessed-propspec: Internal classes
programmatic-apply-hostattrs: Internal conditions
propspec: Internal classes

R
rehome-connection: Exported classes
run-failed: Exported conditions

S
setuid-connection: Internal classes
shell-chroot-connection: Internal classes
shell-wrap-connection: Exported classes
ssh-connection: Internal classes
string-data: Exported classes
su-connection: Internal classes
sudo-connection: Internal classes
System, consfigurator: The consfigurator system

U
unixlike: Exported classes
unpreprocessed-host: Internal classes
unpreprocessed-propspec: Internal classes

Jump to:   A   C   D   F   H   I   L   M   P   R   S   U