From d427cda015913e578b61b1b40140e7cba70dae1e Mon Sep 17 00:00:00 2001 From: Kathryn Alexander Date: Fri, 25 Jan 2019 15:27:15 -0500 Subject: [PATCH] updates to the custom install draft --- _topic_map.yml | 2 +- {installation-AWS => installing-aws}/images | 0 .../installing-aws-account.adoc | 4 +- .../installing-customizations-cloud.adoc | 16 +-- .../installing-quickly-cloud.adoc | 4 +- {installation-AWS => installing-aws}/modules | 0 .../uninstalling-cluster-aws.adoc | 0 .../installing-existing-hosts.adoc | 0 .../uninstalling-existing-hosts.adoc | 0 modules/glusterfs-hardware-requirements.adoc | 2 +- modules/installation-about-custom.adoc | 135 ++++++------------ modules/installation-aws-config-yaml.adoc | 56 ++++++++ modules/installation-aws-iam-user.adoc | 4 +- modules/installation-aws-limits.adoc | 4 +- modules/installation-aws-route53.adoc | 4 +- modules/installation-base-packages.adoc | 2 +- .../installation-byo-cloud-requirements.adoc | 2 +- .../installation-byo-system-requirements.adoc | 2 +- modules/installation-clouds.adoc | 24 +++- ...installation-configuration-parameters.adoc | 111 ++++++++++---- modules/installation-configuring-dns.adoc | 2 +- ...tallation-configuring-node-host-names.adoc | 2 +- modules/installation-customizing.adoc | 2 +- .../installation-default-aws-config-yaml.adoc | 42 ++++++ modules/installation-initializing.adoc | 32 +++-- modules/installation-launching-installer.adoc | 15 +- .../installation-networking-requirements.adoc | 2 +- modules/installation-obtaining-installer.adoc | 4 +- modules/installation-overview.adoc | 6 +- modules/installation-planning.adoc | 2 +- modules/installation-preparing-assets.adoc | 2 +- modules/installation-preparing-custom.adoc | 4 +- modules/installation-preparing-hosts.adoc | 2 +- modules/installation-provide-credentials.adoc | 4 +- modules/installation-registering-hosts.adoc | 2 +- modules/installation-render-options.adoc | 27 ---- modules/installation-rendering.adoc | 27 ---- modules/installation-required-ports.adoc | 2 +- modules/installation-security-warning.adoc | 2 +- .../installation-storage-requirements.adoc | 2 +- modules/installation-uninstall-aws.adoc | 5 +- modules/installing-customizations-cloud.adoc | 2 +- modules/installing-docker.adoc | 2 +- ...metheus-database-storage-requirements.adoc | 2 +- modules/wildcard-dns-configuring.adoc | 2 +- 45 files changed, 320 insertions(+), 248 deletions(-) rename {installation-AWS => installing-aws}/images (100%) rename {installation-AWS => installing-aws}/installing-aws-account.adoc (82%) rename {installation-AWS => installing-aws}/installing-customizations-cloud.adoc (66%) rename {installation-AWS => installing-aws}/installing-quickly-cloud.adoc (83%) rename {installation-AWS => installing-aws}/modules (100%) rename {installation-AWS => installing-aws}/uninstalling-cluster-aws.adoc (100%) rename {installation-BYOH => installing-byoh}/installing-existing-hosts.adoc (100%) rename {installation-BYOH => installing-byoh}/uninstalling-existing-hosts.adoc (100%) create mode 100644 modules/installation-aws-config-yaml.adoc create mode 100644 modules/installation-default-aws-config-yaml.adoc delete mode 100644 modules/installation-render-options.adoc delete mode 100644 modules/installation-rendering.adoc diff --git a/_topic_map.yml b/_topic_map.yml index a94a9c866002..b5b5c44e5f23 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -65,7 +65,7 @@ Topics: File: architecture --- Name: Installing clusters on AWS -Dir: installation-AWS +Dir: installing-aws Distros: openshift-origin, openshift-enterprise Topics: - Name: Configuring an AWS account diff --git a/installation-AWS/images b/installing-aws/images similarity index 100% rename from installation-AWS/images rename to installing-aws/images diff --git a/installation-AWS/installing-aws-account.adoc b/installing-aws/installing-aws-account.adoc similarity index 82% rename from installation-AWS/installing-aws-account.adoc rename to installing-aws/installing-aws-account.adoc index 9195c83bd5e4..1ec0a328c0ac 100644 --- a/installation-AWS/installing-aws-account.adoc +++ b/installing-aws/installing-aws-account.adoc @@ -17,6 +17,6 @@ include::modules/installation-aws-iam-user.adoc[leveloffset=+1] .Next steps * Install a {product-title} cluster. You can -xref:../installing-AWS/installing-customizations-cloud.adoc#installing-customizations-cloud[install a customized cluster] -or xref:../installing-AWS/installing-quickly-cloud.adoc#installing-quickly-cloud[quickly install a cluster] +xref:../installing-aws/installing-customizations-cloud.adoc#installing-customizations-cloud[install a customized cluster] +or xref:../installing-aws/installing-quickly-cloud.adoc#installing-quickly-cloud[quickly install a cluster] with default options. diff --git a/installation-AWS/installing-customizations-cloud.adoc b/installing-aws/installing-customizations-cloud.adoc similarity index 66% rename from installation-AWS/installing-customizations-cloud.adoc rename to installing-aws/installing-customizations-cloud.adoc index 264bd5f91db4..9b6d5c8ad256 100644 --- a/installation-AWS/installing-customizations-cloud.adoc +++ b/installing-aws/installing-customizations-cloud.adoc @@ -11,32 +11,22 @@ cluster on Amazon Web Services (AWS). .Prerequisites -* xref:../installing-AWS/installing-aws-account.adoc#installing-aws-account[Configure an AWS account] +* xref:../installing-aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account] to host the cluster. include::modules/installation-overview.adoc[leveloffset=+1] include::modules/installation-clouds.adoc[leveloffset=+1] -include::modules/installation-about-custom.adoc[leveloffset=+1] - -include::modules/installation-preparing-custom.adoc[leveloffset=+1] - -include::modules/installation-configuration-parameters.adoc[leveloffset=+2] - -include::modules/installation-render-options.adoc[leveloffset=+2] - include::modules/installation-provide-credentials.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] include::modules/installation-initializing.adoc[leveloffset=+1] -include::modules/installation-rendering.adoc[leveloffset=+1] - -include::modules/installation-customizing.adoc[leveloffset=+1] +include::modules/installation-aws-config-yaml.adoc[leveloffset=+1] -include::modules/installation-preparing-assets.adoc[leveloffset=+1] +include::modules/installation-configuration-parameters.adoc[leveloffset=+2] include::modules/installation-launching-installer.adoc[leveloffset=+1] diff --git a/installation-AWS/installing-quickly-cloud.adoc b/installing-aws/installing-quickly-cloud.adoc similarity index 83% rename from installation-AWS/installing-quickly-cloud.adoc rename to installing-aws/installing-quickly-cloud.adoc index fbeeb3396a24..f823ce4113a8 100644 --- a/installation-AWS/installing-quickly-cloud.adoc +++ b/installing-aws/installing-quickly-cloud.adoc @@ -11,7 +11,7 @@ Amazon Web Services (AWS) that uses the default configuration options. .Prerequisites -* xref:../installing-AWS/installing-aws-account.adoc#installing-aws-account[Configure an AWS account] +* xref:../installing-aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account] to host the cluster. include::modules/installation-overview.adoc[leveloffset=+1] @@ -23,3 +23,5 @@ include::modules/installation-provide-credentials.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] + +include::modules/installation-default-aws-config-yaml.adoc[leveloffset=+1] diff --git a/installation-AWS/modules b/installing-aws/modules similarity index 100% rename from installation-AWS/modules rename to installing-aws/modules diff --git a/installation-AWS/uninstalling-cluster-aws.adoc b/installing-aws/uninstalling-cluster-aws.adoc similarity index 100% rename from installation-AWS/uninstalling-cluster-aws.adoc rename to installing-aws/uninstalling-cluster-aws.adoc diff --git a/installation-BYOH/installing-existing-hosts.adoc b/installing-byoh/installing-existing-hosts.adoc similarity index 100% rename from installation-BYOH/installing-existing-hosts.adoc rename to installing-byoh/installing-existing-hosts.adoc diff --git a/installation-BYOH/uninstalling-existing-hosts.adoc b/installing-byoh/uninstalling-existing-hosts.adoc similarity index 100% rename from installation-BYOH/uninstalling-existing-hosts.adoc rename to installing-byoh/uninstalling-existing-hosts.adoc diff --git a/modules/glusterfs-hardware-requirements.adoc b/modules/glusterfs-hardware-requirements.adoc index bb595d7bae1f..69f759124954 100644 --- a/modules/glusterfs-hardware-requirements.adoc +++ b/modules/glusterfs-hardware-requirements.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='glusterfs-hardware-requirements-{context}'] = {gluster} hardware requirements diff --git a/modules/installation-about-custom.adoc b/modules/installation-about-custom.adoc index 5ad54ee5b233..6ba1774fdc3f 100644 --- a/modules/installation-about-custom.adoc +++ b/modules/installation-about-custom.adoc @@ -1,95 +1,52 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * orphaned [id='installation-about-custom-{context}'] = About the custom installation -The custom installation is divided into four phases: - -* Initialization, where you create and customize the installation configuration -file -* Rendering, where you provide YAML files that describe further customizations -* Preparing, where the system creates assets based on the rendered data -* Launching, where you create the cluster in your cloud. - -During initialization, you generate and customize a cluster configuration file that -defines high level configuration and topology and specifies your cloud provider -credentials. This configuration file contains a limited set of parameters that -most clusters require. - -During rendering, you do a thing with a bunch of yaml files that allows you to -provide more customization to your cluster. You can specify ... - -During the preparing phase, the assets that you render... - -Finally, you launch the installation. The installation program first creates the -infrastructure for the cluster, such as the load balancers, security groups, and -VPCs, and then creates an initial configuration on a bootstrap master node. -The bootstrap master then completes the configuration of the cluster by -self-configuring and loading other components. By default, all the cluster nodes -run Red Hat CoreOS as the operating system. - -After the installation and configuration process is complete, instructions for -connecting to the cluster displays. - -[discrete] -== Key concepts - -Before you complete a customized installation, review the following key concepts. - -[discrete] -=== Targets - -The {product-title} installer operates on the notion of creating and destroying -targets. Similar to other tools that operate on a graph of dependencies, like -`make` and `systemd`, each target represents a subset of the dependencies in the -graph. The main target in the installation program creates a cluster, but the other targets -allow the user to interrupt this process and use or modify the intermediate -artifacts, such as the the Kubernetes manifests that are installed into the -cluster. Only the immediate dependencies of a target are written to disk by the -installer, but you can run the installation program multiple times to update more -dependencies. - -The installation program can create the following targets: - -`install-config`:: -The installation configuration contains the main parameters -for the installation process. This configuration provides you with more options -than the interactive prompts and comes pre-populated with default values. -`manifest-templates`:: These are the unrendered Kubernetes manifest templates -that `manifests` target uses. This target is unstable. -`manifests`:: -You can generate the Kubernetes manifests that will be installed on the cluster. -This target is unstable. -`ignition-configs`:: -These files contain the Ignition configurations for the bootstrap, master, and -worker machines. -`cluster`:: -This target provisions the cluster and its associated infrastructure. - -The following targets can be destroyed by the installation program: - -`cluster`:: -This destroys the created cluster and its associated infrastructure. -`bootstrap`:: -This destroys the bootstrap infrastructure. - -[discrete] -=== Multiple invocations - -Because you must run the installation program to generate the assets that you need to -customize your installation, you can run the installation program multiple times. The -installation state is stored in a hidden file in the asset directory which -contains all of the intermediate artifacts. Storing the artifacts in this way -lets you pause installation and modify the intermediate artifacts. - -For example, if you wanted to create a different number of worker machines, you -must first run the installation program with the `install-config` target with the -`openshift-install create install-config` command. After you provide the required -parameters to the interactive installer, it writes the installation -configuration into the target directory. You can then modify the installation -configuration and run the installation program with the `cluster` target with the -`openshift-install create cluster` command. The installation program reads the install -configuration from disk, removes it from the target directory, and creates a -cluster from the provided configuration. +You can use the {product-title} installation program to customize four levels +of the program: + +* {product-title} itself +* The cluster platform +* Kubernetes +* The cluster operating system + +Changes to {product-title} and its platform are managed and supported, but +changes to Kubernetes and the cluster operating system currently are not. If +you customize unsupported levels program levels, future installation and +upgrades might fail. + +When you select values for the prompts that the installation program presents, +you customize {product-title}. You can further modify the cluster platform +by modifying the `install-config.yaml` file that the installation program +uses to deploy your cluster. In this file, you can make changes like setting the +number of machines that the control plane uses, the type of virtual machine +that the cluster deploys, or the CIDR range for the Kubernetes service network. + +It is possible, but not supported, to modify the Kubernetes objects that are injected into the cluster. +A common modification is additional manifests in the initial installation. +No validation is available to confirm the validity of any modifications that +you make to these manifests, so if you modify these objects, you might render +your cluster non-functional. +[IMPORTANT] +==== +Modifying the Kubernetes objects is not supported. +==== + +Similarly it is possible, but not supported, to modify the +Ignition Configs for the bootstrap and other machines. No validation is +available to confirm the validity of any modifications that +you make to these Ignition Configs, so if you modify these objects, you might render +your cluster non-functional. + +[IMPORTANT] +==== +Modifying the Ignition Configs is not supported. +==== + +To complete a custom installation, you use the installation program to generate +the installation files and then customize them. +The installation status is stored in a hidden +file in the asset directory and contains all of the installation files. diff --git a/modules/installation-aws-config-yaml.adoc b/modules/installation-aws-config-yaml.adoc new file mode 100644 index 000000000000..d74f535f5666 --- /dev/null +++ b/modules/installation-aws-config-yaml.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * installing-aws/installing-customizations-cloud.adoc + +[id='installation-aws-config-yaml-{context}'] += Customized `install-config.yaml` file for AWS + +You can customize the `install-config.yaml` file to specify more details about +your {product-title} cluster's platform or modify the values of the required +parameters. + +[source,yaml] +---- +apiVersion: v1beta1 +baseDomain: example.com <1> +machines: +- name: master <2> + platform: + aws: + zones: + - us-west-2a + - us-west-2b + replicas: 3 <2> +- name: worker <2> + platform: + aws: + iamRoleName: elastictranscoder-access + rootVolume: + iops: 4000 + size: 500 + type: io1 + type: c5.9xlarge + zones: + - us-west-2c + replicas: 5 <2> +metadata: + name: test-cluster <1> +networking: <2> + clusterNetworks: + - cidr: 10.128.0.0/14 + hostSubnetLength: 9 + machineCIDR: 10.0.0.0/16 + serviceCIDR: 172.30.0.0/16 + type: OpenshiftSDN +platform: + aws: + region: us-west-2 <1> + userTags: + adminContact: jdoe + costCenter: 7536 +pullSecret: '{"auths": ...}' <1> +sshKey: ssh-ed25519 AAAA... <1> +---- +<1> Required. The installation program prompts you for this value. +<2> If you do not provide these parameters and values, the installation program +provides the default value. diff --git a/modules/installation-aws-iam-user.adoc b/modules/installation-aws-iam-user.adoc index 753882171af5..aabf11efeacf 100644 --- a/modules/installation-aws-iam-user.adoc +++ b/modules/installation-aws-iam-user.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-aws-account.adoc +// * installing-aws/installing-aws-account.adoc -[id='installation-aws-iam-user-{context}'] +[id='installing-aws-iam-user-{context}'] = Creating an IAM user Each Amazon Web Services (AWS) account contains a root user account that is diff --git a/modules/installation-aws-limits.adoc b/modules/installation-aws-limits.adoc index 26ef7b2e190f..cad06fb4e728 100644 --- a/modules/installation-aws-limits.adoc +++ b/modules/installation-aws-limits.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-aws-account.adoc +// * installing-aws/installing-aws-account.adoc -[id='installation-aws-limits-{context}'] +[id='installing-aws-limits-{context}'] = AWS account limits The {product-title} cluster uses a number of Amazon Web Services (AWS) diff --git a/modules/installation-aws-route53.adoc b/modules/installation-aws-route53.adoc index ff1ddb9fca73..986ce6f08dba 100644 --- a/modules/installation-aws-route53.adoc +++ b/modules/installation-aws-route53.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-aws-account.adoc +// * installing-aws/installing-aws-account.adoc -[id='installation-aws-route53-{context}'] +[id='installing-aws-route53-{context}'] = Configuring Route53 To install {product-title}, the Amazon Web Services (AWS) account you use must diff --git a/modules/installation-base-packages.adoc b/modules/installation-base-packages.adoc index 9dc947ec8088..289e629227dd 100644 --- a/modules/installation-base-packages.adoc +++ b/modules/installation-base-packages.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installing-base-packages-{context}'] = Installing base packages diff --git a/modules/installation-byo-cloud-requirements.adoc b/modules/installation-byo-cloud-requirements.adoc index 77c92efd0383..a163d61e29ee 100644 --- a/modules/installation-byo-cloud-requirements.adoc +++ b/modules/installation-byo-cloud-requirements.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-BYO-cloud-requirements-{context}'] = Cloud requirements for BYO installations diff --git a/modules/installation-byo-system-requirements.adoc b/modules/installation-byo-system-requirements.adoc index 0cfccac7c197..cc6fdfdf2229 100644 --- a/modules/installation-byo-system-requirements.adoc +++ b/modules/installation-byo-system-requirements.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-byo-system-requirements-{context}'] = System requirements for installing on BYO diff --git a/modules/installation-clouds.adoc b/modules/installation-clouds.adoc index 6b5b6d4eef97..0680846dc8a9 100644 --- a/modules/installation-clouds.adoc +++ b/modules/installation-clouds.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-quickly-cloud.adoc -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-quickly-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='cloud-installations-{context}'] = {product-title} clusters on Installer Provisioned Infrastructure @@ -13,14 +13,24 @@ Web Services (AWS). ==== You can install either a standard cluster or a customized cluster. With a -standard cluster, you provide only some details about your AWS account to the -installer, and it creates a cluster. +standard cluster, you provide minimum details that you need to install the +cluster. With a customized cluster, you can specify more details about the +platform, such as the number of machines that the control plane uses, the type +of virtual machine that the cluster deploys, or the CIDR range for the +Kubernetes service network. -With a customized cluster, you can specify more details of the installation, -such as ... +[IMPORTANT] +==== +It is possible to modify Kubernetes and the Ignition Configs that control +the underlying Red Hat CoreOS operating system during installation. However, +no validation is available to confirm the suitability of any modifications that +you make to these objects. If you modify these objects, you might render +your cluster non-functional. Because of this risk, modifying Kubernetes and +Ignition Configs is not supported. +==== When you install {product-title} cluster with Installer Provisioned Infrastructure (IPI), you download the -installer from link:try.openshift.com. This site manages: +installer from link:try.openshift.com[the OpenShift start page]. This site manages: * REST API for accounts * Registry tokens, which are the pull secrets that you use to obtain the required diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc index cdc26c9eb517..787d0f6ced07 100644 --- a/modules/installation-configuration-parameters.adoc +++ b/modules/installation-configuration-parameters.adoc @@ -1,54 +1,109 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installation-configuration-parameters_{context}'] = Installation configuration parameters -You use a `*./install-config.yaml*` file to provide parameter values during a -{product-title} installation. During the initialization phase of installation, -you provide values for parameters that are unique to your cluster through the -command line. You can also modify the default values of the remaining 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. ==== -.Parameters that you define during initialization -[cols=".^2,.^3,.^3a",options="header"] +.Required parameters +[cols=".^2,.^3,.^5a",options="header"] |==== |Parameter|Description|Values |`provider` |The cloud provider to host the cluster. -a|Enter one of the following values: +|`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`. -* aws -* azure -* openstack +|`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":"you@example.com" + }, + "quay.io":{ + "auth":"b3Blb=", + "email":"you@example.com" + } + } +} +---- -|`base-domain` -|The base domain of your cloud provider. This value is used to . -|A FQDN, such as `dev.example.com`. +|`sshKey` +|The SSH key to use to access your cluster machines. +|A valid public SSH key. |==== -.All installation parameters -[cols=".^3,.^5,.^5a,.^5",options="header"] + +.Optional AWS platform parameters +[cols=".^2,.^3,.^3a",options="header"] |==== -|Parameter|Description|Value format|Default value +|Parameter|Description|Values -|`provider` -|The cloud provider to host the cluster. -a|Enter one of the following 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` +|The instance type of the root volume. +|Valid link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html[AWS EBS instance type], +such as `io1`. + +|`machines.platform.aws.type` +|The EC2 instance type for the control plane machines. +|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type], +such as `c5.9xlarge`. + +|`machines.platform.aws.zones` +|The availability zones where the installation program creates machines for this +pool. +|A list of valid AWS availability zones, such as `us-east-1c`, in a +link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence]. -* aws -* azure -* openstack -| n/a +|`platform.aws.region` +|The AWS region that the installation program creates resources in. +|Valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS region], +such as `us-east-1` -|`base-domain` -|The base domain of your cloud provider. This value is used to . -|A FQDN, such as `dev.example.com`. -|n/a +|`platform.aws.userTags` +|A map of keys and values that the installation program adds as tags to all +resources that it creates. +|Any valid YAML map, such as key value pairs in the `: ` format. +For more information about AWS tags, +see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html[Tagging Your Amazon EC2 Resources] +in the AWS documentation. |==== diff --git a/modules/installation-configuring-dns.adoc b/modules/installation-configuring-dns.adoc index a05a627478fb..d4aac20543e0 100644 --- a/modules/installation-configuring-dns.adoc +++ b/modules/installation-configuring-dns.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-configuring-dns-{context}'] = Configuring hosts to use DNS diff --git a/modules/installation-configuring-node-host-names.adoc b/modules/installation-configuring-node-host-names.adoc index 3ba390498c20..97cc6bbea69f 100644 --- a/modules/installation-configuring-node-host-names.adoc +++ b/modules/installation-configuring-node-host-names.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-configuring-node-host-names-{context}'] = Configuring node host names diff --git a/modules/installation-customizing.adoc b/modules/installation-customizing.adoc index 20d6dc63c55a..880df336cabe 100644 --- a/modules/installation-customizing.adoc +++ b/modules/installation-customizing.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installation-customizing_{context}'] diff --git a/modules/installation-default-aws-config-yaml.adoc b/modules/installation-default-aws-config-yaml.adoc new file mode 100644 index 000000000000..c58c47258a6f --- /dev/null +++ b/modules/installation-default-aws-config-yaml.adoc @@ -0,0 +1,42 @@ +// Module included in the following assemblies: +// +// * installing-aws/installing-customizations-cloud.adoc + +[id='installation-default-aws-config-yaml-{context}'] += Default `install-config.yaml` file for AWS + +The default `install-config.yaml` file defines the information that is required +to deploy your {product-title} cluster and some default cluster values. The +installation program generates the following file based on your inputs to its +prompts. + +[source,yaml] +---- +apiVersion: v1beta1 +baseDomain: example.com <1> +machines: <2> +- name: master + platform: {} + replicas: 3 +- name: worker + platform: {} + replicas: 3 +metadata: + creationTimestamp: null + name: cluster <1> +networking: <2> + clusterNetworks: + - cidr: 10.128.0.0/14 + hostSubnetLength: 9 + machineCIDR: 10.0.0.0/16 + serviceCIDR: 172.30.0.0/16 + type: OpenshiftSDN +platform: + aws: + region: us-east-1 <1> +pullSecret: '{"auths....' <1> +sshKey: ssh-ed25519 AAAA... <1> +---- +<1> Required. The installation program prompts you for this value. +<2> If you do not provide these parameters and values, the installation program +provides the default value. diff --git a/modules/installation-initializing.adoc b/modules/installation-initializing.adoc index dd6424a4e101..ba2a8cc18a5a 100644 --- a/modules/installation-initializing.adoc +++ b/modules/installation-initializing.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installation-initializing_{context}'] = Creating the installation configuration file @@ -14,20 +14,32 @@ You can customize your installation of {product-title} on a compatible cloud. .Procedure - -. Obtain the `*./install-config.yaml*` file. +. Obtain the `install-config.yaml` file. .. Run the following command: + +[source,bash] ---- -$ openshift-install init +$ ./openshift-install create install-config --dir= <1> ---- -.. At the prompts, provide the configuration details for your cloud. - -. If required, modify the `*./install-config.yaml*` file. In this file, you can -provide more values. - -. Validate the contents of the `*./install-config.yaml*` file. +<1> Specify the directory name to store the files that the installation program +creates. +.. At the prompts, provide the configuration details for your cloud: +... Select an SSH key to use to access your cluster machines. +... Select AWS as the platform to target. +... Select the AWS region to deploy the cluster to. +... Select the base domain for the Route53 service that you configured for your cluster. +... Enter a descriptive name for your cluster. +... Paste the pull secret that you obtained from link:https://try.openshift.com[the OpenShift start page]. + +. Modify the `install-config.yaml` file. You can find more information about +the available parameters in the +link:https://godoc.org/github.com/openshift/installer/pkg/types#InstallConfig[Go documentation]. + +. Validate the contents of the `install-config.yaml` file. + ---- $ openshift-install NEED TO VALIDATE ---- + +. Optionally, back up the `install-config.yaml` file so that you can use +it to install multiple clusters. diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc index 178ddeb01167..5fca85a05167 100644 --- a/modules/installation-launching-installer.adoc +++ b/modules/installation-launching-installer.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-quickly-cloud.adoc -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-quickly-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='launching-installer-{context}'] = Deploy the cluster @@ -23,20 +23,21 @@ You can run the installation program only once, during initial installation. . Run the installation program: + ---- -$ ./openshift-install create cluster --dir <1> +$ ./openshift-install create cluster --dir= <1> ---- <1> Specify the directory name to store the files that the installation program -creates. +creates or the location of your customized `./install-config.yaml` file. + -- -Follow the installation prompts: +If you did not customize the `install-config.yaml` file, provide values +at the prompts: -.. Select an SSH key to use when you access your account. +.. Select an SSH key to use to access your cluster machines. .. Select AWS as the platform to target. .. Select the AWS region to deploy the cluster to. .. Select the base domain for the Route53 service that you configured for your cluster. .. Enter a descriptive name for your cluster. -.. Paste the pull secret that you obtained from link:https://try.openshift.com[try.openshift.com]. +.. Paste the pull secret that you obtained from link:https://try.openshift.com[the OpenShift start page]. -- + When the cluster deployment completes, directions for accessing your cluster, diff --git a/modules/installation-networking-requirements.adoc b/modules/installation-networking-requirements.adoc index f4dd0305d44d..1a7388e3d888 100644 --- a/modules/installation-networking-requirements.adoc +++ b/modules/installation-networking-requirements.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-networking-requirements-{context}'] = Networking requirements for BYO installations diff --git a/modules/installation-obtaining-installer.adoc b/modules/installation-obtaining-installer.adoc index 156c36255952..628133dcea38 100644 --- a/modules/installation-obtaining-installer.adoc +++ b/modules/installation-obtaining-installer.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-quickly-cloud.adoc -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-quickly-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installing-quickly-cloud-{context}'] diff --git a/modules/installation-overview.adoc b/modules/installation-overview.adoc index 658c130a3f38..79bd18c457e7 100644 --- a/modules/installation-overview.adoc +++ b/modules/installation-overview.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-quickly-cloud.adoc -// * installing-AWS/installing-customizations-cloud.adoc -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-aws/installing-quickly-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-overview-{context}'] = {product-title} installation overview diff --git a/modules/installation-planning.adoc b/modules/installation-planning.adoc index 3947d787a838..3fb319287d91 100644 --- a/modules/installation-planning.adoc +++ b/modules/installation-planning.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-planning-{context}'] = Planning your installation diff --git a/modules/installation-preparing-assets.adoc b/modules/installation-preparing-assets.adoc index 4e7785914dc8..1cdede39fb8e 100644 --- a/modules/installation-preparing-assets.adoc +++ b/modules/installation-preparing-assets.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installation-preparing-assets_{context}'] diff --git a/modules/installation-preparing-custom.adoc b/modules/installation-preparing-custom.adoc index 68167876128e..e43f48b999e5 100644 --- a/modules/installation-preparing-custom.adoc +++ b/modules/installation-preparing-custom.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installation-preparing-custom_{context}'] = Preparing to install a custom {product-title} cluster @@ -11,7 +11,7 @@ customizations that you must need to define at installation. .Procedure . Gather your cloud credentials. -. Review the parameters in the `*./install-config.yaml*` file and obtain +. Review the parameters in the `install-config.yaml` file and obtain custom values for them. . Prepare custom assets to render: .. Review the list of possible assets. diff --git a/modules/installation-preparing-hosts.adoc b/modules/installation-preparing-hosts.adoc index b2ad91f89c8a..284c04519765 100644 --- a/modules/installation-preparing-hosts.adoc +++ b/modules/installation-preparing-hosts.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-preparing-hosts-{context}'] = Preparing your hosts diff --git a/modules/installation-provide-credentials.adoc b/modules/installation-provide-credentials.adoc index 35e60ae42286..38ebf3b57390 100644 --- a/modules/installation-provide-credentials.adoc +++ b/modules/installation-provide-credentials.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc -// * installing-AWS/installing-quickly-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc +// * installing-aws/installing-quickly-cloud.adoc [id='installation-provide-credentials-{context}'] = Configuring your computer for installation diff --git a/modules/installation-registering-hosts.adoc b/modules/installation-registering-hosts.adoc index 6b79cd35617a..75c6632459cf 100644 --- a/modules/installation-registering-hosts.adoc +++ b/modules/installation-registering-hosts.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc ifdef::openshift-enterprise[] diff --git a/modules/installation-render-options.adoc b/modules/installation-render-options.adoc deleted file mode 100644 index dbb2acef1aaf..000000000000 --- a/modules/installation-render-options.adoc +++ /dev/null @@ -1,27 +0,0 @@ -// Module included in the following assemblies: -// -// * installing-AWS/installing-customizations-cloud.adoc - -[id='installation-render-options_{context}'] -= Installation rending options - -You can customize and different assets during installation. - -[NOTE] -==== -You cannot select different assets after installation. -==== - -.Assets that you can render during installation -[cols=".^3,.^5,.^5",options="header"] -|==== -|Asset|Description|Sample YAML - -|*EXAMPLE* -|DESCRIPTION -|YAML - -|*EXAMPLE* -|DESCRIPTION -|YAML -|==== diff --git a/modules/installation-rendering.adoc b/modules/installation-rendering.adoc deleted file mode 100644 index bcba23953580..000000000000 --- a/modules/installation-rendering.adoc +++ /dev/null @@ -1,27 +0,0 @@ -// Module included in the following assemblies: -// -// * installing-AWS/installing-customizations-cloud.adoc - - -[id='installation-rendering_{context}'] -= Rendering installation assets - -.Prerequisites - -* Customize the `*./install-config.yaml*` file for your installation. - -.Procedure - - -. Render assets from the parameters that you defined in the -`*./install-config.yaml*` -+ ----- -$ openshift-install render ----- - -. Edit rendered assets (e.g modify kube-dns manifest) -+ ----- -$ vi ./manifests/kube-dns-daemonset.yaml ----- diff --git a/modules/installation-required-ports.adoc b/modules/installation-required-ports.adoc index f84487f4e039..1fce08da5bc7 100644 --- a/modules/installation-required-ports.adoc +++ b/modules/installation-required-ports.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-required-ports-{context}'] = Required ports diff --git a/modules/installation-security-warning.adoc b/modules/installation-security-warning.adoc index 18690571073a..243f40a946c2 100644 --- a/modules/installation-security-warning.adoc +++ b/modules/installation-security-warning.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-security-warning-{context}'] = Security Warning diff --git a/modules/installation-storage-requirements.adoc b/modules/installation-storage-requirements.adoc index 8d4de5ce9fe5..5e5c5a7a93da 100644 --- a/modules/installation-storage-requirements.adoc +++ b/modules/installation-storage-requirements.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installation-storage-requirements-{context}'] = Persistent storage requirements for BYO installations diff --git a/modules/installation-uninstall-aws.adoc b/modules/installation-uninstall-aws.adoc index cf597acb4d8e..5ccc0a8fb7be 100644 --- a/modules/installation-uninstall-aws.adoc +++ b/modules/installation-uninstall-aws.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-AWS/uninstalling-cluster-aws'adoc +// * installing-aws/uninstalling-cluster-aws'adoc [id='installation-uninstall-aws-{context}'] = Removing a cluster from AWS @@ -13,7 +13,8 @@ You can remove a cluster that you installed on Amazon Web Services (AWS). + [source,bash] ---- -$ ./openshift-install destroy cluster --dir= --log-level=debug <1> +$ ./openshift-install destroy cluster \ +--dir= --log-level=debug <1> ---- <1> `installation_directory` is the directory you stored the {product-title} definition files that the installation program creates. diff --git a/modules/installing-customizations-cloud.adoc b/modules/installing-customizations-cloud.adoc index dc84f86fac61..161391e4031c 100644 --- a/modules/installing-customizations-cloud.adoc +++ b/modules/installing-customizations-cloud.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-AWS/installing-customizations-cloud.adoc +// * installing-aws/installing-customizations-cloud.adoc [id='installing-customizations-cloud-{context}'] = Installation command options diff --git a/modules/installing-docker.adoc b/modules/installing-docker.adoc index deeb1c2dfc08..c52287921e64 100644 --- a/modules/installing-docker.adoc +++ b/modules/installing-docker.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='installing-docker-{context}'] = Installing Docker diff --git a/modules/prometheus-database-storage-requirements.adoc b/modules/prometheus-database-storage-requirements.adoc index c36f9b2fce0f..f14304b206db 100644 --- a/modules/prometheus-database-storage-requirements.adoc +++ b/modules/prometheus-database-storage-requirements.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * scalability_and_performance/scaling-cluster-monitoring-operator.adoc -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='prometheus-database-storage-requirements-{context}'] = Prometheus database storage requirements diff --git a/modules/wildcard-dns-configuring.adoc b/modules/wildcard-dns-configuring.adoc index 01b77a029fe3..96130d377d45 100644 --- a/modules/wildcard-dns-configuring.adoc +++ b/modules/wildcard-dns-configuring.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing-BYOH/installing-existing-hosts.adoc +// * installing-byoh/installing-existing-hosts.adoc [id='wildcard-dns-configuring-{context}'] = Configuring a DNS wildcard