-
Notifications
You must be signed in to change notification settings - Fork 1.9k
draft of install from available notes #11372
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,46 @@ | ||
| // This assembly is included in the following assemblies: | ||
| // | ||
| // * n/a | ||
|
|
||
|
|
||
| [id='installing-customizations-cloud'] | ||
| = Installing a cluster on AWS with customizations | ||
| {product-author} | ||
| {product-version} | ||
| :data-uri: | ||
| :icons: | ||
| :experimental: | ||
| :toc: macro | ||
| :toc-title: | ||
| :prewrap!: | ||
| :context: install-customizations-cloud | ||
|
|
||
| toc::[] | ||
|
|
||
|
|
||
| In {product-title} version {product-version}, you can install a cluster on | ||
| Amazon Web Services (AWS). | ||
|
|
||
| This cluster is ... | ||
|
|
||
| include::modules/cloud_installations.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/about-custom-installation.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/preparing-custom-installation.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/installation-configuration-parameters.adoc[leveloffset=+2] | ||
|
|
||
| include::modules/installation-render-options.adoc[leveloffset=+2] | ||
|
|
||
| include::modules/obtaining_cloud_installer.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/initializing-installation.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/rendering-installation.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/customizing-installation.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/preparing-assets-installation.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/launching-installer.adoc[leveloffset=+1] |
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,36 @@ | ||
| // This assembly is included in the following assemblies: | ||
| // | ||
| // * n/a | ||
|
|
||
|
|
||
| [id='installing-existing-hosts'] | ||
| = Installing a cluster on existing hosts | ||
| {product-author} | ||
| {product-version} | ||
| :data-uri: | ||
| :icons: | ||
| :experimental: | ||
| :toc: macros | ||
| :toc-title: | ||
| :prewrap!: | ||
| :context: install-existing-hosts | ||
|
|
||
| toc::[] | ||
|
|
||
|
|
||
| You can install {product-title} version {product-version} on existing Red Hat | ||
| Enterprise Linux (RHEL) hosts. | ||
|
|
||
| You run an Ansible-based installer to establish the cluster on your hosts. | ||
|
|
||
| Use this option if you: | ||
|
|
||
| * Already have your own mechanisms for building and provisioning machines that | ||
| run RHEL | ||
| * Have your own infrastructure provisioning | ||
| * Are upgrading your {product-title} cluster | ||
| * Are willing to give up upgrade automation and the cluster’s default | ||
| self-management of nodes in exchange for more flexibility | ||
|
|
||
|
|
||
| *TBD* |
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,30 @@ | ||
| // This assembly is included in the following assemblies: | ||
| // | ||
| // * n/a | ||
|
|
||
|
|
||
| [id='installing-quickly-cloud'] | ||
| = Installing a cluster quickly on AWS | ||
| {product-author} | ||
| {product-version} | ||
| :data-uri: | ||
| :icons: | ||
| :experimental: | ||
| :toc: macro | ||
| :toc-title: | ||
| :prewrap!: | ||
| :context: installing-quickly-cloud | ||
|
|
||
| toc::[] | ||
|
|
||
|
|
||
| In {product-title} version {product-version}, you can install a cluster on | ||
| Amazon Web Services (AWS). | ||
|
|
||
| This cluster is ... | ||
|
|
||
| include::modules/cloud_installations.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/obtaining_cloud_installer.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/launching-installer.adoc[leveloffset=+1] |
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,34 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/installing-customizations-cloud.adoc | ||
|
|
||
| [id='about-custom-installation-{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 installer 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. | ||
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,26 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/installing-quickly-cloud.adoc | ||
| // * installation/installing-customizations-cloud.adoc | ||
|
|
||
| [id='concept-explanation-{context}'] | ||
| = {product-title} clusters on clouds | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| In version {product-version}, you can install {product-title} on only Amazon | ||
| Web Services (AWS) or your own hosts. | ||
| ==== | ||
|
|
||
| You can install either a standard cluster or a customized cluster. With a | ||
| standard cluster, you specify the minimum number of details to establish the | ||
| cluster. These details include ... | ||
|
|
||
| With a customized cluster, you can specify more details of the installation, | ||
| such as ... | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| You cannot modify the parameters that you set during installation. You have to | ||
| ... | ||
| ==== |
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,22 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/installing-customizations-cloud.adoc | ||
|
|
||
|
|
||
| [id='customizing-installation_{context}'] | ||
| = Further customizing the installation | ||
|
|
||
| If you need to make even more customizations, you can. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Render the installation assets. | ||
|
|
||
| .Procedure | ||
|
|
||
|
|
||
| . Create the YAML definition: | ||
|
|
||
| . Modify the controlling file: | ||
|
|
||
| . Add more Kubernetes files: |
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,33 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/installing-customizations-cloud.adoc | ||
|
|
||
| [id='initializing-installation_{context}'] | ||
| = Creating the installation configuration file | ||
|
|
||
| You can customize your installation of {product-title} on a compatible cloud. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Obtain the {product-title} installer and the access token for your cluster. | ||
| * Obtain configuration details for your cloud. | ||
|
|
||
| .Procedure | ||
|
|
||
|
|
||
| . Obtain the `*./install-config.yaml*` file. | ||
| .. Run the following command: | ||
| + | ||
| ---- | ||
| $ openshift-install init | ||
| ---- | ||
| .. 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. | ||
| + | ||
| ---- | ||
| $ openshift-install NEED TO VALIDATE | ||
| ---- |
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,54 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/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. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| You cannot modify these parameters after installation. | ||
| ==== | ||
|
|
||
| .Parameters that you define during initialization | ||
| [cols=".^2,.^3,.^3a",options="header"] | ||
| |==== | ||
| |Parameter|Description|Values | ||
|
|
||
| |`provider` | ||
| |The cloud provider to host the cluster. | ||
| a|Enter one of the following values: | ||
|
|
||
| * aws | ||
| * azure | ||
| * openstack | ||
|
|
||
| |`base-domain` | ||
| |The base domain of your cloud provider. This value is used to <do a thing>. | ||
| |A FQDN, such as `dev.example.com`. | ||
| |==== | ||
|
|
||
| .All installation parameters | ||
| [cols=".^3,.^5,.^5a,.^5",options="header"] | ||
| |==== | ||
| |Parameter|Description|Value format|Default value | ||
|
|
||
| |`provider` | ||
| |The cloud provider to host the cluster. | ||
| a|Enter one of the following values: | ||
|
|
||
| * aws | ||
| * azure | ||
| * openstack | ||
| | n/a | ||
|
|
||
| |`base-domain` | ||
| |The base domain of your cloud provider. This value is used to <do a thing>. | ||
| |A FQDN, such as `dev.example.com`. | ||
| |n/a | ||
| |==== |
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,27 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/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 | ||
| |==== |
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,33 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/installing-quickly-cloud.adoc | ||
| // * installation/installing-customizations-cloud.adoc | ||
|
|
||
| [id='launching-installer-{context}'] | ||
| = Launching the installer | ||
|
|
||
| You can install {product-title} on a compatible cloud. | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| You can run the launch command only once, during initial installation. If you | ||
| need to change your cluster later, you must update the configuration manually. | ||
| ==== | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Obtain the {product-title} installer and the access token for your cluster. | ||
| * Obtain configuration details for your cloud. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Run the installer: | ||
| + | ||
| ---- | ||
| $ openshift-install launch | ||
| ---- | ||
| + | ||
| After several minutes, things happen and you see a thing to know that your | ||
| cluster is online. | ||
|
|
||
| . Optionally, delete the installation media. |
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,26 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installation/installing-quickly-cloud.adoc | ||
| // * installation/installing-customizations-cloud.adoc | ||
|
|
||
|
|
||
| [id='installing-quickly-cloud-{context}'] | ||
| = Obtaining the installer | ||
|
|
||
| Before you install {product-title} on a compatible cloud, download the | ||
| installation file on a local computer. | ||
|
|
||
| The installation media takes up this much space on your hard drive during | ||
| installation. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Any requirements about the computer to run the program on. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Access the link:https://try.openshift.com[the OpenShift start page]. If you | ||
| have a Red Hat account, log in with your credentials. If you do not, create an | ||
| account. | ||
|
|
||
| . Download the installer and your access token. |
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.
We are calling these "installation targets" and they are called "config" (or maybe "install-config"), "manifests", "ignition-configs", and "cluster". Nouns make a little more sense here because that is what is being installed. We are working on those definitions in the installer repo.