OSDOCS#10176: Updates to Terraform files by EricPonvelle · Pull Request #77311 · openshift/openshift-docs

EricPonvelle · 2024-06-11T17:12:39Z

Version(s):
enterprise-4.15+

Link to docs preview:

~~Preparing Terraform to install ROSA clusters~~ This preparing topic has been hidden. The content was added to each installation guide. We can use this idea to structure a Installation Tools topic.
Creating a default ROSA (classic architecture) cluster using Terraform
Creating a default ROSA cluster using Terraform (HCP)
Miscellaneous changes:
- Renamed the original terraform document from rosa-sts-creating-a-cluster-quickly-terraform to rosa-classic-creating-a-cluster-quickly-terraform

QE review:

QE has approved this change.

Additional information:
This PR updates the Terraform files for ROSA (classic architecture) and introduces Terraform for ROSA that uses HCP.

ocpdocs-previewbot · 2024-06-11T17:18:58Z

🤖 Tue Jun 25 19:32:40 - Prow CI generated the docs preview:

https://77311--ocpdocs-pr.netlify.app/
https://77311--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_getting_started/rosa-quickstart-guide-ui.html
https://77311--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.html
https://77311--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.html
https://77311--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.html
https://77311--ocpdocs-pr.netlify.app/openshift-rosa/latest/rosa_install_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.html

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-with-customizations-terraform.adoc

...tall_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.adoc

jneczypor

This is really good for such a large PR! Just a few tiny fixes. Most of my comments and questions revolve around the new naming system for ROSA (classic architecture) and ROSA. You may want to find out how often we are supposed to use parenthetical clarification of (classic architecture). Is it at every mention of ROSA? Just first mention? Will this change when our docs are separate? Now, Classic and HCP is mixed together so we may want to over-clarify a bit to ensure our users know they are on the correct product page. That will involve a lot of conditionalizing, especially in the modules where there is the most re-use. When we have separate docs, it may be less of an issue. Additionally, we will need to inform all our stakeholders and OCP review teams of this change and our guidelines for the name so that they can help us catch the ones we miss.

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.adoc

modules/rosa-classic-cluster-terraform-file-creation.adoc

...tall_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.adoc

snippets/terraform-modification-disclaimer.adoc

...delete_clusters/terraform/rosa-classic-creating-a-cluster-with-customizations-terraform.adoc

JoeAldinger

Some questions and a few suggestions.

JoeAldinger · 2024-06-25T12:25:13Z

_topic_maps/_topic_map_rosa.yml

 - Name: Creating a ROSA cluster with STS using customizations
  File: rosa-sts-creating-a-cluster-with-customizations
- Name: Creating a ROSA cluster with STS using Terraform
+- Name: Creating a ROSA (classic architecture) cluster using Terraform


I'm not sure how the rule about parenthetical expressions applies to naming here, but I wanted to point it out.

There are examples in our docs of parentheticals being used in the topic map, usually smaller stuff like (STS) though. This is probably fine

JoeAldinger · 2024-06-25T12:30:48Z

modules/rosa-classic-cluster-terraform-file-creation.adoc

+#
+# Copyright (c) 2023 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");


I don't think I've ever seen this in the repo where the apache license information is given as part of a code sample. I doubled checked and couldn't find it like this anywhere else. Again, not saying this is wrong just pointing it out.

modules/rosa-classic-cluster-terraform-file-creation.adoc

modules/rosa-hcp-cluster-terraform-file-creation.adoc

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

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.adoc

...delete_clusters/terraform/rosa-classic-creating-a-cluster-with-customizations-terraform.adoc

...tall_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.adoc

...delete_clusters/terraform/rosa-classic-creating-a-cluster-with-customizations-terraform.adoc

openshift-ci · 2024-06-25T19:34:02Z

@EricPonvelle: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

ShaunaDiaz · 2024-06-26T10:23:25Z

@EricPonvelle I don't see QE or SME ack on this PR. Do you those?

stevsmit · 2024-06-26T12:35:33Z

_topic_maps/_topic_map_rosa.yml

 - Name: Creating a ROSA cluster with STS using customizations
  File: rosa-sts-creating-a-cluster-with-customizations
- Name: Creating a ROSA cluster with STS using Terraform
+- Name: Creating a ROSA (classic architecture) cluster using Terraform


There are examples in our docs of parentheticals being used in the topic map, usually smaller stuff like (STS) though. This is probably fine

stevsmit · 2024-06-26T12:37:38Z

modules/rosa-classic-cluster-terraform-file-creation.adoc

+[id="rosa-classic-cluster-terraform-file-creation_{context}"]
+= Creating your Terraform files locally
+
+After you set up your link:https://console.redhat.com/openshift/token/rosa[offline {cluster-manager-first} token], you need to create the Terraform files locally to build your cluster. You can create these files by using the following code templates.


Is "must" too restrictive here?

https://www.ibm.com/docs/en/ibm-style?topic=word-usage#need-to

stevsmit · 2024-06-26T14:36:01Z

@EricPonvelle Good work! Merging now. No glaring issues or anything like that.

stevsmit · 2024-06-26T14:36:31Z

/cherry-pick enterprise-4.15

stevsmit · 2024-06-26T14:36:35Z

/cherry-pick enterprise-4.16

openshift-cherrypick-robot · 2024-06-26T14:37:18Z

@stevsmit: #77311 failed to apply on top of branch "enterprise-4.15":

Applying: OSDOCS#10177: Updates to Terraform files
.git/rebase-apply/patch:474: trailing whitespace.
    
.git/rebase-apply/patch:697: trailing whitespace.
  Enter a value: 
.git/rebase-apply/patch:703: trailing whitespace.
  Enter a value: 
.git/rebase-apply/patch:788: trailing whitespace.
  Enter a value: 
.git/rebase-apply/patch:793: trailing whitespace.
  Enter a value: 
warning: 5 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map_rosa.yml
M	modules/rosa-sts-cluster-terraform-file-creation.adoc
M	modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc
Falling back to patching base and 3-way merge...
Removing rosa_install_access_delete_clusters/terraform/rosa-sts-creating-a-cluster-quickly-terraform.adoc
Auto-merging modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc
CONFLICT (content): Merge conflict in modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc
CONFLICT (modify/delete): modules/rosa-sts-cluster-terraform-file-creation.adoc deleted in OSDOCS#10177: Updates to Terraform files and modified in HEAD. Version HEAD of modules/rosa-sts-cluster-terraform-file-creation.adoc left in tree.
Auto-merging _topic_maps/_topic_map_rosa.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 OSDOCS#10177: Updates to Terraform files
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherry-pick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2024-06-26T14:37:24Z

@stevsmit: new pull request created: #78104

Details

In response to this:

/cherry-pick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

radtriste

@EricPonvelle See my post merge review (sorry for the delay ...)

radtriste · 2024-06-27T12:38:26Z

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.adoc

+[discrete]
+include::modules/rosa-sts-terraform-considerations.adoc[leveloffset=+1]
+
+include::modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc[leveloffset=+1]


Some cluster specifications has no sense in HCP, like:

Control plane node configuration component

Infrastructure plane node configuration component

Cluster settings -> Default EC2 IMDS endpoints

Encryption -> No KMS key encryption by default

@radtriste Do I need to remove the first two items from the HCP flavors of the table? I created this PR that covers the items that I missed with your review: #78211

radtriste · 2024-06-27T13:02:30Z

modules/rosa-classic-cluster-terraform-file-creation.adoc

+# limitations under the License.
+#
+module "vpc" {
+  source  = "terraform-aws-modules/vpc/aws"


Do we want the customer to use the classic modules with BYOVPC as example ?
Because I would rather use rosa-classic vpc submodule to create the VPC

@andyrepton should I update the VPC modules?

radtriste · 2024-06-27T13:03:53Z

modules/rosa-hcp-cluster-terraform-file-creation.adoc

+# limitations under the License.
+#
+module "vpc" {
+  source  = "terraform-aws-modules/vpc/aws"


ROSA HCP should use the rosa-hcp VPC submodule
One example can be found on the repository: https://github.com/terraform-redhat/terraform-rhcs-rosa-hcp/blob/v1.6.2/examples/rosa-hcp-public/main.tf#L51

@andyrepton should I update the VPC modules?

radtriste · 2024-06-27T13:28:08Z

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.adoc

+* All other AWS resources required to create a ROSA with STS cluster
+
+include::modules/rosa-terraform-overview.adoc[leveloffset=+1]
+include::modules/rosa-sts-terraform-prerequisites.adoc[leveloffset=+1]


This file contains See the Additional resources for more information on the AWS account roles. but I cannot find those additional resources

@radtriste updated that mistake in this PR as well: #78211

EricPonvelle added branch/enterprise-4.15 branch/enterprise-4.16 labels Jun 11, 2024

openshift-ci bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jun 11, 2024

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch 4 times, most recently from 7187fce to 60f8467 Compare June 12, 2024 19:10

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 12, 2024

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch 5 times, most recently from ee27d9e to ef14f03 Compare June 13, 2024 21:14

openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 13, 2024

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch 2 times, most recently from cb239a2 to f8c1a35 Compare June 13, 2024 21:39

ocpdocs-vale-bot reviewed Jun 13, 2024

View reviewed changes

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-with-customizations-terraform.adoc Outdated Show resolved Hide resolved

ocpdocs-vale-bot reviewed Jun 13, 2024

View reviewed changes

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-with-customizations-terraform.adoc Outdated Show resolved Hide resolved

ocpdocs-vale-bot reviewed Jun 13, 2024

View reviewed changes

rosa_hcp/terraform/rosa-hcp-creating-a-cluster-with-customizations-terraform.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Jun 13, 2024

View reviewed changes

...tall_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.adoc Outdated Show resolved Hide resolved

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch from f8c1a35 to e3f9c62 Compare June 13, 2024 21:50

jneczypor reviewed Jun 13, 2024

View reviewed changes

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch 3 times, most recently from 114ecf4 to 35aefda Compare June 14, 2024 22:04

ocpdocs-vale-bot reviewed Jun 14, 2024

View reviewed changes

...delete_clusters/terraform/rosa-classic-creating-a-cluster-with-customizations-terraform.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Jun 14, 2024

View reviewed changes

...delete_clusters/terraform/rosa-classic-creating-a-cluster-with-customizations-terraform.adoc Show resolved Hide resolved

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch from 84addea to c9a10a6 Compare June 24, 2024 16:57

EricPonvelle added the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 24, 2024

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch 2 times, most recently from f3c5d25 to 199ad4a Compare June 24, 2024 18:45

JoeAldinger added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 24, 2024

JoeAldinger reviewed Jun 25, 2024

View reviewed changes

JoeAldinger added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jun 25, 2024

OSDOCS#10177: Updates to Terraform files

01c73e4

EricPonvelle force-pushed the OSDOCS-10177_Terraform-Updates branch from 199ad4a to 01c73e4 Compare June 25, 2024 19:24

EricPonvelle added the merge-review-needed Signifies that the merge review team needs to review this PR label Jun 25, 2024

stevsmit added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jun 26, 2024

stevsmit added this to the Continuous Release milestone Jun 26, 2024

stevsmit reviewed Jun 26, 2024

View reviewed changes

stevsmit merged commit df38a71 into openshift:main Jun 26, 2024

openshift-cherrypick-robot mentioned this pull request Jun 26, 2024

[enterprise-4.16] OSDOCS#10177: Updates to Terraform files #78104

Merged

EricPonvelle mentioned this pull request Jun 26, 2024

[enterprise-4.15] OSDOCS#10177: Updates to Terraform files #78109

Merged

EricPonvelle deleted the OSDOCS-10177_Terraform-Updates branch June 26, 2024 16:36

radtriste reviewed Jun 27, 2024

View reviewed changes

EricPonvelle mentioned this pull request Jun 27, 2024

Terraform Post-Merge Clean-up #78211

Merged

EricPonvelle changed the title ~~OSDOCS#10177: Updates to Terraform files~~ OSDOCS#10176: Updates to Terraform files Jul 3, 2024

Conversation

EricPonvelle commented Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jun 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jneczypor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoeAldinger left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci bot commented Jun 25, 2024

Uh oh!

ShaunaDiaz commented Jun 26, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevsmit commented Jun 26, 2024

Uh oh!

stevsmit commented Jun 26, 2024

Uh oh!

stevsmit commented Jun 26, 2024

Uh oh!

openshift-cherrypick-robot commented Jun 26, 2024

Uh oh!

openshift-cherrypick-robot commented Jun 26, 2024

Uh oh!

radtriste left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EricPonvelle commented Jun 11, 2024 •

edited

Loading

ocpdocs-previewbot commented Jun 11, 2024 •

edited

Loading