|
| 1 | +--- |
| 2 | +title: Deploy with Terraform with Bash in Azure Cloud Shell | Microsoft Docs |
| 3 | +description: Deploy Azure resources with Terraform in Bash |
| 4 | +services: Azure |
| 5 | +documentationcenter: '' |
| 6 | +author: jluk |
| 7 | +manager: timlt |
| 8 | +tags: azure-cloud-shell |
| 9 | + |
| 10 | +ms.service: azure |
| 11 | +ms.workload: infrastructure-services |
| 12 | +ms.tgt_pltfrm: vm-linux |
| 13 | +ms.devlang: na |
| 14 | +ms.topic: article |
| 15 | +ms.date: 11/13/2017 |
| 16 | +ms.author: juluk |
| 17 | +--- |
| 18 | + |
| 19 | +# Terraform and Bash in Cloud Shell |
| 20 | +This article walks you through creating a resource group with the [Terraform AzureRM provider](https://www.terraform.io/docs/providers/azurerm/index.html). |
| 21 | + |
| 22 | +[Hashicorp Terraform](https://www.terraform.io/) is an open source tool that codifies APIs into declarative configuration files that can be shared amongst team members to be edited, reviewed, and versioned. The Microsoft AzureRM provider is used to interact with resources supported by Azure Resource Manager via the AzureRM APIs. |
| 23 | + |
| 24 | +## Automatic authentication |
| 25 | +Terraform is installed in Bash in Cloud Shell by default. Additionally, Cloud Shell automatically authenticates your default Azure CLI 2.0 subscription to deploy resources through the Terraform Azure modules. |
| 26 | + |
| 27 | +Terraform uses the default Azure CLI 2.0 subscription that is set. To update default subscriptions, run: |
| 28 | + |
| 29 | +```azurecli-interactive |
| 30 | +az account set --subscription mySubscriptionName |
| 31 | +``` |
| 32 | + |
| 33 | +## Walkthrough |
| 34 | +### Launch Bash in Cloud Shell |
| 35 | +1. Launch Cloud Shell from your preferred location |
| 36 | +2. Verify your preferred subscription is set |
| 37 | + |
| 38 | +```azurecli-interactive |
| 39 | +az account show |
| 40 | +``` |
| 41 | + |
| 42 | +### Create a Terraform template |
| 43 | +Create a new Terraform template named main.tf with your preferred text editor. |
| 44 | + |
| 45 | +``` |
| 46 | +vim main.tf |
| 47 | +``` |
| 48 | + |
| 49 | +Copy/paste the following code into Cloud Shell. |
| 50 | + |
| 51 | +``` |
| 52 | +resource "azurerm_resource_group" "myterraformgroup" { |
| 53 | + name = "myRgName" |
| 54 | + location = "West US" |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +Save your file and exit your text editor. |
| 59 | + |
| 60 | +### Terraform init |
| 61 | +Begin by running `terraform init`. |
| 62 | + |
| 63 | +``` |
| 64 | +justin@Azure:~$ terraform init |
| 65 | +
|
| 66 | +Initializing provider plugins... |
| 67 | +
|
| 68 | +The following providers do not have any version constraints in configuration, |
| 69 | +so the latest version was installed. |
| 70 | +
|
| 71 | +To prevent automatic upgrades to new major versions that may contain breaking |
| 72 | +changes, it is recommended to add version = "..." constraints to the |
| 73 | +corresponding provider blocks in configuration, with the constraint strings |
| 74 | +suggested below. |
| 75 | +
|
| 76 | +* provider.azurerm: version = "~> 0.2" |
| 77 | +
|
| 78 | +Terraform has been successfully initialized! |
| 79 | +
|
| 80 | +You may now begin working with Terraform. Try running "terraform plan" to see |
| 81 | +any changes that are required for your infrastructure. All Terraform commands |
| 82 | +should now work. |
| 83 | +
|
| 84 | +If you ever set or change modules or backend configuration for Terraform, |
| 85 | +rerun this command to reinitialize your working directory. If you forget, other |
| 86 | +commands will detect it and remind you to do so if necessary. |
| 87 | +``` |
| 88 | + |
| 89 | +The [terraform init command](https://www.terraform.io/docs/commands/init.html) is used to initialize a working directory containing Terraform configuration files. The `terraform init` command is the first command that should be run after writing a new Terraform configuration or cloning an existing one from version control. It is safe to run this command multiple times. |
| 90 | + |
| 91 | +### Terraform plan |
| 92 | +Preview the resources to be created by the Terraform template with `terraform plan`. |
| 93 | + |
| 94 | +``` |
| 95 | +justin@Azure:~$ terraform plan |
| 96 | +Refreshing Terraform state in-memory prior to plan... |
| 97 | +The refreshed state will be used to calculate this plan, but will not be |
| 98 | +persisted to local or remote state storage. |
| 99 | +
|
| 100 | +
|
| 101 | +------------------------------------------------------------------------ |
| 102 | +
|
| 103 | +An execution plan has been generated and is shown below. |
| 104 | +Resource actions are indicated with the following symbols: |
| 105 | + + create |
| 106 | +
|
| 107 | +Terraform will perform the following actions: |
| 108 | +
|
| 109 | + + azurerm_resource_group.demo |
| 110 | + id: <computed> |
| 111 | + location: "westus" |
| 112 | + name: "myRGName" |
| 113 | + tags.%: <computed> |
| 114 | +
|
| 115 | +
|
| 116 | +Plan: 1 to add, 0 to change, 0 to destroy. |
| 117 | +
|
| 118 | +------------------------------------------------------------------------ |
| 119 | +
|
| 120 | +Note: You didn't specify an "-out" parameter to save this plan, so Terraform |
| 121 | +can't guarantee that exactly these actions will be performed if |
| 122 | +"terraform apply" is subsequently run. |
| 123 | +``` |
| 124 | + |
| 125 | +The [terraform plan command](https://www.terraform.io/docs/commands/plan.html) is used to create an execution plan. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files. The plan can be saved using -out, and then provided to terraform apply to ensure only the pre-planned actions are executed. |
| 126 | + |
| 127 | +### Terraform apply |
| 128 | +Provision the Azure resources with `terraform apply`. |
| 129 | + |
| 130 | +``` |
| 131 | +justin@Azure:~$ terraform apply |
| 132 | +azurerm_resource_group.demo: Creating... |
| 133 | + location: "" => "westus" |
| 134 | + name: "" => "myRGName" |
| 135 | + tags.%: "" => "<computed>" |
| 136 | +azurerm_resource_group.demo: Creation complete after 0s (ID: /subscriptions/mySubIDmysub/resourceGroups/myRGName) |
| 137 | +
|
| 138 | +Apply complete! Resources: 1 added, 0 changed, 0 destroyed. |
| 139 | +``` |
| 140 | + |
| 141 | +The [terraform apply command](https://www.terraform.io/docs/commands/apply.html) is used to apply the changes required to reach the desired state of the configuration. |
| 142 | + |
| 143 | +### Verify deployment with Azure CLI 2.0 |
| 144 | +Run `az group show -n myRgName` to verify the resource has succeeded provisioning. |
| 145 | + |
| 146 | +```azcliinteractive |
| 147 | +az group show -n myRgName |
| 148 | +``` |
| 149 | + |
| 150 | +### Clean up with terraform destroy |
| 151 | +Clean up the resource group created with the [Terraform destroy command](https://www.terraform.io/docs/commands/destroy.html) to clean up Terraform-created infrastructure. |
| 152 | + |
| 153 | +``` |
| 154 | +justin@Azure:~$ terraform destroy |
| 155 | +azurerm_resource_group.demo: Refreshing state... (ID: /subscriptions/mySubID/resourceGroups/myRGName) |
| 156 | +
|
| 157 | +An execution plan has been generated and is shown below. |
| 158 | +Resource actions are indicated with the following symbols: |
| 159 | + - destroy |
| 160 | +
|
| 161 | +Terraform will perform the following actions: |
| 162 | +
|
| 163 | + - azurerm_resource_group.demo |
| 164 | +
|
| 165 | +
|
| 166 | +Plan: 0 to add, 0 to change, 1 to destroy. |
| 167 | +
|
| 168 | +Do you really want to destroy? |
| 169 | + Terraform will destroy all your managed infrastructure, as shown above. |
| 170 | + There is no undo. Only 'yes' will be accepted to confirm. |
| 171 | +
|
| 172 | + Enter a value: yes |
| 173 | +
|
| 174 | +azurerm_resource_group.demo: Destroying... (ID: /subscriptions/mySubID/resourceGroups/myRGName) |
| 175 | +azurerm_resource_group.demo: Still destroying... (ID: /subscriptions/mySubID/resourceGroups/myRGName, 10s elapsed) |
| 176 | +azurerm_resource_group.demo: Still destroying... (ID: /subscriptions/mySubID/resourceGroups/myRGName, 20s elapsed) |
| 177 | +azurerm_resource_group.demo: Still destroying... (ID: /subscriptions/mySubID/resourceGroups/myRGName, 30s elapsed) |
| 178 | +azurerm_resource_group.demo: Still destroying... (ID: /subscriptions/mySubID/resourceGroups/myRGName, 40s elapsed) |
| 179 | +azurerm_resource_group.demo: Destruction complete after 45s |
| 180 | +
|
| 181 | +Destroy complete! Resources: 1 destroyed. |
| 182 | +``` |
| 183 | + |
| 184 | +You have successfully created an Azure resource through Terraform. Visit next steps to continue learning about Cloud Shell. |
| 185 | + |
| 186 | +## Next steps |
| 187 | +[Learn about the Terraform Azure provider](https://www.terraform.io/docs/providers/azurerm/#)<br> |
| 188 | +[Bash in Cloud Shell quickstart](quickstart.md) |
0 commit comments