[docs] Guide to creating/editing SMF services in omicron #5061
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
smklein
approved these changes
Feb 14, 2024
|
|
||
| == Sled agent services | ||
|
|
||
| To make sure all of the service properties are populated, you'll have to edit the `sled-agent/src/services.rs` file. This is where all of the omicron zones are built. |
There was a problem hiding this comment.
Might be worth noting -- these are valuable for properties that "can only be known at run-time"
|
|
||
| Each directory can contain a myriad of files depending on the service, but only a `manifest.xml` file is necessary. This file contains the complete set of properties associated with the service instance. | ||
|
|
||
| == Packaging |
There was a problem hiding this comment.
Thanks for documenting these short-comings. These are default decisions that were made ("rust package" comes from "package name", and "service_name" means "zone name" for zones) but this also serves as good data points for "how the manifest could be made more clear + explicit in the future".
|
Thanks for the review @smklein 🙇♀️ |
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.
This is probably incomplete, we can add more stuff down the track.
Just wanted to add some information while it's fresh in my mind