Add support for sending down service Running and Desired task counts #39231

dperny · 2019-05-17T16:31:05Z

- What I did

Add an optional ServiceStatus field in Service objects, which is available as part of List operations, and gives the Running and Desired task counts. This is essentially performing a UI operation on the server side, but as this is probably the most common UI operation and it is rather expensive to perform client side, it's worth doing.

- How I did it

Plumbed through the use of a new swarmkit gRPC endpoint (see moby/swarmkit#2856) which allows getting service statuses. This is a separate swarmkit API call because swarmkit's protos function as both the wire format and the persistence format of the objects, and I did not want to add a Status field to the swarmkit Service object. However, because this is much less of a concern in the engine, the ServiceStatus field is present on the engine API type.

Includes updates to swagger.yml, of course.

- How to verify it

The swarmkit code is well-tested to make sure the right values are computed. The Docker code includes an integration test confirming that the values are correctly plumbed through to the API.

- Description for the changelog

GET /services now accepts a status parameter, which instructs the engine to return the number of Running and Desired tasks as part of a service.

dperny · 2019-05-17T16:32:54Z

includes versioning done with an improper version of vndr; however, versioning should match the changes in #39216

thaJeztah

thx! left some comments

integration/service/list_test.go

thaJeztah · 2019-05-25T20:42:00Z

api/server/router/swarm/cluster_routes.go

@@ -167,7 +167,16 @@ func (sr *swarmRouter) getServices(ctx context.Context, w http.ResponseWriter, r
 		return errdefs.InvalidParameter(err)
 	}

-	services, err := sr.backend.GetServices(basictypes.ServiceListOptions{Filters: filter})
+	var status bool
+	if value := r.URL.Query().Get("status"); value != "" {


Can you gate this by API version, so that setting this query-parameter does not have an effect on older API versions?

thaJeztah · 2019-05-25T20:45:42Z

api/swagger.yaml

+        properties:
+          RunningTasks:
+            description: "The number of tasks for the service currently in the Running state"
+            type: "number"


Can you add an example value here, and set the correct format/type?

Suggested change

type: "number"

type: "integer"

format: "uint64"

example: 7

thaJeztah · 2019-05-25T20:45:45Z

api/swagger.yaml

+              service spec. For global services, this is computed by taking
+              count of all tasks for the service with a Desired State other
+              than Shutdown.
+            type: "number"


Can you add an example value here, and set the correct format/type?

Suggested change

type: "number"

type: "integer"

format: "uint64"

example: 10

Can you also add a mention in the API history doc; https://github.com/moby/moby/blob/master/docs/api/version-history.md

thaJeztah · 2019-05-25T20:47:31Z

api/server/router/swarm/cluster_routes.go

+	// the Status field is not supported when retrieving an individual service
+	// because the Backend API changes required to accomodate it would be too
+	// disruptive, and because that field is so rarely needed as part of an
+	// individual service inspection.


Position of this comment is a bit confusing (as there is no code visible here for status?)

codecov · 2019-06-03T15:36:28Z

Codecov Report

❗ No coverage uploaded for pull request base (master@e582a10). Click here to learn what that means.
The diff coverage is 0%.

@@            Coverage Diff            @@
##             master   #39231   +/-   ##
=========================================
  Coverage          ?   37.28%           
=========================================
  Files             ?      609           
  Lines             ?    45261           
  Branches          ?        0           
=========================================
  Hits              ?    16877           
  Misses            ?    26090           
  Partials          ?     2294

dperny · 2019-06-04T15:21:25Z

to the best of my knowledge, the failure in the experimental build is unrelated.

@thaJeztah updated to reflect your comments.

dperny · 2019-07-09T16:14:25Z

unreal tournament announcer voice: re-re-re-rebase

cpuguy83 · 2019-05-17T18:40:31Z

api/swagger.yaml

+          RunningTasks:
+            description: "The number of tasks for the service currently in the Running state"
+            type: "number"
+          DesiredTasks:


Isn't desired in the service spec?

Not necessarily, for two reasons:

As mentioned in the description, for global services, this must be computed by looking at all tasks in desired state Running, which cannot be done without getting all tasks for the service, and avoiding getting all tasks for the service is the point of this PR.

The implementation of this in Swarmkit was done in such a way that it's a separate gRPC call, which means there could be races with service updates, where the desired task count changes while the status is being computed. This is no worse than the existing behavior, as the ServiceStatus is consistent within itself, which was also true of these values as computed by looking at tasks (all tasks were retrieved at once and the values were computed client-side, which could in the same way be inconsistent with the service spec.).

Thanks for explaining, that makes sense.

cpuguy83 · 2019-07-09T16:15:47Z

api/server/router/swarm/cluster_routes.go

 	if value := r.URL.Query().Get("insertDefaults"); value != "" {
 		var err error
 		insertDefaults, err = strconv.ParseBool(value)
 		if err != nil {
-			err := fmt.Errorf("invalid value for insertDefaults: %s", value)


Why remove the error context?

unsure. It must've gotten removed by accident.

Oh, because directly below, it would get wrapped again, and the result (I think) would be something like Error: invalid value for insertDefaults: invalid value for insertDefaults: {{ strconv error }}. Am I incorrect on that?

Oh of course :)

cpuguy83 · 2019-07-09T16:21:20Z

api/server/router/swarm/cluster_routes.go

-	services, err := sr.backend.GetServices(basictypes.ServiceListOptions{Filters: filter})
+	// the status query parameter is only support in API versions >= 1.41. If
+	// the client is using a lesser version, ignore the parameter.
+	cliVersion := r.Header.Get("version")


Should be able to use httputils.VersionFromContext

Fixing this.

dperny · 2019-09-18T15:10:36Z

a test seems to have flaked. i'm going to rebase and push and see if it fails again

thaJeztah

LGTM, thanks!

thaJeztah · 2019-09-18T16:20:58Z

This will need a follow-up in the docker/cli repository to make use of the new field

thaJeztah · 2019-09-23T11:07:53Z

@dperny looks like there's a linting failure;

api/server/router/swarm/cluster_routes.go:205:17: `accomodate` is a misspelling of `accommodate` (misspell)
 	// required to accomodate it would be too disruptive, and because that

Can you also rebase, to get https://github.com/moby/moby/pulls in (flaky test, which has been disabled for Windows)

dperny · 2019-10-01T15:48:45Z

I've rebased this PR but I'm not clear on what's wrong. Something with swagger is failing, but it's panicking, not outputting useful information about the failure.

thaJeztah · 2019-10-01T16:21:22Z

Hm... haven't seen that one before;


[2019-09-30T17:33:36.869Z] Congratulations!  "./pkg/..." is safely isolated from internal code.
[2019-09-30T17:33:41.028Z] panic: object has no key "default"
[2019-09-30T17:33:41.028Z] 
[2019-09-30T17:33:41.028Z] goroutine 1 [running]:
[2019-09-30T17:33:41.028Z] github.com/go-swagger/go-swagger/vendor/github.com/go-openapi/validate.NewSchemaValidator(0xc000f9bb00, 0xbaf840, 0xc000f9bb00, 0x0, 0x0, 0xd11940, 0xc0004be9c0, 0x40)
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/vendor/github.com/go-openapi/validate/schema.go:55 +0xf68
[2019-09-30T17:33:41.028Z] github.com/go-swagger/go-swagger/vendor/github.com/go-openapi/validate.(*SpecValidator).Validate(0xc00118bb78, 0xb69820, 0xc000ec5480, 0xc000f9bb00, 0xc000e75c80)
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/vendor/github.com/go-openapi/validate/spec.go:102 +0x132
[2019-09-30T17:33:41.028Z] github.com/go-swagger/go-swagger/vendor/github.com/go-openapi/validate.Spec(0xc000ec5480, 0xd11940, 0xc0004be9c0, 0x0, 0x0)
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/vendor/github.com/go-openapi/validate/spec.go:50 +0xa6
[2019-09-30T17:33:41.028Z] github.com/go-swagger/go-swagger/cmd/swagger/commands.(*ValidateSpec).Execute(0x12305c8, 0xc00043cee0, 0x1, 0x2, 0x12305c8, 0x1)
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/cmd/swagger/commands/validate.go:46 +0xf6
[2019-09-30T17:33:41.028Z] github.com/go-swagger/go-swagger/vendor/github.com/jessevdk/go-flags.(*Parser).ParseArgs(0xc00068d680, 0xc000088160, 0x2, 0x2, 0x0, 0xc052b7, 0x2a, 0xa9a820, 0xc00065aae0)
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/vendor/github.com/jessevdk/go-flags/parser.go:315 +0x941
[2019-09-30T17:33:41.028Z] github.com/go-swagger/go-swagger/vendor/github.com/jessevdk/go-flags.(*Parser).Parse(...)
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/vendor/github.com/jessevdk/go-flags/parser.go:185
[2019-09-30T17:33:41.028Z] main.main()
[2019-09-30T17:33:41.028Z] 	/tmp/tmp.KMo0CBcPeP/src/github.com/go-swagger/go-swagger/cmd/swagger/swagger.go:90 +0x8bd
script returned exit code 2

Let me have a look if I see what's causing it 🤔

thaJeztah · 2019-10-01T16:25:46Z

api/swagger.yaml

+          in: "query"
+          type: "boolean"
+          description: "Include service status, with count of running and desired tasks"
+          default: false


Wonder if this is what's causing the panic. I guess a query-string may not support a "default" value? https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2

This keyword can be used to supply a default JSON value associated with a particular schema. It is RECOMMENDED that a default value be valid against the associated schema.

Perhaps "required": false would achieve the same

Thanks for looking into this @dperny

Adds a new ServiceStatus field to the Service object, which includes the running and desired task counts. This new field is gated behind a "status" query parameter. Signed-off-by: Drew Erny <drew.erny@docker.com>

thaJeztah

it's green again, with the go-swagger problem fixed 🎉

LGTM

dperny · 2019-10-15T18:47:20Z

bless you sebastiaan you magnificent man

full diff: moby/moby@b6684a4...a30990b relevant changes: - moby/moby#39995 Update containerd binary to v1.2.10 - moby/moby#40001 Update runc to v1.0.0-rc8-92-g84373aaa (CVE-2019-16884) - moby/moby#39999 bump golang 1.13.1 (CVE-2019-16276) - moby/moby#40102 bump golang 1.13.3 (CVE-2019-17596) - moby/moby#39994 homedir: add cgo or osusergo buildtag constraints for unix. This is to ensure that users of the homedir package cannot compile statically (`CGO_ENABLED=0`) without also setting the `osusergo` build tag. - moby/moby#39983 builder: remove legacy build's session handling This feature was used by docker build --stream and it was kept experimental. Users of this endpoint should enable BuildKit anyway by setting Version to BuilderBuildKit. - Related: docker#2105 build: remove --stream (was experimental) - moby/moby #40045 Bump logrus 1.4.2, go-shellwords, mergo, flock, creack/pty, golang/gddo, gorilla/mux - moby/moby#39713 bump containerd and dependencies to v1.3.0 - moby/moby#39987 Add ability to handle index acknowledgment with splunk log driver - moby/moby#40070 Use ocischema package instead of custom handler - relates to moby/moby#39727 Docker 19.03 doesn't support OCI image - relates to docker/hub-feedback#1871 - relates to distribution/distribution#3024 - moby/moby#39231 Add support for sending down service Running and Desired task counts - moby/moby#39822 daemon: Use short libnetwork ID in exec-root Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

full diff: moby/moby@b6684a4...a09e6e3 relevant changes: - moby/moby#39995 Update containerd binary to v1.2.10 - moby/moby#40001 Update runc to v1.0.0-rc8-92-g84373aaa (CVE-2019-16884) - moby/moby#39999 bump golang 1.13.1 (CVE-2019-16276) - moby/moby#40102 bump golang 1.13.3 (CVE-2019-17596) - moby/moby#40134 Revert "homedir: add cgo or osusergo buildtag constraints for unix" - reverts moby/moby#39994 homedir: add cgo or osusergo buildtag constraints for unix, in favor of documenting when to set the `osusergo` build tag. The `osusergo` build-flag must be used when compiling a static binary with `cgo` enabled, and linking against `glibc`. - moby/moby#39983 builder: remove legacy build's session handling This feature was used by docker build --stream and it was kept experimental. Users of this endpoint should enable BuildKit anyway by setting Version to BuilderBuildKit. - Related: docker#2105 build: remove --stream (was experimental) - moby/moby #40045 Bump logrus 1.4.2, go-shellwords, mergo, flock, creack/pty, golang/gddo, gorilla/mux - moby/moby#39713 bump containerd and dependencies to v1.3.0 - moby/moby#39987 Add ability to handle index acknowledgment with splunk log driver - moby/moby#40070 Use ocischema package instead of custom handler - relates to moby/moby#39727 Docker 19.03 doesn't support OCI image - relates to docker/hub-feedback#1871 - relates to distribution/distribution#3024 - moby/moby#39231 Add support for sending down service Running and Desired task counts - moby/moby#39822 daemon: Use short libnetwork ID in exec-root - moby/moby#39100 Use Microsoft/hcsshim constants and deprecate pkg/system.GetOsVersion() - updates/requires Microsoft/hscshim@2226e083fc390003ae5aa8325c3c92789afa0e7a Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

full diff: moby/moby@b6684a4...a09e6e3 relevant changes: - moby/moby#39995 Update containerd binary to v1.2.10 - moby/moby#40001 Update runc to v1.0.0-rc8-92-g84373aaa (CVE-2019-16884) - moby/moby#39999 bump golang 1.13.1 (CVE-2019-16276) - moby/moby#40102 bump golang 1.13.3 (CVE-2019-17596) - moby/moby#40134 Revert "homedir: add cgo or osusergo buildtag constraints for unix" - reverts moby/moby#39994 homedir: add cgo or osusergo buildtag constraints for unix, in favor of documenting when to set the `osusergo` build tag. The `osusergo` build-flag must be used when compiling a static binary with `cgo` enabled, and linking against `glibc`. - moby/moby#39983 builder: remove legacy build's session handling This feature was used by docker build --stream and it was kept experimental. Users of this endpoint should enable BuildKit anyway by setting Version to BuilderBuildKit. - Related: #2105 build: remove --stream (was experimental) - moby/moby #40045 Bump logrus 1.4.2, go-shellwords, mergo, flock, creack/pty, golang/gddo, gorilla/mux - moby/moby#39713 bump containerd and dependencies to v1.3.0 - moby/moby#39987 Add ability to handle index acknowledgment with splunk log driver - moby/moby#40070 Use ocischema package instead of custom handler - relates to moby/moby#39727 Docker 19.03 doesn't support OCI image - relates to docker/hub-feedback#1871 - relates to distribution/distribution#3024 - moby/moby#39231 Add support for sending down service Running and Desired task counts - moby/moby#39822 daemon: Use short libnetwork ID in exec-root - moby/moby#39100 Use Microsoft/hcsshim constants and deprecate pkg/system.GetOsVersion() - updates/requires Microsoft/hscshim@2226e083fc390003ae5aa8325c3c92789afa0e7a Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Upstream-commit: 7f6cd64335dc631efaa8204c01f92aa40939073a Component: cli

GordonTheTurtle added the status/0-triage label May 17, 2019

dperny force-pushed the add-service-status branch from 277be14 to f9fdf44 Compare May 17, 2019 20:30

thaJeztah added area/api area/swarm impact/api status/1-design-review and removed status/0-triage labels May 25, 2019

thaJeztah requested changes May 25, 2019

View reviewed changes

GordonTheTurtle assigned thaJeztah Jun 1, 2019

dperny force-pushed the add-service-status branch from f9fdf44 to a1cabfe Compare June 3, 2019 15:36

dperny force-pushed the add-service-status branch 3 times, most recently from 312f4ec to 51cdc4c Compare June 3, 2019 21:04

dperny force-pushed the add-service-status branch 2 times, most recently from 051f5e2 to b30f83e Compare June 10, 2019 14:17

dperny force-pushed the add-service-status branch 2 times, most recently from e87c3e1 to b614f25 Compare June 17, 2019 17:18

dperny force-pushed the add-service-status branch from b614f25 to a7d5d6c Compare July 9, 2019 16:13

cpuguy83 requested changes Jul 9, 2019

View reviewed changes

dperny force-pushed the add-service-status branch 4 times, most recently from bf4cb85 to f016519 Compare July 16, 2019 16:23

thaJeztah added status/2-code-review and removed status/1-design-review labels Jul 18, 2019

dperny force-pushed the add-service-status branch from f016519 to b817424 Compare September 5, 2019 16:09

dperny force-pushed the add-service-status branch from 38e2f25 to f3b9a3a Compare September 18, 2019 15:11

thaJeztah approved these changes Sep 18, 2019

View reviewed changes

thaJeztah added impact/changelog status/4-merge and removed status/2-code-review labels Sep 18, 2019

thaJeztah added the status/failing-ci Indicates that the PR in its current state fails the test suite label Sep 23, 2019

dperny force-pushed the add-service-status branch 2 times, most recently from 151a3c6 to 9caf9a1 Compare September 30, 2019 17:30

thaJeztah reviewed Oct 1, 2019

View reviewed changes

dperny force-pushed the add-service-status branch from 9caf9a1 to 87ba762 Compare October 2, 2019 16:18

Add support for sending down service Running and Desired task counts

f36042d

Adds a new ServiceStatus field to the Service object, which includes the running and desired task counts. This new field is gated behind a "status" query parameter. Signed-off-by: Drew Erny <drew.erny@docker.com>

dperny force-pushed the add-service-status branch from 87ba762 to f36042d Compare October 14, 2019 15:45

thaJeztah removed the status/failing-ci Indicates that the PR in its current state fails the test suite label Oct 14, 2019

thaJeztah approved these changes Oct 15, 2019

View reviewed changes

thaJeztah merged commit 7521bd1 into moby:master Oct 15, 2019

thaJeztah mentioned this pull request Oct 15, 2019

Refactor the stack services command to be uniform docker/cli#2131

Closed

This was referenced Oct 23, 2019

Services: use ServiceStatus on API v1.41 and up docker/cli#2157

Merged

bump docker/docker to a09e6e323e55e1a9b21df9c2c555f5668df3ac9b docker/cli#2158

Merged

thaJeztah added this to the 20.03.0 milestone Apr 2, 2020

lorinbucher mentioned this pull request Feb 1, 2023

Add status parameter to services list API docker/docker-py#3093

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for sending down service Running and Desired task counts #39231

Add support for sending down service Running and Desired task counts #39231

dperny commented May 17, 2019

dperny commented May 17, 2019

thaJeztah left a comment

thaJeztah May 25, 2019

thaJeztah May 25, 2019

thaJeztah May 25, 2019

thaJeztah May 25, 2019

thaJeztah May 25, 2019

codecov bot commented Jun 3, 2019 •

edited

Loading

dperny commented Jun 4, 2019

dperny commented Jul 9, 2019

cpuguy83 May 17, 2019

dperny Jul 9, 2019

cpuguy83 Jul 9, 2019

cpuguy83 Jul 9, 2019

dperny Jul 9, 2019

dperny Jul 9, 2019

cpuguy83 Jul 9, 2019

cpuguy83 Jul 9, 2019

dperny Jul 9, 2019

dperny commented Sep 18, 2019

thaJeztah left a comment

thaJeztah commented Sep 18, 2019

thaJeztah commented Sep 23, 2019

dperny commented Oct 1, 2019

thaJeztah commented Oct 1, 2019

thaJeztah Oct 1, 2019

thaJeztah Oct 1, 2019

david-yu Oct 1, 2019

thaJeztah left a comment

dperny commented Oct 15, 2019

-            type: "number"
+            type: "integer"
+            format: "uint64"
+            example: 7

Add support for sending down service Running and Desired task counts #39231

Add support for sending down service Running and Desired task counts #39231

Conversation

dperny commented May 17, 2019

dperny commented May 17, 2019

thaJeztah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jun 3, 2019 • edited Loading

Codecov Report

dperny commented Jun 4, 2019

dperny commented Jul 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dperny commented Sep 18, 2019

thaJeztah left a comment

Choose a reason for hiding this comment

thaJeztah commented Sep 18, 2019

thaJeztah commented Sep 23, 2019

dperny commented Oct 1, 2019

thaJeztah commented Oct 1, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thaJeztah left a comment

Choose a reason for hiding this comment

dperny commented Oct 15, 2019

codecov bot commented Jun 3, 2019 •

edited

Loading