github.com/rish1988/moby@v25.0.2+incompatible/client/service_update.go (about)

     1  package client // import "github.com/docker/docker/client"
     2  
     3  import (
     4  	"context"
     5  	"encoding/json"
     6  	"net/http"
     7  	"net/url"
     8  
     9  	"github.com/docker/docker/api/types"
    10  	"github.com/docker/docker/api/types/registry"
    11  	"github.com/docker/docker/api/types/swarm"
    12  	"github.com/docker/docker/api/types/versions"
    13  )
    14  
    15  // ServiceUpdate updates a Service. The version number is required to avoid conflicting writes.
    16  // It should be the value as set *before* the update. You can find this value in the Meta field
    17  // of swarm.Service, which can be found using ServiceInspectWithRaw.
    18  func (cli *Client) ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error) {
    19  	// Make sure we negotiated (if the client is configured to do so),
    20  	// as code below contains API-version specific handling of options.
    21  	//
    22  	// Normally, version-negotiation (if enabled) would not happen until
    23  	// the API request is made.
    24  	cli.checkVersion(ctx)
    25  
    26  	var (
    27  		query    = url.Values{}
    28  		response = swarm.ServiceUpdateResponse{}
    29  	)
    30  
    31  	if options.RegistryAuthFrom != "" {
    32  		query.Set("registryAuthFrom", options.RegistryAuthFrom)
    33  	}
    34  
    35  	if options.Rollback != "" {
    36  		query.Set("rollback", options.Rollback)
    37  	}
    38  
    39  	query.Set("version", version.String())
    40  
    41  	if err := validateServiceSpec(service); err != nil {
    42  		return response, err
    43  	}
    44  
    45  	// ensure that the image is tagged
    46  	var resolveWarning string
    47  	switch {
    48  	case service.TaskTemplate.ContainerSpec != nil:
    49  		if taggedImg := imageWithTagString(service.TaskTemplate.ContainerSpec.Image); taggedImg != "" {
    50  			service.TaskTemplate.ContainerSpec.Image = taggedImg
    51  		}
    52  		if options.QueryRegistry {
    53  			resolveWarning = resolveContainerSpecImage(ctx, cli, &service.TaskTemplate, options.EncodedRegistryAuth)
    54  		}
    55  	case service.TaskTemplate.PluginSpec != nil:
    56  		if taggedImg := imageWithTagString(service.TaskTemplate.PluginSpec.Remote); taggedImg != "" {
    57  			service.TaskTemplate.PluginSpec.Remote = taggedImg
    58  		}
    59  		if options.QueryRegistry {
    60  			resolveWarning = resolvePluginSpecRemote(ctx, cli, &service.TaskTemplate, options.EncodedRegistryAuth)
    61  		}
    62  	}
    63  
    64  	headers := http.Header{}
    65  	if versions.LessThan(cli.version, "1.30") {
    66  		// the custom "version" header was used by engine API before 20.10
    67  		// (API 1.30) to switch between client- and server-side lookup of
    68  		// image digests.
    69  		headers["version"] = []string{cli.version}
    70  	}
    71  	if options.EncodedRegistryAuth != "" {
    72  		headers[registry.AuthHeader] = []string{options.EncodedRegistryAuth}
    73  	}
    74  	resp, err := cli.post(ctx, "/services/"+serviceID+"/update", query, service, headers)
    75  	defer ensureReaderClosed(resp)
    76  	if err != nil {
    77  		return response, err
    78  	}
    79  
    80  	err = json.NewDecoder(resp.body).Decode(&response)
    81  	if resolveWarning != "" {
    82  		response.Warnings = append(response.Warnings, resolveWarning)
    83  	}
    84  
    85  	return response, err
    86  }