OSDOCS#10177: ROSA Terraform Tutorials and Enhancements #77742
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../_attributes/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
| [id="cloud-experts-cloud-experts-terraform-customization"] | ||
| = Tutorial: Customizing your cluster with Terraform | ||
| include::_attributes/attributes-openshift-dedicated.adoc[] | ||
| :context: cloud-experts-terraform-customization | ||
|
|
||
| toc::[] | ||
|
|
||
| You can customize your cluster with Terraform by using the following guides. This tutorial assumes that you have created your cluster using either xref:../../rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.adoc#rosa-hcp-creating-a-cluster-quickly-terraform[Creating a default ROSA cluster using Terraform] or xref:../../rosa_install_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.adoc#rosa-classic-creating-a-cluster-quickly-terraform[Creating a default {rosa-classic} cluster using Terraform] or link:https://registry.terraform.io/providers/terraform-redhat/rhcs/latest/docs[Terraform registry documentation]. | ||
|
|
||
| include::modules/terraform-guide-env-variables.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/terraform-guide-autoscaling.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/terraform-guide-private-clusters.adoc[leveloffset=+1] | ||
|
|
||
| [role="_additional-resources"] | ||
| [id="additional-resources_cloud-experts-terraform-customization"] | ||
| .Additional resources | ||
|
|
||
| * See link:https://registry.terraform.io/providers/terraform-redhat/rhcs/latest/docs[Terraform registry documentation]. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../images/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../modules/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../snippets/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // Module included in the following assemblies: | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable. |
||
| // | ||
| // * cloud_experts_tutorials/terraform/cloud-experts-terraform-customization.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCESS | ||
| [id="terraform-guide-autoscaling_{context}"] | ||
| = Enabling autoscaling on your cluster | ||
|
|
||
| In your `variables.tf` file, set the default value to `true`: | ||
|
|
||
| [source,terminal] | ||
| ---- | ||
|
|
||
| ---- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,67 @@ | ||||||
| // Module included in the following assemblies: | ||||||
| // | ||||||
| // * cloud_experts_tutorials/terraform/cloud-experts-terraform-customization.adoc | ||||||
|
|
||||||
| :_mod-docs-content-type: CONCEPT | ||||||
| [id="terraform-guide-env-variable_{context}"] | ||||||
| = Using environmental variables | ||||||
|
|
||||||
| You can use locally set variables to specify a value once and reuse that value later. | ||||||
|
|
||||||
| .Procedure | ||||||
|
|
||||||
| . Set an environment variable by running the following command: | ||||||
| + | ||||||
| [source,terminal] | ||||||
| ---- | ||||||
| $ export <1> = <2> | ||||||
|
There was a problem hiding this comment.
Suggested change
Spaces between the variable name and value are not supported in bash, so probably better to not include the spaces here |
||||||
| VARIABLE_NAME="VARIABLE_VALUE" | ||||||
| ---- | ||||||
| + | ||||||
| Your variable name and value can be any string. For example, if you want to consistently refer to your cluster's name, you run the following commad: | ||||||
| + | ||||||
| .Example input | ||||||
| [source,terminal] | ||||||
| ---- | ||||||
| $ export CLUSTER_NAME="rosa-cluster" | ||||||
| ---- | ||||||
|
|
||||||
| . Confirm the environment variable by running the following: | ||||||
| + | ||||||
| [source,terminal] | ||||||
| ---- | ||||||
| $ echo $<variable_name> | ||||||
|
Contributor
There was a problem hiding this comment. Again, maybe add a call out (1) here for "variable name" |
||||||
| ---- | ||||||
| + | ||||||
| .Example output | ||||||
|
Contributor
There was a problem hiding this comment. Again, maybe show both example input and example output. |
||||||
| [source,terminal] | ||||||
| ---- | ||||||
| $ echo $CLUSTER_NAME | ||||||
| $ rosa-cluster | ||||||
| ---- | ||||||
|
|
||||||
| [id="terraform-guide-env-variable-table_{context}"] | ||||||
| == Examples of variables used for OpenShift resources | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Use this table as a guideline for your own environment. The table is not a comprehensive model of all possible environment variables. | ||||||
|
|
||||||
| [cols="1,1"] | ||||||
| |=== | ||||||
| |Example variable name| Description | ||||||
|
|
||||||
| |CLUSTER_NAME | ||||||
| |This is the text-based string that you use as the name of your cluster. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| |AWS_REGION | ||||||
| |This is text-based string is the AWS region that you want to use for your resource. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| |ACCOUNT_ROLES_PREFIX | ||||||
| | | ||||||
|
|
||||||
| | | ||||||
| | | ||||||
|
|
||||||
| |=== | ||||||
|
|
||||||
| [id="terraform-guide-env-variable-example_{context}"] | ||||||
| == Example workflow using environmental variables to create a ROSA cluster | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * cloud_experts_tutorials/terraform/cloud-experts-terraform-customization.adoc | ||
|
|
||
| ifeval::["{context}" == "cloud-experts-terraform-customization"] | ||
| :enable-vpc: | ||
| endif::[] | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="terraform-guide-private-cluster_{context}"] | ||
| = Creating a private {hcp-title} cluster | ||
|
|
||
| . Run the following command in your terminal to create a private {hcp-title} cluster: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ export TF_VAR_private_cluster="true" | ||
| ---- | ||
|
|
||
| include::snippets/terraform-apply.adoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two options are required for the module to work. Seems a bit weird to get rid of the other options as well