Introduce netavark create command#1394
Conversation
|
Container libs part lives here as a draft, but the tests won't pass until this PR merges, unless there's another way to throw it at tests? The config tests are updated there and pass locally, but if there's good ideas for testing, I'm all ears. |
|
@ashley-cui you have some test unhappiness |
ashley-cui
force-pushed
the
create
branch
2 times, most recently
from
ea6d595 to
5047c27
Compare
|
Ephemeral COPR build failed. @containers/packit-build please check. |
|
@containers/netavark-maintainers PTAL |
|
LGTM |
Luap99
left a comment
Luap99
left a comment
There was a problem hiding this comment.
not a full review but some comments
I did not carefully check all the validation logic matches common but I guess we can run the common libnetwork unit tests with your new code to ensure we have proper coverage if you haven't done already
src/network/create_config/driver.rs
Outdated
| "" => Ok(String::from("false")), | ||
| "1" => Ok(String::from("true")), | ||
| "0" => Ok(String::from("false")), | ||
| "strict" | "true" | "false" => Ok(ndr.to_string()), |
There was a problem hiding this comment.
that does not seem right here for routes?
In general with all these functions here I am a bit worried about duplication with the already existing parsing in, i.e. bridge.rs file in validation there.
I think this option parsing should likely be streamlined to have one proper function that can parse all options based on the driver and return it as a sane type? Like this I find it to messy if we parse things differently in two places.
| ) -> NetavarkResult<()> { | ||
| // Find the plugin binary | ||
| let driver_name = &network.driver; | ||
| let plugin_path = if let Some(dirs) = plugin_directories { |
There was a problem hiding this comment.
this here can likely be shared with the other location where we lookup the plugin?
src/network/create_config/driver.rs
Outdated
| let mut child = Command::new(&plugin_path) | ||
| .arg("create") | ||
| .stdin(Stdio::piped()) | ||
| .stdout(Stdio::piped()) | ||
| .stderr(Stdio::inherit()) | ||
| .spawn()?; | ||
|
|
||
| let stdin = child.stdin.take().unwrap(); | ||
| serde_json::to_writer(&stdin, &input)?; | ||
| // Close stdin here to avoid that the plugin waits forever for an EOF. | ||
| // And then we would wait for the child to exit which would cause a hang. | ||
| drop(stdin); | ||
|
|
||
| // Note: We need to buffer the output and then deserialize into the correct type after | ||
| // the plugin exits, since the plugin can return two different json types depending on | ||
| // the exit code. | ||
| let mut buffer: Vec<u8> = Vec::new(); | ||
|
|
||
| let mut stdout = child.stdout.take().unwrap(); | ||
| // Do not handle error here, we have to wait for the child first. | ||
| let result = stdout.read_to_end(&mut buffer); | ||
|
|
||
| let exit_status = wrap!(child.wait(), "wait for plugin to exit")?; | ||
| if let Some(rc) = exit_status.code() { | ||
| // make sure the buffer is correct | ||
| wrap!(result, "read into buffer")?; | ||
| if rc == 0 { | ||
| // read the modified network config | ||
| let updated_network: Network = serde_json::from_slice(&buffer)?; | ||
| // Update the network with the plugin's response | ||
| *network = updated_network; | ||
| Ok(()) | ||
| } else { | ||
| // exit code not 0 => error | ||
| let err: JsonError = serde_json::from_slice(&buffer)?; | ||
| Err(NetavarkError::msg(format!( | ||
| "plugin {:?} failed with exit code {}, message: {}", | ||
| plugin_path.file_name().unwrap_or_default(), | ||
| rc, | ||
| err.error | ||
| ))) | ||
| } | ||
| } else { | ||
| // If we could not get the exit code then the process was killed by a signal. | ||
| // I don't think it is necessary to read and return the signal so we just return a generic error. | ||
| Err(NetavarkError::msg(format!( | ||
| "plugin {:?} killed by signal", | ||
| plugin_path.file_name().unwrap_or_default() | ||
| ))) | ||
| } | ||
| } |
There was a problem hiding this comment.
this feels like copy pasted from the other location so this must be shared as well
There was a problem hiding this comment.
There are some differences in how the code is used - the other driver plugin code requires fields such as container_name and container_id which we don't have since we're only filling out the config, I've re-pushed to consolidate some of the code using helper functions, but that was heavily LLM-aided. Let me know if the changes are theoretically okay, or if i should leave it as two separate functions.
Signed-off-by: Ashley Cui <acui@redhat.com>
The netavark create command is a new command that takes a partially filled out network config, and some options, via a json on stdin. The command will validate the network and fill out incompleted fields in the config. It then will return a complete network config json. The behavior is to match and replace https://github.com/containers/container-libs/blob/1e46b0756b39f76f287c64aa46c41107ad1110bb/common/libnetwork/netavark/config.go#L118 Signed-off-by: Ashley Cui <acui@redhat.com>
Signed-off-by: Ashley Cui <acui@redhat.com>
|
re-pushed with some fixes, and split out some of the commits for easier review, I'll squash them later. |
|
@containers/netavark-maintainers PTAL |
3 participants
The netavark create command is a new command that takes a partially filled out network config, and some options, via a json on stdin. The command will validate the network and fill out incompleted fields in the config. It then will return a complete network config json. The behavior is to match and replace https://github.com/containers/container-libs/blob/1e46b0756b39f76f287c64aa46c41107ad1110bb/common/libnetwork/netavark/config.go#L118