HCPCP-2315: POC support geography in provider

Author: huikang

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/hashicorp/go-cty v1.5.0
 	github.com/hashicorp/go-uuid v1.0.3
 	github.com/hashicorp/go-version v1.7.0
-	github.com/hashicorp/hcp-sdk-go v0.146.0
+	github.com/hashicorp/hcp-sdk-go v0.151.0
 	github.com/hashicorp/terraform-plugin-docs v0.20.1
 	github.com/hashicorp/terraform-plugin-framework v1.15.0
 	github.com/hashicorp/terraform-plugin-framework-validators v0.18.0

go.sum

@@ -126,8 +126,8 @@ github.com/hashicorp/hc-install v0.9.2 h1:v80EtNX4fCVHqzL9Lg/2xkp62bbvQMnvPQ0G+O
 github.com/hashicorp/hc-install v0.9.2/go.mod h1:XUqBQNnuT4RsxoxiM9ZaUk0NX8hi2h+Lb6/c0OZnC/I=
 github.com/hashicorp/hcl/v2 v2.23.0 h1:Fphj1/gCylPxHutVSEOf2fBOh1VE4AuLV7+kbJf3qos=
 github.com/hashicorp/hcl/v2 v2.23.0/go.mod h1:62ZYHrXgPoX8xBnzl8QzbWq4dyDsDtfCRgIq1rbJEvA=
-github.com/hashicorp/hcp-sdk-go v0.146.0 h1:S6XnAvrcofTvYieEYNm2ATq1AgdYYTJDqBYAN22C/zY=
-github.com/hashicorp/hcp-sdk-go v0.146.0/go.mod h1:HYHwfLOi7gvZwtqTQfPRYlK+XDup9NWhVRDU6N24tOs=
+github.com/hashicorp/hcp-sdk-go v0.151.0 h1:dPLgab1oihguGcOqjFoI8y+iZ05dwGK9euEvG5tzyXY=
+github.com/hashicorp/hcp-sdk-go v0.151.0/go.mod h1:HYHwfLOi7gvZwtqTQfPRYlK+XDup9NWhVRDU6N24tOs=
 github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y=
 github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
 github.com/hashicorp/terraform-exec v0.23.0 h1:MUiBM1s0CNlRFsCLJuM5wXZrzA3MnPYEsiXmzATMW/I=

internal/clients/client.go

@@ -67,9 +67,17 @@ import (
 	radar_resource_service "github.com/hashicorp/hcp-sdk-go/clients/cloud-vault-radar/preview/2023-05-01/client/resource_service"
 
 	hcpConfig "github.com/hashicorp/hcp-sdk-go/config"
+	hcpConfigGeography "github.com/hashicorp/hcp-sdk-go/config/geography"
 	sdk "github.com/hashicorp/hcp-sdk-go/httpclient"
 )
 
+const (
+	// TODO: replace these two with the constants as defined in
+	// hcp-sdk-go/config/geography
+	GeographyUS = "us"
+	GeographyEU = "eu"
+)
+
 // Client is an HCP client capable of making requests on behalf of a service principal
 type Client struct {
 	Config ClientConfig
@@ -104,6 +112,7 @@ type ClientConfig struct {
 	ClientID       string
 	ClientSecret   string
 	CredentialFile string
+	Geography      string
 
 	// WorkloadIdentityTokenFile and WorkloadIdentityResourceName can be set to
 	// indicate that authentication should occur by using workload identity
@@ -141,6 +150,17 @@ func NewClient(config ClientConfig) (*Client, error) {
 		opts = append(opts, hcpConfig.WithCredentialFile(cf))
 	}
 
+	// TODO: once the naming in hcp-sdk-go has been finalized, the following can
+	// be changed to
+	// 		if config.Geography != "" {
+	//			opts = append(opts, hcpConfig.WithGeography(config.Geography))
+	// 		}
+	if config.Geography == GeographyUS {
+		opts = append(opts, hcpConfig.WithGeography(string(hcpConfigGeography.US)))
+	} else if config.Geography == GeographyEU {
+		opts = append(opts, hcpConfig.WithGeography(string(hcpConfigGeography.EU)))
+	}
+
 	// Create the HCP Config
 	hcp, err := hcpConfig.NewHCPConfig(opts...)
 	if err != nil {

internal/provider/provider.go

@@ -31,6 +31,8 @@ import (
 	"github.com/hashicorp/terraform-provider-hcp/internal/provider/waypoint"
 	"github.com/hashicorp/terraform-provider-hcp/internal/provider/webhook"
 	"github.com/hashicorp/terraform-provider-hcp/internal/statuspage"
+
+	"github.com/hashicorp/terraform-plugin-log/tflog"
 )
 
 // This is an implementation using the Provider framework
@@ -48,6 +50,7 @@ type ProviderFrameworkModel struct {
 	ProjectID        types.String `tfsdk:"project_id"`
 	WorkloadIdentity types.List   `tfsdk:"workload_identity"`
 	SkipStatusCheck  types.Bool   `tfsdk:"skip_status_check"`
+	Geography        types.String `tfsdk:"geography"`
 }
 
 type WorkloadIdentityFrameworkModel struct {
@@ -62,6 +65,7 @@ func (p *ProviderFramework) Metadata(ctx context.Context, req provider.MetadataR
 }
 
 func (p *ProviderFramework) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
+	tflog.Info(ctx, "Configuring hcp schema")
 	resp.Schema = schema.Schema{
 		Attributes: map[string]schema.Attribute{
 			"client_id": schema.StringAttribute{
@@ -98,6 +102,13 @@ func (p *ProviderFramework) Schema(ctx context.Context, req provider.SchemaReque
 				Optional:    true,
 				Description: "When set to true, the provider will skip checking the HCP status page for service outages or returning warnings.",
 			},
+			"geography": schema.StringAttribute{
+				Optional:    true,
+				Description: "The geography in which resources should be created.",
+				Validators: []validator.String{
+					stringvalidator.OneOf(clients.GeographyUS, clients.GeographyEU),
+				},
+			},
 		},
 		Blocks: map[string]schema.Block{
 			// TODO migrate to SingleNestedAttribute once the providersdkv2 is
@@ -235,6 +246,8 @@ func NewFrameworkProvider(version string) func() provider.Provider {
 }
 
 func (p *ProviderFramework) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) {
+	tflog.Info(ctx, "Configuring hcp provider")
+
 	// Sets up HCP SDK client.
 	var data ProviderFrameworkModel
 	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
@@ -271,6 +284,14 @@ func (p *ProviderFramework) Configure(ctx context.Context, req provider.Configur
 		}
 	}
 
+	if data.Geography.IsNull() {
+		tflog.Info(ctx, "Geography is null; using default")
+	} else {
+		clientConfig.Geography = data.Geography.ValueString()
+	}
+	tflog.Info(ctx, "Configure creating a new client", map[string]interface{}{
+		"geography": clientConfig.Geography,
+	})
 	client, err := clients.NewClient(clientConfig)
 	if err != nil {
 		resp.Diagnostics.AddError(fmt.Sprintf("unable to create HCP api client: %v", err), "")

internal/providersdkv2/provider.go

@@ -84,6 +84,12 @@ func New() func() *schema.Provider {
 						"Using a credential file allows you to authenticate the provider as a service principal via client " +
 						"credentials or dynamically based on Workload Identity Federation.",
 				},
+				"geography": {
+					Type:     schema.TypeString,
+					Optional: true,
+					// Required:    true,
+					Description: "The geography in which resources should be created.",
+				},
 				"workload_identity": {
 					Type:     schema.TypeList,
 					Optional: true,
@@ -147,6 +153,7 @@ func configure(p *schema.Provider) func(context.Context, *schema.ResourceData) (
 			ClientSecret:   d.Get("client_secret").(string),
 			CredentialFile: d.Get("credential_file").(string),
 			ProjectID:      d.Get("project_id").(string),
+			Geography:      d.Get("geography").(string),
 			SourceChannel:  p.UserAgent("terraform-provider-hcp", version.ProviderVersion),
 		}