Skip to content

Commit 6ec728b

Browse files
committed
[docs] Migrates docs to redhat.com
1 parent b849510 commit 6ec728b

16 files changed

+64
-63
lines changed

Containerfile.bundle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
3333

3434
LABEL distribution-scope=public
3535
LABEL release="10.20.0"
36-
LABEL url="https://docs.openshift.com/container-platform/4.20/windows_containers/index.html"
36+
LABEL url="https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/index"
3737
LABEL vendor="Red Hat, Inc."
3838

3939
# Copy files to locations specified by labels.

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44
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),
66
or by specifying existing instances through a ConfigMap. The operator will do all the necessary steps to configure the instance so that it
77
can join the cluster as a worker node.
88

@@ -25,7 +25,7 @@ the private key that will be used to access the Windows instances:
2525
oc create secret generic cloud-private-key --from-file=private-key.pem=/path/to/key -n openshift-windows-machine-config-operator
2626
```
2727
We strongly recommend not using the same
28-
[private key](https://docs.openshift.com/container-platform/latest/installing/installing_azure/installing-azure-default.html#ssh-agent-using_installing-azure-default)
28+
[private key](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/installing_on_azure/installer-provisioned-infrastructure#installing-azure-default)
2929
used when installing the cluster
3030

3131
#### Changing the private key secret
@@ -223,34 +223,35 @@ in a healthy state with no disruptions.
223223
- The cluster must be running on a supported EUS version of OCP
224224
- All Windows nodes must be in a healthy state
225225
- 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)
227227

228228
### Windows nodes EUS-to-EUS update using the web console
229229

230230
**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)
233233
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+
235236
5. Wait for the Windows nodes to be upgraded towards the corresponding EUS version
236237

237238
### Windows nodes EUS-to-EUS update using the CLI
238239

239240
**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)
242243
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)
244245
5. Wait for the Windows nodes to be upgraded towards the corresponding EUS version
245246

246247
## Enabled features
247248

248249
### Autoscaling Windows nodes
249250
Cluster autoscaling is supported for Windows instances.
250251

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).
252253
- 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.
254255

255256
### Container Runtime
256257
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.
262263

263264
### Running in a disconnected/airgapped environment
264265
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)
266267
in order to mirror and run WMCO on your cluster.
267268

268269
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
273274
See install options in the [EC2LaunchV2 documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2launch-v2-install.html#lv2-configure-install).
274275

275276
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.
277278
Using ImageDigestMirrorSets and ImageTagMirrorSets to mirror container images results in different behavior than Linux Nodes.
278279
Please account for the following differences when reading the above documentation.
279280

@@ -312,18 +313,18 @@ must deploy the appropriate Windows CSI driver Daemonset. This should be done by
312313
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).
313314

314315
### 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
316317
autoscaling support is not available for Windows workloads.
317318

318319
### Other limitations
319320
WMCO / Windows nodes does not work with the following products:
320-
* [odo](https://docs.openshift.com/container-platform/latest/cli_reference/developer_cli_odo/understanding-odo.html)
321-
* [OpenShift Builds](https://docs.openshift.com/container-platform/latest/cicd/builds/understanding-image-builds.html#understanding-image-builds)
322-
* [OpenShift Pipelines](https://docs.openshift.com/container-platform/latest/cicd/pipelines/understanding-openshift-pipelines.html#understanding-openshift-pipelines)
323-
* [OpenShift Service Mesh](https://docs.openshift.com/container-platform/latest/service_mesh/v2x/ossm-about.html)
321+
* [odo](https://docs.redhat.com/en/documentation/openshift_container_platform/4.8/html/cli_tools/developer-cli-odo)
322+
* [OpenShift Builds](https://docs.redhat.com/en/documentation/builds_for_red_hat_openshift/1.4/html/about_builds/overview-of-builds)
323+
* [OpenShift Pipelines](https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.17/html-single/about_openshift_pipelines/index)
324+
* [OpenShift Service Mesh](https://docs.redhat.com/en/documentation/openshift_container_platform/4.1/html/service_mesh/service-mesh-architecture#understanding-service-mesh)
324325
* [Red Hat Insights cost management](https://docs.redhat.com/en/documentation/cost_management_service/1-latest)
325326
* [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)
327328
* [HugePages](https://kubernetes.io/docs/tasks/manage-hugepages/scheduling-hugepages/)
328329

329330
### Trunk port

bundle/manifests/windows-machine-config-operator.clusterserviceversion.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ spec:
3535
description: |-
3636
### Introduction
3737
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)
4040
The operator completes all the necessary steps to configure the Windows instance so that it can join the cluster as a worker node.
4141
4242
Usage of this operator requires an OpenShift Container Platform for Windows Containers subscription. Users looking to
@@ -47,7 +47,7 @@ spec:
4747
### Pre-requisites
4848
* A Red Hat OpenShift Container Platform for Windows Containers [subscription](https://access.redhat.com/support/policy/updates/openshift#windows)
4949
* OCP 4.19 cluster running on Azure, AWS, GCP or vSphere configured with hybrid OVN Kubernetes networking
50-
* [WMCO prerequisites](https://docs.openshift.com/container-platform/4.19/windows_containers/understanding-windows-container-workloads.html#wmco-prerequisites__understanding-windows-container-workloads)
50+
* [WMCO prerequisites](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/understanding-windows-container-workloads)
5151
5252
### Usage
5353
Once the `openshift-windows-machine-config-operator` namespace has been created, a secret must be created containing
@@ -57,7 +57,7 @@ spec:
5757
oc create secret generic cloud-private-key --from-file=private-key.pem=/path/to/key -n openshift-windows-machine-config-operator
5858
```
5959
We strongly recommend not using the same
60-
[private key](https://docs.openshift.com/container-platform/4.19/installing/installing_azure/installing-azure-default.html#ssh-agent-using_installing-azure-default)
60+
[private key](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/installing_on_azure/installing-on-azure#ssh-agent-using_installing-azure-customizations)
6161
used when installing the cluster
6262
6363
Below is an example of a vSphere Windows MachineSet which can create Windows Machines that the WMCO can react upon.
@@ -142,9 +142,9 @@ spec:
142142
server: <vCenter Server FQDN/IP>
143143
```
144144
Example MachineSet for other cloud providers:
145-
- [AWS](https://docs.openshift.com/container-platform/4.19/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.html)
146-
- [Azure](https://docs.openshift.com/container-platform/4.19/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.html)
147-
- [GCP](https://docs.openshift.com/container-platform/4.19/windows_containers/creating_windows_machinesets/creating-windows-machineset-gcp.html)
145+
- [AWS](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/creating-windows-machine-sets#creating-windows-machineset-aws)
146+
- [Azure](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/creating-windows-machine-sets#creating-windows-machineset-azure)
147+
- [GCP](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/windows_container_support_for_openshift/creating-windows-machine-sets#creating-windows-machineset-gcp)
148148
149149
### Limitations
150150
#### DeploymentConfigs
@@ -153,7 +153,7 @@ spec:
153153
154154
### Reporting issues
155155
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)
157157
before opening a support case.
158158
displayName: Windows Machine Config Operator
159159
icon:

0 commit comments

Comments
 (0)