diff --git a/docs/guides/get-started.md b/docs/guides/get-started.md index e976f415..404235e7 100644 --- a/docs/guides/get-started.md +++ b/docs/guides/get-started.md @@ -163,16 +163,16 @@ Do you want to perform these actions? Enter a value: yes astro_workspace.my_first_tf_workspace: Creating... -astro_workspace.my_first_tf_workspace: Creation complete after 0s [id=clxn24vhy0as101ohmeg9i72o] +astro_workspace.my_first_tf_workspace: Creation complete after 0s [id=<workspace-id>] astro_deployment.my_first_tf_deployment: Creating... -astro_deployment.my_first_tf_deployment: Creation complete after 1s [id=clxn24vs00afv01ot12ph6ejb] +astro_deployment.my_first_tf_deployment: Creation complete after 1s [id=<deployment-id>] Apply complete! Resources: 2 added, 0 changed, 0 destroyed. Outputs: -terraform_deployment = "clxn24vs00afv01ot12ph6ejb" -terraform_workspace = "clxn24vhy0as101ohmeg9i72o" +terraform_deployment = "<deployment-id>" +terraform_workspace = "<workspace-id>" ``` The resources were created and will now be visible in Astro. @@ -181,9 +181,9 @@ Run `terraform destroy` and select `yes`: ``` $ terraform destroy astro_workspace.my_first_tf_workspace: Refreshing state... - [id=clxn24vhy0as101ohmeg9i72o] + [id=<workspace-id>] astro_deployment.my_first_tf_deployment: Refreshing state... - [id=clxn24vs00afv01ot12ph6ejb] + [id=<deployment-id>] Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols: - destroy @@ -195,8 +195,8 @@ Terraform will perform the following actions: Plan: 0 to add, 0 to change, 2 to destroy. Changes to Outputs: - - terraform_deployment = "clxn24vs00afv01ot12ph6ejb" -> null - - terraform_workspace = "clxn24vhy0as101ohmeg9i72o" -> null + - terraform_deployment = "<deployment-id>" -> null + - terraform_workspace = "<workspace-id>" -> null Do you really want to destroy all resources? Terraform will destroy all your managed infrastructure, as shown above. @@ -205,10 +205,10 @@ Do you really want to destroy all resources? Enter a value: yes astro_deployment.my_first_tf_deployment: Destroying... - [id=clxn24vs00afv01ot12ph6ejb] + [id=<deployment-id>] astro_deployment.my_first_tf_deployment: Destruction complete after 1s astro_workspace.my_first_tf_workspace: Destroying... - [id=clxn24vhy0as101ohmeg9i72o] + [id=<workspace-id>] astro_workspace.my_first_tf_workspace: Destruction complete after 0s Destroy complete! Resources: 2 destroyed. diff --git a/docs/guides/import-script.md b/docs/guides/import-script.md index eda35e86..f5204d15 100644 --- a/docs/guides/import-script.md +++ b/docs/guides/import-script.md @@ -28,7 +28,7 @@ In this guide, we will migrate an existing Workspace, API token and Team into Te ## Step 2: Run the Import Script --> Make sure you run `terraform init` before using the import script, or use the `-runTerraformInit` option when running the import script. +-> Make sure you run `terraform init` before using the Import Script, or use the `-runTerraformInit` option when running the Import Script. 1. Authenticate with Astro by creating an [API token](https://www.astronomer.io/docs/astro/organization-api-tokens#create-an-organization-api-token) with the **organization owner** role and configure it as an `ASTRO_API_TOKEN` environment variable: ``` @@ -39,7 +39,7 @@ export ASTRO_API_TOKEN=<your-api-token> ``` chmod +x terraform-provider-astro-import-script_<version-number>_<os>_<arc> ``` -3. Run the import script. Insert the script's version, your computer's operating system, and your computer's architecture for ``, `` and ``. +3. Run the Import Script. Insert the script's version, your computer's operating system, and your computer's architecture for ``, `` and ``. - On Unix-based systems: ``` @@ -75,7 +75,7 @@ Successfully wrote import configuration to import.tf Successfully deleted generated.tf terraform.tfstate does not exist, no need to delete astro_team.team_<team-id>: Preparing import... [id=<team-id>] -astro_api_token.api_token_cm2c9slvb08p601n3lb4jljps: Preparing import... [id=cm2c9slvb08p601n3lb4jljps] +astro_api_token.api_token_<api_token-id>: Preparing import... [id=<api_token-id>] astro_workspace.workspace_<workspace-id>: Preparing import... [id=<workspace-id>] astro_workspace.workspace_<workspace-id>: Refreshing state... [id=<workspace-id>] astro_api_token.api_token_<api_token-id>: Refreshing state... [id=<api_token-id>] @@ -106,7 +106,7 @@ The script will generate two main files: The generated Terraform configurations may require some manual adjustment to match your specific requirements or to resolve any conflicts. ## Step 4: Extract and organize resources -The `generated.tf` file that is created by the import script will contain all of the specified resources in one file. It is recommended that you extract and modularize the resources so they are easily maintained and reusable. This is an example of a well structured Terraform project for managing Astro infrastructure: +The `generated.tf` file that is created by the Import Script will contain all of the specified resources in one file. It is recommended that you extract and modularize the resources so they are easily maintained and reusable. This is an example of a well structured Terraform project for managing Astro infrastructure: ``` terraform-astro-project/ ├── environments/