diff options
| -rw-r--r-- | README.rst | 2 | ||||
| -rw-r--r-- | doc/data.rst | 2 | ||||
| -rw-r--r-- | doc/introduction.rst | 6 | ||||
| -rw-r--r-- | doc/pitfalls.rst | 6 | ||||
| -rw-r--r-- | doc/properties.rst | 4 | ||||
| -rw-r--r-- | src/connection.lisp | 4 | ||||
| -rw-r--r-- | src/data.lisp | 8 | ||||
| -rw-r--r-- | src/propspec.lisp | 4 |
8 files changed, 18 insertions, 18 deletions
@@ -18,7 +18,7 @@ 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 process to execute your deployment code, you would just +starting up a Lisp image to execute your deployment code, you would just evaluate ``(deploy (:ssh (:sudo :user "root") :debian-sbcl) foo.example.com)``. Declarative configuration management systems like Consfigurator and Propellor_ diff --git a/doc/data.rst b/doc/data.rst index 7780ae7..d30eab8 100644 --- a/doc/data.rst +++ b/doc/data.rst @@ -37,7 +37,7 @@ the ``DATA-UPLOADED`` property, to get access to the requested data. A Lisp connection gathers all needed prerequisite data once at the beginning, and copies it to an on-disk cache inside the home directory of the remote UID -which will run the Lisp process. A POSIX connection only attempts to obtain +which will run the Lisp image. A POSIX connection only attempts to obtain prerequisite data when a property's check function indicates the property is not already applied. diff --git a/doc/introduction.rst b/doc/introduction.rst index f35f441..65cedea 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -29,7 +29,7 @@ Connection A means by which properties can be applied to hosts, and multihop connections to other hosts can be established. There are two types of connections: those which interact with the remote host by means of a POSIX shell, and those which -apply properties by executing them in a Lisp process running on the host. +apply properties by executing them in a Lisp image running on the host. POSIX connections can pass input to and return output from processes, but cannot start asynchronous processes for interaction with your Lisp functions. @@ -52,7 +52,7 @@ be nested: one remote host can be used to deploy others, as a controller. Root Lisp ~~~~~~~~~ -The Lisp process you control directly when you execute deployments. Typically +The Lisp image you control directly when you execute deployments. Typically running on your development laptop/workstation (and not as the ``root`` user). Property application specification @@ -100,7 +100,7 @@ data; this avoids uploading the same data over and over again. In addition to secrets management, prerequisite data is Consfigurator's mechanism for the common need to upload files to controlled hosts. The same mechanism is used internally to upload the Lisp code needed to start up remote -Lisp processes for ``:lisp`` connections. +Lisp images for ``:lisp`` connections. Consfig ~~~~~~~ diff --git a/doc/pitfalls.rst b/doc/pitfalls.rst index d4bcb4a..7a7bbae 100644 --- a/doc/pitfalls.rst +++ b/doc/pitfalls.rst @@ -27,7 +27,7 @@ not try to define properties and connection types programmatically, or try to dynamically rebind or flet-bind them. The reason for this restriction is that some connection types need to invoke -fresh Lisp processes on remote hosts with (local equivalents to) the function +fresh Lisp images on remote hosts with (local equivalents to) the function objects contained in properties and connections available to be called. Since function objects are not serialisable, the only way to do this is to send over the contents of your ``.lisp`` files and load the same properties and @@ -35,8 +35,8 @@ connection types into the remote Lisp. By contrast, hosts, property application specifications and deployments can be send over in serialised form. If you were to dynamically rebind properties or connection types in the root -Lisp, then connections which do not start remote Lisp processes would use your -new definitions, but connections which start remote Lisp processes would use +Lisp, then connections which do not start remote Lisp images would use your +new definitions, but connections which start remote Lisp images would use the static definitions in your ``.lisp`` files (or lack definitions altogether). This would violate the idea in Consfigurator that properties, including nested deployments, have the same meaning regardless of the diff --git a/doc/properties.rst b/doc/properties.rst index 9261127..6df06ff 100644 --- a/doc/properties.rst +++ b/doc/properties.rst @@ -58,12 +58,12 @@ Errors in attempting to apply a property are indicated by signalling a ``:posix`` properties should not make any assumptions about what localhost is -- they may be running in the root Lisp, but they might be running in a Lisp -process running on an intermediary host, or even on the host to be configured. +image running on an intermediary host, or even on the host to be configured. They should perform I/O only by calling ``RUN``, ``RUNLINES``, ``READFILE``, ``WRITEFILE``, requesting prerequisite data, and applying or unapplying other ``:posix`` properties. Otherwise, they should be pure functions. ``:lisp`` properties, by contrast, may (and should) assume that they are -running in a Lisp process on the host to which they are to be applied, so they +running in a Lisp image on the host to which they are to be applied, so they can perform arbitrary I/O in that context. They can also make use of ``RUN``, ``RUNLINES``, ``READFILE`` and ``WRITEFILE`` if desired. diff --git a/src/connection.lisp b/src/connection.lisp index f672bd2..51fc39d 100644 --- a/src/connection.lisp +++ b/src/connection.lisp @@ -31,12 +31,12 @@ global value should be regarded as a constant.") (:documentation "Within the context of the current connection, connect to HOST by establishing a new connection of type TYPE. -Either starts a Lisp process somewhere else, tells it to continue establishing +Either starts a Lisp image somewhere else, tells it to continue establishing REMAINING (by telling it to call DEPLOY* with arguments obtained by (locally) evaluating (list (or REMAINING '(:local)) *host*)), and returns nil, or returns a object suitable to be the value of *CONNECTION*. -Any implementation which hands over to a remote Lisp process will need to +Any implementation which hands over to a remote Lisp image will need to upload any prerequisite data required by the deployment.")) (defclass connection () diff --git a/src/data.lisp b/src/data.lisp index b2fab07..2fb7021 100644 --- a/src/data.lisp +++ b/src/data.lisp @@ -72,7 +72,7 @@ prerequisite data.")) ;; to get at from this terminal. (defgeneric register-data-source (type &key) (:documentation - "Initialise and register a source of prerequisite data in this Lisp process. + "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 @@ -85,7 +85,7 @@ 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 processes started up by Consfigurator, since prerequisite data +all new Lisp images started up by Consfigurator, since prerequisite data sources are not expected to be available outside of the root Lisp.")) (defvar *data-sources* nil "Known sources of prerequisite data.") @@ -107,7 +107,7 @@ This function is typically called in consfigs." (invoke-restart 'skip-data-source)) (defun reset-data-sources () - "Forget all data sources registered in this Lisp process. + "Forget all data sources registered in this Lisp image. This function is typically called at the REPL." (setq *data-sources* nil *data-source-registrations* nil)) @@ -174,7 +174,7 @@ This function is called by property :APPLY and :UNAPPLY subroutines." (compose #'version> #'car)))) ;; called by implementations of ESTABLISH-CONNECTION which start up remote -;; Lisp processes +;; Lisp images (defun upload-all-prerequisite-data (&optional (host *host*)) (macrolet ((highest-version-in-cache (cache) `(third (car (remove-if-not (lambda (c) diff --git a/src/propspec.lisp b/src/propspec.lisp index 038e745..59e7cea 100644 --- a/src/propspec.lisp +++ b/src/propspec.lisp @@ -32,7 +32,7 @@ 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. -Consfigurator uses this information when starting up remote Lisp processes to +Consfigurator uses this information when starting up remote Lisp images to effect deployments: it sends over the ASDF systems specified by SYSTEMS." (when (atom systems) (setq systems (list systems))) @@ -71,7 +71,7 @@ the list implicitly depend on earlier ones. Members of ARGS must all be objects which can be serialised. In particular, function objects are not permitted.")) (:documentation - "The point of this data structure is to be a way to inform a Lisp process + "The point of this data structure is to be a way to inform a Lisp image running on a remote host how it can apply some properties: load each of the systems, resolve unapply, onchange etc., and then look in the value cell of each PROPERTY to find a property, and pass each of ARGS to the function in the |