You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-19Lines changed: 20 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Introduction
4
4
The Windows Machine Config Operator configures Windows instances into nodes, enabling Windows container workloads to
5
-
be ran within OKD/OCP clusters. Windows instances can be added either by creating a [MachineSet](https://docs.openshift.com/container-platform/latest/machine_management/creating_machinesets/creating-machineset-aws.html#machine-api-overview_creating-machineset-aws),
5
+
be ran within OKD/OCP clusters. Windows instances can be added either by creating a [MachineSet](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/machine_management/overview-of-machine-management#machine-mgmt-intro-managing-compute_overview-of-machine-management),
6
6
or by specifying existing instances through a ConfigMap. The operator will do all the necessary steps to configure the instance so that it
7
7
can join the cluster as a worker node.
8
8
@@ -25,7 +25,7 @@ the private key that will be used to access the Windows instances:
@@ -223,34 +223,35 @@ in a healthy state with no disruptions.
223
223
- The cluster must be running on a supported EUS version of OCP
224
224
- All Windows nodes must be in a healthy state
225
225
- All Windows nodes must be running on the same version of WMCO
226
-
- All the of the [prerequisites of the EUS-to-EUS OCP upgrade](https://docs.openshift.com/container-platform/latest/updating/updating_a_cluster/eus-eus-update.html)
226
+
- All the of the [prerequisites of the Control Plane Only OCP upgrade](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/windows-node-upgrades#wmco-upgrades-eus_windows-node-upgrades)
227
227
228
228
### Windows nodes EUS-to-EUS update using the web console
229
229
230
230
**Procedure**
231
-
1. Uninstall WMCO from the [cluster using the web console](https://docs.openshift.com/container-platform/latest/operators/admin/olm-deleting-operators-from-cluster.html#olm-deleting-operators-from-a-cluster-using-web-console_olm-deleting-operators-from-a-cluster)
232
-
2. Follow steps for [EUS-to-EUS update using the web console](https://docs.openshift.com/container-platform/latest/updating/updating_a_cluster/eus-eus-update.html#updating-eus-to-eus-upgrade-console_eus-to-eus-update)
231
+
1. Uninstall WMCO from the [cluster using the web console](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-deleting-operators-from-a-cluster-using-web-console_olm-deleting-operators-from-a-cluster)
232
+
2. Follow steps for [Control Plane Only update using the web console](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/windows-node-upgrades#wmco-upgrades-eus-using-web-console_windows-node-upgrades)
233
233
3. Wait for the upgrade to complete towards the target EUS version
234
-
4. Install the latest available WMCO version [from OperatorHub](https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster)
234
+
4. Install the latest available WMCO version [from OperatorHub](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-adding-operators-to-a-cluster)
235
+
235
236
5. Wait for the Windows nodes to be upgraded towards the corresponding EUS version
236
237
237
238
### Windows nodes EUS-to-EUS update using the CLI
238
239
239
240
**Procedure**
240
-
1. Uninstall WMCO from the [cluster using the CLI](https://docs.openshift.com/container-platform/latest/operators/admin/olm-deleting-operators-from-cluster.html#olm-deleting-operator-from-a-cluster-using-cli_olm-deleting-operators-from-a-cluster)
241
-
2. Follow the steps for [EUS-to-EUS update using the CLI](https://docs.openshift.com/container-platform/latest/updating/updating_a_cluster/eus-eus-update.html#updating-eus-to-eus-upgrade-cli_eus-to-eus-update)
241
+
1. Uninstall WMCO from the [cluster using the CLI](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-deleting-operators-from-a-cluster)
242
+
2. Follow the steps for [Control Plane Only update using the CLI](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/windows-node-upgrades#wmco-upgrades-eus-using-cli_windows-node-upgrades)
242
243
3. Wait for the upgrade to complete towards the target EUS version
243
-
4. Install the latest available WMCO version [using the CLI](https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster)
244
+
4. Install the latest available WMCO version [using the CLI](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/enabling-windows-container-workloads#installing-wmco-using-cli_enabling-windows-container-workloads)
244
245
5. Wait for the Windows nodes to be upgraded towards the corresponding EUS version
245
246
246
247
## Enabled features
247
248
248
249
### Autoscaling Windows nodes
249
250
Cluster autoscaling is supported for Windows instances.
250
251
251
-
- Define and deploy a [ClusterAutoscaler](https://docs.openshift.com/container-platform/latest/machine_management/applying-autoscaling.html#configuring-clusterautoscaler).
252
+
- Define and deploy a [ClusterAutoscaler](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/machine_management/applying-autoscaling).
252
253
- Create a Windows node through a MachineSet (see spec in [Usage section](https://github.com/openshift/windows-machine-config-operator#usage)).
253
-
- Define and deploy a [MachineAutoscaler](https://docs.openshift.com/container-platform/latest/machine_management/applying-autoscaling.html#configuring-machineautoscaler), referencing a Windows MachineSet.
254
+
- Define and deploy a [MachineAutoscaler](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/machine_management/applying-autoscaling#configuring-clusterautoscaler_applying-autoscaling), referencing a Windows MachineSet.
254
255
255
256
### Container Runtime
256
257
Windows instances brought up with WMCO are set up with the containerd container runtime. As WMCO installs and manages the container runtime,
@@ -262,7 +263,7 @@ to route egress traffic from Windows nodes on OpenShift Container Platform.
262
263
263
264
### Running in a disconnected/airgapped environment
264
265
WMCO supports running in a disconnected environment.
265
-
Please follow the [disconnected mirroring docs](https://docs.openshift.com/container-platform/latest/installing/disconnected_install/index.html)
266
+
Please follow the [disconnected mirroring docs](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/installing_an_on-premise_cluster_with_the_agent-based_installer/understanding-disconnected-installation-mirroring#agent-install-mirroring-images-disconnected_understanding-disconnected-installation-mirroring)
266
267
in order to mirror and run WMCO on your cluster.
267
268
268
269
Nodes can be added through both MachineSets and the windows-instances ConfigMap.
@@ -273,7 +274,7 @@ For AWS platform, the Windows AMI must have installed the EC2LaunchV2 agent with
273
274
See install options in the [EC2LaunchV2 documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2launch-v2-install.html#lv2-configure-install).
274
275
275
276
In order to run Windows workloads on Nodes, the image `mcr.microsoft.com/oss/kubernetes/pause:3.9` must be mirrored.
276
-
See [Image configuration resources](https://docs.openshift.com/container-platform/latest/openshift_images/image-configuration.html) for general information on image mirroring.
277
+
See [Image configuration resources](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/images/image-configuration) for general information on image mirroring.
277
278
Using ImageDigestMirrorSets and ImageTagMirrorSets to mirror container images results in different behavior than Linux Nodes.
278
279
Please account for the following differences when reading the above documentation.
279
280
@@ -312,18 +313,18 @@ must deploy the appropriate Windows CSI driver Daemonset. This should be done by
312
313
by the chosen storage driver's provider. A list of drivers can be found [here](https://kubernetes-csi.github.io/docs/drivers.html#production-drivers).
313
314
314
315
### Pod Autoscaling
315
-
[Vertical](https://docs.openshift.com/container-platform/latest/nodes/pods/nodes-pods-vertical-autoscaler.html) Pod
316
+
[Vertical](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/nodes/working-with-pods#additional-resources-2) Pod
316
317
autoscaling support is not available for Windows workloads.
317
318
318
319
### Other limitations
319
320
WMCO / Windows nodes does not work with the following products:
* [OpenShift Service Mesh](https://docs.redhat.com/en/documentation/openshift_container_platform/4.1/html/service_mesh/service-mesh-architecture#understanding-service-mesh)
324
325
* [Red Hat Insights cost management](https://docs.redhat.com/en/documentation/cost_management_service/1-latest)
325
326
* [Red Hat OpenShift Local](https://developers.redhat.com/products/openshift-local/overview)
326
-
* [OpenShift monitoring of user defined project](https://docs.openshift.com/container-platform/latest/monitoring/enabling-monitoring-for-user-defined-projects.html#enabling-monitoring-for-user-defined-projects)
327
+
* [OpenShift monitoring of user defined project](https://docs.redhat.com/en/documentation/openshift_container_platform/4.10/html/monitoring/enabling-monitoring-for-user-defined-projects)
Copy file name to clipboardExpand all lines: bundle/manifests/windows-machine-config-operator.clusterserviceversion.yaml
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -35,8 +35,8 @@ spec:
35
35
description: |-
36
36
### Introduction
37
37
The Windows Machine Config Operator configures Windows Machines into nodes, enabling Windows container workloads to
38
-
be run on OCP clusters. Windows instances can be added either by creating a [MachineSet](https://docs.openshift.com/container-platform/4.19/machine_management/creating_machinesets/creating-machineset-aws.html#machine-api-overview_creating-machineset-aws),
39
-
or by specifying existing instances through a [ConfigMap](https://docs.openshift.com/container-platform/4.19/windows_containers/byoh-windows-instance.html)
38
+
be run on OCP clusters. Windows instances can be added either by creating a [MachineSet](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/creating-windows-machine-sets),
39
+
or by specifying existing instances through a [ConfigMap](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/byoh-windows-instance)
40
40
The operator completes all the necessary steps to configure the Windows instance so that it can join the cluster as a worker node.
41
41
42
42
Usage of this operator requires an OpenShift Container Platform for Windows Containers subscription. Users looking to
@@ -47,7 +47,7 @@ spec:
47
47
### Pre-requisites
48
48
* A Red Hat OpenShift Container Platform for Windows Containers [subscription](https://access.redhat.com/support/policy/updates/openshift#windows)
49
49
* OCP 4.19 cluster running on Azure, AWS, GCP or vSphere configured with hybrid OVN Kubernetes networking
Support for this distribution of WMCO requires a Red Hat OpenShfit subscription. Support should be requested through the Red Hat Customer Portal.
156
-
Please read through the [troubleshooting document](https://docs.openshift.com/container-platform/4.19/support/troubleshooting/troubleshooting-windows-container-workload-issues.html)
156
+
Please read through the [troubleshooting document](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/support/troubleshooting)
0 commit comments