- Notifications
You must be signed in to change notification settings - Fork23
feat: reuse agent tokens when a prebuilt agent reinitializes#374
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
13 commits Select commitHold shift + click to select a range
5418ed7 feat: allow presets to define prebuilds
SasSwartaf25037 document prebuild parameters
SasSwart56d1ab7 remove todo
SasSwartc8c5101 make gen
SasSwart0a50b31 feat: reuse agent tokens when a prebuilt agent reinitializes
SasSwart50bda99 Merge remote-tracking branch 'origin/main' into jjs/364
SasSwarte46f69a WIP: get agent.go ready to be merged with support for prebuilds
SasSwart0f5842a fix: ensure the agent token is reused for prebuilds
SasSwartf0e699a lint and make gen
SasSwart5a2fd97 Merge remote-tracking branch 'origin/main' into jjs/364
SasSwarte51bf1c simplify function
SasSwarteff062b test: rbac role test assertion to handle site wide roles
Emyrk7b1d8e6 Merge remote-tracking branch 'origin/main' into jjs/364
SasSwartFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 1 addition & 1 deletiongo.mod
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
51 changes: 46 additions & 5 deletionsprovider/agent.go
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 |
|---|---|---|
| @@ -2,13 +2,16 @@ package provider | ||
| import ( | ||
| "context" | ||
| "crypto/sha256" | ||
| "encoding/hex" | ||
| "fmt" | ||
| "path/filepath" | ||
| "reflect" | ||
| "strings" | ||
| "github.com/google/uuid" | ||
| "github.com/hashicorp/go-cty/cty" | ||
| "github.com/hashicorp/terraform-plugin-log/tflog" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" | ||
| @@ -22,10 +25,12 @@ func agentResource() *schema.Resource { | ||
| SchemaVersion: 1, | ||
| Description: "Use this resource to associate an agent.", | ||
| CreateContext: func(ctx context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics { | ||
| agentID := uuid.NewString() | ||
| resourceData.SetId(agentID) | ||
| token := agentAuthToken(ctx, "") | ||
| err := resourceData.Set("token", token) | ||
| if err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
| @@ -48,10 +53,12 @@ func agentResource() *schema.Resource { | ||
| return updateInitScript(resourceData, i) | ||
| }, | ||
| ReadWithoutTimeout: func(ctx context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics { | ||
| token := agentAuthToken(ctx, "") | ||
| err := resourceData.Set("token", token) | ||
| if err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
| if _, ok := resourceData.GetOk("display_apps"); !ok { | ||
| err = resourceData.Set("display_apps", []interface{}{ | ||
| map[string]bool{ | ||
| @@ -469,3 +476,37 @@ func updateInitScript(resourceData *schema.ResourceData, i interface{}) diag.Dia | ||
| } | ||
| return nil | ||
| } | ||
| func agentAuthToken(ctx context.Context, agentID string) string { | ||
| existingToken := helpers.OptionalEnv(RunningAgentTokenEnvironmentVariable(agentID)) | ||
| if existingToken == "" { | ||
| // Most of the time, we will generate a new token for the agent. | ||
| // In the case of a prebuilt workspace being claimed, we will override with | ||
| // an existing token provided below. | ||
| token := uuid.NewString() | ||
| return token | ||
| } | ||
| // An existing token was provided for this agent. That means that this | ||
| // is a prebuilt workspace in the process of being claimed. | ||
| // We should reuse the token. | ||
| tflog.Info(ctx, "using provided agent token for prebuild", map[string]interface{}{ | ||
| "agent_id": agentID, | ||
| }) | ||
| return existingToken | ||
| } | ||
| // RunningAgentTokenEnvironmentVariable returns the name of an environment variable | ||
| // that contains the token to use for the running agent. This is used for prebuilds, | ||
| // where we want to reuse the same token for the next iteration of a workspace agent | ||
| // before and after the workspace was claimed by a user. | ||
| // | ||
| // By reusing an existing token, we can avoid the need to change a value that may have been | ||
| // used immutably. Thus, allowing us to avoid reprovisioning resources that may take a long time | ||
| // to replace. | ||
| // | ||
| // agentID is unused for now, but will be used as soon as we support multiple agents. | ||
| func RunningAgentTokenEnvironmentVariable(agentID string) string { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. How will the ID be injected? How will we maintain a persistent identity across | ||
| sum := sha256.Sum256([]byte(agentID)) | ||
| return "CODER_RUNNING_WORKSPACE_AGENT_TOKEN_" + hex.EncodeToString(sum[:]) | ||
| } | ||
28 changes: 23 additions & 5 deletionsprovider/workspace.go
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.
Uh oh!
There was an error while loading.Please reload this page.
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.