/ 
API-Docker-0.004
/ API::Docker::Type::ProcessConfig

NAME

API::Docker::Type::ProcessConfig - The ProcessConfig field of the 200 response to GET /exec/{id}/json

VERSION

version 0.004

DESCRIPTION

Generated from the ProcessConfig definition of spec/v1.51.yaml, which the swagger leaves undescribed. paths: says what it is: the ProcessConfig field of the 200 response to GET /exec/{id}/json. The swagger describes none of its five fields, but the example response it gives for that endpoint shows all five, and the body of POST /containers/{id}/exec describes the options they report back.

privileged

Undocumented upstream. Whether the process runs with extended privileges, which is how the swagger describes Privileged on the exec-create body. false in the example response. Serialised as privileged -- spelled out, because deriving it from the Perl name would produce Privileged.

user

Undocumented upstream. The user, and optionally the group, the process runs as inside the container -- one of user, user:group, uid or uid:gid, as the swagger describes User on the exec-create body. "1000" in the example response. Serialised as user -- spelled out, because deriving it from the Perl name would produce User.

tty

Undocumented upstream. Whether a pseudo-TTY was allocated, which is what Tty asks for on the exec-create body. It decides how the output arrives: with a TTY the stream is raw, without one it is the multiplexed frame format, see "Detecting a framed stream" in API::Docker::Role::HTTP. true in the example response. Serialised as tty -- spelled out, because deriving it from the Perl name would produce Tty.

entrypoint

Undocumented upstream. The program being run, "sh" in the example response. The exec-create body takes it together with "arguments" as one Cmd, which the swagger describes as the command to run. Serialised as entrypoint -- spelled out, because deriving it from the Perl name would produce Entrypoint.

arguments

Undocumented upstream. Its arguments, ["-c", "exit 2"] beside that "sh" in the example response. Serialised as arguments -- spelled out, because deriving it from the Perl name would produce Arguments.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.