Skip to content

Ensure Piped uses QUICK_SYNC for deployment triggered on OUT_OF_SYNC #2795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pipecd-bot merged 2 commits into from
Nov 17, 2021
Merged

Ensure Piped uses QUICK_SYNC for deployment triggered on OUT_OF_SYNC #2795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25fb347
Ensure that Piped uses QUICK_SYNC for deployment triggered on OUT_OF_…
nghialv Nov 16, 2021
c29e27e
Fix web test
nghialv Nov 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pkg/app/piped/planner/cloudrun/cloudrun.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu

autoRollback := *cfg.Input.AutoRollback

// If the deployment was triggered by forcing via web UI,
// we rely on the user's decision.
// In case the strategy has been decided by trigger.
// For example: user triggered the deployment via web console.
switch in.Trigger.SyncStrategy {
case model.SyncStrategy_QUICK_SYNC:
out.SyncStrategy = model.SyncStrategy_QUICK_SYNC
out.Stages = buildQuickSyncPipeline(autoRollback, time.Now())
out.Summary = fmt.Sprintf("Quick sync to deploy image %s and configure all traffic to it (forced via web)", out.Version)
out.Summary = in.Trigger.StrategySummary
return
case model.SyncStrategy_PIPELINE:
if cfg.Pipeline == nil {
Expand All @@ -79,7 +79,7 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu
}
out.SyncStrategy = model.SyncStrategy_PIPELINE
out.Stages = buildProgressivePipeline(cfg.Pipeline, autoRollback, time.Now())
out.Summary = fmt.Sprintf("Sync with pipeline to deploy image %s (forced via web)", out.Version)
out.Summary = in.Trigger.StrategySummary
return
}

Expand Down
8 changes: 4 additions & 4 deletions pkg/app/piped/planner/ecs/ecs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu

autoRollback := *cfg.Input.AutoRollback

// If the deployment was triggered by forcing via web UI,
// we rely on the user's decision.
// In case the strategy has been decided by trigger.
// For example: user triggered the deployment via web console.
switch in.Trigger.SyncStrategy {
case model.SyncStrategy_QUICK_SYNC:
out.SyncStrategy = model.SyncStrategy_QUICK_SYNC
out.Stages = buildQuickSyncPipeline(autoRollback, time.Now())
out.Summary = fmt.Sprintf("Quick sync to deploy image %s and configure all traffic to it (forced via web)", out.Version)
out.Summary = in.Trigger.StrategySummary
return
case model.SyncStrategy_PIPELINE:
if cfg.Pipeline == nil {
Expand All @@ -79,7 +79,7 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu
}
out.SyncStrategy = model.SyncStrategy_PIPELINE
out.Stages = buildProgressivePipeline(cfg.Pipeline, autoRollback, time.Now())
out.Summary = fmt.Sprintf("Sync with pipeline to deploy image %s (forced via web)", out.Version)
out.Summary = in.Trigger.StrategySummary
return
}

Expand Down
8 changes: 4 additions & 4 deletions pkg/app/piped/planner/kubernetes/kubernetes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu

autoRollback := *cfg.Input.AutoRollback

// If the deployment was triggered by forcing via web UI,
// we rely on the user's decision.
// In case the strategy has been decided by trigger.
// For example: user triggered the deployment via web console.
switch in.Trigger.SyncStrategy {
case model.SyncStrategy_QUICK_SYNC:
out.SyncStrategy = model.SyncStrategy_QUICK_SYNC
out.Stages = buildQuickSyncPipeline(autoRollback, time.Now())
out.Summary = "Quick sync by applying all manifests (forced via web)"
out.Summary = in.Trigger.StrategySummary
return
case model.SyncStrategy_PIPELINE:
if cfg.Pipeline == nil {
Expand All @@ -114,7 +114,7 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu
}
out.SyncStrategy = model.SyncStrategy_PIPELINE
out.Stages = buildProgressivePipeline(cfg.Pipeline, autoRollback, time.Now())
out.Summary = "Sync with the specified pipeline (forced via web)"
out.Summary = in.Trigger.StrategySummary
return
}

Expand Down
8 changes: 4 additions & 4 deletions pkg/app/piped/planner/lambda/lambda.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu

autoRollback := *cfg.Input.AutoRollback

// If the deployment was triggered by forcing via web UI,
// we rely on the user's decision.
// In case the strategy has been decided by trigger.
// For example: user triggered the deployment via web console.
switch in.Trigger.SyncStrategy {
case model.SyncStrategy_QUICK_SYNC:
out.SyncStrategy = model.SyncStrategy_QUICK_SYNC
out.Stages = buildQuickSyncPipeline(autoRollback, time.Now())
out.Summary = fmt.Sprintf("Quick sync to deploy version %s and configure all traffic to it (forced via web)", out.Version)
out.Summary = in.Trigger.StrategySummary
return
case model.SyncStrategy_PIPELINE:
if cfg.Pipeline == nil {
Expand All @@ -79,7 +79,7 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu
}
out.SyncStrategy = model.SyncStrategy_PIPELINE
out.Stages = buildProgressivePipeline(cfg.Pipeline, autoRollback, time.Now())
out.Summary = fmt.Sprintf("Sync with pipeline to deploy version %s (forced via web)", out.Version)
out.Summary = in.Trigger.StrategySummary
return
}

Expand Down
8 changes: 4 additions & 4 deletions pkg/app/piped/planner/terraform/terraform.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu
return
}

// If the deployment was triggered by forcing via web UI,
// we rely on the user's decision.
// In case the strategy has been decided by trigger.
// For example: user triggered the deployment via web console.
switch in.Trigger.SyncStrategy {
case model.SyncStrategy_QUICK_SYNC:
out.SyncStrategy = model.SyncStrategy_QUICK_SYNC
out.Stages = buildQuickSyncPipeline(cfg.Input.AutoRollback, time.Now())
out.Summary = "Quick sync by automatically applying any detected changes because no pipeline was configured (forced via web)"
out.Summary = in.Trigger.StrategySummary
return
case model.SyncStrategy_PIPELINE:
if cfg.Pipeline == nil {
Expand All @@ -66,7 +66,7 @@ func (p *Planner) Plan(ctx context.Context, in planner.Input) (out planner.Outpu
}
out.SyncStrategy = model.SyncStrategy_PIPELINE
out.Stages = buildProgressivePipeline(cfg.Pipeline, cfg.Input.AutoRollback, time.Now())
out.Summary = "Sync with the specified progressive pipeline (forced via web)"
out.Summary = in.Trigger.StrategySummary
return
}

Expand Down
10 changes: 7 additions & 3 deletions pkg/app/piped/trigger/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ func (t *Trigger) triggerDeployment(
commit git.Commit,
commander string,
syncStrategy model.SyncStrategy,
strategySummary string,
) (*model.Deployment, error) {

// Build deployment model to trigger.
Expand All @@ -48,6 +49,7 @@ func (t *Trigger) triggerDeployment(
commit,
commander,
syncStrategy,
strategySummary,
time.Now(),
appCfg.DeploymentNotification,
)
Expand Down Expand Up @@ -80,6 +82,7 @@ func buildDeployment(
commit git.Commit,
commander string,
syncStrategy model.SyncStrategy,
strategySummary string,
now time.Time,
noti *config.DeploymentNotification,
) (*model.Deployment, error) {
Expand Down Expand Up @@ -119,9 +122,10 @@ func buildDeployment(
Url: commitURL,
CreatedAt: int64(commit.CreatedAt),
},
Commander: commander,
Timestamp: now.Unix(),
SyncStrategy: syncStrategy,
Commander: commander,
Timestamp: now.Unix(),
SyncStrategy: syncStrategy,
StrategySummary: strategySummary,
},
GitPath: app.GitPath,
CloudProvider: app.CloudProvider,
Expand Down
8 changes: 4 additions & 4 deletions pkg/app/piped/trigger/determiner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ type determiners struct {
onCommit Determiner
}

func (ds *determiners) Determiner(ck candidateKind) Determiner {
switch ck {
case commandCandidate:
func (ds *determiners) Determiner(k model.TriggerKind) Determiner {
switch k {
case model.TriggerKind_ON_COMMAND:
return ds.onCommand
case outOfSyncCandidate:
case model.TriggerKind_ON_OUT_OF_SYNC:
return ds.onOutOfSync
default:
return ds.onCommit
Expand Down
51 changes: 37 additions & 14 deletions pkg/app/piped/trigger/trigger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,9 @@ type notifier interface {
Notify(event model.NotificationEvent)
}

type candidateKind int

const (
commitCandidate candidateKind = iota
commandCandidate
outOfSyncCandidate
)

type candidate struct {
application *model.Application
kind candidateKind
kind model.TriggerKind
command model.ReportableCommand
}

Expand Down Expand Up @@ -219,10 +211,16 @@ func (t *Trigger) checkRepoCandidates(ctx context.Context, repoID string, cs []c
onOutOfSync: NewOnOutOfSyncDeterminer(t.apiClient),
onCommit: NewOnCommitDeterminer(gitRepo, headCommit.Hash, t.commitStore, t.logger),
}
triggered := make(map[string]struct{})

for _, c := range cs {
app := c.application

// Avoid triggering multiple deployments for the same application in the same iteration.
if _, ok := triggered[app.Id]; ok {
continue
}
Comment on lines +219 to +222
Copy link
Member

@khanhtc1202 khanhtc1202 Nov 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the trigger which comes first has a higher priority than the one of the same application which comes after. I'm okay with that but since those candidates come from different kinds (onCommand, onCommit, onOutOfSync, etc), maybe we need a better way to choose which one should have a higher priority based on the c.Kind or something.

Copy link
Member Author

@nghialv nghialv Nov 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I understand your feeling. 👍
Tbh, I was thinking about that. One way I was planned to use is sorting the candidate list in this function by kind, but after the second thought, I decided to do nothing because the passing list could be controlled by the caller. The caller can sort in the order it wants.
Maybe in the future, when we have more kinds we can add some kind of priority field to the candidate struct to decide.

Copy link
Member

@khanhtc1202 khanhtc1202 Nov 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, let's keep it as is and make changes to use ordering later.


appCfg, err := loadDeploymentConfiguration(gitRepo.GetPath(), app)
if err != nil {
t.logger.Error("failed to load application config file", zap.Error(err))
Expand All @@ -248,20 +246,45 @@ func (t *Trigger) checkRepoCandidates(ctx context.Context, repoID string, cs []c
continue
}

var (
commander string
strategy model.SyncStrategy
strategySummary string
)

switch c.kind {
case model.TriggerKind_ON_COMMAND:
strategy = c.command.GetSyncApplication().SyncStrategy
commander = c.command.Commander
if strategy == model.SyncStrategy_QUICK_SYNC {
strategySummary = "Quick sync because piped received a command from user via web console or pipectl"
} else {
strategySummary = "Sync with the specified pipeline because piped received a command from user via web console or pipectl"
}

case model.TriggerKind_ON_OUT_OF_SYNC:
strategy = model.SyncStrategy_QUICK_SYNC
strategySummary = "Quick sync to attempt to resolve the detected configuration drift"

default:
strategy = model.SyncStrategy_AUTO
}

// Build deployment model and send a request to API to create a new deployment.
deployment, err := t.triggerDeployment(ctx, app, appCfg, branch, headCommit, "", model.SyncStrategy_AUTO)
deployment, err := t.triggerDeployment(ctx, app, appCfg, branch, headCommit, commander, strategy, strategySummary)
if err != nil {
msg := fmt.Sprintf("failed to trigger application %s: %v", app.Id, err)
t.notifyDeploymentTriggerFailed(app, msg, headCommit)
t.logger.Error(msg, zap.Error(err))
continue
}

triggered[app.Id] = struct{}{}
t.commitStore.Put(app.Id, headCommit.Hash)
t.notifyDeploymentTriggered(ctx, appCfg, deployment)

// Mask command as handled since the deployment has been triggered successfully.
if c.kind == commandCandidate {
if c.kind == model.TriggerKind_ON_COMMAND {
metadata := map[string]string{
triggeredDeploymentIDKey: deployment.Id,
}
Expand Down Expand Up @@ -301,7 +324,7 @@ func (t *Trigger) listCommandCandidates() []candidate {

apps = append(apps, candidate{
application: app,
kind: commandCandidate,
kind: model.TriggerKind_ON_COMMAND,
command: cmd,
})
}
Expand All @@ -321,7 +344,7 @@ func (t *Trigger) listOutOfSyncCandidates() []candidate {
}
apps = append(apps, candidate{
application: app,
kind: outOfSyncCandidate,
kind: model.TriggerKind_ON_OUT_OF_SYNC,
})
}
return apps
Expand All @@ -338,7 +361,7 @@ func (t *Trigger) listCommitCandidates() []candidate {
for _, app := range list {
apps = append(apps, candidate{
application: app,
kind: commitCandidate,
kind: model.TriggerKind_ON_COMMIT,
})
}
return apps
Expand Down
1 change: 1 addition & 0 deletions pkg/app/web/src/__fixtures__/dummy-trigger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export const dummyTrigger: DeploymentTrigger.AsObject = {
url: "",
},
syncStrategy: SyncStrategy.AUTO,
strategySummary: "",
};

function createCommitFromObject(o: Commit.AsObject): Commit {
Expand Down
1 change: 1 addition & 0 deletions pkg/app/web/src/components/deployments-detail-page/pipeline/index.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const fakeDeployment: Deployment.AsObject = {
commander: "cakecatz",
timestamp: 1592201366,
syncStrategy: SyncStrategy.AUTO,
strategySummary: "",
},
runningCommitHash: "3808585b46f1e90196d7ffe8dd04c807a251febc",
summary: "This deployment is debug",
Expand Down
7 changes: 7 additions & 0 deletions pkg/model/deployment.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,19 @@ message Deployment {
int64 updated_at = 102 [(validate.rules).int64.gte = 0];
}

enum TriggerKind {
ON_COMMIT = 0;
ON_COMMAND = 1;
ON_OUT_OF_SYNC = 2;
}

message DeploymentTrigger {
Commit commit = 1 [(validate.rules).message.required = true];
// Who triggered this deployment via web page.
string commander= 2;
int64 timestamp = 3 [(validate.rules).int64.gt = 0];
SyncStrategy sync_strategy = 4;
string strategy_summary = 5;
}

message PipelineStage {
Expand Down