-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11181 from g0t4/11153-compose-attach-override-con…
…tainer-attach-cmd Implement `docker compose attach`
- Loading branch information
Showing
9 changed files
with
264 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| Copyright 2020 Docker Compose CLI authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package compose | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/docker/cli/cli/command" | ||
| "github.com/docker/compose/v2/pkg/api" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| type attachOpts struct { | ||
| *composeOptions | ||
|
|
||
| service string | ||
| index int | ||
|
|
||
| detachKeys string | ||
| noStdin bool | ||
| proxy bool | ||
| } | ||
|
|
||
| func attachCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service) *cobra.Command { | ||
| opts := attachOpts{ | ||
| composeOptions: &composeOptions{ | ||
| ProjectOptions: p, | ||
| }, | ||
| } | ||
| runCmd := &cobra.Command{ | ||
| Use: "attach [OPTIONS] SERVICE", | ||
| Short: "Attach local standard input, output, and error streams to a service's running container.", | ||
| Args: cobra.MinimumNArgs(1), | ||
| PreRunE: Adapt(func(ctx context.Context, args []string) error { | ||
| opts.service = args[0] | ||
| return nil | ||
| }), | ||
| RunE: Adapt(func(ctx context.Context, args []string) error { | ||
| return runAttach(ctx, dockerCli, backend, opts) | ||
| }), | ||
| ValidArgsFunction: completeServiceNames(dockerCli, p), | ||
| } | ||
|
|
||
| runCmd.Flags().IntVar(&opts.index, "index", 0, "index of the container if service has multiple replicas.") | ||
| runCmd.Flags().StringVarP(&opts.detachKeys, "detach-keys", "", "", "Override the key sequence for detaching from a container.") | ||
|
|
||
| runCmd.Flags().BoolVar(&opts.noStdin, "no-stdin", false, "Do not attach STDIN") | ||
| runCmd.Flags().BoolVar(&opts.proxy, "sig-proxy", true, "Proxy all received signals to the process") | ||
| return runCmd | ||
| } | ||
|
|
||
| func runAttach(ctx context.Context, dockerCli command.Cli, backend api.Service, opts attachOpts) error { | ||
| projectName, err := opts.toProjectName(dockerCli) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| attachOpts := api.AttachOptions{ | ||
| Service: opts.service, | ||
| Index: opts.index, | ||
| DetachKeys: opts.detachKeys, | ||
| NoStdin: opts.noStdin, | ||
| Proxy: opts.proxy, | ||
| } | ||
| return backend.Attach(ctx, projectName, attachOpts) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # docker compose attach | ||
|
|
||
| <!---MARKER_GEN_START--> | ||
| Attach local standard input, output, and error streams to a service's running container. | ||
|
|
||
| ### Options | ||
|
|
||
| | Name | Type | Default | Description | | ||
| |:----------------|:---------|:--------|:----------------------------------------------------------| | ||
| | `--detach-keys` | `string` | | Override the key sequence for detaching from a container. | | ||
| | `--dry-run` | | | Execute command in dry run mode | | ||
| | `--index` | `int` | `0` | index of the container if service has multiple replicas. | | ||
| | `--no-stdin` | | | Do not attach STDIN | | ||
| | `--sig-proxy` | | | Proxy all received signals to the process | | ||
|
|
||
|
|
||
| <!---MARKER_GEN_END--> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| command: docker compose attach | ||
| short: | | ||
| Attach local standard input, output, and error streams to a service's running container. | ||
| long: | | ||
| Attach local standard input, output, and error streams to a service's running container. | ||
| usage: docker compose attach [OPTIONS] SERVICE | ||
| pname: docker compose | ||
| plink: docker_compose.yaml | ||
| options: | ||
| - option: detach-keys | ||
| value_type: string | ||
| description: Override the key sequence for detaching from a container. | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: false | ||
| experimentalcli: false | ||
| kubernetes: false | ||
| swarm: false | ||
| - option: index | ||
| value_type: int | ||
| default_value: "0" | ||
| description: index of the container if service has multiple replicas. | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: false | ||
| experimentalcli: false | ||
| kubernetes: false | ||
| swarm: false | ||
| - option: no-stdin | ||
| value_type: bool | ||
| default_value: "false" | ||
| description: Do not attach STDIN | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: false | ||
| experimentalcli: false | ||
| kubernetes: false | ||
| swarm: false | ||
| - option: sig-proxy | ||
| value_type: bool | ||
| default_value: "true" | ||
| description: Proxy all received signals to the process | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: false | ||
| experimentalcli: false | ||
| kubernetes: false | ||
| swarm: false | ||
| inherited_options: | ||
| - option: dry-run | ||
| value_type: bool | ||
| default_value: "false" | ||
| description: Execute command in dry run mode | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: false | ||
| experimentalcli: false | ||
| kubernetes: false | ||
| swarm: false | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: false | ||
| experimentalcli: false | ||
| kubernetes: false | ||
| swarm: false | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| Copyright 2020 Docker Compose CLI authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package compose | ||
|
|
||
| import ( | ||
| "context" | ||
| "strings" | ||
|
|
||
| "github.com/docker/cli/cli/command/container" | ||
| "github.com/docker/compose/v2/pkg/api" | ||
| ) | ||
|
|
||
| func (s *composeService) Attach(ctx context.Context, projectName string, options api.AttachOptions) error { | ||
| projectName = strings.ToLower(projectName) | ||
| target, err := s.getSpecifiedContainer(ctx, projectName, oneOffInclude, false, options.Service, options.Index) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var attach container.AttachOptions | ||
| attach.DetachKeys = options.DetachKeys | ||
| attach.NoStdin = options.NoStdin | ||
| attach.Proxy = options.Proxy | ||
| return container.RunAttach(ctx, s.dockerCli, target.ID, &attach) | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.