Skip to content

Commit 54a4d5c

Browse files
committed
updating install drafts
1 parent b1fd271 commit 54a4d5c

27 files changed

+586
-208
lines changed

_topic_map.yml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,19 @@ Topics:
6464
- Name: Architecture
6565
File: architecture
6666
---
67+
Name: Installing clusters
68+
Dir: installation
69+
Distros: openshift-origin, openshift-enterprise
70+
Topics:
71+
- Name: Configuring an AWS account
72+
File: installing-aws-account
73+
- Name: Installing a cluster quickly on AWS
74+
File: installing-quickly-cloud
75+
- Name: Installing a cluster on AWS with customizations
76+
File: installing-customizations-cloud
77+
- Name: Uninstalling a cluster on AWS
78+
File: uninstalling-cluster-aws
79+
---
6780
Name: Authentication
6881
Dir: authentication
6982
Distros: openshift-*
@@ -127,15 +140,6 @@ Topics:
127140
File: creating-project-other-user
128141
Distros: openshift-enterprise,openshift-origin
129142
---
130-
Name: Installing clusters
131-
Dir: installation
132-
Distros: openshift-origin, openshift-enterprise
133-
Topics:
134-
- Name: Installing a cluster quickly on AWS
135-
File: installing-quickly-cloud
136-
- Name: Installing a cluster on AWS with customizations
137-
File: installing-customizations-cloud
138-
---
139143
Name: Networking
140144
Dir: networking
141145
Distros: openshift-*
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[id='installing-aws-account']
2+
= Configuring an AWS account
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-aws-account
5+
6+
toc::[]
7+
8+
Before you can install {product-title}, you must configure an
9+
Amazon Web Services (AWS) account.
10+
11+
include::modules/installation-aws-route53.adoc[leveloffset=+1]
12+
13+
include::modules/installation-aws-limits.adoc[leveloffset=+1]
14+
15+
include::modules/installation-aws-iam-user.adoc[leveloffset=+1]
16+
17+
.Next steps
18+
19+
* Install a {product-title} cluster. You can
20+
xref:../installation/installing-customizations-cloud.adoc#installing-customizations-cloud[install a customized cluster]
21+
or xref:../installation/installing-quickly-cloud.adoc#installing-quickly-cloud[quickly install a cluster]
22+
with default options.

installation/installing-customizations-cloud.adoc

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,38 @@ include::modules/common-attributes.adoc[]
66
toc::[]
77

88

9-
In {product-title} version {product-version}, you can install a cluster on
10-
Amazon Web Services (AWS).
9+
In {product-title} version {product-version}, you can install a customized
10+
cluster on Amazon Web Services (AWS).
1111

12-
This cluster is ...
12+
.Prerequisites
13+
14+
* xref:../installation/installing-aws-account.adoc#installing-aws-account[Configure an AWS account]
15+
to host the cluster.
1316

1417
include::modules/installation-overview.adoc[leveloffset=+1]
1518

16-
include::modules/cloud_installations.adoc[leveloffset=+1]
19+
include::modules/installation-clouds.adoc[leveloffset=+1]
1720

18-
include::modules/about-custom-installation.adoc[leveloffset=+1]
21+
include::modules/installation-about-custom.adoc[leveloffset=+1]
1922

20-
include::modules/preparing-custom-installation.adoc[leveloffset=+1]
23+
include::modules/installation-preparing-custom.adoc[leveloffset=+1]
2124

2225
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
2326

2427
include::modules/installation-render-options.adoc[leveloffset=+2]
2528

26-
include::modules/obtaining_cloud_installer.adoc[leveloffset=+1]
29+
include::modules/installation-provide-credentials.adoc[leveloffset=+1]
30+
31+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
32+
33+
include::modules/installation-initializing.adoc[leveloffset=+1]
2734

28-
include::modules/initializing-installation.adoc[leveloffset=+1]
35+
include::modules/installation-rendering.adoc[leveloffset=+1]
2936

30-
include::modules/rendering-installation.adoc[leveloffset=+1]
37+
include::modules/installation-customizing.adoc[leveloffset=+1]
3138

32-
include::modules/customizing-installation.adoc[leveloffset=+1]
39+
include::modules/installation-preparing-assets.adoc[leveloffset=+1]
3340

34-
include::modules/preparing-assets-installation.adoc[leveloffset=+1]
41+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
3542

36-
include::modules/launching-installer.adoc[leveloffset=+1]
43+
include::modules/installing-customizations-cloud.adoc[leveloffset=+1]

installation/installing-quickly-cloud.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,19 @@ toc::[]
77

88

99
In {product-title} version {product-version}, you can install a cluster on
10-
Amazon Web Services (AWS).
10+
Amazon Web Services (AWS) that uses the default configuration options.
1111

12-
This cluster is ...
12+
.Prerequisites
13+
14+
* xref:../installation/installing-aws-account.adoc#installing-aws-account[Configure an AWS account]
15+
to host the cluster.
1316

1417
include::modules/installation-overview.adoc[leveloffset=+1]
1518

16-
include::modules/cloud_installations.adoc[leveloffset=+1]
19+
include::modules/installation-clouds.adoc[leveloffset=+1]
20+
21+
include::modules/installation-provide-credentials.adoc[leveloffset=+1]
1722

18-
include::modules/obtaining_cloud_installer.adoc[leveloffset=+1]
23+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
1924

20-
include::modules/launching-installer.adoc[leveloffset=+1]
25+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[id='uninstalling-cluster-aws']
2+
= Uninstalling a cluster on AWS
3+
include::modules/common-attributes.adoc[]
4+
:context: uninstall-cluster-aws
5+
6+
toc::[]
7+
8+
You can remove a cluster that you deployed to Amazon Web Services (AWS).
9+
10+
include::modules/installation-uninstall-aws.adoc[leveloffset=+1]

mod_docs_guide/getting-started-modular-docs-ocp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ initiative.
2323
* You have read through and familiarized yourself with the
2424
link:https://redhat-documentation.github.io/modular-docs[Red Hat CCS modular docs guide].
2525
* You have reviewed
26-
xref:../mod_docs_guide/mod-docs-coventions-ocp.adoc#mod-docs-ocp-references[the Modular Docs OpenShift Conventions].
26+
xref:../mod_docs_guide/mod-docs-conventions-ocp.adoc#mod-docs-ocp-references[the Modular Docs OpenShift Conventions].
2727
* [Optional] You have received the modular docs training.
2828
* You know how to use Git.
2929

modules/about-custom-installation.adoc

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installation/installing-customizations-cloud.adoc
4+
5+
[id='installation-about-custom-{context}']
6+
= About the custom installation
7+
8+
The custom installation is divided into four phases:
9+
10+
* Initialization, where you create and customize the installation configuration
11+
file
12+
* Rendering, where you provide YAML files that describe further customizations
13+
* Preparing, where the system creates assets based on the rendered data
14+
* Launching, where you create the cluster in your cloud.
15+
16+
During initialization, you generate and customize a cluster configuration file that
17+
defines high level configuration and topology and specifies your cloud provider
18+
credentials. This configuration file contains a limited set of parameters that
19+
most clusters require.
20+
21+
During rendering, you do a thing with a bunch of yaml files that allows you to
22+
provide more customization to your cluster. You can specify ...
23+
24+
During the preparing phase, the assets that you render...
25+
26+
Finally, you launch the installation. The installation program first creates the
27+
infrastructure for the cluster, such as the load balancers, security groups, and
28+
VPCs, and then creates an initial configuration on a bootstrap master node.
29+
The bootstrap master then completes the configuration of the cluster by
30+
self-configuring and loading other components. By default, all the cluster nodes
31+
run Red Hat CoreOS as the operating system.
32+
33+
After the installation and configuration process is complete, instructions for
34+
connecting to the cluster displays.
35+
36+
[discrete]
37+
== Key concepts
38+
39+
Before you complete a customized installation, review the following key concepts.
40+
41+
[discrete]
42+
=== Targets
43+
44+
The {product-title} installer operates on the notion of creating and destroying
45+
targets. Similar to other tools that operate on a graph of dependencies, like
46+
`make` and `systemd`, each target represents a subset of the dependencies in the
47+
graph. The main target in the installation program creates a cluster, but the other targets
48+
allow the user to interrupt this process and use or modify the intermediate
49+
artifacts, such as the the Kubernetes manifests that are installed into the
50+
cluster. Only the immediate dependencies of a target are written to disk by the
51+
installer, but you can run the installation program multiple times to update more
52+
dependencies.
53+
54+
The installation program can create the following targets:
55+
56+
`install-config`::
57+
The installation configuration contains the main parameters
58+
for the installation process. This configuration provides you with more options
59+
than the interactive prompts and comes pre-populated with default values.
60+
`manifest-templates`:: These are the unrendered Kubernetes manifest templates
61+
that `manifests` target uses. This target is unstable.
62+
`manifests`::
63+
You can generate the Kubernetes manifests that will be installed on the cluster.
64+
This target is unstable.
65+
`ignition-configs`::
66+
These files contain the Ignition configurations for the bootstrap, master, and
67+
worker machines.
68+
`cluster`::
69+
This target provisions the cluster and its associated infrastructure.
70+
71+
The following targets can be destroyed by the installation program:
72+
73+
`cluster`::
74+
This destroys the created cluster and its associated infrastructure.
75+
`bootstrap`::
76+
This destroys the bootstrap infrastructure.
77+
78+
[discrete]
79+
=== Multiple invocations
80+
81+
Because you must run the installation program to generate the assets that you need to
82+
customize your installation, you can run the installation program multiple times. The
83+
installation state is stored in a hidden file in the asset directory which
84+
contains all of the intermediate artifacts. Storing the artifacts in this way
85+
lets you pause installation and modify the intermediate artifacts.
86+
87+
For example, if you wanted to create a different number of worker machines, you
88+
must first run the installation program with the `install-config` target with the
89+
`openshift-install create install-config` command. After you provide the required
90+
parameters to the interactive installer, it writes the installation
91+
configuration into the target directory. You can then modify the installation
92+
configuration and run the installation program with the `cluster` target with the
93+
`openshift-install create cluster` command. The installation program reads the install
94+
configuration from disk, removes it from the target directory, and creates a
95+
cluster from the provided configuration.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installation/installing-aws-account.adoc
4+
5+
[id='installation-aws-iam-user-{context}']
6+
= Creating an IAM user
7+
8+
Each Amazon Web Services (AWS) account contains a root user account that is
9+
based on the email address you used to create the account. This is a
10+
highly-privileged account, and it is recommended to use it for only initial
11+
account and billing configuration, creating an initial set of users, and
12+
securing the account.
13+
14+
Before you install {product-title}, create a secondary IAM
15+
administrative user. As you complete the
16+
link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html[Creating an IAM User in Your AWS Account]
17+
procedure in the the AWS documentation, set the following options:
18+
19+
.Procedure
20+
21+
. Specify the IAM user name and select `Programmatic access`.
22+
23+
. Attach the `AdministratorAccess` policy to ensure that the account has
24+
sufficient permission to create the cluster.
25+
26+
. Optionally, add metadata to the user by attaching tags.
27+
28+
. Confirm that the user name that you specified is granted the
29+
`AdministratorAccess` policy.
30+
31+
. Record the access key ID and secret access key values. You must use these
32+
values when you configure your local machine to run the installation program, and this is
33+
the only time that you can obtain them.

0 commit comments

Comments
 (0)