Skip to content

Commit c0afd9c

Browse files
nishanttotlanishanttotla
committed
Disabling digest pinning for API versions < 1.30
Signed-off-by: Nishant Totla <[email protected]>
1 parent c1635c1 commit c0afd9c

5 files changed

Lines changed: 38 additions & 21 deletions

File tree

‎api/server/router/swarm/backend.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ type Backend interface {
1919

2020
GetServices(basictypes.ServiceListOptions) ([]types.Service, error)
2121
GetService(idOrName string, insertDefaults bool) (types.Service, error)
22-
CreateService(types.ServiceSpec, string) (*basictypes.ServiceCreateResponse, error)
23-
UpdateService(string, uint64, types.ServiceSpec, basictypes.ServiceUpdateOptions) (*basictypes.ServiceUpdateResponse, error)
22+
CreateService(types.ServiceSpec, string, bool) (*basictypes.ServiceCreateResponse, error)
23+
UpdateService(string, uint64, types.ServiceSpec, basictypes.ServiceUpdateOptions, bool) (*basictypes.ServiceUpdateResponse, error)
2424
RemoveService(string) error
2525

2626
ServiceLogs(context.Context, *backend.LogSelector, *basictypes.ContainerLogsOptions) (<-chan *backend.LogMessage, error)

‎api/server/router/swarm/cluster_routes.go‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"github.com/docker/docker/api/types/backend"
1414
"github.com/docker/docker/api/types/filters"
1515
types "github.com/docker/docker/api/types/swarm"
16+
"github.com/docker/docker/api/types/versions"
1617
"golang.org/x/net/context"
1718
)
1819

@@ -178,8 +179,13 @@ func (sr *swarmRouter) createService(ctx context.Context, w http.ResponseWriter,
178179

179180
// Get returns "" if the header does not exist
180181
encodedAuth := r.Header.Get("X-Registry-Auth")
182+
cliVersion := r.Header.Get("version")
183+
queryRegistry := false
184+
if cliVersion != "" && versions.LessThan(cliVersion, "1.30") {
185+
queryRegistry = true
186+
}
181187

182-
resp, err := sr.backend.CreateService(service, encodedAuth)
188+
resp, err := sr.backend.CreateService(service, encodedAuth, queryRegistry)
183189
if err != nil {
184190
logrus.Errorf("Error creating service %s: %v", service.Name, err)
185191
return err
@@ -207,8 +213,13 @@ func (sr *swarmRouter) updateService(ctx context.Context, w http.ResponseWriter,
207213
flags.EncodedRegistryAuth = r.Header.Get("X-Registry-Auth")
208214
flags.RegistryAuthFrom = r.URL.Query().Get("registryAuthFrom")
209215
flags.Rollback = r.URL.Query().Get("rollback")
216+
cliVersion := r.Header.Get("version")
217+
queryRegistry := false
218+
if cliVersion != "" && versions.LessThan(cliVersion, "1.30") {
219+
queryRegistry = true
220+
}
210221

211-
resp, err := sr.backend.UpdateService(vars["id"], version, service, flags)
222+
resp, err := sr.backend.UpdateService(vars["id"], version, service, flags, queryRegistry)
212223
if err != nil {
213224
logrus.Errorf("Error updating service %s: %v", vars["id"], err)
214225
return err

‎client/service_create.go‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,14 @@ import (
1313

1414
// ServiceCreate creates a new Service.
1515
func (cli *Client) ServiceCreate(ctx context.Context, service swarm.ServiceSpec, options types.ServiceCreateOptions) (types.ServiceCreateResponse, error) {
16-
var (
17-
headers map[string][]string
18-
distErr error
19-
)
16+
var distErr error
17+
18+
headers := map[string][]string{
19+
"version": {cli.version},
20+
}
2021

2122
if options.EncodedRegistryAuth != "" {
22-
headers = map[string][]string{
23-
"X-Registry-Auth": {options.EncodedRegistryAuth},
24-
}
23+
headers["X-Registry-Auth"] = []string{options.EncodedRegistryAuth}
2524
}
2625

2726
// Contact the registry to retrieve digest and platform information

‎client/service_update.go‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@ import (
1313
// ServiceUpdate updates a Service.
1414
func (cli *Client) ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (types.ServiceUpdateResponse, error) {
1515
var (
16-
headers map[string][]string
1716
query = url.Values{}
1817
distErr error
1918
)
2019

20+
headers := map[string][]string{
21+
"version": {cli.version},
22+
}
23+
2124
if options.EncodedRegistryAuth != "" {
22-
headers = map[string][]string{
23-
"X-Registry-Auth": {options.EncodedRegistryAuth},
24-
}
25+
headers["X-Registry-Auth"] = []string{options.EncodedRegistryAuth}
2526
}
2627

2728
if options.RegistryAuthFrom != "" {

‎daemon/cluster/services.go‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ func (c *Cluster) GetService(input string, insertDefaults bool) (types.Service,
117117
}
118118

119119
// CreateService creates a new service in a managed swarm cluster.
120-
func (c *Cluster) CreateService(s types.ServiceSpec, encodedAuth string) (*apitypes.ServiceCreateResponse, error) {
120+
func (c *Cluster) CreateService(s types.ServiceSpec, encodedAuth string, queryRegistry bool) (*apitypes.ServiceCreateResponse, error) {
121121
var resp *apitypes.ServiceCreateResponse
122122
err := c.lockedManagerAction(func(ctx context.Context, state nodeState) error {
123123
err := c.populateNetworkID(ctx, state.controlClient, &s)
@@ -151,8 +151,11 @@ func (c *Cluster) CreateService(s types.ServiceSpec, encodedAuth string) (*apity
151151
}
152152
}
153153

154-
// pin image by digest
155-
if os.Getenv("DOCKER_SERVICE_PREFER_OFFLINE_IMAGE") != "1" {
154+
// pin image by digest for API versions < 1.30
155+
// TODO(nishanttotla): The check on "DOCKER_SERVICE_PREFER_OFFLINE_IMAGE"
156+
// should be removed in the future. Since integration tests only use the
157+
// latest API version, so this is no longer required.
158+
if os.Getenv("DOCKER_SERVICE_PREFER_OFFLINE_IMAGE") != "1" && queryRegistry {
156159
digestImage, err := c.imageWithDigestString(ctx, ctnr.Image, authConfig)
157160
if err != nil {
158161
logrus.Warnf("unable to pin image %s to digest: %s", ctnr.Image, err.Error())
@@ -193,7 +196,7 @@ func (c *Cluster) CreateService(s types.ServiceSpec, encodedAuth string) (*apity
193196
}
194197

195198
// UpdateService updates existing service to match new properties.
196-
func (c *Cluster) UpdateService(serviceIDOrName string, version uint64, spec types.ServiceSpec, flags apitypes.ServiceUpdateOptions) (*apitypes.ServiceUpdateResponse, error) {
199+
func (c *Cluster) UpdateService(serviceIDOrName string, version uint64, spec types.ServiceSpec, flags apitypes.ServiceUpdateOptions, queryRegistry bool) (*apitypes.ServiceUpdateResponse, error) {
197200
var resp *apitypes.ServiceUpdateResponse
198201

199202
err := c.lockedManagerAction(func(ctx context.Context, state nodeState) error {
@@ -256,8 +259,11 @@ func (c *Cluster) UpdateService(serviceIDOrName string, version uint64, spec typ
256259

257260
resp = &apitypes.ServiceUpdateResponse{}
258261

259-
// pin image by digest
260-
if os.Getenv("DOCKER_SERVICE_PREFER_OFFLINE_IMAGE") != "1" {
262+
// pin image by digest for API versions < 1.30
263+
// TODO(nishanttotla): The check on "DOCKER_SERVICE_PREFER_OFFLINE_IMAGE"
264+
// should be removed in the future. Since integration tests only use the
265+
// latest API version, so this is no longer required.
266+
if os.Getenv("DOCKER_SERVICE_PREFER_OFFLINE_IMAGE") != "1" && queryRegistry {
261267
digestImage, err := c.imageWithDigestString(ctx, newCtnr.Image, authConfig)
262268
if err != nil {
263269
logrus.Warnf("unable to pin image %s to digest: %s", newCtnr.Image, err.Error())

0 commit comments

Comments
 (0)