Skip to content

Commit 3323113

Browse files
jhrotkondeloof
jhrotko
authored and
ndeloof
committed
Recreate container on volume configuration change
Signed-off-by: Joana Hrotko <[email protected]> Signed-off-by: Nicolas De Loof <[email protected]>
1 parent df9e420 commit 3323113

File tree

7 files changed

+138
-32
lines changed

7 files changed

+138
-32
lines changed

‎pkg/compose/convergence.go‎

Lines changed: 56 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import (
3535
"github.com/docker/compose/v2/internal/tracing"
3636
moby "github.com/docker/docker/api/types"
3737
containerType "github.com/docker/docker/api/types/container"
38+
mmount "github.com/docker/docker/api/types/mount"
3839
"github.com/docker/docker/api/types/versions"
3940
specs "github.com/opencontainers/image-spec/specs-go/v1"
4041
"github.com/sirupsen/logrus"
@@ -60,6 +61,7 @@ type convergence struct {
6061
service *composeService
6162
services map[string]Containers
6263
networks map[string]string
64+
volumes map[string]string
6365
stateMutex sync.Mutex
6466
}
6567

@@ -75,7 +77,7 @@ func (c *convergence) setObservedState(serviceName string, containers Containers
7577
c.services[serviceName] = containers
7678
}
7779

78-
func newConvergence(services []string, state Containers, networks map[string]string, s *composeService) *convergence {
80+
func newConvergence(services []string, state Containers, networks map[string]string, volumes map[string]string, s *composeService) *convergence {
7981
observedState := map[string]Containers{}
8082
for _, s := range services {
8183
observedState[s] = Containers{}
@@ -88,6 +90,7 @@ func newConvergence(services []string, state Containers, networks map[string]str
8890
service: s,
8991
services: observedState,
9092
networks: networks,
93+
volumes: volumes,
9194
}
9295
}
9396

@@ -341,28 +344,63 @@ func (c *convergence) mustRecreate(expected types.ServiceConfig, actual moby.Con
341344
}
342345

343346
if c.networks != nil && actual.State == "running" {
344-
// check the networks container is connected to are the expected ones
345-
for net := range expected.Networks {
346-
id := c.networks[net]
347-
if id == "swarm" {
348-
// corner-case : swarm overlay network isn't visible until a container is attached
349-
continue
347+
if checkExpectedNetworks(expected, actual, c.networks) {
348+
return true, nil
349+
}
350+
}
351+
352+
if c.volumes != nil {
353+
if checkExpectedVolumes(expected, actual, c.volumes) {
354+
return true, nil
355+
}
356+
}
357+
358+
return false, nil
359+
}
360+
361+
func checkExpectedNetworks(expected types.ServiceConfig, actual moby.Container, networks map[string]string) bool {
362+
// check the networks container is connected to are the expected ones
363+
for net := range expected.Networks {
364+
id := networks[net]
365+
if id == "swarm" {
366+
// corner-case : swarm overlay network isn't visible until a container is attached
367+
continue
368+
}
369+
found := false
370+
for _, settings := range actual.NetworkSettings.Networks {
371+
if settings.NetworkID == id {
372+
found = true
373+
break
350374
}
351-
found := false
352-
for _, settings := range actual.NetworkSettings.Networks {
353-
if settings.NetworkID == id {
354-
found = true
355-
break
356-
}
375+
}
376+
if !found {
377+
// config is up-to-date but container is not connected to network
378+
return true
379+
}
380+
}
381+
return false
382+
}
383+
384+
func checkExpectedVolumes(expected types.ServiceConfig, actual moby.Container, volumes map[string]string) bool {
385+
// check container's volume mounts and search for the expected ones
386+
for _, vol := range expected.Volumes {
387+
id := volumes[vol.Source]
388+
found := false
389+
for _, mount := range actual.Mounts {
390+
if mount.Type != mmount.TypeVolume {
391+
continue
357392
}
358-
if !found {
359-
// config is up-to-date but container is not connected to network - maybe recreated ?
360-
return true, nil
393+
if mount.Name == id {
394+
found = true
395+
break
361396
}
362397
}
398+
if !found {
399+
// config is up-to-date but container doesn't have volume mounted
400+
return true
401+
}
363402
}
364-
365-
return false, nil
403+
return false
366404
}
367405

368406
func getContainerName(projectName string, service types.ServiceConfig, number int) string {

‎pkg/compose/create.go‎

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ func (s *composeService) create(ctx context.Context, project *types.Project, opt
9292
return err
9393
}
9494

95-
if err := s.ensureProjectVolumes(ctx, project); err != nil {
95+
volumes, err := s.ensureProjectVolumes(ctx, project)
96+
if err != nil {
9697
return err
9798
}
9899

@@ -115,7 +116,7 @@ func (s *composeService) create(ctx context.Context, project *types.Project, opt
115116
"--remove-orphans flag to clean it up.", orphans.names())
116117
}
117118
}
118-
return newConvergence(options.Services, observedState, networks, s).apply(ctx, project, options)
119+
return newConvergence(options.Services, observedState, networks, volumes, s).apply(ctx, project, options)
119120
}
120121

121122
func prepareNetworks(project *types.Project) {
@@ -141,15 +142,17 @@ func (s *composeService) ensureNetworks(ctx context.Context, project *types.Proj
141142
return networks, nil
142143
}
143144

144-
func (s *composeService) ensureProjectVolumes(ctx context.Context, project *types.Project) error {
145+
func (s *composeService) ensureProjectVolumes(ctx context.Context, project *types.Project) (map[string]string, error) {
146+
ids := map[string]string{}
145147
for k, volume := range project.Volumes {
146148
volume.Labels = volume.Labels.Add(api.VolumeLabel, k)
147149
volume.Labels = volume.Labels.Add(api.ProjectLabel, project.Name)
148150
volume.Labels = volume.Labels.Add(api.VersionLabel, api.ComposeVersion)
149-
err := s.ensureVolume(ctx, volume, project.Name)
151+
id, err := s.ensureVolume(ctx, volume, project.Name)
150152
if err != nil {
151-
return err
153+
return nil, err
152154
}
155+
ids[k] = id
153156
}
154157

155158
err := func() error {
@@ -205,7 +208,7 @@ func (s *composeService) ensureProjectVolumes(ctx context.Context, project *type
205208
if err != nil {
206209
progress.ContextWriter(ctx).TailMsgf("Failed to prepare Synchronized file shares: %v", err)
207210
}
208-
return nil
211+
return ids, nil
209212
}
210213

211214
func (s *composeService) getCreateConfigs(ctx context.Context,
@@ -1431,21 +1434,21 @@ func (s *composeService) resolveExternalNetwork(ctx context.Context, n *types.Ne
14311434
}
14321435
}
14331436

1434-
func (s *composeService) ensureVolume(ctx context.Context, volume types.VolumeConfig, project string) error {
1437+
func (s *composeService) ensureVolume(ctx context.Context, volume types.VolumeConfig, project string) (string, error) {
14351438
inspected, err := s.apiClient().VolumeInspect(ctx, volume.Name)
14361439
if err != nil {
14371440
if !errdefs.IsNotFound(err) {
1438-
return err
1441+
return "", err
14391442
}
14401443
if volume.External {
1441-
return fmt.Errorf("external volume %q not found", volume.Name)
1444+
return "", fmt.Errorf("external volume %q not found", volume.Name)
14421445
}
1443-
err := s.createVolume(ctx, volume)
1444-
return err
1446+
err = s.createVolume(ctx, volume)
1447+
return "", err
14451448
}
14461449

14471450
if volume.External {
1448-
return nil
1451+
return volume.Name, nil
14491452
}
14501453

14511454
// Volume exists with name, but let's double-check this is the expected one
@@ -1456,7 +1459,16 @@ func (s *composeService) ensureVolume(ctx context.Context, volume types.VolumeCo
14561459
if ok && p != project {
14571460
logrus.Warnf("volume %q already exists but was created for project %q (expected %q). Use `external: true` to use an existing volume", volume.Name, p, project)
14581461
}
1459-
return nil
1462+
1463+
expected, err := VolumeHash(volume)
1464+
if err != nil {
1465+
return "", err
1466+
}
1467+
actual, ok := inspected.Labels[api.ConfigHashLabel]
1468+
if ok && actual != expected {
1469+
logrus.Warnf("volume %q exists but doesn't match configuration in compose file. You should remove it so it get recreated", volume.Name)
1470+
}
1471+
return inspected.Name, nil
14601472
}
14611473

14621474
func (s *composeService) createVolume(ctx context.Context, volume types.VolumeConfig) error {

‎pkg/compose/hash.go‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,23 @@ func ServiceHash(o types.ServiceConfig) (string, error) {
4242
return digest.SHA256.FromBytes(bytes).Encoded(), nil
4343
}
4444

45+
// NetworkHash computes the configuration hash for a network.
4546
func NetworkHash(o *types.NetworkConfig) (string, error) {
4647
bytes, err := json.Marshal(o)
4748
if err != nil {
4849
return "", err
4950
}
5051
return digest.SHA256.FromBytes(bytes).Encoded(), nil
5152
}
53+
54+
// VolumeHash computes the configuration hash for a volume.
55+
func VolumeHash(o types.VolumeConfig) (string, error) {
56+
if o.Driver == "" { // (TODO: jhrotko) This probably should be fixed in compose-go
57+
o.Driver = "local"
58+
}
59+
bytes, err := json.Marshal(o)
60+
if err != nil {
61+
return "", err
62+
}
63+
return digest.SHA256.FromBytes(bytes).Encoded(), nil
64+
}

‎pkg/compose/run.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ func (s *composeService) prepareRun(ctx context.Context, project *types.Project,
104104
Labels: mergeLabels(service.Labels, service.CustomLabels),
105105
}
106106

107-
err = newConvergence(project.ServiceNames(), observedState, nil, s).resolveServiceReferences(&service)
107+
err = newConvergence(project.ServiceNames(), observedState, nil, nil, s).resolveServiceReferences(&service)
108108
if err != nil {
109109
return "", err
110110
}

‎pkg/e2e/fixtures/recreate-volumes/compose.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
services:
2+
app:
3+
image: alpine
4+
volumes:
5+
- my_vol:/my_vol
6+
7+
volumes:
8+
my_vol:
9+
external: true
10+
name: test_external_volume

‎pkg/e2e/fixtures/recreate-volumes/compose2.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
services:
2+
app:
3+
image: alpine
4+
volumes:
5+
- my_vol:/my_vol
6+
7+
volumes:
8+
my_vol:
9+
external: true
10+
name: test_external_volume_2

‎pkg/e2e/volumes_test.go‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package e2e
1818

1919
import (
20+
"fmt"
2021
"net/http"
2122
"os"
2223
"path/filepath"
@@ -121,3 +122,25 @@ func TestProjectVolumeBind(t *testing.T) {
121122
assert.Assert(t, strings.Contains(ret.Stdout(), "SUCCESS"))
122123
})
123124
}
125+
126+
func TestUpRecreateVolumes(t *testing.T) {
127+
c := NewCLI(t)
128+
const projectName = "compose-e2e-recreate-volumes"
129+
t.Cleanup(func() {
130+
c.cleanupWithDown(t, projectName)
131+
c.RunDockerCmd(t, "volume", "rm", "-f", "test_external_volume")
132+
c.RunDockerCmd(t, "volume", "rm", "-f", "test_external_volume_2")
133+
})
134+
135+
c.RunDockerCmd(t, "volume", "create", "test_external_volume")
136+
c.RunDockerCmd(t, "volume", "create", "test_external_volume_2")
137+
138+
c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose.yaml", "--project-name", projectName, "up", "-d")
139+
140+
res := c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ (index .Mounts 0).Name }}")
141+
res.Assert(t, icmd.Expected{Out: "test_external_volume"})
142+
143+
c.RunDockerComposeCmd(t, "-f", "./fixtures/recreate-volumes/compose2.yaml", "--project-name", projectName, "up", "-d")
144+
res = c.RunDockerCmd(t, "inspect", fmt.Sprintf("%s-app-1", projectName), "-f", "{{ (index .Mounts 0).Name }}")
145+
res.Assert(t, icmd.Expected{Out: "test_external_volume_2"})
146+
}

0 commit comments

Comments
 (0)