support for organization-level default execution mode and agent pool #1137
There are no files selected for viewing
This file contains 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 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 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,162 @@ | ||
| package provider | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| tfe "github.com/hashicorp/go-tfe" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" | ||
| "log" | ||
| ) | ||
|
|
||
| func resourceTFEOrganizationDefaultExecutionMode() *schema.Resource { | ||
| return &schema.Resource{ | ||
| Create: resourceTFEOrganizationDefaultExecutionModeCreate, | ||
| Read: resourceTFEOrganizationDefaultExecutionModeRead, | ||
| Delete: resourceTFEOrganizationDefaultExecutionModeDelete, | ||
| Importer: &schema.ResourceImporter{ | ||
| StateContext: resourceTFEOrganizationDefaultExecutionModeImporter, | ||
| }, | ||
|
|
||
| Schema: map[string]*schema.Schema{ | ||
| "organization": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Computed: true, | ||
| ForceNew: true, | ||
| }, | ||
|
|
||
| "default_execution_mode": { | ||
| Type: schema.TypeString, | ||
| Required: true, | ||
| ValidateFunc: validation.StringInSlice( | ||
| []string{ | ||
| "agent", | ||
| "local", | ||
| "remote", | ||
| }, | ||
| false, | ||
| ), | ||
| ForceNew: true, | ||
| }, | ||
|
|
||
| "default_agent_pool_id": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| ForceNew: true, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func resourceTFEOrganizationDefaultExecutionModeCreate(d *schema.ResourceData, meta interface{}) error { | ||
| config := meta.(ConfiguredClient) | ||
|
|
||
| // Get the organization name. | ||
| organization, err := config.schemaOrDefaultOrganization(d) | ||
| if err != nil { | ||
| return fmt.Errorf("error getting organization name: %w", err) | ||
| } | ||
|
|
||
| // If the "default_agent_pool_id" was provided, get the agent pool | ||
| var agentPool *tfe.AgentPool | ||
| if v, ok := d.GetOk("default_agent_pool_id"); ok && v.(string) != "" { | ||
| agentPool = &tfe.AgentPool{ | ||
| ID: v.(string), | ||
| } | ||
| } | ||
|
|
||
| defaultExecutionMode := "" | ||
| if v, ok := d.GetOk("default_execution_mode"); ok { | ||
| defaultExecutionMode = v.(string) | ||
| } else { | ||
| return fmt.Errorf("default_execution_mode was missing from tfstate, please create an issue to report this error") | ||
| } | ||
|
|
||
| // set organization default execution mode | ||
| _, err = config.Client.Organizations.Update(context.Background(), organization, tfe.OrganizationUpdateOptions{ | ||
| DefaultExecutionMode: tfe.String(defaultExecutionMode), | ||
| DefaultAgentPool: agentPool, | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("error setting default execution mode of organization %s: %w", d.Id(), err) | ||
| } | ||
|
|
||
| d.SetId(organization) | ||
|
|
||
| return resourceTFEOrganizationDefaultExecutionModeRead(d, meta) | ||
| } | ||
|
|
||
| func resourceTFEOrganizationDefaultExecutionModeRead(d *schema.ResourceData, meta interface{}) error { | ||
| config := meta.(ConfiguredClient) | ||
|
|
||
| log.Printf("[DEBUG] Read the organization: %s", d.Id()) | ||
| organization, err := config.Client.Organizations.Read(ctx, d.Id()) | ||
| if err != nil { | ||
| if errors.Is(err, tfe.ErrResourceNotFound) { | ||
| log.Printf("[DEBUG] organization %s no longer exists", d.Id()) | ||
| d.SetId("") | ||
| return nil | ||
| } | ||
| return fmt.Errorf("error reading organization %s: %w", d.Id(), err) | ||
| } | ||
|
|
||
| defaultExecutionMode := "" | ||
| if v, ok := d.GetOk("default_execution_mode"); ok { | ||
| defaultExecutionMode = v.(string) | ||
| } else { | ||
| return fmt.Errorf("default_execution_mode was missing from tfstate, please create an issue to report this error") | ||
| } | ||
| if organization.DefaultExecutionMode != defaultExecutionMode { | ||
| // set id to empty string so that the provider knows it needs to set the default execution mode again | ||
| d.SetId("") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func resourceTFEOrganizationDefaultExecutionModeDelete(d *schema.ResourceData, meta interface{}) error { | ||
| config := meta.(ConfiguredClient) | ||
|
|
||
| // Get the organization name. | ||
| organization, err := config.schemaOrDefaultOrganization(d) | ||
| if err != nil { | ||
| return fmt.Errorf("error getting organization name: %w", err) | ||
| } | ||
|
|
||
| log.Printf("[DEBUG] Reseting default execution mode of organization: %s", organization) | ||
| // reset organization default execution mode | ||
| _, err = config.Client.Organizations.Update(context.Background(), organization, tfe.OrganizationUpdateOptions{ | ||
| DefaultExecutionMode: tfe.String("remote"), | ||
| DefaultAgentPool: nil, | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("error updating organization default execution mode: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func resourceTFEOrganizationDefaultExecutionModeImporter(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) { | ||
| config := meta.(ConfiguredClient) | ||
|
|
||
| log.Printf("[DEBUG] Read the organization: %s", d.Id()) | ||
| organization, err := config.Client.Organizations.Read(ctx, d.Id()) | ||
| if err != nil { | ||
| if errors.Is(err, tfe.ErrResourceNotFound) { | ||
| log.Printf("[DEBUG] organization %s no longer exists", d.Id()) | ||
| d.SetId("") | ||
| } | ||
| return nil, fmt.Errorf("error reading organization %s: %w", d.Id(), err) | ||
| } | ||
|
|
||
| // Set the organization field. | ||
| d.Set("organization", d.Id()) | ||
| d.Set("default_execution_mode", organization.DefaultExecutionMode) | ||
| if organization.DefaultAgentPool != nil { | ||
| d.Set("default_agent_pool_id", organization.DefaultAgentPool.ID) | ||
| } | ||
|
|
||
| return []*schema.ResourceData{d}, nil | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change which should be highlighted
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this breaks the API of the provider or the platform API itself because it's a purely additive change. If you don't change the default at the org level, everything continues to behave as before.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah but what if someone does? 🙂
The provider is still pre-1.0 so everything is allowed. I'm just suggesting to add a specific note about this in the changelog.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a fair point. Previously, I was thinking setting the default
execution_modein an admission that you were prepared for that change to affect all the workspaces in your organization, but adding a note here couldn't hurt!