Add update strategy to the channel badge #839

afiune · 2019-07-10T07:27:48Z

🔩 Description

The update strategy tells users how the services will be updated among a group. Habitat supports three update strategies: none, rolling, and at-once.

Showing the data along with the channel name helps users understand where the service will get an update from, and how it will update.

👍 Definition of Done

Include the update strategy for a service instance in the channel badge, in the format of [channel name]: [update strategy name] (there is a space after the :)

When there is NO channel and NO update strategy, display NO CHANNEL: NONE

Mockup

👟 Demo Script / Repro Steps

Enter your studio.
Build the automate-gateway, applications-service, and the automate-ui.
Start all services. start_all_services.
Publish a single service message with no channel and no strategy:

[5][default:/src:0]# applications_publish_supervisor_message --sup-id 2cc9c042-65cd-4812-81ed-176f98afaca2

Look at the UI: https://a2-dev.test/applications

Update the same service to have a channel and strategy:

[6][default:/src:0]# applications_publish_supervisor_message --sup-id 2cc9c042-65cd-4812-81ed-176f98afaca2 --channel stable --strategy rolling

-- or

[6][default:/src:0]# applications_publish_supervisor_message --sup-id 2cc9c042-65cd-4812-81ed-176f98afaca2 --channel stable --strategy at-once

Look back at the UI: https://a2-dev.test/applications

⛓️ Related Resources

https://chefio.atlassian.net/browse/A2-887 & #629

✅ Checklist

Necessary tests added/updated?
Necessary docs added/updated?
Code actually executed?
Vetting performed (unit tests, lint, etc.)?

Signed-off-by: Salim Afiune <afiune@chef.io>

srenatus · 2019-07-10T08:59:29Z

components/applications-service/integration_test/global_test.go

+// exactly the same, we do care about order but in some degree, for example health check
+// status and fqdn, but we don't care about things like order of supervisor_id so we can
+// skip that check by not specifying it into the expected response
+func assertServicesEqual(t *testing.T, expected, actual []*applications.Service) {


❓ assert.ElementsMatch(t, expected, actual) doesn't do the trick?

First of all, thanks for looking into this PR! Second, this was just a move of code from A to B file 06b87a1
Third and last, no, it doesn't do the trick since we might have db IDs and timestamps that won't match exactly the same.

Ah, I see. Thanks.

srenatus

Just some nitpicks

srenatus · 2019-07-10T12:16:20Z

components/applications-service/cmd/applications-publisher/main.go

@@ -126,6 +129,25 @@ func main() {
 		clientID = "applications-publisher-" + strconv.FormatInt(t.UnixNano(), 10)
 	}

+	// If the channel was specified, add the update config
+	if len(channel) > 0 {


It's probably fine, but if no channel is provided, but an update-strategy, the latter will just be ignored; it won't raise an error.

@srenatus not sure if you noticed but, we default the strategy to at-once, but the important thing here is that channel, we want to replicate the behavior of habitat and, if in Habitat you don't specify a channel, then the strategy won't be populated. TL DR no channel, no strategy.

Yeah, what I imagined to possibly happen is this:
When I call applications-publisher --channel dev --update-strategy foobar, I get an error. When I run applications-publisher --update-strategy foobar, I don't. In a perfect world, specifying --update-strategy without specifying --channel would perhaps be an error.

However, I don't know if our cli arg lib makes this simple; if it doesn't, I doubt it's worth it 🤷‍♂

I see, well I can add this check for sure. At the end, this is just a publisher tool to populate our DB but we want it to be as similar as a habitat supervisor as possible.

Your call -- I have to little context to discern if this an issue. Probably not 😄

srenatus · 2019-07-10T12:18:52Z

components/applications-service/pkg/storage/client.go

@@ -58,6 +88,7 @@ type Service struct {
 	Channel             string
 	Site                string
 	PreviousHealth      string    `db:"previous_health"`
+	UpdateStrategy      string    `db:"update_strategy"`


I'm a little surprised about db struct tags here; in pkg/storage/postgres, I understand them. Here? Not really.

yeah, I might have to fix that in a next PR. I agree with what you are mentioning here!

Another fix that you pointed out @srenatus #906

srenatus · 2019-07-10T12:19:11Z

components/applications-service/pkg/storage/postgres/db.go

@@ -106,6 +106,7 @@ type service struct {
 	Channel             string    `db:"channel"`
 	FullPkgIdent        string    `db:"package_ident"`
 	PreviousHealth      string    `db:"previous_health"`
+	UpdateStrategy      string    `db:"update_strategy"`


I suppose we could also use a PG ENUM here. But I know it's cumbersome to do all the translation... (we've got example code for this in authz-service, but using database/sql)

What would it be the benefits of using an ENUM in postgres?

The same as your storage layer's enum, I guess, just one layer down. Anyways, in authlahoma, we've stopped doing that, as it's cumbersome to deal with enums on every layer. 🙄

srenatus · 2019-07-10T12:21:12Z

components/applications-service/pkg/storage/postgres/hab_event.go

@@ -7,6 +7,7 @@ import (

 	"github.com/chef/automate/api/external/applications"
 	"github.com/chef/automate/api/external/habitat"
+	"github.com/chef/automate/components/applications-service/pkg/storage"
 	"github.com/go-gorp/gorp"


[nit] It's nice if the imports are sorted; first stdlib, then third-party deps, then internal deps. goimports -local github.com/chef/automate supports that.

I am supposedly running that command in my vim editor, not sure why it is not sorting them! 🤔

Is this how you want them¿?

import ( "fmt" "strings" "time" dblib "github.com/chef/automate/lib/db" "github.com/go-gorp/gorp" "github.com/golang/protobuf/ptypes" timestamp "github.com/golang/protobuf/ptypes/timestamp" "github.com/pkg/errors" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promauto" log "github.com/sirupsen/logrus" "github.com/chef/automate/api/external/applications" "github.com/chef/automate/api/external/habitat" "github.com/chef/automate/components/applications-service/pkg/storage" )

💭 I'd cluster the dblib with the rest in the last section, but it's also a bit of a nitpicky comment anyways -- 👍

srenatus · 2019-07-10T12:22:23Z

components/automate-ui/src/app/entities/service-groups/service-groups.model.ts

@@ -19,6 +19,7 @@ export interface Service {
  fqdn: string;
  site: string;
  channel: string;
+  update_strategy: string;


This could use a string literal type, I guess? update_strategy: "NONE" | "ROLLING" | "AT_ONCE";

FYI: It is AT-ONCE, but I like that idea!

Yeah, you get the gist 😉

Signed-off-by: Salim Afiune <afiune@chef.io>

danielsdeleo

Wondering if the enum way of specifying the update strategy might make some possible upgrade scenarios between habitat supervisor and Automate a little more difficult.

danielsdeleo · 2019-07-10T20:48:36Z

components/applications-service/pkg/storage/client.go

+type UpdateStrategy int
+
+const (
+	NoneStrategy UpdateStrategy = iota


💭 could this cause an issue if, say habitat adds a new kind of upgrade strategy and the user adopts the new upgrade strategy before they upgrade automate to a newer version that has this "enum" updated? If we really want this to be an enum then maybe 0 should be "Unknown" or something like that(?). "NONE" implies that the supervisor won't update following a package promotion, which could affect a use case like "find all the services that will update if I promote package X to the "production" channel.

No. When habitat has a new upgrade strategy, the habitat team has to also update the protobuf enum defined in the event messages, that is where automate and habitat won’t be in sync and we need to update our protobuf and code to accept the new strategy.

Going deeper into this topic, any modification that habitat will do will also trigger a need for us to update our protobuf and code. Unless we code to accept anything that comes through, which has its trade offs.

What would you like do to here? Remove the enum or continue having it?

apriofrost

Looking great on the UI!

Shadae

👍

Signed-off-by: Salim Afiune <afiune@chef.io>

afiune · 2019-07-11T06:49:45Z

Talked with @apriofrost and @danielsdeleo about those cases where Habitat could introduce a new update strategy and Automate is not capable to understand it, an example is a customer that upgrade Habitat to the latest version with a new update strategy but not upgrade Automate, in such cases we would like to create a new UNRECOGNIZED label/enum that will cover any other strategy that Automate doesn't know about but Habitat is sending.

I will work on this in a separate PR since it will be simpler and smaller for review.

Signed-off-by: Salim Afiune <afiune@chef.io>

Salim Afiune added 3 commits July 10, 2019 09:14

Adds update_strategy to the storage package

d15d4f5

Signed-off-by: Salim Afiune <afiune@chef.io>

Expose update strategy to RPC functions

dfc67ea

Signed-off-by: Salim Afiune <afiune@chef.io>

Update applications-publisher with new strategy param

3f13f14

Signed-off-by: Salim Afiune <afiune@chef.io>

afiune added ui automate-ui eas labels Jul 10, 2019

afiune requested review from danielsdeleo, srenatus, apriofrost and kmacgugan July 10, 2019 07:27

afiune self-assigned this Jul 10, 2019

Salim Afiune added 3 commits July 10, 2019 09:34

Adds withStrategyRolling to integration tests

2ee590b

Signed-off-by: Salim Afiune <afiune@chef.io>

move global test functions to global file

06b87a1

Signed-off-by: Salim Afiune <afiune@chef.io>

Show update strategy in the UI badge

54f2f5a

Signed-off-by: Salim Afiune <afiune@chef.io>

srenatus reviewed Jul 10, 2019

View reviewed changes

srenatus approved these changes Jul 10, 2019

View reviewed changes

Salim Afiune added 3 commits July 10, 2019 14:38

Update all integration tests with UpdateStrategy

f889fc7

Signed-off-by: Salim Afiune <afiune@chef.io>

Use string literal type in Service interface

80a5cff

Signed-off-by: Salim Afiune <afiune@chef.io>

Sort imports

54b0dfc

Signed-off-by: Salim Afiune <afiune@chef.io>

danielsdeleo reviewed Jul 10, 2019

View reviewed changes

apriofrost approved these changes Jul 10, 2019

View reviewed changes

Shadae approved these changes Jul 10, 2019

View reviewed changes

Salim Afiune added 2 commits July 11, 2019 08:41

merge master branch

159fc25

Signed-off-by: Salim Afiune <afiune@chef.io>

move one import to the recommended place

3bb18b8

Signed-off-by: Salim Afiune <afiune@chef.io>

Fix integration test from rebase

070802b

Signed-off-by: Salim Afiune <afiune@chef.io>

afiune merged commit d56d370 into master Jul 11, 2019

chef-ci deleted the afiune/A2-887/update-strategy branch July 11, 2019 08:27

ekmixon mentioned this pull request May 14, 2022

[Snyk] Fix for 1 vulnerabilities ekmixon/automate#54

Open

snyk-bot mentioned this pull request Nov 5, 2022

[Snyk] Fix for 1 vulnerabilities ekmixon/automate#77

Open

ekmixon mentioned this pull request Dec 26, 2022

[Snyk] Fix for 1 vulnerabilities ekmixon/automate#100

Open

ekmixon mentioned this pull request Nov 28, 2023

[Snyk] Fix for 21 vulnerabilities ekmixon/automate#139

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add update strategy to the channel badge #839

Add update strategy to the channel badge #839

afiune commented Jul 10, 2019 •

edited

Loading

srenatus Jul 10, 2019

afiune Jul 10, 2019

srenatus Jul 10, 2019

srenatus left a comment

srenatus Jul 10, 2019

afiune Jul 10, 2019

srenatus Jul 10, 2019

afiune Jul 10, 2019

srenatus Jul 10, 2019

srenatus Jul 10, 2019

afiune Jul 10, 2019

afiune Jul 16, 2019

srenatus Jul 10, 2019

afiune Jul 10, 2019

srenatus Jul 10, 2019

srenatus Jul 10, 2019

afiune Jul 10, 2019

afiune Jul 10, 2019

srenatus Jul 10, 2019

srenatus Jul 10, 2019

afiune Jul 10, 2019

srenatus Jul 10, 2019

afiune Jul 10, 2019

danielsdeleo left a comment

danielsdeleo Jul 10, 2019

afiune Jul 10, 2019

apriofrost left a comment

Shadae left a comment

afiune commented Jul 11, 2019

Add update strategy to the channel badge #839

Add update strategy to the channel badge #839

Conversation

afiune commented Jul 10, 2019 • edited Loading

🔩 Description

👍 Definition of Done

Mockup

👟 Demo Script / Repro Steps

⛓️ Related Resources

✅ Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srenatus 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

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

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

danielsdeleo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apriofrost left a comment

Choose a reason for hiding this comment

Shadae left a comment

Choose a reason for hiding this comment

afiune commented Jul 11, 2019

afiune commented Jul 10, 2019 •

edited

Loading