// Package gcs implements remote storage of state on Google Cloud Storage (GCS). package gcs import ( "context" "fmt" "strings" "cloud.google.com/go/storage" "github.com/hashicorp/terraform/backend" "github.com/hashicorp/terraform/helper/pathorcontents" "github.com/hashicorp/terraform/helper/schema" "golang.org/x/oauth2" "golang.org/x/oauth2/google" "google.golang.org/api/option" ) // gcsBackend implements "backend".Backend for GCS. // Input(), Validate() and Configure() are implemented by embedding *schema.Backend. // State(), DeleteState() and States() are implemented explicitly. type gcsBackend struct { *schema.Backend storageClient *storage.Client storageContext context.Context bucketName string stateDir string defaultStateFile string } func New() backend.Backend { be := &gcsBackend{} be.Backend = &schema.Backend{ ConfigureFunc: be.configure, Schema: map[string]*schema.Schema{ "bucket": { Type: schema.TypeString, Required: true, Description: "The name of the Google Cloud Storage bucket", }, "path": { Type: schema.TypeString, Optional: true, Description: "(Legacy) Path of the default state file; use state_dir instead", }, "state_dir": { Type: schema.TypeString, Optional: true, Description: "The directory where state files will be saved inside the bucket", }, "credentials": { Type: schema.TypeString, Optional: true, Description: "Google Cloud JSON Account Key", Default: "", }, }, } return be } func (b *gcsBackend) configure(ctx context.Context) error { if b.storageClient != nil { return nil } // ctx is a background context with the backend config added. // Since no context is passed to remoteClient.Get(), .Lock(), etc. but // one is required for calling the GCP API, we're holding on to this // context here and re-use it later. b.storageContext = ctx data := schema.FromContextBackendConfig(b.storageContext) b.bucketName = data.Get("bucket").(string) b.stateDir = strings.TrimLeft(data.Get("state_dir").(string), "/") b.defaultStateFile = strings.TrimLeft(data.Get("path").(string), "/") var tokenSource oauth2.TokenSource if credentials := data.Get("credentials").(string); credentials != "" { credentialsJson, _, err := pathorcontents.Read(data.Get("credentials").(string)) if err != nil { return fmt.Errorf("Error loading credentials: %v", err) } jwtConfig, err := google.JWTConfigFromJSON([]byte(credentialsJson), storage.ScopeReadWrite) if err != nil { return fmt.Errorf("Failed to get Google OAuth2 token: %v", err) } tokenSource = jwtConfig.TokenSource(b.storageContext) } else { var err error tokenSource, err = google.DefaultTokenSource(b.storageContext, storage.ScopeReadWrite) if err != nil { return fmt.Errorf("Failed to get Google Application Default Credentials: %v", err) } } client, err := storage.NewClient(b.storageContext, option.WithTokenSource(tokenSource)) if err != nil { return fmt.Errorf("Failed to create Google Storage client: %v", err) } b.storageClient = client return nil }