package client import ( "context" "encoding/json" "net/http" "net/url" "github.com/moby/moby/api/types/registry" "github.com/moby/moby/api/types/swarm" ) // ServiceUpdateOptions contains the options to be used for updating services. type ServiceUpdateOptions struct { Version swarm.Version Spec swarm.ServiceSpec // EncodedRegistryAuth is the encoded registry authorization credentials to // use when updating the service. // // This field follows the format of the X-Registry-Auth header. EncodedRegistryAuth string // TODO(stevvooe): Consider moving the version parameter of ServiceUpdate // into this field. While it does open API users up to racy writes, most // users may not need that level of consistency in practice. // RegistryAuthFrom specifies where to find the registry authorization // credentials if they are not given in EncodedRegistryAuth. Valid // values are "spec" and "previous-spec". RegistryAuthFrom swarm.RegistryAuthSource // Rollback indicates whether a server-side rollback should be // performed. When this is set, the provided spec will be ignored. // The valid values are "previous" and "none". An empty value is the // same as "none". Rollback string // QueryRegistry indicates whether the service update requires // contacting a registry. A registry may be contacted to retrieve // the image digest and manifest, which in turn can be used to update // platform or other information about the service. QueryRegistry bool } // ServiceUpdateResult represents the result of a service update. type ServiceUpdateResult struct { // Warnings contains any warnings that occurred during the update. Warnings []string } // ServiceUpdate updates a Service. The version number is required to avoid // conflicting writes. It must be the value as set *before* the update. // You can find this value in the [swarm.Service.Meta] field, which can // be found using [Client.ServiceInspectWithRaw]. func (cli *Client) ServiceUpdate(ctx context.Context, serviceID string, options ServiceUpdateOptions) (ServiceUpdateResult, error) { serviceID, err := trimID("service", serviceID) if err != nil { return ServiceUpdateResult{}, err } if err := validateServiceSpec(options.Spec); err != nil { return ServiceUpdateResult{}, err } query := url.Values{} if options.RegistryAuthFrom != "" { query.Set("registryAuthFrom", string(options.RegistryAuthFrom)) } if options.Rollback != "" { query.Set("rollback", options.Rollback) } query.Set("version", options.Version.String()) // ensure that the image is tagged var warnings []string switch { case options.Spec.TaskTemplate.ContainerSpec != nil: if taggedImg := imageWithTagString(options.Spec.TaskTemplate.ContainerSpec.Image); taggedImg != "" { options.Spec.TaskTemplate.ContainerSpec.Image = taggedImg } if options.QueryRegistry { if warning := resolveContainerSpecImage(ctx, cli, &options.Spec.TaskTemplate, options.EncodedRegistryAuth); warning != "" { warnings = append(warnings, warning) } } case options.Spec.TaskTemplate.PluginSpec != nil: if taggedImg := imageWithTagString(options.Spec.TaskTemplate.PluginSpec.Remote); taggedImg != "" { options.Spec.TaskTemplate.PluginSpec.Remote = taggedImg } if options.QueryRegistry { if warning := resolvePluginSpecRemote(ctx, cli, &options.Spec.TaskTemplate, options.EncodedRegistryAuth); warning != "" { warnings = append(warnings, warning) } } } headers := http.Header{} if options.EncodedRegistryAuth != "" { headers.Set(registry.AuthHeader, options.EncodedRegistryAuth) } resp, err := cli.post(ctx, "/services/"+serviceID+"/update", query, options.Spec, headers) defer ensureReaderClosed(resp) if err != nil { return ServiceUpdateResult{}, err } var response swarm.ServiceUpdateResponse err = json.NewDecoder(resp.Body).Decode(&response) warnings = append(warnings, response.Warnings...) return ServiceUpdateResult{Warnings: warnings}, err }