oxidecomputer / oxidecomputer/omicron

errors returned by instance serial console Nexus API should include the *effective* state

Open
#6,457 0 comments 0 reactions 1 assignee View on GitHub

@hawkw is already working on this.

Since Aug 27, 2024.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

The instance serial console endpoint will return an error when the instance is in a state where it doesn't have a serial console. Currently, though, that error message includes the instance's database (internal) instance state, rather than its external API state (which is determined based on both the instance and VMM records). This results in leaking internal instance states to the user, in the form of "instance is no VMM and has no active serial console server".

Incidentally, that error message should probably be improved; it's using the instance's internal state, when it should really be using the instance's effective state determined from the instance and VMM records. Then, it would actually tell us what the VMM's state was, rather than saying "instance is no VMM", which is both unhelpful and grammatically incorrect :)

Originally posted by @hawkw in https://github.com/oxidecomputer/omicron/issues/6453#issuecomment-2313422396

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.