Skip to main content

Module names

Module names 

Source
Expand description

What QCode calls the images, containers and volumes it makes.

The names are a contract with the engine, not a display: the same workspace and profile always lead back to the same container, so QCode finds its own work again after a restart. They are built in one place so that nothing has to spell them out a second time.

Every part that goes into a name comes from a SafeName or a WorkspaceId, both of which hold only characters podman and docker accept; the tests below prove that what those two can produce is a name the engine takes, so nothing here has to escape anything.

Constants§

BASE_IMAGE
The image every profile image is built on.
HOSTNAME
The machine name every container QCode creates answers to.
PROFILE_LABEL
The label every profile image carries, whose value is the name of the profile it was built for.

Functions§

base_container
The container a workspace’s plain shell lives in.
credential_volume
The volume holding a profile’s login, shared by every workspace that uses the profile.
desktop_container
The container the window of a workspace’s desktop profile is open in.
home_volume
The volume holding one workspace’s copy of a profile’s home: its history, memory and settings, which stay inside that workspace.
profile_container
The container a workspace’s profile lives in.
profile_image
The image a profile is installed into.
settings_container
The short-lived container that writes the bridge’s server into the settings on a workspace profile’s home volume, for a profile whose own container cannot be written to from the inside.
sound_container
The container a sound of a workspace is played in while the tab tab plays it.