Skip to content

Clarify when not to use multihost testing#4958

Open
thrix wants to merge 1 commit into
teemtee:mainfrom
thrix:docs/multihost-separate-plans-4946
Open

Clarify when not to use multihost testing#4958
thrix wants to merge 1 commit into
teemtee:mainfrom
thrix:docs/multihost-separate-plans-4946

Conversation

@thrix

@thrix thrix commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Document that multihost testing is intended for scenarios where the provisioned guests need to communicate with each other (e.g. a server/client setup).

For multi-environment testing where hosts run independently and do not need to talk to each other (for example running the same tests across multiple environments or architectures), users should create a separate plan per environment instead of using multihost testing.

Fixes #4946

Assisted-by: Claude Code

Pull Request Checklist

  • write the documentation

Document that multihost testing is intended for scenarios where the
provisioned guests need to communicate with each other (e.g. a
server/client setup).

For multi-environment testing where hosts run independently and do not
need to talk to each other (for example running the same tests across
multiple environments or architectures), users should create a
**separate plan** per environment instead of using multihost testing.

Fixes teemtee#4946

Assisted-by: Claude Code
Signed-off-by: Miroslav Vadkerti <mvadkert@redhat.com>
@thrix thrix requested a review from psss June 3, 2026 23:37

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a note to docs/guide.rst clarifying the appropriate use cases for multihost testing. Simplify the phrasing and use parentheses in the note to improve readability.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/guide.rst
Comment on lines +1156 to +1159
If your guests do **not** need to talk to each other, for example
when you only want to run the same tests across multiple
environments or architectures independently, do **not** use
multihost testing. Create a **separate plan** for each environment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Use parentheses and simplify the phrasing to improve readability.

Suggested change
If your guests do **not** need to talk to each other, for example
when you only want to run the same tests across multiple
environments or architectures independently, do **not** use
multihost testing. Create a **separate plan** for each environment
If your guests do **not** need to talk to each other (for example,
when running the same tests across multiple environments or
architectures independently), do **not** use multihost testing.
Create a **separate plan** for each environment

@LecrisUT LecrisUT left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I do not think this is important to document on our side. It's an issue on how a user deployed, we offer advice and move on, we do not have to document each of these situations that individual users encounter.

Comment thread docs/guide.rst
Comment on lines +1159 to +1160
multihost testing. Create a **separate plan** for each environment
instead. This keeps the scenarios isolated, makes results easier to

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem like a good design for the user to use. Testing-farm has explicit api to specify the architectures. It is better handled on that kind of layer rather then the user one, i.e. do not want the user to go through all of their plans to enable risc-v manually because that is how we recommended them to mange this.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree with the idea of creating separate plans - that is not needed, not even remotely, users do not have to create separate plans. They can and do have one plan and live happily. The key is to run the plan multiple times, for example with different context given to each invocation to adjust plans and tests for the given environment (namely architecture). That may be realized as a TF job with multiple architectures, or multiple tmt run commands locally, but it does not require creation of separate plans.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@happz yeah, indeed, should not require create multiple plans. Will remove.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I do not think this is important to document on our side. It's an issue on how a user deployed, we offer advice and move on, we do not have to document each of these situations that individual users encounter.

Well, I do not agree it should not be documented, It should be documented so next time the user tries to do this we have some clear guidance and I can just point him to some FAQ or whatever

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I do not think this is important to document on our side. It's an issue on how a user deployed, we offer advice and move on, we do not have to document each of these situations that individual users encounter.

Well, I do not agree it should not be documented, It should be documented so next time the user tries to do this we have some clear guidance and I can just point him to some FAQ or whatever

I do not like having lists of "do not do this" because there is an endless amount of things that we would be putting there. Positive guidance on how you could be using is more useful, but that is already covered in the current documentation, just in different wordings and less emphasis.

@psss psss added the documentation Improvements or additions to documentation label Jun 5, 2026
@psss psss changed the title docs: clarify when not to use multihost testing Clarify when not to use multihost testing Jun 5, 2026
@psss psss added the area | multihost Issues related to the multihost testing support label Jun 5, 2026
@vaibhavdaren vaibhavdaren added the ci | full test Pull request is ready for the full test execution label Jun 8, 2026
@vaibhavdaren

Copy link
Copy Markdown
Contributor

/packit test

@vaibhavdaren

Copy link
Copy Markdown
Contributor

using this PR as a bait to check which CI Tests are failing.

Since its only documentation changes it makes a good candidate.

@github-project-automation github-project-automation Bot moved this to backlog in planning Jun 10, 2026
@therazix therazix moved this from backlog to implement in planning Jun 10, 2026
@therazix therazix moved this from implement to review in planning Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area | multihost Issues related to the multihost testing support ci | full test Pull request is ready for the full test execution documentation Improvements or additions to documentation

Projects

Status: review

Development

Successfully merging this pull request may close these issues.

Support partial provision failure in multi-guest scenarios

6 participants