Skip to content

Add examples for dynamic shadow config generation#2605

Merged
sporksmith merged 3 commits intoshadow:mainfrom
sporksmith:advanced-spec
Dec 13, 2022
Merged

Add examples for dynamic shadow config generation#2605
sporksmith merged 3 commits intoshadow:mainfrom
sporksmith:advanced-spec

Conversation

@sporksmith
Copy link
Copy Markdown
Contributor

No description provided.

@sporksmith sporksmith added this to the Documentation milestone Dec 13, 2022
@sporksmith
Copy link
Copy Markdown
Contributor Author

I could be convinced to drop the nix example. I think it's neat, and the language has a lot more useful features for this kind of thing, but it's admittedly weird to point to given how coupled it is with the nix package manager.

@github-actions github-actions bot added the Component: Documentation In-repository documentation, under docs/ label Dec 13, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 13, 2022

Codecov Report

Base: 67.78% // Head: 67.63% // Decreases project coverage by -0.15% ⚠️

Coverage data is based on head (bda02c3) compared to base (884f478).
Patch has no changes to coverable lines.

❗ Current head bda02c3 differs from pull request most recent head 545237e. Consider uploading reports for the commit 545237e to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2605      +/-   ##
==========================================
- Coverage   67.78%   67.63%   -0.16%     
==========================================
  Files         198      198              
  Lines       29180    29192      +12     
  Branches     5739     5740       +1     
==========================================
- Hits        19781    19743      -38     
- Misses       4829     4885      +56     
+ Partials     4570     4564       -6     
Flag Coverage Δ
tests 67.63% <ø> (-0.16%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/main/host/syscall/handler/eventfd.rs 0.00% <0.00%> (-68.58%) ⬇️
src/main/host/descriptor/eventfd.rs 21.21% <0.00%> (-43.44%) ⬇️
src/main/host/syscall/format.rs 77.88% <0.00%> (-1.39%) ⬇️
src/main/host/syscall/handler/mod.rs 82.05% <0.00%> (-1.29%) ⬇️
src/test/futex/test_futex.c 64.00% <0.00%> (-0.89%) ⬇️
src/main/host/syscall/handler/unistd.rs 64.60% <0.00%> (-0.42%) ⬇️
src/main/host/descriptor/mod.rs 67.22% <0.00%> (-0.21%) ⬇️
src/main/host/host.rs 81.57% <0.00%> (+0.16%) ⬆️
src/main/host/memory_manager/memory_mapper.rs 71.63% <0.00%> (+0.20%) ⬆️
src/main/host/syscall/handler/socket.rs 66.66% <0.00%> (+0.21%) ⬆️
... and 7 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@sporksmith
Copy link
Copy Markdown
Contributor Author

Oh! Just noticed that https://shadow.github.io/docs/guide/shadow_config_overview.html#yaml-extensions-experimental already talks about the yaml extensions and has examples.

I do kind of like having a separate page with single running example of the yaml extension + generating with other tools, though. Maybe it's fine to have both, or maybe it'd make sense to drop the examples from the overview page and have a forward reference to this page instead?

Copy link
Copy Markdown
Contributor

@stevenengler stevenengler left a comment

Choose a reason for hiding this comment

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

I do kind of like having a separate page with single running example of the yaml extension + generating with other tools, though. Maybe it's fine to have both, or maybe it'd make sense to drop the examples from the overview page and have a forward reference to this page instead?

Either sounds good to me.

@sporksmith sporksmith enabled auto-merge December 13, 2022 18:07
@sporksmith sporksmith merged commit c44c5d7 into shadow:main Dec 13, 2022
@sporksmith sporksmith deleted the advanced-spec branch December 13, 2022 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Documentation In-repository documentation, under docs/

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants