In this quickstart guide, you'll create a Terraform configuration file
that provisions a storage bucket and
uploads a sample_file.txt
object to the bucket. To complete this quickstart,
you'll use your local shell and terminal or the Cloud Shell Editor and
Cloud Shell terminal. You'll also use the
Terraform CLI, which is preinstalled in Cloud Shell.
Before you begin
To set up a project for this quickstart, complete the following steps:
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verify that billing is enabled for your Google Cloud project .
-
Enable the Cloud Storage API.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verify that billing is enabled for your Google Cloud project .
-
Enable the Cloud Storage API.
Create the folder structure and Terraform configuration file
To create the Terraform configuration file and the file you'll upload as an object to Cloud Storage, complete the following steps:
Cloud Shell
-
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
- Set the default Google Cloud project where you want to apply your
Terraform configuration:
export GOOGLE_CLOUD_PROJECT= PROJECT_ID - In the Cloud Shell terminal, set the home
directory as the active directory:
cd - Create a new folder named
terraform:
mkdir terraform - Launch the Cloud Shell Editor by clicking Open Editoron the toolbar of the Cloud Shell window.
- In the Explorerpane, right-click the
terraformfolder and then click New File. - Enter
main.tfas the file name and then click OK. - In the Explorerpane, right-click the
terraformfolder and then click New File. - Enter
sample_file.txtas the file name and then click OK.
Local shell
- If you haven't already, install and configure Terraform
.
Make sure you install
and initialize
the Google Cloud CLI.
By default, Terraform reads the configuration created by Google Cloud CLI and deploys the resources you later specify into your active Google Cloud CLI project.
- In your terminal, set the home
directory as the active directory:
cd - Create a new folder named
terraform:
mkdir terraform - In your text editor of choice, create a new file named
main.tfin yourterraformfolder. - In your text editor of choice, create a new file named
sample_file.txtin yourterraformfolder.
Define the infrastructure in the Terraform configuration file
To define the infrastructure you want to provision in your Terraform configuration file, complete the following steps:
-
Open the
main.tffile. -
Copy the following sample to the
main.tffile.# Create new storage bucket in the US # location with Standard Storage resource "google_storage_bucket" "static" { name = " BUCKET_NAME " location = "US" storage_class = "STANDARD" uniform_bucket_level_access = true } # Upload a text file as an object # to the storage bucket resource "google_storage_bucket_object" "default" { name = " OBJECT_NAME " source = " OBJECT_PATH " content_type = "text/plain" bucket = google_storage_bucket.static.id }
Replace:
-
BUCKET_NAME with the name of the bucket you want to create. For example,
my-bucket. -
OBJECT_NAME with the name of the object you want to upload. For this quickstart, enter the name
sample_file.txt. -
OBJECT_PATH with the path to the object you want to upload. For this quickstart, enter the path
~/terraform/sample_file.txt.
-
-
Save the
main.tffile.
Initialize the working directory containing the Terraform configuration file
To initialize Terraform and the directory containing your Terraform configuration file, complete the following steps:
-
In your terminal, set the
terraformfolder as the current working directory:cd ~/terraform -
Initialize Terraform:
terraform init -
If you're using the Cloud Shell and you're prompted to authorize Cloud Shell, click Authorize.
Terraform initializes the working directory. If it successfully initializes the working directory, Terraform returns output similar to the following:
Terraform has been successfully initialized ! You may now begin working with Terraform . Try running "terraform plan" to see any changes that are required for your infrastructure . All Terraform commands should now work . If you ever set or change modules or backend configuration for Terraform , rerun this command to reinitialize your working directory . If you forget , other commands will detect it and remind you to do so if necessary .
Preview the execution plan
The Terraform execution plan is based on the Terraform configuration and indicates the changes that Terraform plans to make to the Cloud Storage infrastructure and services.
View the Terraform execution plan:
terraform
plan
Example output:
Terraform
used
the
selected
providers
to
generate
the
following
execution
plan
.
Resource
actions
are
indicated
with
the
following
symbols
:
+
create
Terraform
will
perform
the
following
actions
:
# google_storage_bucket.static will be created
+
resource
"google_storage_bucket"
"static"
{
+
force_destroy
=
false
+
id
=
(
known
after
apply
)
+
location
=
"US"
+
name
=
"my-bucket"
+
project
=
"my-project"
+
public_access_prevention
=
(
known
after
apply
)
+
self_link
=
(
known
after
apply
)
+
storage_class
=
"STANDARD"
+
uniform_bucket_level_access
=
true
+
url
=
(
known
after
apply
)
+
versioning
{
+
enabled
=
(
known
after
apply
)
}
+
website
{
+
main_page_suffix
=
(
known
after
apply
)
+
not_found_page
=
(
known
after
apply
)
}
}
# google_storage_bucket_object.default will be created
+
resource
"google_storage_bucket_object"
"default"
{
+
bucket
=
(
known
after
apply
)
+
content_type
=
"text/plain"
+
crc32c
=
(
known
after
apply
)
+
detect_md5hash
=
"different hash"
+
id
=
(
known
after
apply
)
+
kms_key_name
=
(
known
after
apply
)
+
md5hash
=
(
known
after
apply
)
+
media_link
=
(
known
after
apply
)
+
name
=
"sample_file.txt"
+
output_name
=
(
known
after
apply
)
+
self_link
=
(
known
after
apply
)
+
source
=
"sample_file.txt"
+
storage_class
=
(
known
after
apply
)
}
Plan
:
2
to
add
,
0
to
change
,
0
to
destroy
.
Apply the changes proposed in the execution plan
To apply the changes in your Terraform configuration file, complete the following steps:
-
Apply the changes from the execution plan to the Cloud Storage infrastructure with the following command. When you apply the changes, Terraform creates a storage bucket and uploads
sample_file.txtto the bucket.terraform applyExample output:
Terraform used the selected providers to generate the following execution plan . Resource actions are indicated with the following symbols : + create Terraform will perform the following actions : # google_storage_bucket.static will be created + resource "google_storage_bucket" "static" { + force_destroy = false + id = ( known after apply ) + location = "US" + name = "my-bucket" + project = "my-project" + public_access_prevention = ( known after apply ) + self_link = ( known after apply ) + storage_class = "STANDARD" + uniform_bucket_level_access = true + url = ( known after apply ) + versioning { + enabled = ( known after apply ) } + website { + main_page_suffix = ( known after apply ) + not_found_page = ( known after apply ) } } # google_storage_bucket_object.default will be created + resource "google_storage_bucket_object" "default" { + bucket = ( known after apply ) + content_type = "text/plain" + crc32c = ( known after apply ) + detect_md5hash = "different hash" + id = ( known after apply ) + kms_key_name = ( known after apply ) + md5hash = ( known after apply ) + media_link = ( known after apply ) + name = "sample_file.txt" + output_name = ( known after apply ) + self_link = ( known after apply ) + source = "sample_file.txt" + storage_class = ( known after apply ) } Plan : 2 to add , 0 to change , 0 to destroy . Do you want to perform these actions ? Terraform will perform the actions described above . Only 'yes' will be accepted to approve . Enter a value : -
Type
yesand press Enter.If successful, Terraform returns output similar to the following:
Apply complete ! Resources : 2 added , 0 changed , 0 destroyed .
View your storage bucket and uploaded object
In the Google Cloud console, go to the Cloud Storage Buckets page.The new bucket appears, containing the sample_file.txt
object. Note that the
resources might take a few minutes to get provisioned after you run terraform apply
.
Clean up your project
In order to avoid incurring unexpected charges from the Google Cloud resources you created during this quickstart, complete the following steps to clean up the resources:
-
In your terminal, set the
terraformfolder as the current working directory:cd ~/terraform -
Delete the Cloud Storage resources that you created based on your Terraform configuration file:
terraform destroy -
If successful, Terraform returns output similar to the following:
Terraform used the selected providers to generate the following execution plan . Resource actions are indicated with the following symbols : - destroy Terraform will perform the following actions : # google_storage_bucket.static will be destroyed - resource "google_storage_bucket" "static" { - default_event_based_hold = false - > null - force_destroy = false - > null - id = "my-bucket" - > null - labels = {} - > null - location = "US" - > null - name = "" - > null - project = "example-project" - > null - public_access_prevention = "inherited" - > null - requester_pays = false - > null - self_link = "https://www.googleapis.com/storage/v1/b/cbonnie-bucket-9" - > null - storage_class = "STANDARD" - > null - uniform_bucket_level_access = true - > null - url = "gs://BUCKET_NAME" - > null } # google_storage_bucket_object.default will be destroyed - resource "google_storage_bucket_object" "default" { - bucket = "my-bucket" - > null - content_type = "text/plain" - > null - crc32c = "yZRlqg==" - > null - detect_md5hash = "XrY7u+Ae7tCTyyK7j1rNww==" - > null - event_based_hold = false - > null - id = "my-bucket-sample_file.txt" - > null - md5hash = "XrY7u+Ae7tCTyyK7j1rNww==" - > null - media_link = "https://storage.googleapis.com/download/storage/v1/b/BUCKET_NAME/o/sample_file.txt?generation=1675800386233102&alt=media" - > null - metadata = {} - > null - name = "sample_file.txt" - > null - output_name = "sample_file.txt" - > null - self_link = "https://www.googleapis.com/storage/v1/b/BUCKET_NAME/o/sample_file.txt" - > null - source = "sample_file.txt" - > null - storage_class = "STANDARD" - > null - temporary_hold = false - > null } Plan : 0 to add , 0 to change , 2 to destroy . Do you really want to destroy all resources ? Terraform will destroy all your managed infrastructure , as shown above . There is no undo . Only 'yes' will be accepted to confirm . Enter a value : -
Type
yesand press Enter. If successful, Terraform returns output similar to the following:Destroy complete ! Resources : 2 destroyed . -
In your terminal, delete the
terraformfolder.rm -rf ~/terraform -
To verify that the bucket and object were deleted, go to the Bucketspage in the Google Cloud console.
