diff --git a/cmd/compose/cp.go b/cmd/compose/cp.go index e8b053fa4..c09efd471 100644 --- a/cmd/compose/cp.go +++ b/cmd/compose/cp.go @@ -64,10 +64,10 @@ func copyCommand(p *ProjectOptions, backend api.Service) *cobra.Command { } flags := copyCmd.Flags() - flags.IntVar(&opts.index, "index", 0, "Index of the container if there are multiple instances of a service .") - flags.BoolVar(&opts.all, "all", false, "Copy to all the containers of the service.") + flags.IntVar(&opts.index, "index", 0, "index of the container if service has multiple replicas") + flags.BoolVar(&opts.all, "all", false, "copy to all the containers of the service.") flags.MarkHidden("all") //nolint:errcheck - flags.MarkDeprecated("all", "By default all the containers of the service will get the source file/directory to be copied.") //nolint:errcheck + flags.MarkDeprecated("all", "by default all the containers of the service will get the source file/directory to be copied.") //nolint:errcheck flags.BoolVarP(&opts.followLink, "follow-link", "L", false, "Always follow symbol link in SRC_PATH") flags.BoolVarP(&opts.copyUIDGID, "archive", "a", false, "Archive mode (copy all uid/gid information)") diff --git a/cmd/compose/exec.go b/cmd/compose/exec.go index 4c24841f9..a9e2d1ac1 100644 --- a/cmd/compose/exec.go +++ b/cmd/compose/exec.go @@ -65,7 +65,7 @@ func execCommand(p *ProjectOptions, streams api.Streams, backend api.Service) *c runCmd.Flags().BoolVarP(&opts.detach, "detach", "d", false, "Detached mode: Run command in the background.") runCmd.Flags().StringArrayVarP(&opts.environment, "env", "e", []string{}, "Set environment variables") - runCmd.Flags().IntVar(&opts.index, "index", 1, "index of the container if there are multiple instances of a service [default: 1].") + runCmd.Flags().IntVar(&opts.index, "index", 0, "index of the container if service has multiple replicas") runCmd.Flags().BoolVarP(&opts.privileged, "privileged", "", false, "Give extended privileges to the process.") runCmd.Flags().StringVarP(&opts.user, "user", "u", "", "Run the command as this user.") runCmd.Flags().BoolVarP(&opts.noTty, "no-TTY", "T", !streams.Out().IsTerminal(), "Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY.") diff --git a/cmd/compose/port.go b/cmd/compose/port.go index 7d9aacb80..11c68724b 100644 --- a/cmd/compose/port.go +++ b/cmd/compose/port.go @@ -57,7 +57,7 @@ func portCommand(p *ProjectOptions, streams api.Streams, backend api.Service) *c ValidArgsFunction: completeServiceNames(p), } cmd.Flags().StringVar(&opts.protocol, "protocol", "tcp", "tcp or udp") - cmd.Flags().IntVar(&opts.index, "index", 1, "index of the container if service has multiple replicas") + cmd.Flags().IntVar(&opts.index, "index", 0, "index of the container if service has multiple replicas") return cmd } diff --git a/docs/reference/compose_cp.md b/docs/reference/compose_cp.md index e6513e943..9be79443a 100644 --- a/docs/reference/compose_cp.md +++ b/docs/reference/compose_cp.md @@ -5,12 +5,12 @@ Copy files/folders between a service container and the local filesystem ### Options -| Name | Type | Default | Description | -|:----------------------|:------|:--------|:----------------------------------------------------------------------| -| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | -| `--dry-run` | | | Execute command in dry run mode | -| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | -| `--index` | `int` | `0` | Index of the container if there are multiple instances of a service . | +| Name | Type | Default | Description | +|:----------------------|:------|:--------|:--------------------------------------------------------| +| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) | +| `--dry-run` | | | Execute command in dry run mode | +| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH | +| `--index` | `int` | `0` | index of the container if service has multiple replicas | diff --git a/docs/reference/compose_exec.md b/docs/reference/compose_exec.md index 213677914..7c5f7d6a4 100644 --- a/docs/reference/compose_exec.md +++ b/docs/reference/compose_exec.md @@ -5,16 +5,16 @@ Execute a command in a running container. ### Options -| Name | Type | Default | Description | -|:------------------|:--------------|:--------|:----------------------------------------------------------------------------------| -| `-d`, `--detach` | | | Detached mode: Run command in the background. | -| `--dry-run` | | | Execute command in dry run mode | -| `-e`, `--env` | `stringArray` | | Set environment variables | -| `--index` | `int` | `1` | index of the container if there are multiple instances of a service [default: 1]. | -| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | -| `--privileged` | | | Give extended privileges to the process. | -| `-u`, `--user` | `string` | | Run the command as this user. | -| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | +| Name | Type | Default | Description | +|:------------------|:--------------|:--------|:---------------------------------------------------------------------------------| +| `-d`, `--detach` | | | Detached mode: Run command in the background. | +| `--dry-run` | | | Execute command in dry run mode | +| `-e`, `--env` | `stringArray` | | Set environment variables | +| `--index` | `int` | `0` | index of the container if service has multiple replicas | +| `-T`, `--no-TTY` | | | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. | +| `--privileged` | | | Give extended privileges to the process. | +| `-u`, `--user` | `string` | | Run the command as this user. | +| `-w`, `--workdir` | `string` | | Path to workdir directory for this command. | diff --git a/docs/reference/compose_port.md b/docs/reference/compose_port.md index c3e59da9e..ffd3d8eb5 100644 --- a/docs/reference/compose_port.md +++ b/docs/reference/compose_port.md @@ -8,7 +8,7 @@ Print the public port for a port binding. | Name | Type | Default | Description | |:-------------|:---------|:--------|:--------------------------------------------------------| | `--dry-run` | | | Execute command in dry run mode | -| `--index` | `int` | `1` | index of the container if service has multiple replicas | +| `--index` | `int` | `0` | index of the container if service has multiple replicas | | `--protocol` | `string` | `tcp` | tcp or udp | diff --git a/docs/reference/docker_compose_cp.yaml b/docs/reference/docker_compose_cp.yaml index 18e4f9be8..8ff6be355 100644 --- a/docs/reference/docker_compose_cp.yaml +++ b/docs/reference/docker_compose_cp.yaml @@ -10,7 +10,7 @@ options: - option: all value_type: bool default_value: "false" - description: Copy to all the containers of the service. + description: copy to all the containers of the service. deprecated: true hidden: true experimental: false @@ -42,8 +42,7 @@ options: - option: index value_type: int default_value: "0" - description: | - Index of the container if there are multiple instances of a service . + description: index of the container if service has multiple replicas deprecated: false hidden: false experimental: false diff --git a/docs/reference/docker_compose_exec.yaml b/docs/reference/docker_compose_exec.yaml index 96466bee0..9b1c37cd8 100644 --- a/docs/reference/docker_compose_exec.yaml +++ b/docs/reference/docker_compose_exec.yaml @@ -33,9 +33,8 @@ options: swarm: false - option: index value_type: int - default_value: "1" - description: | - index of the container if there are multiple instances of a service [default: 1]. + default_value: "0" + description: index of the container if service has multiple replicas deprecated: false hidden: false experimental: false diff --git a/docs/reference/docker_compose_port.yaml b/docs/reference/docker_compose_port.yaml index 6ffe8065a..d206bcbca 100644 --- a/docs/reference/docker_compose_port.yaml +++ b/docs/reference/docker_compose_port.yaml @@ -7,7 +7,7 @@ plink: docker_compose.yaml options: - option: index value_type: int - default_value: "1" + default_value: "0" description: index of the container if service has multiple replicas deprecated: false hidden: false diff --git a/pkg/compose/containers.go b/pkg/compose/containers.go index 0b7a3df97..47df374d5 100644 --- a/pkg/compose/containers.go +++ b/pkg/compose/containers.go @@ -20,6 +20,7 @@ import ( "context" "fmt" "sort" + "strconv" "github.com/docker/compose/v2/pkg/api" "github.com/docker/compose/v2/pkg/utils" @@ -72,7 +73,9 @@ func getDefaultFilters(projectName string, oneOff oneOff, selectedServices ...st func (s *composeService) getSpecifiedContainer(ctx context.Context, projectName string, oneOff oneOff, stopped bool, serviceName string, containerIndex int) (moby.Container, error) { defaultFilters := getDefaultFilters(projectName, oneOff, serviceName) - defaultFilters = append(defaultFilters, containerNumberFilter(containerIndex)) + if containerIndex > 0 { + defaultFilters = append(defaultFilters, containerNumberFilter(containerIndex)) + } containers, err := s.apiClient().ContainerList(ctx, moby.ContainerListOptions{ Filters: filters.NewArgs( defaultFilters..., @@ -83,8 +86,16 @@ func (s *composeService) getSpecifiedContainer(ctx context.Context, projectName return moby.Container{}, err } if len(containers) < 1 { - return moby.Container{}, fmt.Errorf("service %q is not running container #%d", serviceName, containerIndex) + if containerIndex > 0 { + return moby.Container{}, fmt.Errorf("service %q is not running container #%d", serviceName, containerIndex) + } + return moby.Container{}, fmt.Errorf("service %q is not running", serviceName) } + sort.Slice(containers, func(i, j int) bool { + x, _ := strconv.Atoi(containers[i].Labels[api.ContainerNumberLabel]) + y, _ := strconv.Atoi(containers[j].Labels[api.ContainerNumberLabel]) + return x < y + }) container := containers[0] return container, nil } diff --git a/pkg/compose/port.go b/pkg/compose/port.go index 5c57a334b..570c6202f 100644 --- a/pkg/compose/port.go +++ b/pkg/compose/port.go @@ -24,25 +24,14 @@ import ( "github.com/docker/compose/v2/pkg/api" moby "github.com/docker/docker/api/types" - "github.com/docker/docker/api/types/filters" ) func (s *composeService) Port(ctx context.Context, projectName string, service string, port uint16, options api.PortOptions) (string, int, error) { projectName = strings.ToLower(projectName) - list, err := s.apiClient().ContainerList(ctx, moby.ContainerListOptions{ - Filters: filters.NewArgs( - projectFilter(projectName), - serviceFilter(service), - containerNumberFilter(options.Index), - ), - }) + container, err := s.getSpecifiedContainer(ctx, projectName, oneOffInclude, false, service, options.Index) if err != nil { return "", 0, err } - if len(list) == 0 { - return "", 0, fmt.Errorf("no container found for %s%s%d", service, api.Separator, options.Index) - } - container := list[0] for _, p := range container.Ports { if p.PrivatePort == port && p.Type == options.Protocol { return p.IP, int(p.PublicPort), nil