aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-12-26 18:42:10 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-12-27 10:49:11 -0700
commitc0aec4adcd899ff52fc2737eb90e3c4438d322cd (patch)
tree84394d7c8f018be5381c04335e6c146edb0b2d84 /doc
parent7053cad118529d9e02afb8887504709318f6faa3 (diff)
downloadconsfigurator-c0aec4adcd899ff52fc2737eb90e3c4438d322cd.tar.gz
in examples, use fewer of my personal hostnames & domains
Additionally, in conventions.rst, fix an example of the :SUDO connection type to use the correct hostname for looking up the password. Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
-rw-r--r--doc/tutorial/conventions.rst6
-rw-r--r--doc/tutorial/disk_image.rst16
-rw-r--r--doc/tutorial/os_installation.rst6
3 files changed, 14 insertions, 14 deletions
diff --git a/doc/tutorial/conventions.rst b/doc/tutorial/conventions.rst
index 753ae03..b64fdeb 100644
--- a/doc/tutorial/conventions.rst
+++ b/doc/tutorial/conventions.rst
@@ -2,13 +2,13 @@ Tutorial conventions
--------------------
In these tutorials we assume that you have a workstation called
-``laptop.silentflame.com`` where you run the root Lisp. We also assume that
+``laptop.example.com`` where you run the root Lisp. We also assume that
Consfigurator knows about your laptop, and that it has a host deployment
specified, so that you can use ``HOSTDEPLOY-THESE`` to deploy properties to
the laptop as root. For example,::
- (defhost laptop.silentflame.com
- (:deploy ((:sudo :as "spwhitton@melete.silentflame.com") :sbcl))
+ (defhost laptop.example.com
+ (:deploy ((:sudo :as "spwhitton@laptop.example.com") :sbcl))
"Sean's laptop."
(os:debian-stable "bullseye" :amd64))
diff --git a/doc/tutorial/disk_image.rst b/doc/tutorial/disk_image.rst
index bad4c27..459d992 100644
--- a/doc/tutorial/disk_image.rst
+++ b/doc/tutorial/disk_image.rst
@@ -11,7 +11,7 @@ Consfiguration
Here is a minimal definition of the host for which we can build a disk image:::
- (defhost test.silentflame.com ()
+ (defhost test.example.com ()
(os:debian-stable "bullseye" :amd64)
(disk:has-volumes
(physical-disk
@@ -49,19 +49,19 @@ Building the image
------------------
What we've established so far is a definition of a host. But it does not yet
-make any sense to say ``(deploy :foo test.silentflame.com ...)`` because the
+make any sense to say ``(deploy :foo test.example.com ...)`` because the
host does not yet exist anywhere for us to connect to it. What we can now use
is the ``DISK:RAW-IMAGE-BUILT-FOR`` property, which we can apply to a host
which *does* already exist to build an image for our host which does not yet
exist:::
- CONSFIG> (hostdeploy-these laptop.silentflame.com
+ CONSFIG> (hostdeploy-these laptop.example.com
(disk:raw-image-built-for
- nil test.silentflame.com "/home/spwhitton/tmp/test.img"))
+ nil test.example.com "/home/spwhitton/tmp/test.img"))
-This property does the following on laptop.silentflame.com:
+This property does the following on laptop.example.com:
-1. Build a chroot with the root filesystem of test.silentflame.com, and apply
+1. Build a chroot with the root filesystem of test.example.com, and apply
all its properties, such as installing the kernel and building the
initramfs.
@@ -105,9 +105,9 @@ Uses for the disk image
You might upload this image to a cloud provider and boot up a minimal
instance. Supposing we also added at least an sshd and our public key, we
could then continue to add properties to the ``DEFHOST`` for
-test.silentflame.com and then apply them with SSH:::
+test.example.com and then apply them with SSH:::
- CONSFIG> (deploy ((:ssh :user "root") :sbcl) test.silentflame.com)
+ CONSFIG> (deploy ((:ssh :user "root") :sbcl) test.example.com)
Another possibility is to dd the image out to a USB flash drive and then boot
a physical machine from it.
diff --git a/doc/tutorial/os_installation.rst b/doc/tutorial/os_installation.rst
index 7c114f0..02aa38a 100644
--- a/doc/tutorial/os_installation.rst
+++ b/doc/tutorial/os_installation.rst
@@ -64,11 +64,11 @@ disk, copy in the contents of the prebuilt chroot, and update /etc/fstab and
(merge-pathnames (get-hostname with-chroot-for) "/srv/chroot/")
with-chroot-for)))
-Supposing we've a DEFHOST form for test.silentflame.com, on our laptop we
+Supposing we've a DEFHOST form for test.example.com, on our laptop we
could then use::
- CONSFIG> (hostdeploy-these laptop.silentflame.com
- (live-installer-built-for test.silentflame.com))
+ CONSFIG> (hostdeploy-these laptop.example.com
+ (live-installer-built-for test.example.com))
Then once the live system has booted on the target host, you'd use the
DISK:HOST-VOLUMES-CREATED and INSTALLER:CHROOT-INSTALLED-TO-VOLUMES properties