container/name¶
Name for a container created by the generic containerStart action.
The container name for the generic containerStart action.
A name is required rather than optional: it is what makes containerStart
idempotent. The action looks for an existing container of this name and
reuses it rather than creating a second one, which is how a caller
re-attaches to a container it started earlier after losing track of the
returned id.
Choose a name that is unique to the thing you are running -- a session id, a job id -- so two callers do not collide.
Accepted values are constrained to
^[A-Za-z0-9][A-Za-z0-9_.-]{0,127}$ -- a leading letter or digit, then
letters, digits, _, . or -. Anything else is rejected with a 422
before the container engine is invoked. This is deliberate and must not
be relaxed: the value reaches the engine's argument list, and podman
(which the plugin prefers over docker) reads --all and -l as flags on
both container stop and container rm, so an unvalidated value of
--all would remove every container on the host.
Never set this on the global profile. Action parameters aggregate
from the global profile the same way plugin Config parameters do, so a
container/name set there is silently supplied to every
containerStart call that does not pass one explicitly. The call then
reuses or creates a container the caller never asked for, and nothing in
the result says why. Always pass this per call. The plugin logs the
container/name and container/image it resolved at Info level so this
is at least diagnosable if it happens.
Objects that Reference container/name¶
Not used in current content packs
Objects used by container/name¶
Not used in current content packs