Skip to content

Commit 1b75894

Browse files
committed
Almost done
1 parent 5796612 commit 1b75894

File tree

11 files changed

+146
-145
lines changed

11 files changed

+146
-145
lines changed

content/terraform-docs-common/data/cloud-docs-nav-data.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@
599599
"title": "Deploy infrastructure",
600600
"routes": [
601601
{ "title": "Configuration versions", "path": "stacks/deploy/configuration-versions" },
602-
{ "title": "Review deployment plans", "path": "stacks/deploy/plans" }
602+
{ "title": "Review deployment plans", "path": "stacks/deploy/runs" }
603603
]
604604
},
605605
{

content/terraform-docs-common/docs/cloud-docs/stacks/configure.mdx

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,29 @@ This guide explains configuring a Stack’s name, description, project, and VCS
1212

1313
To view a Stack and its configurations, you must also be a member of a team in your organization with one of the following permissions:
1414

15-
* [Organization-level **Manage all projects**](/terraform/cloud-docs/users-teams-organizations/permissions#manage-all-projects) or higher
15+
* [Organization-level **Manage all projects**](/terraform/cloud-docs/users-teams-organizations/permissions#manage-all-projects) or higher
1616
* [Project-level **Maintain**](/terraform/cloud-docs/users-teams-organizations/permissions#maintain) or higher
1717

1818
## Configure a Stack
1919

2020
You can configure a Stack by performing the following steps:
2121

2222
1. Sign in to [HCP Terraform](https://app.terraform.io) and select the organization that contains your Stack.
23-
1. In the navigation menu, click **Projects** under **Manage**.
24-
1. Select the project containing your Stack.
25-
1. Click **Stacks** in the navigation menu.
26-
1. Select the Stack you want to configure.
27-
1. Click **Stack settings** in the navigation menu.
28-
1. Update any of the following settings:
29-
* Name
30-
* Description
31-
* Project, learn about [moving a Stack to another project](/terraform/cloud-docs/stacks/configure#move-a-stack-to-another-project).
32-
* Version control settings, including:
33-
* Stacks automatically trigger new plans when you push them to your repositories’ default branch. To deactivate this behavior, uncheck **VCS Trigger Enabled**.
34-
* You can also configure Stacks to work from either a branch or tag-based workflow.
23+
1. In the navigation menu, select **Projects** under **Manage**.
24+
1. Select the project containing your Stack.
25+
1. Select the Stack you want to configure.
26+
1. Select **Settings** in the side navigation.
27+
1. Update any of the following settings:
28+
- Name
29+
- Description
30+
- Project, learn about [moving a Stack to another project](/terraform/cloud-docs/stacks/configure#move-a-stack-to-another-project).
31+
- Version control settings, including:
32+
- You can also view any linked VCS repository, add a VCS connection, change your source repository, or disconnect your Stack from VCS.
33+
- Stacks automatically trigger new runs when you push a configuration change to a linked repository. To stop HCP Terraform from automatically fetching configuration changes, toggle **VCS Trigger Enabled**.
34+
- You can enable or disable **Automatic speculative plans** to have your Stack create plan-only runs for pull requests to your linked VCS repository.
35+
- You can also configure Stacks to work from either a branch or tag-based workflow.
36+
- You can **Enable debug logging** to be able to download detailed logs from your Stack's runs.
37+
- You can change your Stack's **Execution mode** to either **Remote** or **Agent**. Refer to [Change execution mode](#change-execution-mode) to learn more.
3538
1. Click **Save settings** to apply your changes.
3639

3740
## Move a Stack to another project
@@ -40,6 +43,12 @@ To move a Stack, you must have the **Manage all Projects** organization permissi
4043

4144
Upstream Stacks must be in the same project as their downstream Stacks. Moving an upstream Stack to another project breaks any downstream Stack inputs, affecting future plans. Move upstream and downstream Stacks together to avoid disruptions. Learn more about [passing data from one Stack to another](/terraform/language/stacks/deploy/pass-data).
4245

46+
### Change execution mode
47+
48+
By default, HCP Terraform deploys infrastructure remotely using its own disposable virtual machines. This default execution mode is named **Remote** mode.
49+
50+
[HCP Terraform agents](/terraform/cloud-docs/agents/) let HCP Terraform communicate with isolated, private, or on-premises infrastructure. After setting up an agent and an agent pool, you can choose to change a Stack's execution mode to **Agent** to have HCP Terraform execute your Stack runs on an agent. To learn more about setting up agents, refer to [Install and run agents](/terraform/cloud-docs/agents/agents).
51+
4352
## Next steps
4453

45-
After configuring your Stack, you can learn more about how to [review your Stack’s deployment plans](/terraform/cloud-docs/stacks/deploy/plans) or [destroy your stack](/terraform/cloud-docs/stacks/destroy).
54+
After configuring your Stack, you can learn more about how to [review your Stack’s deployment runs](/terraform/cloud-docs/stacks/deploy/runs) or [destroy your Stack](/terraform/cloud-docs/stacks/destroy).

content/terraform-docs-common/docs/cloud-docs/stacks/create.mdx

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,13 @@ Stacks live alongside workspaces in a project. To create a new Stack in HCP Terr
4040
1. Sign in to [HCP Terraform](https://app.terraform.io), and select the organization that contains your Stack.
4141
1. In the navigation menu, click **Projects** under **Manage**.
4242
1. Select the project where you want to create your Stack.
43-
1. In the project's navigation menu, select **Stacks**.
44-
1. Click **+ New stack**.
43+
1. Click **New**, then **Stack**.
4544
1. Select a version control provider from the list.
4645
1. Choose an organization and repository from the filterable list. If your repository is missing, enter its ID in the text field below the list. The list only displays the first 100 repositories from your VCS provider.
4746
1. Enter a new **Stack Name**.
4847
* The name must be unique within the project and can include letters, numbers, dashes (`-`), and underscores (`_`). We recommend using 90 characters or less for the name of your Stack.
4948
1. You can optionally add a description for your Stack.
50-
1. You can optionally adjust your version control settings by expanding **Advanced Options.**
51-
* Stacks automatically trigger new plans when you push them to your repositories’ default branch. You can deactivate this by toggling the **VCS Trigger Enabled** setting.
52-
* You can configure Stacks to use either a branch or tag-based workflow.
53-
* By default, HCP Terraform fetches your Stack's configuration after creating your Stack. To fetch your Stack configuration manually, uncheck **Fetch configuration after HCP Terraform creates stack.**
49+
1. By default, HCP Terraform fetches your Stack's configuration after creating your Stack. To fetch your Stack configuration manually, uncheck **Fetch configuration after HCP Terraform creates stack**.
5450
1. Click **Create Stack**.
5551

5652
### Terraform CLI workflow
@@ -61,56 +57,60 @@ Stacks live alongside workspaces in an HCP Terraform project. To create a new St
6157
1. Run `terraform login` to authenticate with HCP Terraform. Alternatively, you can manually configure credentials in the CLI config file or through environment variables. Refer to [CLI Configuration](/terraform/cli/config/config-file#environment-variable-credentials) for details.
6258
1. Run the `terraform stacks create` command, replacing the placeholders with your organization name, project name, and desired Stack name:
6359

64-
```shell-session
65-
$ terraform stacks create -organization <ORGANIZATION_NAME> -project <PROJECT_NAME> -stack-name <STACK_NAME>
66-
```
60+
```shell-session
61+
$ terraform stacks create -organization <ORGANIZATION_NAME> -project <PROJECT_NAME> -stack-name <STACK_NAME>
62+
```
6763

68-
A Stack name must be unique within the project and can include letters, numbers, dashes (`-`), and underscores (`_`). We recommend using 90 characters or less for the name of your Stack.
64+
A Stack name must be unique within the project and can include letters, numbers, dashes (`-`), and underscores (`_`). We recommend using 90 characters or less for the name of your Stack.
6965

70-
After running the command, you can view your new Stack in the HCP Terraform UI, or by running the `terraform stacks list` command:
66+
1. After running the command, you can view your new Stack in the HCP Terraform UI, or by running the `terraform stacks list` command:
7167

72-
```shell-session
73-
$ terraform stacks list -organization <ORGANIZATION_NAME> -project <PROJECT_NAME>
74-
```
68+
```shell-session
69+
$ terraform stacks list -organization <ORGANIZATION_NAME> -project <PROJECT_NAME>
70+
```
7571

76-
After creating your Stack, you can push up your Stack component and deployment configuration files to create a new configuration version. Use the `terraform stacks configuration upload` command to manually upload your configuration files:
72+
1. After creating your Stack, you can push up your Stack component and deployment configuration files to create a new configuration version. Use the `terraform stacks configuration upload` command to manually upload your configuration files:
7773

78-
```shell-session
79-
$ terraform stacks configuration upload -organization <ORGANIZATION_NAME> -project <PROJECT_NAME> -stack-name <STACK_NAME>
80-
```
74+
```shell-session
75+
$ terraform stacks configuration upload -organization <ORGANIZATION_NAME> -project <PROJECT_NAME> -stack-name <STACK_NAME>
76+
```
8177

82-
The Terraform CLI uploads the configuration files, and returns a new configuration version ID and sequence number:
78+
The Terraform CLI uploads the configuration files, and returns a new configuration version ID and sequence number:
8379

84-
```shell-session
85-
Uploading stack configuration...
80+
```shell-session
81+
Uploading stack configuration...
8682
87-
Configuration for Stack (id: 'st-MLQLSJVrdtGazA4aU') was uploaded
88-
Configuration ID: stc-6fSRO81hOzTPKMM
89-
Sequence Number: 1
83+
Configuration for Stack (id: 'st-MLQLSJVrdtGazA4aU') was uploaded
84+
Configuration ID: stc-6fSRO81hOzTPKMM
85+
Sequence Number: 1
9086
91-
See run at: <URL>
92-
```
87+
See run at: <URL>
88+
```
9389

94-
A Stack configuration version is a snapshot of all of the pieces that make up your Stack. Each configuration version creates a deployment run for every deployment of your Stack in order to implement the changes in that version. To learn more, refer to [Stack deployment runs](/terraform/cloud-docs/stacks/runs).
90+
A Stack configuration version is a snapshot of all of the pieces that make up your Stack. Each configuration version creates a deployment run for every deployment of your Stack in order to implement the changes in that version. To learn more, refer to [Stack deployment runs](/terraform/cloud-docs/stacks/runs).
9591

96-
After uploading your configuration, you can watch your Stack's configuration roll out using `terraform stacks configuration watch` to review a list of the deployment groups in your configuration:
92+
After uploading your configuration, you can watch your Stack's configuration roll out using `terraform stacks configuration watch` to review a list of the deployment groups in your configuration:
9793

98-
```shell-session
99-
$ terraform stacks configuration watch -organization <ORGANIZATION_NAME> -project <PROJECT_NAME>
94+
```shell-session
95+
$ terraform stacks configuration watch -organization <ORGANIZATION_NAME> -project <PROJECT_NAME>
96+
```
10097

98+
The Terraform CLI then displays the status of each deployment group in your Stack:
10199

102-
[Stack Id: st-MLQLSJVrdtGazA4aU]
103-
✓ Configuration: 'stc-6fSRO81hOzTPKMM' [Completed] [11s]
104-
↻ Deployment Group: 'many_default' [Pending] [58s]
105-
↻ Deployment Group: 'some_default' [Pending] [58s]
106-
↻ Deployment Group: 'single_default' [Failed] [6s]
100+
```shell-session
107101
108-
Press q to quit
109-
```
102+
[Stack Id: st-MLQLSJVrdtGazA4aU]
103+
✓ Configuration: 'stc-6fSRO81hOzTPKMM' [Completed] [11s]
104+
↻ Deployment Group: 'many_default' [Pending] [58s]
105+
↻ Deployment Group: 'some_default' [Pending] [58s]
106+
↻ Deployment Group: 'single_default' [Failed] [6s]
110107
111-
You can continue to use the `terraform stacks` CLI commands to directly approve deployment runs, review configuration versions, and manage your Stack. To learn more, refer to the [`terraform stacks` commands](/terraform/cli/commands/stacks).
108+
Press q to quit
109+
```
112110

113-
Note that though you can create a Stack from the Terraform CLI, you cannot deploy a Stack locally. You can only deploy a Stack remotely in HCP Terraform, or by running your a Stack on a custom HCP Terraform agent. To learn more, refer to [Stack deployment runs](/terraform/cloud-docs/stacks/runs).
111+
You can continue to use the `terraform stacks` CLI commands to directly approve deployment runs, review configuration versions, and manage your Stack. To learn more, refer to the [`terraform stacks` commands](/terraform/cli/commands/stacks).
112+
113+
Note that though you can create a Stack from the Terraform CLI, you cannot deploy a Stack locally. You can only deploy a Stack remotely in HCP Terraform, or by running your a Stack on a custom HCP Terraform agent. To learn more, refer to [Stack deployment runs](/terraform/cloud-docs/stacks/runs).
114114

115115
## Next steps
116116

0 commit comments

Comments
 (0)