-
Notifications
You must be signed in to change notification settings - Fork 263
feat(clean): reap leaked AMP integ-test workspaces #2233
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
Open
olowosulu
wants to merge
3
commits into
aws:main
Choose a base branch
from
olowosulu:feat/clean-amp-workspaces
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+150
−15
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "flag" | ||
| "log" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/aws/aws-sdk-go-v2/aws" | ||
| "github.com/aws/aws-sdk-go-v2/config" | ||
| "github.com/aws/aws-sdk-go-v2/service/amp" | ||
| "github.com/aws/aws-sdk-go-v2/service/amp/types" | ||
|
|
||
| "github.com/aws/amazon-cloudwatch-agent/tool/clean" | ||
| ) | ||
|
|
||
| // WorkspacesToClean lists the alias prefixes of AMP (Amazon Managed Service for | ||
| // Prometheus) workspaces created by the integration-test harness. The harness sets | ||
| // workspace_alias to "cwagent-integ-test-<testing_id>" in | ||
| // terraform/ec2/linux/main.tf (module "amp"). | ||
| var WorkspacesToClean = []string{ | ||
| "cwagent-integ-test-", | ||
| } | ||
|
|
||
| var dryRun bool | ||
|
|
||
| // Clean AMP workspaces created by the integration tests if they have been open | ||
| // longer than one day. A test run creates a workspace, uses it for a few minutes, | ||
| // then destroys it via terraform. Workspaces left behind by cancelled or | ||
| // hard-killed jobs (whose terraform state is lost with the ephemeral runner) | ||
| // accumulate to the per-region 75-workspace quota; once at the cap every new run | ||
| // fails at CreateWorkspace with ServiceQuotaExceededException. The existing | ||
| // terraform destroy cleanup step cannot reclaim these because their state is gone, | ||
| // so this cleaner deletes them out-of-band via the AMP API. | ||
| func main() { | ||
| flag.BoolVar(&dryRun, "dry-run", false, "Enable dry-run mode (no actual deletion)") | ||
| flag.Parse() | ||
|
|
||
| if err := cleanWorkspaces(); err != nil { | ||
| log.Fatalf("errors cleaning %v", err) | ||
| } | ||
| } | ||
|
|
||
| func cleanWorkspaces() error { | ||
| log.Print("Begin to clean AMP workspaces") | ||
| ctx := context.Background() | ||
| defaultConfig, err := config.LoadDefaultConfig(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| client := amp.NewFromConfig(defaultConfig) | ||
| return terminateWorkspaces(ctx, client) | ||
| } | ||
|
|
||
| func aliasMatchesWorkspacesToClean(alias string, workspacesToClean []string) bool { | ||
| for _, workspaceToClean := range workspacesToClean { | ||
| if workspaceToClean == "" { | ||
| continue | ||
| } | ||
| if strings.HasPrefix(alias, workspaceToClean) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func terminateWorkspaces(ctx context.Context, client *amp.Client) error { | ||
| expirationDate := time.Now().UTC().Add(clean.KeepDurationOneDay) | ||
|
|
||
| var deleteErrors []error | ||
| paginator := amp.NewListWorkspacesPaginator(client, &.ListWorkspacesInput{}) | ||
| for paginator.HasMorePages() { | ||
| page, err := paginator.NextPage(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| for _, workspace := range page.Workspaces { | ||
| workspaceID := aws.ToString(workspace.WorkspaceId) | ||
| alias := aws.ToString(workspace.Alias) | ||
|
|
||
| if workspace.Status == nil || | ||
| (workspace.Status.StatusCode != types.WorkspaceStatusCodeActive && | ||
| workspace.Status.StatusCode != types.WorkspaceStatusCodeCreationFailed) { | ||
| log.Printf("Ignoring workspace %s (alias %q) since it is not ACTIVE or CREATION_FAILED", workspaceID, alias) | ||
| continue | ||
| } | ||
| if workspace.CreatedAt == nil || !expirationDate.After(*workspace.CreatedAt) { | ||
| log.Printf("Ignoring workspace %s (alias %q) with create-date %v since it was created in the last %s", | ||
| workspaceID, alias, aws.ToTime(workspace.CreatedAt), -clean.KeepDurationOneDay) | ||
| continue | ||
| } | ||
| if !aliasMatchesWorkspacesToClean(alias, WorkspacesToClean) { | ||
| log.Printf("Ignoring workspace %s since alias %q does not match any clean prefix", workspaceID, alias) | ||
| continue | ||
| } | ||
| if dryRun { | ||
| log.Printf("Dry-Run: would delete workspace %s (alias %q, create-date %v)", | ||
| workspaceID, alias, aws.ToTime(workspace.CreatedAt)) | ||
| continue | ||
| } | ||
| log.Printf("Try to delete workspace %s (alias %q, create-date %v)", | ||
| workspaceID, alias, aws.ToTime(workspace.CreatedAt)) | ||
| if _, err := client.DeleteWorkspace(ctx, &.DeleteWorkspaceInput{WorkspaceId: workspace.WorkspaceId}); err != nil { | ||
| log.Printf("could not delete workspace %s err %v", workspaceID, err) | ||
|
olowosulu marked this conversation as resolved.
|
||
| deleteErrors = append(deleteErrors, err) | ||
| } | ||
| } | ||
| } | ||
| return errors.Join(deleteErrors...) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.