Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Docker CLI
9,193 Commits 11 Branches 241 Tags 240 MiB
Go 91.3%
Shell 5.8%
Go-Checksums 1.3%
Dockerfile 1.1%
Makefile 0.3%
Other 0.2%
Go to file
Laura Brehm ef5e5fa03f
plugins: run plugin with new process group ID 
Changes were made in 1554ac3b5f to provide
a mechanism for the CLI to notify running plugin processes that they
should exit, in order to improve the general CLI/plugin UX. The current
implementation boils down to:
1. The CLI creates a socket
2. The CLI executes the plugin
3. The plugin connects to the socket
4. (When) the CLI receives a termination signal, it uses the socket to
   notify the plugin that it should exit
5. The plugin's gets notified via the socket, and cancels it's `cmd.Context`,
   which then gets handled appropriately

This change works in most cases and fixes the issue it sets out to solve
(see: https://github.com/docker/compose/pull/11292) however, in the case
where the user has a TTY attached and the plugin is not already handling
received signals, steps 4+ changes:
4. (When) the CLI receives a termination signal, before it can use the
   socket to notify the plugin that it should exit, the plugin process
   also receives a signal due to sharing the pgid with the CLI

Since we now have a proper "job control" mechanism, we can simplify the
scenarios by executing the plugins with their own process group id,
thereby removing the "double notification" issue and making it so that
plugins can handle the same whether attached to a TTY or not.

In order to make this change "plugin-binary" backwards-compatible, in
the case that a plugin does not connect to the socket, the CLI passes
the signal to the plugin process.

Co-authored-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
Signed-off-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
 		2024-01-12 13:53:28 -07:00
.circleci dummy circleci config 2022-02-25 21:15:39 +01:00
.github build(deps): bump actions/setup-go from 4 to 5 2023-12-07 08:17:34 +00:00
cli prune: fix build cache prune warning 2023-12-05 20:11:15 +01:00
cli-plugins plugins: run plugin with new process group ID 2024-01-12 13:53:28 -07:00
cmd/docker plugins: run plugin with new process group ID 2024-01-12 13:53:28 -07:00
contrib/completion Stop slowing bash init by caching plugins path slowly 2023-08-23 13:40:29 +03:00
dockerfiles update to go1.21.5 2023-12-05 23:53:29 +01:00
docs docs: fix typo in "network create" docs 2023-12-11 22:33:52 +01:00
e2e update to go1.21.5 2023-12-05 23:53:29 +01:00
experimental experimental: fix broken link to "checkpoint and restore" page 2021-09-07 13:30:48 +02:00
internal/test golangci-lint: revive: enable import-shadowing 2023-11-20 19:52:41 +01:00
man docs: fix typo in "network create" docs 2023-12-11 22:33:52 +01:00
opts Permit '=' separator and '[ipv6]' in --add-host 2023-12-07 18:29:19 +00:00
scripts update go-md2man to v2.0.3 2023-10-11 18:26:14 +02:00
service/logs service/logs: use strings.Cut 2022-12-29 15:19:31 +01:00
templates templates: linting: fix "error return value is not checked (errchkjson) 2023-11-20 19:52:46 +01:00
vendor vendor: github.com/docker/docker 4046ae5e2fd4 (v25.0.0-dev) 2023-12-06 02:06:38 +01:00
.dockerignore validate manpages target 2022-02-25 17:11:17 +01:00
.gitattributes fix linguist with .gitattributes 2021-12-16 21:16:02 +01:00
.gitignore validate manpages target 2022-02-25 17:11:17 +01:00
.golangci.yml templates: linting: fix "error return value is not checked (errchkjson) 2023-11-20 19:52:46 +01:00
.mailmap update authors and mailmap 2023-11-13 22:32:27 +01:00
AUTHORS update authors and mailmap 2023-11-13 22:32:27 +01:00
CONTRIBUTING.md - What I did 2023-10-19 16:10:27 -04:00
Dockerfile update to go1.21.5 2023-12-05 23:53:29 +01:00
LICENSE Add project files 2017-04-17 17:49:33 -04:00
MAINTAINERS not actually a maintainer 2023-11-10 21:35:15 +01:00
Makefile docs: generate markdown 2023-01-06 22:36:47 +01:00
NOTICE switch kr/pty to creack/pty v1.1.7 2019-07-29 16:45:41 -07:00
README.md Readme: remove reference to "Docker EE" 2023-11-28 10:23:11 +01:00
TESTING.md tweak description of login/logout 2022-04-04 10:44:11 +02:00
VERSION Update version to v25.0.0-dev 2023-05-08 08:57:19 +02:00
codecov.yml Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
docker-bake.hcl update to go1.21.5 2023-12-05 23:53:29 +01:00
docker.Makefile docs: generate markdown 2023-01-06 22:36:47 +01:00
vendor.mod vendor: github.com/docker/docker 4046ae5e2fd4 (v25.0.0-dev) 2023-12-06 02:06:38 +01:00
vendor.sum vendor: github.com/docker/docker 4046ae5e2fd4 (v25.0.0-dev) 2023-12-06 02:06:38 +01:00

README.md

Docker CLI

PkgGoDev Build Status Test Status Go Report Card Codecov

About

This repository is the home of the Docker CLI.

Development

docker/cli is developed using Docker.

Build CLI from source:

docker buildx bake

Build binaries for all supported platforms:

docker buildx bake cross

Build for a specific platform:

docker buildx bake --set binary.platform=linux/arm64

Build dynamic binary for glibc or musl:

USE_GLIBC=1 docker buildx bake dynbinary

Run all linting:

docker buildx bake lint shellcheck

Run test:

docker buildx bake test

List all the available targets:

make help

In-container development environment

Start an interactive development environment:

make -f docker.Makefile shell

Legal

Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see https://www.bis.doc.gov

Licensing

docker/cli is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.