{"id":32467,"date":"2023-10-11T06:06:42","date_gmt":"2023-10-11T06:06:42","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=32467"},"modified":"2023-10-11T06:07:57","modified_gmt":"2023-10-11T06:07:57","slug":"terraform-backend-tutorial","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/terraform-backend-tutorial\/","title":{"rendered":"Terraform Backend Tutorial"},"content":{"rendered":"\n
\"\"<\/figure>\n\n\n\n

Terraform is a popular open-source infrastructure as code tool used to create and manage infrastructure resources. The state of the infrastructure resources managed by Terraform is stored in a backend, which can be a remote storage location such as Amazon S3.<\/p>\n\n\n\n

To configure Terraform to use an S3 backend, you will need to perform the following steps:<\/p>\n\n\n\n

    \n
  1. Create an S3 bucket – create a new S3 bucket or use an existing one for storing the Terraform state file.<\/li>\n\n\n\n
  2. Create an S3 access key – generate an access key and secret key with the appropriate permissions for accessing the S3 bucket.<\/li>\n\n\n\n
  3. Configure Terraform backend – add the following code block to your Terraform configuration file, replacing the values with your specific S3 bucket and access key information:<\/li>\n<\/ol>\n\n\n\n

    List of Terraform Backends Options<\/h2>\n\n\n\n

    Terraform uses backends to determine how the state is loaded and how an operation such as apply<\/code> is executed. The backend configuration can control where the state is stored and how the operations are executed.<\/p>\n\n\n\n

    Here’s a list of commonly used Terraform backends:<\/p>\n\n\n\n

      \n
    1. Local<\/strong>:\n
        \n
      • Stores state on the local filesystem.<\/li>\n\n\n\n
      • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
      • Remote<\/strong>:\n
          \n
        • Uses the Terraform Cloud to store state and optionally execute operations.<\/li>\n\n\n\n
        • It’s the default backend for Terraform Cloud workspaces.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
        • Consul<\/strong>:\n
            \n
          • Stores the state in Consul’s key\/value store.<\/li>\n\n\n\n
          • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
          • AzureRM<\/strong>:\n
              \n
            • Stores the state in an Azure Storage Blob.<\/li>\n\n\n\n
            • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
            • S3<\/strong>:\n
                \n
              • Stores state in an Amazon S3 bucket.<\/li>\n\n\n\n
              • It can use DynamoDB for state locking and consistency.<\/li>\n\n\n\n
              • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
              • Google Cloud Storage (GCS)<\/strong>:\n
                  \n
                • Stores state in a Google Cloud Storage bucket.<\/li>\n\n\n\n
                • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                • Swift<\/strong>:\n
                    \n
                  • Stores state in OpenStack Swift.<\/li>\n\n\n\n
                  • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                  • Artifactory<\/strong>:\n
                      \n
                    • Stores state in JFrog Artifactory.<\/li>\n\n\n\n
                    • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                    • Etcd V2 & V3<\/strong>:\n
                        \n
                      • Store the state in Etcd’s key\/value store.<\/li>\n\n\n\n
                      • Executes operations locally.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                      • Manta<\/strong>:<\/li>\n<\/ol>\n\n\n\n
                          \n
                        • Stores the state in Joyent’s Manta service.<\/li>\n\n\n\n
                        • Executes operations locally.<\/li>\n<\/ul>\n\n\n\n
                            \n
                          1. OSS<\/strong>:<\/li>\n<\/ol>\n\n\n\n
                              \n
                            • Stores state in Alibaba Cloud Object Storage Service.<\/li>\n\n\n\n
                            • Executes operations locally.<\/li>\n<\/ul>\n\n\n\n
                                \n
                              1. Pg<\/strong>:<\/li>\n<\/ol>\n\n\n\n
                                  \n
                                • Stores state within a configured PostgreSQL database.<\/li>\n\n\n\n
                                • Executes operations locally.<\/li>\n<\/ul>\n\n\n\n
                                    \n
                                  1. Kubernetes<\/strong>:<\/li>\n<\/ol>\n\n\n\n
                                      \n
                                    • Stores state within a Kubernetes Secret.<\/li>\n\n\n\n
                                    • Executes operations locally.<\/li>\n<\/ul>\n\n\n\n
                                      \n\n\n
                                      terraform {\n  backend \"s3\"<\/span> {\n    bucket = \"your-bucket-name\"<\/span>\n    key    = \"path\/to\/terraform.tfstate\"<\/span>\n    region = \"your-aws-region\"<\/span>\n    access_key = \"your-access-key\"<\/span>\n    secret_key = \"your-secret-key\"<\/span>\n  }\n}<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
                                      \n\n\n\n
                                      Initialize the backend – run the terraform init<\/code> command to initialize the backend configuration and create the state file in the S3 bucket.<\/p>\n\n\n\n
                                      \n\n\n
                                      terraform {\n  required_providers {\n    aws = {\n      source  = \"hashicorp\/aws\"<\/span>\n      version = \"~> 4.0\"<\/span>\n    }\n  }\n  backend \"s3\"<\/span> {\n    bucket = \"art54654654546546456\"<\/span>\n    key    = \"aug\"<\/span>\n    region = \"ap-south-1\"<\/span>\n\taccess_key = \"\"<\/span>\n    secret_key = \"\"<\/span>\n  }\n}\n\n\n# Configure the AWS Provider<\/span>\nprovider \"aws\"<\/span> {\n  region = \"ap-south-1\"<\/span>\n  access_key = \"\"<\/span>\n  secret_key = \"\"<\/span>\n}<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
                                      \n\n\n\n
                                      Terraform Backend Credentail Pass Through Command line<\/h2>\n\n\n\n
                                      $ terraform init -backend-config=”access_key=ASSSSSSSSSSSSSY” -backend-config=”secret_key=VddddddddddddddG” -reconfigure<\/p>\n\n\n\n
                                      How to Setup Terraform Backend with Azure Blob Container?<\/h2>\n\n\n\n
                                      \"\"<\/figure>\n\n\n\n
                                      \n\n\n
                                      terraform {\n  required_providers {\n    azurerm = {\n      source = \"hashicorp\/azurerm\"<\/span>\n      version = \"3.75.0\"<\/span>\n    }\n\taws = {\n      source = \"hashicorp\/aws\"<\/span>\n      version = \"5.20.0\"<\/span>\n    }\n\tgithub = {\n      source = \"integrations\/github\"<\/span>\n      version = \"5.39.0\"<\/span>\n    }\n  }\n  backend \"azurerm\"<\/span> {\n    resource_group_name  = \"eksuw01-rg\"<\/span>\n    storage_account_name = \"eksuw01sa\"<\/span>\n    container_name       = \"rajesh\"<\/span>\n    key                  = \"prod.terraform.tfstate\"<\/span>\n\tsubscription_id = \"b3dbe884-c3dc\"<\/span>\n    client_id       = \"6046fe74-dfd2-4\"<\/span>\n    client_secret   = \"3XJ8Q~uvlwVL\"<\/span>\n    tenant_id       = \"f34c8fc4-16b\"<\/span>\n  }\n}\nprovider \"azurerm\"<\/span> {\n  features {}\n  subscription_id = \"b3dbe884c\"<\/span>\n  client_id       = \"6046fe74-d\"<\/span>\n  client_secret   = \"3XJ8Q~uvlwV\"<\/span>\n  tenant_id       = \"f34c8fc4-1\"<\/span>\n}<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
                                      \n","protected":false},"excerpt":{"rendered":"
                                      Terraform is a popular open-source infrastructure as code tool used to create and manage infrastructure resources. The state of the infrastructure resources managed by Terraform is stored in a backend,… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-32467","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/32467","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=32467"}],"version-history":[{"count":6,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/32467\/revisions"}],"predecessor-version":[{"id":40901,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/32467\/revisions\/40901"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=32467"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=32467"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=32467"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}