-
Bug
-
Resolution: Done
-
Undefined
-
None
-
4.13, 4.12, 4.14, 4.15, 4.16, 4.17, 4.18
-
None
-
Quality / Stability / Reliability
-
False
-
-
3
-
Low
-
None
-
None
-
None
-
None
-
OSDOCS Sprint 264
-
1
-
None
-
None
-
None
-
None
-
None
-
None
-
None
Description of problem
The "Load balancing for A/B testing" documentation has a xref link with a hard-coded version number:
When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation].
This means that in all versions of the documentation with this link, clicking the link takes the reader to the OpenShift 4.13 documentation. It also means that the link is more likely to be broken if product documentation migrates to a new location.
Version-Release number of selected component (if applicable)
4.10 through 4.18 as well as the main branch.
How reproducible
Consistently.
Steps to Reproduce
1. Search for hard-coded version strings in links: https://docs.openshift.com/container-platform/4..
Actual results
% git --no-pager -C ~/src/github.com/openshift/openshift-docs grep -e 'docs\.openshift\.com/[-a-z]\+/4\.' origin/{enterprise-4.{1..18},main} -- modules/deployments-ab-testing-lb.adoc origin/enterprise-4.10:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load-balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.11:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load-balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.12:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load-balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.13:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.14:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.15:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.16:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.17:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/enterprise-4.18:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/main:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. %
Expected results
I would expect a relative ../ link or at least a /{product-version} in the absolute link.
Additional info
I found other links with hard-coded version numbers:
% git --no-pager -C ~/src/github.com/openshift/openshift-docs grep -e 'docs.openshift.com/[-a-z]\+/4.' origin/main -- '**/*.adoc' origin/main:_unused_topics/osdk-updating-v1101-to-v1160.adoc:See link:https://docs.openshift.com/container-platform/4.9/release_notes/ocp-4-9-release-notes.html#ocp-4-9-osdk-k8s-api-bundle-validate[Validating bundle manifests for APIs removed from Kubernetes 1.22] and link:https://docs.openshift.com/container-platform/4.9/release_notes/ocp-4-9-release-notes.html#ocp-4-9-removed-kube-1-22-apis[Beta APIs removed from Kubernetes 1.22] for more information about changes introduced in Kubernetes 1.22. origin/main:authentication/assuming-an-aws-iam-role-for-a-service-account.adoc:* For general information about webhook admission plugins for OpenShift, see link:https://docs.openshift.com/container-platform/4.17/architecture/admission-plug-ins.html#admission-webhooks-about_admission-plug-ins[Webhook admission plugins] in the OpenShift Container Platform documentation. origin/main:contributing_to_docs/term_glossary.adoc:// NOTE: This is inconsistently used, e.g. https://docs.openshift.com/container-platform/4.5/rest_api/metadata_apis/event-core-v1.html origin/main:hardware_enablement/kmm-kernel-module-management.adoc:* link:https://docs.openshift.com/container-platform/4.12/authentication/understanding-and-creating-service-accounts.html#service-accounts-managing_understanding-service-accounts[Creating service accounts] origin/main:hardware_enablement/kmm-kernel-module-management.adoc:* link:https://docs.openshift.com/container-platform/4.13/hardware_enablement/psap-driver-toolkit.html[Driver Toolkit] origin/main:microshift_configuring/microshift-ingress-controller.adoc:* link:https://docs.openshift.com/container-platform/4.17/networking/networking_operators/ingress-operator.html#nw-http2-haproxy_configuring-ingress[Enabling HTTP/2 Ingress connectivity] (OpenShift Container Platform documentation) origin/main:migrating_from_ocp_3_to_4/planning-migration-3-4.adoc:Beginning with {product-title} 4.13, {op-system} now uses {op-system-base-full} 9.2 packages. This enhancement enables the latest fixes and features as well as the latest hardware support and driver updates. For more information about how this upgrade to RHEL 9.2 might affect your options configuration and services as well as driver and container support, see the link:https://docs.openshift.com/container-platform/4.13/release_notes/ocp-4-13-release-notes.html#ocp-4-13-rhel-9-considerations[RHCOS now uses RHEL 9.2] in the _OpenShift Container Platform 4.13 release notes_. origin/main:modules/about-developer-perspective.adoc:See link:https://docs.openshift.com/container-platform/4.17/applications/odc-viewing-application-composition-using-topology-view.html[Viewing application composition using the Topology] view for more information on using the *Topology* view in *Developer* perspective. origin/main:modules/adding-node-iso-configs.adoc:Here's the reference doc for agent-config.yaml: https://docs.openshift.com/container-platform/4.16/installing/installing_with_agent_based_installer/installation-config-parameters-agent.html#agent-configuration-parameters_installation-config-parameters-agent origin/main:modules/ccs-aws-provisioned.adoc:AWS security groups provide security at the protocol and port-access level; they are associated with EC2 instances and Elastic Load Balancing. Each security group contains a set of rules that filter traffic coming in and out of an EC2 instance. You must ensure the ports required for the link:https://docs.openshift.com/container-platform/4.7/installing/installing_aws/installing-aws-user-infra.html#installation-aws-user-infra-other-infrastructure_installing-aws-user-infra[{OCP} installation] are open on your network and configured to allow access between hosts. origin/main:modules/deployments-ab-testing-lb.adoc:When using `alternateBackends`, also use the `roundrobin` load balancing strategy to ensure requests are distributed as expected to the services based on weight. `roundrobin` can be set for a route by using a link:https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html#nw-route-specific-annotations_route-configuration[route annotation]. origin/main:modules/microshift-control-permissions-security-context-constraints.adoc:For more information see link:https://docs.openshift.com/container-platform/4.16/authentication/managing-security-context-constraints.html[Managing security context constraints]. origin/main:modules/microshift-olm-build-op-catalogs.adoc:* For details, see link:https://docs.openshift.com/container-platform/4.14/operators/admin/olm-managing-custom-catalogs.html#olm-creating-fb-catalog-image_olm-managing-custom-catalogs[Managing custom catalogs] and link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/understanding-operators#olm-fb-catalogs-example_olm-packaging-format[Example catalog]. origin/main:modules/microshift-updating-pods-mismatch.adoc:. When there is a mismatch of the SELinux content, create a new security context constraint (SCC) and assign it to both pods. To create a SCC, see link:https://docs.openshift.com/container-platform/4.15/authentication/managing-security-context-constraints.html#security-context-constraints-creating_configuring-internal-oauth[Creating security context constraints]. origin/main:modules/mirror-registry-release-notes.adoc:To view the _mirror registry for Red{nbsp}Hat OpenShift_ 1.3 release notes, see link:https://docs.openshift.com/container-platform/4.17/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-3_installing-mirroring-creating-registry[Mirror registry for Red{nbsp}Hat OpenShift 1.3 release notes]. origin/main:modules/mirror-registry-release-notes.adoc:To view the _mirror registry for Red{nbsp}Hat OpenShift_ 1.2 release notes, see link:https://docs.openshift.com/container-platform/4.15/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-2_installing-mirroring-creating-registry[Mirror registry for Red{nbsp}Hat OpenShift 1.2 release notes]. origin/main:modules/mirror-registry-release-notes.adoc:To view the _mirror registry for Red{nbsp}Hat OpenShift_ 1.1 release notes, see link:https://docs.openshift.com/container-platform/4.15/installing/disconnected_install/installing-mirroring-creating-registry.html#mirror-registry-release-notes-1-1_installing-mirroring-creating-registry[Mirror registry for Red Hat OpenShift 1.1 release notes]. origin/main:modules/nw-ingress-controller-nodeportservice-projects.adoc:// https://docs.openshift.com/container-platform/4.17/networking/ingress-controller-dnsmgt.html (does not detail how to create the DNS) origin/main:modules/oadp-gcp-wif-cloud-authentication.adoc:* You have installed a cluster in manual mode with link:https://docs.openshift.com/container-platform/4.17/installing/installing_gcp/installing-gcp-customizations.html#installing-gcp-with-short-term-creds_installing-gcp-customizations[GCP Workload Identity configured]. origin/main:modules/oadp-installing-oadp-rosa-sts.adoc:You are now ready to backup and restore OpenShift applications, as described in the link:https://docs.openshift.com/container-platform/4.11/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.html[OADP documentation]. origin/main:modules/odc-accessing-perspectives.adoc:See link:https://docs.openshift.com/container-platform/4.17/web_console/adding-user-preferences.html[Adding User Preferences] for more information on changing perspectives. origin/main:modules/olm-mirroring-catalog-manifests.adoc:If you used the `--manifests-only` flag during the mirroring process and want to further trim the subset of packages to mirror, see the steps in the link:https://docs.openshift.com/container-platform/4.7/operators/admin/olm-managing-custom-catalogs.html#olm-mirroring-package-manifest-catalog_olm-managing-custom-catalogs[Mirroring a package manifest format catalog image] procedure of the {product-title} 4.7 documentation about modifying your `mapping.txt` file and using the file with the `oc image mirror` command. origin/main:modules/olm-updating-use-operatorconditions.adoc:An Operator author can develop their Operator to use the `operator-lib` library such that, after the Operator has been deployed by OLM, it can set its own conditions. For more resources about setting Operator conditions as an Operator author, see the link:https://docs.openshift.com/container-platform/4.12/operators/operator_sdk/osdk-generating-csvs.html#osdk-operatorconditions_osdk-generating-csvs[Enabling Operator conditions] page. origin/main:modules/ossm-release-2-6-0.adoc://Kubernetes Gateway API and {product-title} Gateway API are the same. It is referenced as {product-title} Gateway API in 2.5 and as {product-title} Gateway API here https://docs.openshift.com/container-platform/4.15/nodes/clusters/nodes-cluster-enabling-features.html so to be consistent, it is also referenced as {product-title} Gateway API for 2.6. origin/main:modules/rosa-aws-privatelink-create-cluster.adoc:. With AWS PrivateLink, you can create a cluster with a single availability zone (Single-AZ) or multiple availability zones (Multi-AZ). In either case, your machine's classless inter-domain routing (CIDR) must match your virtual private cloud's CIDR. See https://docs.openshift.com/container-platform/4.14/installing/installing_aws/installing-aws-vpc.html#installation-custom-aws-vpc-requirements_installing-aws-vpc[Requirements for using your own VPC] and link:https://docs.openshift.com/container-platform/4.14/installing/installing_aws/installing-aws-vpc.html#installation-custom-aws-vpc-validation_installing-aws-vpc[VPC Validation] for more information. origin/main:modules/rosa-hcp-aws-private-create-cluster.adoc:. Create a VPC with at least one private subnet. Ensure that your machine's classless inter-domain routing (CIDR) matches your virtual private cloud's CIDR. For more information, see https://docs.openshift.com/container-platform/4.14/installing/installing_aws/installing-aws-vpc.html#installation-custom-aws-vpc-requirements_installing-aws-vpc[Requirements for using your own VPC] and link:https://docs.openshift.com/container-platform/4.14/installing/installing_aws/installing-aws-vpc.html#installation-custom-aws-vpc-validation_installing-aws-vpc[VPC Validation]. origin/main:modules/rosa-red-hat-support-access.adoc:2. Elevated access gives SRE the access levels of a cluster-admin role. See link:https://docs.openshift.com/container-platform/4.17/authentication/using-rbac.html#default-roles_using-rbac[cluster roles] for more information. origin/main:modules/telco-ran-ref-design-features.adoc:See link:https://docs.openshift.com/container-platform/4.14/telco_ref_design_specs/ran/telco-ran-ref-design-spec.html#telco-ran-ref-design-features_ran-ref-design-spec[{product-title} 4.14 {rds} features] for more information. origin/main:networking/networking_operators/aws-load-balancer-operator.adoc:* For detailed instructions on verifying that the ELBv2 was created for the application running in the ROSA cluster, see link:https://docs.openshift.com/container-platform/4.13/networking/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.html[Creating an instance of AWS Load Balancer Controller]. origin/main:networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc:* link:https://docs.openshift.com/container-platform/4.14/networking/ovn_kubernetes_network_provider/assigning-egress-ips-ovn.html#assigning-egress-ips-ovn[Assigning egress IPs] origin/main:networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc:* link:https://docs.openshift.com/container-platform/4.14/rest_api/objects/index.html#labelselector-meta-v1[LabelSelector meta/v1] origin/main:networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc:* link:https://docs.openshift.com/container-platform/4.14/rest_api/objects/index.html#labelselectorrequirement-meta-v1[LabelSelectorRequirement meta/v1] origin/main:observability/logging/logging_alerts/custom-logging-alerts.adoc:// maybe need an update to https://docs.openshift.com/container-platform/4.13/observability/monitoring/monitoring-overview.html#default-monitoring-targets_monitoring-overview to talk about Loki and Vector now? Are these part of default monitoring? origin/main:rosa_backing_up_and_restoring_applications/backing-up-applications.adoc:* For more information about OADP, see link:https://docs.openshift.com/container-platform/4.13/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.html[About installing OADP]. origin/main:rosa_backing_up_and_restoring_applications/backing-up-applications.adoc:* For more information about CSI volumes, see link:https://docs.openshift.com/container-platform/4.13/storage/container_storage_interface/persistent-storage-csi.html[Configuring CSI volumes]. origin/main:rosa_release_notes/rosa-release-notes.adoc:* **{VirtProductName} support.** The release of {VirtProductName} 4.14 added support for running {VirtProductName} on ROSA Classic clusters. For more information, see link:https://docs.openshift.com/container-platform/4.14/virt/install/preparing-cluster-for-virt.html#virt-aws-bm_preparing-cluster-for-virt[{VirtProductName} on AWS bare metal] in the {OCP} documentation. origin/main:scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc:* link:https://docs.openshift.com/container-platform/4.11/architecture/architecture-rhcos.html[Red Hat Enterprise Linux CoreOS (RHCOS)] origin/main:service_mesh/v1x/threescale-adapter.adoc:* link:https://docs.openshift.com/container-platform/4.7/support/troubleshooting/investigating-pod-issues.html#inspecting-pod-and-container-logs_investigating-pod-issues[Inspecting pod and container logs]. origin/main:service_mesh/v2x/threescale-adapter.adoc:* link:https://docs.openshift.com/container-platform/4.7/support/troubleshooting/investigating-pod-issues.html#inspecting-pod-and-container-logs_investigating-pod-issues[Inspecting pod and container logs]. origin/main:support/approved-access.adoc:Red{nbsp}Hat Site Reliability Engineering (SRE) typically does not require elevated access to systems as part of normal operations to manage and support {product-title} clusters. Elevated access gives SRE the access levels of a cluster-admin role. See link:https://docs.openshift.com/container-platform/4.17/authentication/using-rbac.html#default-roles_using-rbac[cluster roles] for more information. %
Do these all need to be examined or have tickets submitted?