Skip to content

Commit 74583d3

Browse files
author
Michael Burke
committed
Revert 'WMCO hiding 4.19.0 docs'
1 parent a017fec commit 74583d3

File tree

9 files changed

+95
-138
lines changed

9 files changed

+95
-138
lines changed

_topic_maps/_topic_map.yml

Lines changed: 61 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -869,8 +869,8 @@ Topics:
869869
File: troubleshooting-s2i
870870
- Name: Troubleshooting storage issues
871871
File: troubleshooting-storage-issues
872-
# - Name: Troubleshooting Windows container workload issues
873-
# File: troubleshooting-windows-container-workload-issues
872+
- Name: Troubleshooting Windows container workload issues
873+
File: troubleshooting-windows-container-workload-issues
874874
- Name: Investigating monitoring issues
875875
File: investigating-monitoring-issues
876876
- Name: Diagnosing OpenShift CLI (oc) issues
@@ -1231,40 +1231,6 @@ Topics:
12311231
File: cert-manager-log-levels
12321232
- Name: Uninstalling the cert-manager Operator for Red Hat OpenShift
12331233
File: cert-manager-operator-uninstall
1234-
- Name: Zero Trust Workload Identity Manager
1235-
Dir: zero_trust_workload_identity_manager
1236-
Distros: openshift-enterprise
1237-
Topics:
1238-
- Name: Zero Trust Workload Identity Manager overview
1239-
File: zero-trust-manager-overview
1240-
- Name: Zero Trust Workload Identity Manager release notes
1241-
File: zero-trust-manager-release-notes
1242-
- Name: Zero Trust Workload Identity Manager components and features
1243-
File: zero-trust-manager-features
1244-
- Name: Installing Zero Trust Workload Identity Manager
1245-
File: zero-trust-manager-install
1246-
- Name: Deploying Zero Trust Workload Identity Manager operands
1247-
File: zero-trust-manager-configuration
1248-
- Name: Monitoring Zero Trust Workload Identity Manager
1249-
File: zero-trust-manager-monitoring
1250-
- Name: Uninstalling Zero Trust Workload Identity Manager
1251-
File: zero-trust-manager-uninstall
1252-
- Name: External Secrets Operator for Red Hat OpenShift
1253-
Dir: external_secrets_operator
1254-
Distros: openshift-enterprise
1255-
Topics:
1256-
- Name: External Secrets Operator overview
1257-
File: index
1258-
- Name: External Secrets Operator release notes
1259-
File: external-secrets-operator-release-notes
1260-
- Name: Installing the External Secrets Operator
1261-
File: external-secrets-operator-install
1262-
- Name: Monitoring the External Secrets Operator
1263-
File: external-secrets-operator-monitoring
1264-
- Name: Uninstalling the External Secrets Operator
1265-
File: external-secrets-operator-uninstall
1266-
- Name: External Secrets Operator APIs
1267-
File: external-secrets-operator-api
12681234
- Name: Viewing audit logs
12691235
File: audit-log-view
12701236
- Name: Configuring the audit log policy
@@ -1291,6 +1257,24 @@ Topics:
12911257
- Name: Disaster recovery considerations
12921258
File: nbde-disaster-recovery-considerations
12931259
Distros: openshift-enterprise,openshift-origin
1260+
- Name: Zero Trust Workload Identity Manager
1261+
Dir: zero_trust_workload_identity_manager
1262+
Distros: openshift-enterprise
1263+
Topics:
1264+
- Name: Zero Trust Workload Identity Manager overview
1265+
File: zero-trust-manager-overview
1266+
- Name: Zero Trust Workload Identity Manager features
1267+
File: zero-trust-manager-features
1268+
- Name: Installing Zero Trust Workload Identity Manager
1269+
File: zero-trust-manager-install
1270+
- Name: Uninstalling Zero Trust Workload Identity Manager
1271+
File: zero-trust-manager-uninstall
1272+
- Name: Deploying Zero Trust Workload Identity Manager operands
1273+
File: zero-trust-manager-configuration
1274+
- Name: Zero Trust Workload Identity Manager release notes
1275+
File: zero-trust-manager-release-notes
1276+
- Name: Monitoring Zero Trust Workload Identity Manager
1277+
File: zero-trust-manager-monitoring
12941278
---
12951279
Name: Authentication and authorization
12961280
Dir: authentication
@@ -2850,47 +2834,47 @@ Distros: openshift-origin,openshift-enterprise
28502834
Topics:
28512835
- Name: Red Hat OpenShift support for Windows Containers overview
28522836
File: index
2853-
#- Name: Release notes
2854-
# Dir: wmco_rn
2855-
# Topics:
2856-
# - Name: Red Hat OpenShift support for Windows Containers release notes
2857-
# File: windows-containers-release-notes-10-17-x
2858-
# - Name: Past releases
2859-
# File: windows-containers-release-notes-10-17-x-past
2860-
# - Name: Windows Machine Config Operator prerequisites
2861-
# File: windows-containers-release-notes-10-17-x-prereqs
2862-
# - Name: Windows Machine Config Operator known limitations
2863-
# File: windows-containers-release-notes-10-17-x-limitations
2864-
#- Name: Getting support
2865-
# File: windows-containers-support
2866-
# Distros: openshift-enterprise
2867-
#- Name: Understanding Windows container workloads
2868-
# File: understanding-windows-container-workloads
2869-
#- Name: Enabling Windows container workloads
2870-
# File: enabling-windows-container-workloads
2871-
#- Name: Creating Windows machine sets
2872-
# Dir: creating_windows_machinesets
2873-
# Topics:
2874-
# - Name: Creating a Windows machine set on AWS
2875-
# File: creating-windows-machineset-aws
2876-
# - Name: Creating a Windows machine set on Azure
2877-
# File: creating-windows-machineset-azure
2878-
# - Name: Creating a Windows machine set on GCP
2879-
# File: creating-windows-machineset-gcp
2880-
# - Name: Creating a Windows machine set on Nutanix
2881-
# File: creating-windows-machineset-nutanix
2882-
# - Name: Creating a Windows machine set on vSphere
2883-
# File: creating-windows-machineset-vsphere
2884-
#- Name: Scheduling Windows container workloads
2885-
# File: scheduling-windows-workloads
2886-
#- Name: Windows node updates
2887-
# File: windows-node-upgrades
2888-
#- Name: Using Bring-Your-Own-Host Windows instances as nodes
2889-
# File: byoh-windows-instance
2890-
#- Name: Removing Windows nodes
2891-
# File: removing-windows-nodes
2892-
#- Name: Disabling Windows container workloads
2893-
# File: disabling-windows-container-workloads
2837+
- Name: Release notes
2838+
Dir: wmco_rn
2839+
Topics:
2840+
- Name: Red Hat OpenShift support for Windows Containers release notes
2841+
File: windows-containers-release-notes-10-17-x
2842+
- Name: Past releases
2843+
File: windows-containers-release-notes-10-17-x-past
2844+
- Name: Windows Machine Config Operator prerequisites
2845+
File: windows-containers-release-notes-10-17-x-prereqs
2846+
- Name: Windows Machine Config Operator known limitations
2847+
File: windows-containers-release-notes-10-17-x-limitations
2848+
- Name: Getting support
2849+
File: windows-containers-support
2850+
Distros: openshift-enterprise
2851+
- Name: Understanding Windows container workloads
2852+
File: understanding-windows-container-workloads
2853+
- Name: Enabling Windows container workloads
2854+
File: enabling-windows-container-workloads
2855+
- Name: Creating Windows machine sets
2856+
Dir: creating_windows_machinesets
2857+
Topics:
2858+
- Name: Creating a Windows machine set on AWS
2859+
File: creating-windows-machineset-aws
2860+
- Name: Creating a Windows machine set on Azure
2861+
File: creating-windows-machineset-azure
2862+
- Name: Creating a Windows machine set on GCP
2863+
File: creating-windows-machineset-gcp
2864+
- Name: Creating a Windows machine set on Nutanix
2865+
File: creating-windows-machineset-nutanix
2866+
- Name: Creating a Windows machine set on vSphere
2867+
File: creating-windows-machineset-vsphere
2868+
- Name: Scheduling Windows container workloads
2869+
File: scheduling-windows-workloads
2870+
- Name: Windows node updates
2871+
File: windows-node-upgrades
2872+
- Name: Using Bring-Your-Own-Host Windows instances as nodes
2873+
File: byoh-windows-instance
2874+
- Name: Removing Windows nodes
2875+
File: removing-windows-nodes
2876+
- Name: Disabling Windows container workloads
2877+
File: disabling-windows-container-workloads
28942878
---
28952879
Name: OpenShift sandboxed containers
28962880
Dir: sandboxed_containers
@@ -2937,10 +2921,6 @@ Topics:
29372921
File: troubleshooting-ui-plugin
29382922
# - Name: Dashboard UI plugin
29392923
# File: dashboard-ui-plugin
2940-
- Name: Monitoring API reference
2941-
File: api-monitoring-package
2942-
# - Name: Observability API reference
2943-
# File: api-observability-package
29442924
- Name: Monitoring
29452925
Dir: monitoring
29462926
Distros: openshift-enterprise,openshift-origin

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

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

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

112-
////
113-
Hiding until WMCO 10.19.0 GAs
114112
[NOTE]
115113
====
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].
114+
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].
117115
====
118-
////
119116

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

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,10 @@ 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-
////
50-
Hiding until WMCO 10.19.0 GAs
5149
[NOTE]
5250
====
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].
51+
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].
5452
====
55-
////
5653

5754
[role="_additional-resources"]
5855
.Additional resources

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,10 @@ 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-
////
54-
Hiding until WMCO 10.19.0 GAs
5553
[NOTE]
5654
====
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].
55+
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].
5856
====
59-
////
6057

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

installing/overview/installing-preparing.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,7 @@ For a production cluster, you must configure the following integrations:
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.
119119

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-
////
120+
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.
124121

125122
[id="supported-installation-methods-for-different-platforms"]
126123
== Supported installation methods for different platforms

modules/configuring-hybrid-ovnkubernetes.adoc

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,14 @@ 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.
2018
[NOTE]
2119
====
2220
This configuration is necessary to run both Linux and Windows nodes in the same cluster.
2321
====
24-
////
2522

2623
ifndef::post-install[]
2724
.Prerequisites
2825

29-
// Made changes to hide Windows-related material until WMCO 4.19.0 releases. The full procedure is below, commented out.
30-
3126
* 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.
3227
3328
.Procedure
@@ -82,9 +77,16 @@ spec:
8277
hybridClusterNetwork: <1>
8378
- cidr: 10.132.0.0/14
8479
hostPrefix: 23
80+
hybridOverlayVXLANPort: 9898 <2>
8581
----
8682
<1> Specify the CIDR configuration used for nodes on the additional overlay network. The `hybridClusterNetwork` CIDR must not overlap with the `clusterNetwork` CIDR.
83+
<2> Specify a custom VXLAN port for the additional overlay network. This is required for running Windows nodes in a cluster installed on vSphere, and must not be configured for any other cloud provider. The custom port can be any open port excluding the default `4789` port. For more information on this requirement, see the Microsoft documentation on link:https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/common-problems#pod-to-pod-connectivity-between-hosts-is-broken-on-my-kubernetes-cluster-running-on-vsphere[Pod-to-pod connectivity between hosts is broken].
8784
--
85+
+
86+
[NOTE]
87+
====
88+
Windows Server Long-Term Servicing Channel (LTSC): Windows Server 2019 is not supported on clusters with a custom `hybridOverlayVXLANPort` value because this Windows server version does not support selecting a custom VXLAN port.
89+
====
8890

8991
. Save the `cluster-network-03-config.yml` file and quit the text editor.
9092
. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The
@@ -116,7 +118,8 @@ $ oc patch networks.operator.openshift.io cluster --type=merge \
116118
"cidr": "<cidr>",
117119
"hostPrefix": <prefix>
118120
}
119-
]
121+
],
122+
"hybridOverlayVXLANPort": <overlay_port>
120123
}
121124
}
122125
}
@@ -129,6 +132,12 @@ where:
129132

130133
`cidr`:: Specify the CIDR configuration used for nodes on the additional overlay network. This CIDR must not overlap with the cluster network CIDR.
131134
`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.
135+
`hybridOverlayVXLANPort`:: Specify a custom VXLAN port for the additional overlay network. This is required for running Windows nodes in a cluster installed on vSphere, and must not be configured for any other cloud provider. The custom port can be any open port excluding the default `4789` port. For more information on this requirement, see the Microsoft documentation on link:https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/common-problems#pod-to-pod-connectivity-between-hosts-is-broken-on-my-kubernetes-cluster-running-on-vsphere[Pod-to-pod connectivity between hosts is broken].
136+
137+
[NOTE]
138+
====
139+
Windows Server Long-Term Servicing Channel (LTSC): Windows Server 2019 is not supported on clusters with a custom `hybridOverlayVXLANPort` value because this Windows server version does not support selecting a custom VXLAN port.
140+
====
132141
--
133142
+
134143
.Example output
@@ -143,11 +152,9 @@ network.operator.openshift.io/cluster patched
143152
----
144153
$ oc get network.operator.openshift.io -o jsonpath="{.items[0].spec.defaultNetwork.ovnKubernetesConfig}"
145154
----
146-
147155
endif::post-install[]
148-
149-
////
150-
Hiding until WMCO 10.19.0 GAs. Swap the two sections after WMCO GA.
156+
////
157+
Made changes to hide Windows-related material. Use this material instead of the above if the WMCO is not available at the time of an OCP release.
151158
ifndef::post-install[]
152159
.Prerequisites
153160

@@ -205,16 +212,9 @@ spec:
205212
hybridClusterNetwork: <1>
206213
- cidr: 10.132.0.0/14
207214
hostPrefix: 23
208-
hybridOverlayVXLANPort: 9898 <2>
209215
----
210216
<1> Specify the CIDR configuration used for nodes on the additional overlay network. The `hybridClusterNetwork` CIDR must not overlap with the `clusterNetwork` CIDR.
211-
<2> Specify a custom VXLAN port for the additional overlay network. This is required for running Windows nodes in a cluster installed on vSphere, and must not be configured for any other cloud provider. The custom port can be any open port excluding the default `4789` port. For more information on this requirement, see the Microsoft documentation on link:https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/common-problems#pod-to-pod-connectivity-between-hosts-is-broken-on-my-kubernetes-cluster-running-on-vsphere[Pod-to-pod connectivity between hosts is broken].
212217
--
213-
+
214-
[NOTE]
215-
====
216-
Windows Server Long-Term Servicing Channel (LTSC): Windows Server 2019 is not supported on clusters with a custom `hybridOverlayVXLANPort` value because this Windows server version does not support selecting a custom VXLAN port.
217-
====
218218

219219
. Save the `cluster-network-03-config.yml` file and quit the text editor.
220220
. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The
@@ -246,8 +246,7 @@ $ oc patch networks.operator.openshift.io cluster --type=merge \
246246
"cidr": "<cidr>",
247247
"hostPrefix": <prefix>
248248
}
249-
],
250-
"hybridOverlayVXLANPort": <overlay_port>
249+
]
251250
}
252251
}
253252
}
@@ -260,12 +259,6 @@ where:
260259

261260
`cidr`:: Specify the CIDR configuration used for nodes on the additional overlay network. This CIDR must not overlap with the cluster network CIDR.
262261
`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.
263-
`hybridOverlayVXLANPort`:: Specify a custom VXLAN port for the additional overlay network. This is required for running Windows nodes in a cluster installed on vSphere, and must not be configured for any other cloud provider. The custom port can be any open port excluding the default `4789` port. For more information on this requirement, see the Microsoft documentation on link:https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/common-problems#pod-to-pod-connectivity-between-hosts-is-broken-on-my-kubernetes-cluster-running-on-vsphere[Pod-to-pod connectivity between hosts is broken].
264-
265-
[NOTE]
266-
====
267-
Windows Server Long-Term Servicing Channel (LTSC): Windows Server 2019 is not supported on clusters with a custom `hybridOverlayVXLANPort` value because this Windows server version does not support selecting a custom VXLAN port.
268-
====
269262
--
270263
+
271264
.Example output
@@ -280,6 +273,7 @@ network.operator.openshift.io/cluster patched
280273
----
281274
$ oc get network.operator.openshift.io -o jsonpath="{.items[0].spec.defaultNetwork.ovnKubernetesConfig}"
282275
----
276+
283277
endif::post-install[]
284278
////
285279

0 commit comments

Comments
 (0)