Skip to content
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.

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

Add documentation to canary and improvements #4447

Merged
merged 11 commits into from
Sep 10, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
comment
  • Loading branch information
longquanzheng authored Sep 10, 2021
commit 6efb5c6dcc23fab645c8ada8d1f344e69c686ce7
4 changes: 4 additions & 0 deletions canary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ For local development, you can also start the cron canary workflows along with t
./cadence-canary start -m all
```

The Cron Schedule is from the Configuration.
However, changing the schedule requires you manually terminate the existing cron workflow to take into effect.
It can be [improved](https://github.com/uber/cadence/issues/4469) in the future.

#### Test case starter & Sanity suite
The sanity workflow is test suite workflow. It will kick off a bunch of childWorkflows for all the test to verify that Cadence server is operating correctly.

Expand Down
1 change: 1 addition & 0 deletions canary/canary.go
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ func (c *canaryImpl) startCronWorkflow() {
_, err := c.canaryClient.StartWorkflow(ctx, opts, cronWorkflow, wfTypeSanity)
if err != nil {
// TODO: improvement: compare the cron schedule to decide whether or not terminating the current one
// https://github.com/uber/cadence/issues/4469
if _, ok := err.(*shared.WorkflowExecutionAlreadyStartedError); !ok {
c.runtime.logger.Error("error starting cron workflow", zap.Error(err))
} else {
Expand Down