<commit_before>// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc

[id='installation-configuration-parameters_{context}']
= Installation configuration parameters

Before you deploy a {product-title} cluster, you provide parameter values to 
describe your Amazon Web Services (AWS) account and optionally customize your
cluster's platform.  During the initialization phase of installation, you
provide values for the required parameters through the command line. If you
customize your cluster, you can modify the `install-config.yaml` file to
provide more details about the platform.

[NOTE]
====
You cannot modify these parameters after installation.
====

.Required parameters
[cols=".^2,.^3,.^5a",options="header"]
|====
|Parameter|Description|Values

|`provider`
|The cloud provider to host the cluster.
|`aws`

|`baseDomain`
|The base domain of your cloud provider. This value is used to create routes
to your {product-title} cluster components.
|A fully-qualified domain or subdomain name, such as `example.com`.

|`name`
|The name of your cluster.
|A string that contains uppercase or lowercase letters, such as `dev`.

|`region`
|The name of your cluster.
|A valid AWS region, such as `us-east-1`.

|`pullSecret`
|The pull secret that you obtained from
link:https://cloud.openshift.com/clusters/install#pull-secret[the OpenShift start page].
|
[source,json]
----
{  
   "auths":{  
      "cloud.openshift.com":{  
         "auth":"b3Blb=",
         "email":"<EMAIL>"
      },
      "quay.io":{  
         "auth":"b3Blb=",
         "email":"<EMAIL>"
      }
   }
}
----

|`sshKey`
|The SSH key to use to access your cluster machines.
|A valid public SSH key.
|====


.Optional AWS platform parameters
[cols=".^2,.^3,.^3a",options="header"]
|====
|Parameter|Description|Values

|`machines.platform.aws.rootVolume.iops`
|The Input/Output Operations Per Second (IOPS) that is reserved for the root volume.
|Integer, for example `4000`

|`machines.platform.aws.rootVolume.size`
|The size in GiB of the root volume.
|Integer, for example `500`

|`machines.platform.aws.rootVolume.type`<commit_msg>bug 1683066 sshkey isn't required<commit_after>// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc

[id='installation-configuration-parameters_{context}']
= Installation configuration parameters

Before you deploy a {product-title} cluster, you provide parameter values to
describe your Amazon Web Services (AWS) account and optionally customize your
cluster's platform.  During the initialization phase of installation, you
provide values for the required parameters through the command line. If you
customize your cluster, you can modify the `install-config.yaml` file to
provide more details about the platform.

[NOTE]
====
You cannot modify these parameters after installation.
====

.Required parameters
[cols=".^2,.^3,.^5a",options="header"]
|====
|Parameter|Description|Values

|`provider`
|The cloud provider to host the cluster.
|`aws`

|`baseDomain`
|The base domain of your cloud provider. This value is used to create routes
to your {product-title} cluster components.
|A fully-qualified domain or subdomain name, such as `example.com`.

|`name`
|The name of your cluster.
|A string that contains uppercase or lowercase letters, such as `dev`.

|`region`
|The name of your cluster.
|A valid AWS region, such as `us-east-1`.

|`pullSecret`
|The pull secret that you obtained from
link:https://cloud.openshift.com/clusters/install#pull-secret[the OpenShift start page].
|
[source,json]
----
{
   "auths":{
      "cloud.openshift.com":{
         "auth":"b3Blb=",
         "email":"<EMAIL>"
      },
      "quay.io":{
         "auth":"b3Blb=",
         "email":"<EMAIL>"
      }
   }
}
----

|====


.Optional AWS platform parameters
[cols=".^2,.^3,.^3a",options="header"]
|====
|Parameter|Description|Values

|`sshKey`
|The SSH key to use to access your cluster machines.
|A valid public SSH key.

|`machines.platform.aws.rootVolume.iops`
|The Input/Output Operations Per Second (IOPS) that is reserved for the root volume.
|Integer, for example `4000`

|`machines.platform.aws.rootVolume.size`
|The size in GiB of the root volume.
|Integer, for example `500`

|`machines.platform.aws.rootVolume.type`
{'fraction_non_alphanumeric': 0.12841277186487737, 'fraction_numerical': 0.009023600185099491, 'mean_word_length': 4.304294478527607, 'pattern_counts': {'":': 14, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6840', 'n_tokens_mistral': 1344, 'n_tokens_neox': 1272, 'n_words': 455}