Liking cljdoc? Tell your friends :D

hive-compose.adapter.cli

IComposeEngine over the docker compose CLI. Argv construction and output parsing are pure; the process runs through an injected exec with hive-system's shell.core/exec! contract (argv, opts) -> Result.

Secret references in a profile's env are read only by the calls that create containers (up, a recreating restart), through the injected resolver (see hive-compose.adapter.secrets). Every other call is given their renderings, so it interpolates and reads no store.

IComposeEngine over the docker compose CLI. Argv construction and output
parsing are pure; the process runs through an injected `exec` with
hive-system's `shell.core/exec!` contract (argv, opts) -> Result.

Secret references in a profile's env are read only by the calls that create
containers (`up`, a recreating `restart`), through the injected resolver
(see `hive-compose.adapter.secrets`). Every other call is given their
renderings, so it interpolates and reads no store.
raw docstring

base-argvclj

(base-argv p)

docker compose addressed at profile p: project dir, project name, files and native compose profiles.

`docker compose` addressed at profile `p`: project dir, project name, files
and native compose profiles.
sourceraw docstring

closure-argvclj

(closure-argv p)
source

closure-servicesclj

(closure-services s)

Sorted services of a config --format json document.

Sorted services of a `config --format json` document.
sourceraw docstring

container-addressesclj

(container-addresses rows)

#{ip} of docker inspect rows: the IPv4 and global IPv6 address each running container holds on each of its networks.

#{ip} of `docker inspect` rows: the IPv4 and global IPv6 address each
running container holds on each of its networks.
sourceraw docstring

dependency-graphclj

(dependency-graph s)

{service {dep {:required? bool}}} of a config --format json document. Map-form depends_on reads each entry's "required" (absent = true); list-form depends_on makes every entry required.

{service {dep {:required? bool}}} of a `config --format json` document.
Map-form depends_on reads each entry's "required" (absent = true);
list-form depends_on makes every entry required.
sourceraw docstring

down-argvclj

(down-argv p services)
source

ids-argvclj

(ids-argv p)

The ids of the running containers of p's project.

The ids of the running containers of `p`'s project.
sourceraw docstring

inspect-argvclj

(inspect-argv ids)
source

linesclj

(lines s)

Non-blank trimmed lines of s.

Non-blank trimmed lines of `s`.
sourceraw docstring

listed-argvclj

(listed-argv p)
source

logs-argvclj

(logs-argv p services tail)
source

ls-argvclj

source

make-engineclj

(make-engine opts)

CliEngine. opts: :exec (default hive-system shell.core/exec!), :compose/resolver ({scheme ISecretBackend}, default the pass one over that exec), :compose/timeout-ms, :compose/up-timeout-ms.

CliEngine. `opts`: :exec (default hive-system `shell.core/exec!`),
:compose/resolver ({scheme ISecretBackend}, default the `pass` one over
that exec), :compose/timeout-ms, :compose/up-timeout-ms.
sourceraw docstring

parse-json-rowsclj

(parse-json-rows s)

Rows of compose --format json output, which is a JSON array or one JSON object per line depending on the compose version.

Rows of compose `--format json` output, which is a JSON array or one JSON
object per line depending on the compose version.
sourceraw docstring

profiles-argvclj

(profiles-argv p)
source

projectsclj

(projects rows)

Project summaries of ls rows.

Project summaries of `ls` rows.
sourceraw docstring

ps-argvclj

(ps-argv p)
source

published-portsclj

(published-ports rows)

{service #{host-port}} of the running containers in ps rows: the PublishedPort of each of their Publishers that publishes one.

{service #{host-port}} of the running containers in `ps` rows: the
PublishedPort of each of their Publishers that publishes one.
sourceraw docstring

restart-argvclj

(restart-argv p services recreate?)

compose restart of services, or when recreate? an up -d --force-recreate --no-deps of exactly them: their dependencies are left as they are.

`compose restart` of `services`, or when `recreate?` an `up -d
--force-recreate --no-deps` of exactly them: their dependencies are left
as they are.
sourceraw docstring

running-servicesclj

(running-services rows)

Sorted set of services with a running container in ps rows.

Sorted set of services with a running container in `ps` rows.
sourceraw docstring

stop-argvclj

(stop-argv p services)
source

up-argvclj

(up-argv p services)
source

version-argvclj

source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close