Skip to content
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.

Sign up for GitHub

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

WIP Network operator #14084

Closed
wants to merge 1 commit into from
Closed

WIP Network operator #14084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions _topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,21 @@ Topics:
- Name: Working with projects
File: working-with-projects
---
Name: Installing clusters on AWS
Dir: installing-aws
Name: Installing
Dir: installing
Distros: openshift-origin, openshift-enterprise
Topics:
- Name: Configuring an AWS account
File: installing-aws-account
- Name: Installing a cluster quickly on AWS
File: installing-quickly-cloud
- Name: Installing a cluster on AWS with customizations
File: installing-customizations-cloud
- Name: Uninstalling a cluster on AWS
File: uninstalling-cluster-aws
- Name: Installing on AWS
Dir: installing_aws
Topics:
- Name: Configuring an AWS account
File: installing-aws-account
- Name: Installing a cluster quickly on AWS
File: installing-aws-default
- Name: Installing a cluster on AWS with customizations
File: installing-aws-customizations
- Name: Uninstalling a cluster on AWS
File: uninstalling-cluster-aws
---
Name: Applications
Dir: applications
Expand Down Expand Up @@ -265,8 +268,8 @@ Distros: openshift-*
Topics:
- Name: Understanding networking
File: understanding-networking
- Name: Using cookies to keep route statefulness
File: using-cookies-to-keep-route-statefulness
- Name: Configuring the Network before starting a cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should Network be capitalized here?
Update this reference to match the assembly title.

File: configuring-network-operator
---
Name: Registry
Dir: registry
Expand Down
0 ...lling-byoh/installing-existing-hosts.adoc → installing/installing-existing-hosts.adoc
View file
Open in desktop
File renamed without changes.
0 installing-aws/images → installing/installing_aws/images
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions installing-aws/installing-aws-account.adoc → ...nstalling_aws/installing-aws-account.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ include::modules/installation-aws-regions.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/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[install a customized cluster]
or xref:../../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[quickly install a cluster]
with default options.
6 changes: 3 additions & 3 deletions ...-aws/installing-customizations-cloud.adoc → ...ng_aws/installing-aws-customizations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[id='installing-customizations-cloud']
[id='installing-aws-customizations']
= Installing a cluster on AWS with customizations
include::modules/common-attributes.adoc[]
:context: install-customizations-cloud
Expand All @@ -10,7 +10,7 @@ cluster on Amazon Web Services (AWS).

.Prerequisites

* xref:../installing-aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account]
* xref:../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account]
to host the cluster.

include::modules/installation-overview.adoc[leveloffset=+1]
Expand All @@ -29,7 +29,7 @@ include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]

include::modules/installation-launching-installer.adoc[leveloffset=+1]

include::modules/installing-customizations-cloud.adoc[leveloffset=+1]
include::modules/installing-aws-customizations.adoc[leveloffset=+1]

include::modules/cli-install.adoc[leveloffset=+1]

Expand Down
6 changes: 3 additions & 3 deletions installing-aws/installing-quickly-cloud.adoc → ...nstalling_aws/installing-aws-default.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id='installing-quickly-cloud']
[id='installing-aws-default']
= Installing a cluster quickly on AWS
include::modules/common-attributes.adoc[]
:context: installing-quickly-cloud
:context: installing-aws-default

toc::[]

Expand All @@ -10,7 +10,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/installing_aws/installing-aws-account.adoc#installing-aws-account[Configure an AWS account]
to host the cluster.

include::modules/installation-overview.adoc[leveloffset=+1]
Expand Down
0 installing-aws/modules → installing/installing_aws/modules
View file
Open in desktop
File renamed without changes.
0 installing-aws/uninstalling-cluster-aws.adoc → ...talling_aws/uninstalling-cluster-aws.adoc
View file
Open in desktop
File renamed without changes.
0 ...ing-byoh/uninstalling-existing-hosts.adoc → installing/uninstalling-existing-hosts.adoc
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions modules/cli-install.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing-aws/installing-quickly-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc

[id='cli-install-{context}']
= Installing the {product-title} CLI
Expand Down
4 changes: 2 additions & 2 deletions modules/cli-logging-in-kubeadmin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-quickly-cloud.adoc
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc

[id='cli-logging-in-kubeadmin-{context}']
= Logging into the cluster as the `kubeadmin` user by using the `oc` CLI
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-aws-config-yaml.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc

[id='installation-aws-config-yaml-{context}']
= Sample customized `install-config.yaml` file for AWS
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-aws-iam-user.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-aws-account.adoc
// * installing/installing_aws/installing-aws-account.adoc

[id='installing-aws-iam-user-{context}']
= Creating an IAM user
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-aws-limits.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-aws-account.adoc
// * installing/installing_aws/installing-aws-account.adoc

[id='installing-aws-limits-{context}']
= AWS account limits
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-aws-regions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-aws-account.adoc
// * installing/installing_aws/installing-aws-account.adoc

[id='installation-aws-regions-{context}']
= Supported AWS regions
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-aws-route53.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-aws-account.adoc
// * installing/installing_aws/installing-aws-account.adoc

[id='installing-aws-route53-{context}']
= Configuring Route53
Expand Down
4 changes: 2 additions & 2 deletions modules/installation-clouds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-quickly-cloud.adoc
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc

[id='cloud-installations-{context}']
= {product-title} clusters on Installer Provisioned Infrastructure
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-configuration-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// Consider also adding the installation-configuration-parameters.adoc module.


Expand Down
2 changes: 1 addition & 1 deletion modules/installation-customizing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc


[id='installation-customizing-{context}']
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-initializing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// Consider also adding the installation-configuration-parameters.adoc module.

[id='installation-initializing-{context}']
Expand Down
6 changes: 3 additions & 3 deletions modules/installation-launching-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-quickly-cloud.adoc
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// If you use this module in any other assembly, you must update the ifeval
// statements.

Expand Down Expand Up @@ -30,7 +30,7 @@ $ ./openshift-install create cluster --dir=<directory> <1>
ifeval::["{context}" == "install-customizations-cloud"]
Specify the location of your customized `./install-config.yaml` file.
endif::[]
ifeval::["{context}" == "installing-quickly-cloud"]
ifeval::["{context}" == "installing-aws-default"]
<1> Specify the directory name to store the files that the installation program
creates.
+
Expand Down
6 changes: 3 additions & 3 deletions modules/installation-obtaining-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-quickly-cloud.adoc
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc


[id='installing-quickly-cloud-{context}']
[id='installing-aws-default-{context}']
= Obtaining the installation program

Before you install {product-title} on a compatible cloud, download the
Expand Down
4 changes: 2 additions & 2 deletions modules/installation-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-quickly-cloud.adoc
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing-byoh/installing-existing-hosts.adoc

[id='installation-overview-{context}']
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-preparing-assets.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc


[id='installation-preparing-assets-{context}']
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-preparing-custom.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc

[id='installation-preparing-custom-{context}']
= Preparing to install a custom {product-title} cluster
Expand Down
4 changes: 2 additions & 2 deletions modules/installation-provide-credentials.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing-aws/installing-quickly-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc

[id='installation-provide-credentials-{context}']
= Configuring your computer for installation
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-uninstall-aws.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * installing-aws/uninstalling-cluster-aws'adoc
// * installing/installing_aws/uninstalling-cluster-aws'adoc

[id='installation-uninstall-aws-{context}']
= Removing a cluster from AWS
Expand Down
4 changes: 2 additions & 2 deletions modules/installing-customizations-cloud.adoc → modules/installing-aws-customizations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Module included in the following assemblies:
//
// * installing-aws/installing-customizations-cloud.adoc
// * installing/installing_aws/installing-aws-customizations.adoc

[id='installing-customizations-cloud-{context}']
[id='installing-aws-customizations-{context}']
= Installation command options

The installation program uses
Expand Down
35 changes: 35 additions & 0 deletions modules/nw-modifying-network-config-startup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Module filename: nw-modifying-network-config-startup.adoc
// Module included in the following assemblies:
//
// * networking/configuring-network-operator.adoc

[id='modifying-network-config-startup-{context}']
= Modifying Basic Network Configuration before Starting the Cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All headings need to be sentence case.


You can modify the basic network configuration parameters in the `Network.config.openshift.io` object before you start the cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can or must?


.Procedure

. Use the following command to create an `install-config-yaml` file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that this is the right approach to this use case. I think that if you have to set the networking parameters before installation that it needs to be part of a customized installation flow. These parameters are already in https://docs.openshift.com/container-platform/4.0/installing/installing_aws/installing-aws-customizations.html#installation-aws-config-yaml-install-customizations-cloud, and if a user wants to customize networking, we should frame it as an installation task.

+
----
$ openshift-install create install-config
----

. Edit the parameter values in the networking section of the `install-config-yaml` file.
----
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need another + for this to render right.

$ vim install-config-yaml
----
+
[source,yaml]
----
networking:
clusterNetworks:
- cidr: 10.128.0.0/14
hostSubnetLength: 9
machineCIDR: 10.0.0.0/16
serviceCIDR: 172.30.0.0/16
type: OpenShiftSDN
----

. Save and close `install-config-yaml`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the `install-config-yaml`\ file.

Loading