Description of problem: Bug 1659052 - [RFE] Consider alternative to ICMP ping for hosted engine network test and Bug 1704183 - [RFE] Allow to choose alternative to ICMP ping for hosted engine network test introduced a new feature to hosted engine, which needs to be documented. Version-Release number of selected component (if applicable): The feature will be available in RHV 4.3.5 Additional info: https://github.com/oVirt/ovirt-site/pull/1985/
This is the feature page that was published from the PR in comment 0. https://ovirt.org/develop/release-management/features/sla/hosted-engine-network-check.html
From what I understand, the scope of this is: 1. In the document `Installing Red Hat Virtualization as a self-hosted engine using the Cockpit web interface`, in `5.2. Deploying the Self-hosted Engine using Cockpit` [1], under step 4, add sub-step VI (that's a roman numeral 6) saying: --------------- vi. Specify how to check network connectivity by selecting one of the following options from the *Network Test* pop-up menu: ping, dns, tcp, none. *none* means that the network is always considered connected. --------------- 2. In the document `Installing Red Hat Virtualization as a self-hosted engine using the command line`, in `5.2. Deploying the Self-Hosted Engine Using the Command Line` [2], one of the steps should say: --------------- Specify how to check network connectivity. *none* means that the network is always considered connected. If you select tcp, you need to specify a destination IP address and port: ---- Please specify which way the network connectivity should be checked (ping, dns, tcp, none) [dns]: tcp Please specify the desired destination IP address of the TCP connection test: sdf Please specify the desired destination TCP port of the TCP connection test: 434 ---- --------------- QUESTIONS: 1. Is it necessary to explain the details of the TCP parameters? 2. Is it necessary to explain anything about the DNS option? 3. Where in the command line script does this check appear? Please see [2] and let me know after which step this should appear. [1] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_cockpit_web_interface/index#Deploying_the_Self-Hosted_Engine_Using_Cockpit_install_RHVM [2] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_command_line/index#Deploying_the_Self-Hosted_Engine_Using_the_CLI_install_RHVM
> QUESTIONS: > 1. Is it necessary to explain the details of the TCP parameters? From my point of view, an explanation like "A TCP connection to the given host and port combination will be created. If this succeeds, network is considered as alive. Please ensure that the given host is able to accept incoming TCP connections on the given port." might be helpful for the user. > 2. Is it necessary to explain anything about the DNS option? From my point of view not, because it should succeed on common DNS configurations. > 3. Where in the command line script does this check appear? Please see [2] > and let me know after which step this should appear. > No idea, best thing would be to try in RHV-4.4 Would you try or should I do?
(In reply to Dominik Holler from comment #4) > > 3. Where in the command line script does this check appear? Please see [2] > > and let me know after which step this should appear. > > > > No idea, best thing would be to try in RHV-4.4 > Would you try or should I do? I'll race you to see who does it first! I'll give you a head start, though. You answered my questions, but can you please ACK the proposed changes in comment 3?
Asaf, can you please review my proposed changes in comment 3?
(In reply to Steve Goodman from comment #5) > > You answered my questions, but can you please ACK the proposed changes in > comment 3? Sounds correct, could you also share the change in gitlab, which might help to avoid misunderstandings?
(In reply to Steve Goodman from comment #3) > From what I understand, the scope of this is: > > 1. In the document `Installing Red Hat Virtualization as a self-hosted > engine using the Cockpit web interface`, in `5.2. Deploying the Self-hosted > Engine using Cockpit` [1], under step 4, add sub-step VI (that's a roman > numeral 6) saying: > > --------------- > > vi. Specify how to check network connectivity by selecting one of the > following options from the *Network Test* pop-up menu: ping, dns, tcp, none. > *none* means that the network is always considered connected. > LGTM, maybe use uppercase and the same order as it appears in the UI (DNS, Ping, TCP, None). > > > --------------- > > 2. In the document `Installing Red Hat Virtualization as a self-hosted > engine using the command line`, in `5.2. Deploying the Self-Hosted Engine > Using the Command Line` [2], one of the steps should say: > > --------------- > > Specify how to check network connectivity. *none* means that the network is > always considered connected. If you select tcp, you need to specify a > destination IP address and port: > ---- > Please specify which way the network connectivity should be checked (ping, > dns, tcp, none) [dns]: tcp > Please specify the desired destination IP address of the TCP connection > test: sdf > Please specify the desired destination TCP port of the TCP connection test: > 434 > ---- Will this replace or added to step 7 - "Enter the way in which the script should check network connectivity. The default is dns"? IMO if you are adding this explanation about TCP in the CLI section there should also be an equivalent explanation in the UI section.
(In reply to Asaf Rachmani from comment #8) > IMO if you are adding this explanation about TCP in the CLI section there > should also be an equivalent explanation in the UI section. In Cockpit, if you select TCP, do you have to specify the IP address and port?
Created attachment 1752575 [details] TCP-Screenshot (In reply to Steve Goodman from comment #9) > (In reply to Asaf Rachmani from comment #8) > > > IMO if you are adding this explanation about TCP in the CLI section there > > should also be an equivalent explanation in the UI section. > In Cockpit, if you select TCP, do you have to specify the IP address and > port? Yes (see attachment).
Richard, can you please do peer review on this? The sections in question are: Step 4, substep f: https://cee-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/CCS/job/ccs-mr-preview/27918/artifact/assembly-Installing_Red_Hat_Virtualization_as_a_self-hosted_engine_using_the_Cockpit_web_interface/preview/index.html#Deploying_the_Self-Hosted_Engine_Using_Cockpit_install_RHVM Step 7: https://cee-jenkins.rhev-ci-vms.eng.rdu2.redhat.com/job/CCS/job/ccs-mr-preview/27918/artifact/assembly-Installing_Red_Hat_Virtualization_as_a_self-hosted_engine_using_the_command_line/preview/index.html#Deploying_the_Self-Hosted_Engine_Using_the_CLI_install_RHVM Here's the merge request to add comments: https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/1893
The MR looks good to me.
Merged.
Published at: https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_cockpit_web_interface/index?lb_target=stage#Deploying_the_Self-Hosted_Engine_Using_Cockpit_install_RHVM