[sp-sim] Update README instructions #6315
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The instructions for running MGS currently given in `sp-sim/README.adoc` seem to have bitrotted: the MGS binary is no longer named `gateway`, and is now called `mgs`, and it now requires `--address <IPv6 addr>` and `--id <UUID>` arguments as well. Furthermore, the config file provided with the SP simulator is now called `config.toml`, rather than `sidecar.toml`; as it contains configurations for both a simulated Sidecar *and* two simulated Gimlets. This commit updates the instructions in the README to match the current reality.
|
Discussed in oxide-control-plane -- it would be nice to recommend |
|
We might also want to reference the advanced instructions in the how-to-run-simulated doc? Or move that doc to a Nexus-specific one? I'm not sure -- it just seems a little confusing right now. |
|
Ah, yeah, perhaps this should just refer to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The instructions for running MGS currently given in
sp-sim/README.adocseem to have bitrotted: the MGS binary is no longer namedgateway, and is now calledmgs, and it now requires--address <IPv6 addr>and--id <UUID>arguments as well.Furthermore, the config file provided with the SP simulator is now called
config.toml, rather thansidecar.toml; as it contains configurations for both a simulated Sidecar and two simulated Gimlets.This commit updates the instructions in the README to match the current reality.