Glossae Marginales · found with CEC-002

Marginalia

What the scribe wrote in the margin while copying out the documentation.

The album is the docs performed. This is the docs endured

Provenance

On the hand

Medieval marginalia is not mostly theology. It is mostly complaining about the job. The parchment is hairy. My hand aches. The ink is thin. Thank God it will soon be dark. Scribes copied for hours and left evidence of it in the only space available to them.

Anyone who has read the networking page three times looking for the sentence that explains the thing they actually need is in exactly that position, and has exactly that margin.

A note on accuracy, since this matters more than the joke. The passages below are the documentation as the scribe copied it, which is to say condensed and occasionally smoothed. They are faithful in substance and are not exact quotations. Where the exact wording matters, and for anything you intend to act on, go to the documentation itself. The Kubernetes docs are CC BY 4.0, which is also why CEC-002 exists at all.

The margins
A Service exposes a network application running as one or more Pods.Services, Load Balancing and Networking

Here the scribe has underlined one or more twice.

Kubernetes assigns every Pod its own IP address.The Pod

A later hand has added: and taketh it away.

Pods are the smallest deployable units you can create and manage.Workloads

The scribe notes that they are also the smallest thing that can wake you.

A Deployment provides declarative updates for Pods and ReplicaSets.Deployments

Marginal note, in a shakier hand: declarative, which is to say it will happen, but not necessarily while you are watching.

The kubelet uses liveness probes to know when to restart a container.Configure Liveness, Readiness and Startup Probes

Beside this the scribe has drawn a small wheel, and beneath it: and it will know wrongly, and it will restart anyway.

If the readiness probe fails, the endpoints controller removes the Pod's IP address from the endpoints of all Services that match the Pod.Configure Liveness, Readiness and Startup Probes

The scribe has copied this sentence three times and struck out two of them.

etcd is a consistent and highly available key value store used as Kubernetes' backing store for all cluster data.Operating etcd clusters for Kubernetes

Here the hand changes entirely. The new scribe has written only: back it up.

Namespaces provide a mechanism for isolating groups of resources.Namespaces

Isolating, the scribe observes, from the eye and not from the blast.

You should not use a Deployment for stateful applications.Deployments

Underlined. Then underlined again in a different ink, presumably later, presumably for a reason.

It is recommended to not use the :latest tag when deploying containers in production.Images

The scribe has left the rest of this page blank, which in a manuscript of this period indicates either reverence or exhaustion.

Kubernetes does not guarantee that a preemption target will be terminated before the preemptor is scheduled.Pod Priority and Preemption

In the margin: read this one again in daylight.

By default, containers run with unbounded compute resources on a cluster.Resource Management for Pods and Containers

By default, the scribe writes, which is to say on the cluster you inherited.

A cron job creates a Job object about once per execution time of its schedule. About, because there are certain circumstances where two Jobs might be created, or no Job might be created.CronJob

The scribe has copied the word about in red. It is the only red on the page.

DNS records are created for Services and Pods.DNS for Services and Pods

Nothing is written beside this line. The margin has been left deliberately empty, and a small cross has been drawn at the foot of the page.

Finalizers are namespaced keys that tell Kubernetes to wait until specific conditions are met before it fully deletes resources.Finalizers

Wait, the scribe writes, is doing a great deal of work in this sentence.

Init containers always run to completion.Init Containers

Beside this, twice, in the same hand: always. always.

Colophon

Colophon

Here ends the copy. The scribe asks that you pray for him, in the customary formula, and adds a request of his own: that whoever reads this should not open a ticket asking why the documentation does not say the thing it says.

It says it. It is on a different page.

Explicit liber.
Deo gratias.
The Loop is turning.

Hear the documentation screamed

Explicit liber.
Deo gratias.

The Loop is turning. It turneth still. HA-llelujah.

← Back to the Apocrypha