Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rabbit: add config docs #286

Merged
merged 3 commits into from
Nov 7, 2024
Merged

Conversation

jameshcorbett
Copy link
Member

@jameshcorbett jameshcorbett commented Nov 2, 2024

Two flux-coral2 PRs (flux-framework/flux-coral2#234 and flux-framework/flux-coral2#235) introduced changes to make rabbit behavior configurable through a TOML config file. Add documentation on what the options are.

Problem: the instructions for generating rabbit JGF is out of date.

Update it to describe the new way of generating JGF using the
rabbitmapping script and resources defined in the config file.
@jameshcorbett jameshcorbett marked this pull request as ready for review November 5, 2024 19:25
@jameshcorbett jameshcorbett requested a review from grondo November 5, 2024 19:26
@jameshcorbett jameshcorbett changed the title WIP: rabbit config rabbit: add config docs Nov 5, 2024
Problem: the rabbit config information deserves its own file, rather
than sharing a file with CORAL2 MPI config.

Move it.
Problem: there is no documentation on rabbit configuration with
a config file.

Add it.
Copy link
Contributor

@grondo grondo left a comment

Choose a reason for hiding this comment

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

LGTM!

@jameshcorbett jameshcorbett added the merge-when-passing mark PR for auto-merging by mergify.io bot label Nov 7, 2024
@mergify mergify bot merged commit b10690b into flux-framework:master Nov 7, 2024
7 checks passed
@jameshcorbett jameshcorbett deleted the rabbit-config branch November 7, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-when-passing mark PR for auto-merging by mergify.io bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants