Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-63732

Missing hyperlink to OpenSSH key-based authentication setup in Prerequisites section of BYOH Windows instance documentation

    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • 1
    • Important
    • None
    • None
    • None
    • None
    • OSDOCS Sprint 279
    • 1
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:
      In the Prerequisites section of the [*Bring your own Windows instance*](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/windows_container_support_for_openshift/byoh-windows-instance) document, the following prerequisite is listed:

      An administrator user is present with the private key used in the secret set as an authorized SSH key.

      However, this statement does not provide a reference or hyperlink to documentation that guides users on how to configure key-based authentication in OpenSSH for Windows. Without this reference, users may find it unclear how to correctly configure SSH key-based access on Windows hosts.

       

      Suggested fix:
      Add a hyperlink to the relevant Microsoft or Red Hat documentation on configuring key-based authentication in OpenSSH for Windows. For example:

      An administrator user is present with the private key used in the secret set as an authorized SSH key. See [Configure key-based authentication in OpenSSH for Windows](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_keymanagement#configure-key-based-authentication) for more details. 

      Official Doc link:[ https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/windows_container_support_for_openshift/byoh-windows-instance#configuring-byoh-windows-instance|https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/windows_container_support_for_openshift/byoh-windows-instance#configuring-byoh-windows-instance]

      Version:
      OpenShift Container Platform 4.x

       

      Adding this hyperlink will help users quickly access the official guidance on configuring key-based authentication in OpenSSH for Windows, ensuring they can correctly set up SSH access for their Windows nodes. This improves clarity, reduces configuration errors, and enhances the overall setup experience for BYOH Windows instances.

              mburke@redhat.com Michael Burke
              rhn-support-asadawar Abhijeet Sadawarte
              None
              None
              Aharon Rasouli Aharon Rasouli
              None
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: