Skip to content

Commit

Permalink
Update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yanmastin-astro committed Oct 22, 2024
1 parent 03cecc1 commit 4c88e5f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
20 changes: 10 additions & 10 deletions docs/guides/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&gt]
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&gt]
Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
Outputs:
terraform_deployment = "clxn24vs00afv01ot12ph6ejb"
terraform_workspace = "clxn24vhy0as101ohmeg9i72o"
terraform_deployment = "<deployment-id&gt"
terraform_workspace = "<workspace-id&gt"
```
The resources were created and will now be visible in Astro.

Expand All @@ -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&gt]
astro_deployment.my_first_tf_deployment: Refreshing state...
[id=clxn24vs00afv01ot12ph6ejb]
[id=<deployment-id&gt]
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
- destroy
Expand All @@ -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&gt" -> null
- terraform_workspace = "<workspace-id&gt" -> null
Do you really want to destroy all resources?
Terraform will destroy all your managed infrastructure, as shown above.
Expand All @@ -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&gt]
astro_deployment.my_first_tf_deployment: Destruction complete after 1s
astro_workspace.my_first_tf_workspace: Destroying...
[id=clxn24vhy0as101ohmeg9i72o]
[id=<workspace-id&gt]
astro_workspace.my_first_tf_workspace: Destruction complete after 0s
Destroy complete! Resources: 2 destroyed.
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/import-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
Expand All @@ -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 `<version-number>`, `<os>` and `<arc>`.
3. Run the Import Script. Insert the script's version, your computer's operating system, and your computer's architecture for `<version-number>`, `<os>` and `<arc>`.

- On Unix-based systems:
```
Expand Down Expand Up @@ -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_&lt;team-id&gt: Preparing import... [id=&lt;team-id&gt]
astro_api_token.api_token_cm2c9slvb08p601n3lb4jljps: Preparing import... [id=cm2c9slvb08p601n3lb4jljps]
astro_api_token.api_token_&lt;api_token-id&gt: Preparing import... [id=&lt;api_token-id&gt]
astro_workspace.workspace_&lt;workspace-id&gt: Preparing import... [id=&lt;workspace-id&gt]
astro_workspace.workspace_&lt;workspace-id&gt: Refreshing state... [id=&lt;workspace-id&gt]
astro_api_token.api_token_&lt;api_token-id&gt: Refreshing state... [id=&lt;api_token-id&gt]
Expand Down Expand Up @@ -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/
Expand Down

0 comments on commit 4c88e5f

Please sign in to comment.