Skip to content

Commit 5843d2a

Browse files
mburke5678mburke5678
authored
Merge pull request #94522 from mburke5678/wmco-hide-4.19-docs-take-2
WMCO hiding 4.19.0 docs
2 parents 5c2a942 + 09c5f9e commit 5843d2a

File tree

9 files changed

+207
-60
lines changed

9 files changed

+207
-60
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -867,8 +867,8 @@ Topics:
867867
File: troubleshooting-s2i
868868
- Name: Troubleshooting storage issues
869869
File: troubleshooting-storage-issues
870-
- Name: Troubleshooting Windows container workload issues
871-
File: troubleshooting-windows-container-workload-issues
870+
# - Name: Troubleshooting Windows container workload issues
871+
# File: troubleshooting-windows-container-workload-issues
872872
- Name: Investigating monitoring issues
873873
File: investigating-monitoring-issues
874874
- Name: Diagnosing OpenShift CLI (oc) issues
@@ -2817,47 +2817,47 @@ Distros: openshift-origin,openshift-enterprise
28172817
Topics:
28182818
- Name: Red Hat OpenShift support for Windows Containers overview
28192819
File: index
2820-
- Name: Release notes
2821-
Dir: wmco_rn
2822-
Topics:
2823-
- Name: Red Hat OpenShift support for Windows Containers release notes
2824-
File: windows-containers-release-notes-10-17-x
2825-
- Name: Past releases
2826-
File: windows-containers-release-notes-10-17-x-past
2827-
- Name: Windows Machine Config Operator prerequisites
2828-
File: windows-containers-release-notes-10-17-x-prereqs
2829-
- Name: Windows Machine Config Operator known limitations
2830-
File: windows-containers-release-notes-10-17-x-limitations
2831-
- Name: Getting support
2832-
File: windows-containers-support
2833-
Distros: openshift-enterprise
2834-
- Name: Understanding Windows container workloads
2835-
File: understanding-windows-container-workloads
2836-
- Name: Enabling Windows container workloads
2837-
File: enabling-windows-container-workloads
2838-
- Name: Creating Windows machine sets
2839-
Dir: creating_windows_machinesets
2840-
Topics:
2841-
- Name: Creating a Windows machine set on AWS
2842-
File: creating-windows-machineset-aws
2843-
- Name: Creating a Windows machine set on Azure
2844-
File: creating-windows-machineset-azure
2845-
- Name: Creating a Windows machine set on GCP
2846-
File: creating-windows-machineset-gcp
2847-
- Name: Creating a Windows machine set on Nutanix
2848-
File: creating-windows-machineset-nutanix
2849-
- Name: Creating a Windows machine set on vSphere
2850-
File: creating-windows-machineset-vsphere
2851-
- Name: Scheduling Windows container workloads
2852-
File: scheduling-windows-workloads
2853-
- Name: Windows node updates
2854-
File: windows-node-upgrades
2855-
- Name: Using Bring-Your-Own-Host Windows instances as nodes
2856-
File: byoh-windows-instance
2857-
- Name: Removing Windows nodes
2858-
File: removing-windows-nodes
2859-
- Name: Disabling Windows container workloads
2860-
File: disabling-windows-container-workloads
2820+
#- Name: Release notes
2821+
# Dir: wmco_rn
2822+
# Topics:
2823+
# - Name: Red Hat OpenShift support for Windows Containers release notes
2824+
# File: windows-containers-release-notes-10-19-x
2825+
# - Name: Past releases
2826+
# File: windows-containers-release-notes-10-19-x-past
2827+
# - Name: Windows Machine Config Operator prerequisites
2828+
# File: windows-containers-release-notes-10-19-x-prereqs
2829+
# - Name: Windows Machine Config Operator known limitations
2830+
# File: windows-containers-release-notes-10-19-x-limitations
2831+
#- Name: Getting support
2832+
# File: windows-containers-support
2833+
# Distros: openshift-enterprise
2834+
#- Name: Understanding Windows container workloads
2835+
# File: understanding-windows-container-workloads
2836+
#- Name: Enabling Windows container workloads
2837+
# File: enabling-windows-container-workloads
2838+
#- Name: Creating Windows machine sets
2839+
# Dir: creating_windows_machinesets
2840+
# Topics:
2841+
# - Name: Creating a Windows machine set on AWS
2842+
# File: creating-windows-machineset-aws
2843+
# - Name: Creating a Windows machine set on Azure
2844+
# File: creating-windows-machineset-azure
2845+
# - Name: Creating a Windows machine set on GCP
2846+
# File: creating-windows-machineset-gcp
2847+
# - Name: Creating a Windows machine set on Nutanix
2848+
# File: creating-windows-machineset-nutanix
2849+
# - Name: Creating a Windows machine set on vSphere
2850+
# File: creating-windows-machineset-vsphere
2851+
#- Name: Scheduling Windows container workloads
2852+
# File: scheduling-windows-workloads
2853+
#- Name: Windows node updates
2854+
# File: windows-node-upgrades
2855+
#- Name: Using Bring-Your-Own-Host Windows instances as nodes
2856+
# File: byoh-windows-instance
2857+
#- Name: Removing Windows nodes
2858+
# File: removing-windows-nodes
2859+
#- Name: Disabling Windows container workloads
2860+
# File: disabling-windows-container-workloads
28612861
---
28622862
Name: OpenShift sandboxed containers
28632863
Dir: sandboxed_containers

‎installing/installing_aws/ipi/installing-aws-network-customizations.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,13 @@ include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+1]
109109

110110
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
111111

112-
112+
////
113+
Hiding until WMCO 10.19.0 GAs
113114
[NOTE]
114115
====
115-
For more information about using Linux and Windows nodes in the same cluster, see xref:../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
116+
For more information about using Linux and Windows nodes in the same cluster, see ../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
116117
====
118+
////
117119

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

‎installing/installing_azure/ipi/installing-azure-network-customizations.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,13 @@ include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
4646
include::modules/nw-operator-cr.adoc[leveloffset=+1]
4747
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
4848

49-
49+
////
50+
Hiding until WMCO 10.19.0 GAs
5051
[NOTE]
5152
====
52-
For more information about using Linux and Windows nodes in the same cluster, see xref:../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
53+
For more information about using Linux and Windows nodes in the same cluster, see ../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
5354
====
55+
////
5456

5557
[role="_additional-resources"]
5658
.Additional resources

‎installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,13 @@ include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
5050
include::modules/nw-operator-cr.adoc[leveloffset=+1]
5151
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
5252

53-
53+
////
54+
Hiding until WMCO 10.19.0 GAs
5455
[NOTE]
5556
====
56-
For more information about using Linux and Windows nodes in the same cluster, see xref:../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
57+
For more information about using Linux and Windows nodes in the same cluster, see ../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
5758
====
58-
59+
////
5960

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

‎installing/overview/installing-preparing.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,11 @@ For a production cluster, you must configure the following integrations:
116116
== Preparing your cluster for workloads
117117

118118
Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[monitoring] for application workloads.
119-
If you plan to run xref:../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed.
119+
120+
////
121+
Hiding until WMCO 10.19.0 GAs
122+
If you plan to run ../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed.
123+
////
120124

121125
[id="supported-installation-methods-for-different-platforms"]
122126
== Supported installation methods for different platforms

‎modules/configuring-hybrid-ovnkubernetes.adoc

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,142 @@ endif::[]
1515

1616
You can configure your cluster to use hybrid networking with the OVN-Kubernetes network plugin. This allows a hybrid cluster that supports different node networking configurations.
1717

18+
////
19+
Hiding until WMCO 10.19.0 GAs. Swap the two sections after WMCO GA.
1820
[NOTE]
1921
====
2022
This configuration is necessary to run both Linux and Windows nodes in the same cluster.
2123
====
24+
////
2225

2326
ifndef::post-install[]
2427
.Prerequisites
2528

29+
// Made changes to hide Windows-related material until WMCO 4.19.0 releases. The full procedure is below, commented out.
30+
31+
* You defined `OVNKubernetes` for the `networking.networkType` parameter in the `install-config.yaml` file. See the installation documentation for configuring {product-title} network customizations on your chosen cloud provider for more information.
32+
33+
.Procedure
34+
35+
. Change to the directory that contains the installation program and create the manifests:
36+
+
37+
[source,terminal]
38+
----
39+
$ ./openshift-install create manifests --dir <installation_directory>
40+
----
41+
+
42+
--
43+
where:
44+
45+
`<installation_directory>`:: Specifies the name of the directory that contains the `install-config.yaml` file for your cluster.
46+
--
47+
48+
. Create a stub manifest file for the advanced network configuration that is named `cluster-network-03-config.yml` in the `<installation_directory>/manifests/` directory:
49+
+
50+
[source,terminal]
51+
----
52+
$ cat <<EOF > <installation_directory>/manifests/cluster-network-03-config.yml
53+
apiVersion: operator.openshift.io/v1
54+
kind: Network
55+
metadata:
56+
name: cluster
57+
spec:
58+
EOF
59+
----
60+
+
61+
--
62+
where:
63+
64+
`<installation_directory>`:: Specifies the directory name that contains the
65+
`manifests/` directory for your cluster.
66+
--
67+
68+
. Open the `cluster-network-03-config.yml` file in an editor and configure OVN-Kubernetes with hybrid networking, as in the following example:
69+
+
70+
--
71+
.Specify a hybrid networking configuration
72+
[source,yaml]
73+
----
74+
apiVersion: operator.openshift.io/v1
75+
kind: Network
76+
metadata:
77+
name: cluster
78+
spec:
79+
defaultNetwork:
80+
ovnKubernetesConfig:
81+
hybridOverlayConfig:
82+
hybridClusterNetwork: <1>
83+
- cidr: 10.132.0.0/14
84+
hostPrefix: 23
85+
----
86+
<1> Specify the CIDR configuration used for nodes on the additional overlay network. The `hybridClusterNetwork` CIDR must not overlap with the `clusterNetwork` CIDR.
87+
--
88+
89+
. Save the `cluster-network-03-config.yml` file and quit the text editor.
90+
. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The
91+
installation program deletes the `manifests/` directory when creating the
92+
cluster.
93+
endif::post-install[]
94+
ifdef::post-install[]
95+
.Prerequisites
96+
97+
* Install the OpenShift CLI (`oc`).
98+
* Log in to the cluster as a user with `cluster-admin` privileges.
99+
* Ensure that the cluster uses the OVN-Kubernetes network plugin.
100+
101+
.Procedure
102+
103+
104+
. To configure the OVN-Kubernetes hybrid network overlay, enter the following command:
105+
+
106+
[source,terminal]
107+
----
108+
$ oc patch networks.operator.openshift.io cluster --type=merge \
109+
-p '{
110+
"spec":{
111+
"defaultNetwork":{
112+
"ovnKubernetesConfig":{
113+
"hybridOverlayConfig":{
114+
"hybridClusterNetwork":[
115+
{
116+
"cidr": "<cidr>",
117+
"hostPrefix": <prefix>
118+
}
119+
]
120+
}
121+
}
122+
}
123+
}
124+
}'
125+
----
126+
+
127+
--
128+
where:
129+
130+
`cidr`:: Specify the CIDR configuration used for nodes on the additional overlay network. This CIDR must not overlap with the cluster network CIDR.
131+
`hostPrefix`:: Specifies the subnet prefix length to assign to each individual node. For example, if `hostPrefix` is set to `23`, then each node is assigned a `/23` subnet out of the given `cidr`, which allows for 510 (2^(32 - 23) - 2) pod IP addresses. If you are required to provide access to nodes from an external network, configure load balancers and routers to manage the traffic.
132+
--
133+
+
134+
.Example output
135+
[source,text]
136+
----
137+
network.operator.openshift.io/cluster patched
138+
----
139+
140+
. To confirm that the configuration is active, enter the following command. It can take several minutes for the update to apply.
141+
+
142+
[source,terminal]
143+
----
144+
$ oc get network.operator.openshift.io -o jsonpath="{.items[0].spec.defaultNetwork.ovnKubernetesConfig}"
145+
----
146+
147+
endif::post-install[]
148+
149+
////
150+
Hiding until WMCO 10.19.0 GAs. Swap the two sections after WMCO GA.
151+
ifndef::post-install[]
152+
.Prerequisites
153+
26154
* You defined `OVNKubernetes` for the `networking.networkType` parameter in the `install-config.yaml` file. See the installation documentation for configuring {product-title} network customizations on your chosen cloud provider for more information.
27155
28156
.Procedure
@@ -102,6 +230,7 @@ ifdef::post-install[]
102230
103231
.Procedure
104232

233+
105234
. To configure the OVN-Kubernetes hybrid network overlay, enter the following command:
106235
+
107236
[source,terminal]
@@ -152,6 +281,7 @@ network.operator.openshift.io/cluster patched
152281
$ oc get network.operator.openshift.io -o jsonpath="{.items[0].spec.defaultNetwork.ovnKubernetesConfig}"
153282
----
154283
endif::post-install[]
284+
////
155285

156286
ifdef::post-install[]
157287
:!post-install:

‎networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
1414
[id="configuring-hybrid-networking-additional-resources"]
1515
== Additional resources
1616

17-
* xref:../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads]
18-
* xref:../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Enabling Windows container workloads]
17+
////
18+
Hiding until WMCO 10.19.0 GAs
19+
* ../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads]
20+
* ../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Enabling Windows container workloads]
21+
////
1922
* xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Installing a cluster on AWS with network customizations]
2023
* xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Installing a cluster on Azure with network customizations]

‎welcome/learn_more_about_openshift.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,14 @@ a|* xref:../networking/networking_operators/cluster-network-operator.adoc#nw-clu
172172
| xref:../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Manage Operators]
173173
| xref:../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Creating applications from installed Operators]
174174

175-
| xref:../windows_containers/index.adoc#index[{productwinc} overview]
176-
| xref:../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads_understanding-windows-container-workloads[Understanding Windows container workloads]
177-
178175
|===
179176

177+
////
178+
Hiding until WMCO 10.19.0 releases, replace as the last row of the above table after WMCO GAs
179+
| xref:../windows_containers/index.adoc#index[{productwinc} overview]
180+
| windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads_understanding-windows-container-workloads[Understanding Windows container workloads]
181+
////
182+
180183
[discrete]
181184
==== Changing cluster components
182185

‎windows_containers/index.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
{productwinc} is a feature providing the ability to run Windows compute nodes in an {product-title} cluster. This is possible by using the Red Hat Windows Machine Config Operator (WMCO) to install and manage Windows nodes. With a Red Hat subscription, you can get support for running Windows workloads in {product-title}. Windows instances deployed by the WMCO are configured with the containerd container runtime. For more information, see the xref:../windows_containers/wmco_rn/windows-containers-release-notes-10-17-x.adoc#windows-containers-release-notes-10-17-x[release notes].
9+
10+
Documentation for {productwinc} is planned to be available for {product-title} {product-version} in the near future.
11+
12+
////
13+
Hiding until WMCO 10.19.0 GAs
14+
{productwinc} is a feature providing the ability to run Windows compute nodes in an {product-title} cluster. This is possible by using the Red Hat Windows Machine Config Operator (WMCO) to install and manage Windows nodes. With a Red Hat subscription, you can get support for running Windows workloads in {product-title}. Windows instances deployed by the WMCO are configured with the containerd container runtime. For more information, see the xref:../windows_containers/wmco_rn/windows-containers-release-notes-10-19-x.adoc#windows-containers-release-notes-10-19-x[release notes].
1015

1116
You can add Windows nodes either by creating a xref:../windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc#creating-windows-machineset-aws[compute machine set] or by specifying existing Bring-Your-Own-Host (BYOH) Window instances through a xref:../windows_containers/byoh-windows-instance.adoc#byoh-windows-instance[configuration map].
1217

@@ -33,7 +38,4 @@ You can xref:../windows_containers/disabling-windows-container-workloads.adoc#di
3338

3439
* Uninstalling the Windows Machine Config Operator
3540
* Deleting the Windows Machine Config Operator namespace
36-
37-
////
38-
Documentation for {productwinc} will be available for {product-title} {product-version} in the near future.
3941
////

0 commit comments

Comments
 (0)