Skip to content

Commit a1483ec

Browse files
authored
Merge pull request #73107 from EricPonvelle/OSDOCS-9957_Terraform-Disclaimer
OSDOCS-9957: Created a disclaimer in the Terraform docs about modifying resources
2 parents c5848c5 + 28c605d commit a1483ec

5 files changed

+24
-5
lines changed

modules/rosa-sts-account-roles-terraform.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,7 @@ endif::tf-full[]
1616

1717
The following example shows how Terraform can be used to create your Amazon Web Services (AWS) Identity and Access Management (IAM) account roles for ROSA.
1818

19-
[NOTE]
20-
====
21-
If you want to edit the Terraform files, you can use any text editor. You must re-run the `terraform init` and `terraform apply` commands if you change any values in the files.
22-
====
19+
include::snippets/terraform-modification-disclaimer.adoc[]
2320

2421
.Procedure
2522

modules/rosa-sts-cluster-terraform-execute.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ endif::[]
1212

1313
After you create the Terraform files, you must initiate Terraform to provide all of the required dependencies. Then apply the Terraform plan.
1414

15+
include::snippets/terraform-modification-disclaimer.adoc[]
16+
1517
.Procedure
1618

1719
. Set up Terraform to create your resources based on your Terraform files, run the following command:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_planning/rosa-understanding-terraform.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="rosa-sts-terraform-considerations_{context}"]
6+
= Considerations when using Terraform
7+
8+
In general, using Terraform to manage cloud resources should be done with the expectation that any changes should be done using the Terraform methodology. Use caution when using tools outside of Terraform, such as the AWS console or Red Hat console, to modify cloud resources created by Terraform. Using tools outside Terraform to manage cloud resources that are already managed by Terraform introduces configuration drift from your declared Terraform configuration.
9+
10+
For example, if you upgrade your Terraform-created cluster by using the {hybrid-console-url}, you need to reconcile your Terraform state before applying any forthcoming configuration changes. For more information, see link:https://developer.hashicorp.com/terraform/tutorials/state/state-cli[Manage resources in Terraform state] in the HashiCorp Developer documentation.

rosa_planning/rosa-understanding-terraform.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
22
include::_attributes/attributes-openshift-dedicated.adoc[]
3-
43
[id="rosa-understanding-terraform"]
54
= Preparing Terraform to install ROSA clusters
65
:context: rosa-understanding-terraform
@@ -10,6 +9,7 @@ toc::[]
109
Terraform is an infrastructure-as-code tool that provides a way to configure your resources once and replicate those resources as desired. Terraform accomplishes the creation tasks by using declarative language. You declare what you want the final state of the infrastructure resource to be, and Terraform creates these resources to your specifications.
1110

1211
include::modules/rosa-sts-terraform-prerequisites.adoc[leveloffset=+1]
12+
include::modules/rosa-sts-terraform-considerations.adoc[leveloffset=+1]
1313

1414
[discrete]
1515
[role="_additional-resources"]
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_install_access_delete_clusters/terraform/rosa-sts-creating-a-cluster-quickly-terraform.adoc
4+
// * rosa_planning/rosa-understanding-terraform.adoc
5+
6+
:_mod-docs-content-type: SNIPPET
7+
[IMPORTANT]
8+
====
9+
Do not modify Terraform state files. For more information, see link:https://docs.openshift.com/rosa/rosa_planning/rosa-understanding-terraform.html#rosa-sts-terraform-considerations_rosa-understanding-terraform[Considerations when using Terraform]
10+
====

0 commit comments

Comments
 (0)