OSDOCS#10177: ROSA Terraform Tutorials and Enhancements #77742

EricPonvelle · 2024-06-20T13:24:33Z

Version:
Enterprise-4.16+

Link to docs preview:

QE review:

QE has approved this change.

Additional information:
This PR builds on my Terraform updates in #77311 and creates Terraform tutorials. This content should cover guides for the following topics, for both ROSA classic and ROSA with HCP:

Creating environmental variables for OpenShift resources - Setting environmental variables for your OpenShift resources
Overview of Terraform similar to Kubernetes overview and OpenShift Container Platform overview
OSDOCS-9241: Cluster admin role created Classic only
OSDOCS-9243: Node labels
~~OSDOCS-9245: VPC~~ Covered with the HCP updates
~~OSDOCS-9246: Control plane node, infrastructure node, and compute node type and count~~ Not supported on ROSA with HCP clusters since there are no infrastructure and control plane nodes.
~~OSDOCS-9248: Cluster privacy - public vs. private?~~ Created this guide section to create a private ROSA with HCP cluster. I also updated the overview table for both Classic and HCP to add a default to private_cluster as false. Now, the default clusters are public clusters.
OSDOCS-9249: Autoscaling enabled
OSDOCS-9250: Cluster-wide proxy
OSDOCS-9252: Availability zones: multi-zone, single zone, local zones
OSDOCS-9253: Additional etcd encryption is enabled?
OSDOCS-9254: AWS key management key?

EricPonvelle · 2024-06-20T13:31:32Z

/re-test

EricPonvelle · 2024-06-20T13:53:02Z

/test validate-asciidoc

EricPonvelle · 2024-06-20T13:59:09Z

/re-test

EricPonvelle · 2024-06-20T14:44:28Z

/re-test

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

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

ocpdocs-previewbot · 2024-06-20T18:54:26Z

🤖 Thu Oct 24 19:42:24 - Prow CI generated the docs preview:

jerichokeyne · 2024-08-12T20:45:27Z

modules/terraform-guide-autoscaling.adoc

+In your `variables.tf` file, set the default value to `true`:
+
+[source,terminal]
+----


Should this be empty?

jerichokeyne · 2024-08-14T20:49:48Z

snippets/terraform-apply.adoc

+[source,terminal]
+----
+Success! The configuration is valid.
+----


Could also be worth at least mentioning that you can use terraform plan to see what terraform will do without worrying about it doing anything

jerichokeyne · 2024-08-14T20:52:34Z

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

  count = var.create_vpc ? 1 : 0
-  depends_on = [module.vpc]
-  create_duration = "60s"
-}


This curly brace is required for this to be a valid terraform file

jerichokeyne · 2024-08-14T20:54:33Z

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

-    
-  depends_on = [time_sleep.wait_60_seconds]
-}
 EOF


The curly brace here is also required. Also, seems strange to remove the depends_on for the wait_60_seconds, especially if you're going to leave that resource

jerichokeyne · 2024-08-14T21:04:37Z

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

 +
 [source,terminal]
 ----
-$ cat<<-EOF>variables.tf


This part of the command is required for it to work

jerichokeyne · 2024-08-14T21:06:23Z

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

-  cluster_name           = local.cluster_name
-  openshift_version      = var.openshift_version


These two options are required for the module to work. Seems a bit weird to get rid of the other options as well

jerichokeyne · 2024-08-14T21:07:37Z

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

  source                 = "terraform-redhat/rosa-hcp/rhcs"
  version                = "1.6.2"
  cluster_name           = local.cluster_name
-  openshift_version      = var.openshift_version


This option is required for the module to work

jerichokeyne · 2024-08-14T21:10:19Z

modules/terraform-guide-env-variables.adoc

+
+[source,terminal]
+----
+$ export <1> = <2>


Suggested change

$ export <1> = <2>

$ export <1>=<2>

Spaces between the variable name and value are not supported in bash, so probably better to not include the spaces here

bergerhoffer · 2024-10-14T14:57:06Z

The branch/enterprise-4.18 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.17. And any PR going into main must also target the latest version branch (enterprise-4.18).

If the update in your PR does NOT apply to version 4.18 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

ocpdocs-vale-bot · 2024-10-24T19:43:35Z

modules/terraform-guide-autoscaling.adoc

@@ -0,0 +1,13 @@
+// Module included in the following assemblies:


🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.

openshift-ci · 2024-10-24T19:43:43Z

@EricPonvelle: all tests passed!

Full PR test history. Your PR dashboard.

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.

openshift-bot · 2025-01-23T01:00:59Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-merge-robot · 2025-01-23T01:02:26Z

PR needs rebase.

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-bot · 2025-02-22T08:30:59Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

bergerhoffer · 2025-02-24T19:17:26Z

The branch/enterprise-4.19 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.18. And any PR going into main must also target the latest version branch (enterprise-4.19).

If the update in your PR does NOT apply to version 4.19 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

openshift-bot · 2025-03-27T00:00:26Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2025-03-27T00:01:02Z

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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.

EricPonvelle added do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. branch/enterprise-4.15 branch/enterprise-4.16 labels Jun 20, 2024

EricPonvelle requested a review from jneczypor June 20, 2024 13:24

openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 20, 2024

EricPonvelle mentioned this pull request Jun 20, 2024

OSDOCS#10176: Updates to Terraform files #77311

Merged

1 task

EricPonvelle force-pushed the ROSA-TF_Tutorials branch from a7dde1e to 5882052 Compare June 20, 2024 17:21

EricPonvelle closed this Jun 20, 2024

EricPonvelle reopened this Jun 20, 2024

EricPonvelle removed the request for review from jneczypor June 20, 2024 17:32

EricPonvelle force-pushed the ROSA-TF_Tutorials branch 4 times, most recently from 45a2de1 to e048d0e Compare June 20, 2024 18:47

ocpdocs-vale-bot reviewed Jun 20, 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 20, 2024

View reviewed changes

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

ocpdocs-vale-bot reviewed Jun 20, 2024

View reviewed changes

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

ocpdocs-vale-bot reviewed Jun 20, 2024

View reviewed changes

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

EricPonvelle force-pushed the ROSA-TF_Tutorials branch 7 times, most recently from ccf31bd to cd13e48 Compare June 20, 2024 20:18

EricPonvelle force-pushed the ROSA-TF_Tutorials branch 7 times, most recently from 805ace8 to cd679a2 Compare August 5, 2024 20:44

jerichokeyne reviewed Aug 14, 2024

View reviewed changes

bergerhoffer added the branch/enterprise-4.18 label Oct 14, 2024

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 14, 2024

POC: Created the general structure for Terraform tutorials

e74deec

EricPonvelle force-pushed the ROSA-TF_Tutorials branch from cd679a2 to e74deec Compare October 24, 2024 19:34

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 24, 2024

ocpdocs-vale-bot reviewed Oct 24, 2024

View reviewed changes

EricPonvelle removed the branch/enterprise-4.16 label Oct 24, 2024

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 23, 2025

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 23, 2025

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 22, 2025

bergerhoffer added the branch/enterprise-4.19 label Feb 24, 2025

openshift-ci bot closed this Mar 27, 2025

EricPonvelle deleted the ROSA-TF_Tutorials branch June 13, 2025 16:08

		cluster_name = local.cluster_name
		openshift_version = var.openshift_version

		@@ -0,0 +1,13 @@
		// Module included in the following assemblies:

OSDOCS#10177: ROSA Terraform Tutorials and Enhancements #77742

OSDOCS#10177: ROSA Terraform Tutorials and Enhancements #77742

Uh oh!

Conversation

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

Uh oh!

Uh oh!

EricPonvelle commented Jun 20, 2024

Uh oh!

EricPonvelle commented Jun 20, 2024

Uh oh!

EricPonvelle commented Jun 20, 2024

Uh oh!

EricPonvelle commented Jun 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

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!

bergerhoffer commented Oct 14, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Oct 24, 2024

Uh oh!

openshift-bot commented Jan 23, 2025

Uh oh!

openshift-merge-robot commented Jan 23, 2025

Uh oh!

openshift-bot commented Feb 22, 2025

Uh oh!

bergerhoffer commented Feb 24, 2025

Uh oh!

openshift-bot commented Mar 27, 2025

Uh oh!

openshift-ci bot commented Mar 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

EricPonvelle commented Jun 20, 2024 •

edited

Loading

ocpdocs-previewbot commented Jun 20, 2024 •

edited

Loading