Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-71711

[DOC] Breaking Change in "virtctl ssh" Syntax Undocumented in Release Notes (OCP-V 4.20)

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Critical Critical
    • CNV v4.20.z
    • CNV v4.20.0
    • CNV Documentation
    • None
    • Quality / Stability / Reliability
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • 3
    • Important
    • None

      Description of problem:

      The virtctl ssh command required a change in the way the VM is targeted, specifically requiring the vmi/ prefix before the virtual machine name. This syntax change was introduced in new version 4.20. The change itself is reflected in the OpenShift Virtualization 4.20 documentation, but because the breaking change was not highlighted, existing customer scripts—which followed the previous, working syntax—failed immediately upon upgrading to OCP-V 4.20 from OCP 4.18.
      
      
      - The existing Red Hat documentation contains the old syntax for OCP 4.20 refer link [1]. While the 4.20 document shows the new syntax as well in section "VM connection commands" [2] but as per upstream document still there is difference in syntax [3], The breaking change was not announced or detailed in the 4.20 release notes[4] and our document, violating expected change has affected to all OCP-V scripts to get failed for the customer.
      
      [1] https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/virtualization/managing-vms#virt-using-virtctl-ssh-command_virt-accessing-vm-ssh
      [2] https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/virtualization/getting-started#virtctl-commands_virt-using-the-cli-tools
      [3]https://github.com/kubevirt/kubevirt/issues/15234
      [4]https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/release_notes/ocp-4-20-release-notes   

      Version-Release number of selected component (if applicable):

      CNV 4.20

      How reproducible:

      100%

      Steps to Reproduce:

      1. Attempt to connect VM through CLI using below command:
      
      ~~~
      $ virtctl -n <namespace> ssh <username>@example-vm 
      ~~~ 

      Actual results:

      Failed to connect
      
      
      target must contain type and name separated by '/'

      Expected results:

      The command should successfully establish an SSH session 

      Additional info:

      Below command works as confirmed by customer:
      
      ~~~
      $ virtctl ssh -n <namespace> <user_name>@vmi/<vm_name>
      ~~~ 
      
      This is an upstream change, While it would certainly be helpful if it were written in our docs.
      Kindly include the change https://issues.redhat.com/browse/CNV-66145 in the document.
      
      
      
      Tested in CNV 4.20 Lab environment:
      
      1. $ virtctl ssh rhel@rhel-9 -n default  ##<=============#
      target must contain type and name separated by '/'
      
      Below are the working commands:
      
      
      2. $ virtctl ssh rhel@vmi/rhel-9 -n default 
      
      3. $ virtctl ssh rhel@vm/rhel-9 -n default

       

              dclowers@redhat.com Daniel Clowers
              rhn-support-sarpatil Sarika Patil
              Geetika Kapoor Geetika Kapoor
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated: