Skip to content

Introduce netavark create command#1394

Open
ashley-cui wants to merge 3 commits intocontainers:mainfrom
ashley-cui:create
Open

Introduce netavark create command#1394
ashley-cui wants to merge 3 commits intocontainers:mainfrom
ashley-cui:create

Conversation

@ashley-cui
Copy link
Member

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

@ashley-cui
Copy link
Member Author

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.

@TomSweeneyRedHat
Copy link
Member

@ashley-cui you have some test unhappiness

@ashley-cui ashley-cui force-pushed the create branch 2 times, most recently from ea6d595 to 5047c27 Compare January 28, 2026 18:48
@packit-as-a-service
Copy link

Ephemeral COPR build failed. @containers/packit-build please check.

@ashley-cui
Copy link
Member Author

@containers/netavark-maintainers PTAL

@TomSweeneyRedHat
Copy link
Member

LGTM
but I'd like at least one person with some serious rust chops to look at this.

Copy link
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

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

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

Comment on lines +411 to +461
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()
)))
}
}
Copy link
Member

Choose a reason for hiding this comment

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

this feels like copy pasted from the other location so this must be shared as well

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

@ashley-cui
Copy link
Member Author

re-pushed with some fixes, and split out some of the commits for easier review, I'll squash them later.

@ashley-cui
Copy link
Member Author

@containers/netavark-maintainers PTAL

Copy link
Member

@mheon mheon left a comment

Choose a reason for hiding this comment

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

LGTM

@TomSweeneyRedHat
Copy link
Member

LGTM

@ashley-cui ashley-cui force-pushed the create branch 4 times, most recently from 8629a75 to 4279e31 Compare March 3, 2026 14:56
validate_routes(&mut network)?;
}

network.created = Some(Utc::now());
Copy link
Member

Choose a reason for hiding this comment

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

Is UTC correct, looking at existing code we get the local time in the config not UTC?
I think this need to be the local time Local::now() unless I am missing something

Copy link
Member Author

Choose a reason for hiding this comment

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

I think UTC is correct because Go marshall/unmarshalls into utc?

};

// validate the given options
if let Some(value) = network_opts.remove("com.docker.network.driver.mtu") {
Copy link
Member

Choose a reason for hiding this comment

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

this is fine for now, long term I rather no have docker specific option in this code base so I need to think about how to do that.


let bridge_opts = parse_bridge_opts(&network.options, true)?;
if bridge_opts.vlan.is_some()
|| (bridge_opts.mode.is_some() && bridge_opts.mode.unwrap() != "managed")
Copy link
Member

Choose a reason for hiding this comment

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

using is_some() followed by unwrap() is a bit of an anti pattern I would say.

generally speaking in this function both bools always act the same so one bool is enough. Then there is no need to declare them as mut since we could write this as early return code,

if bridge_opts.vlan.is_some() {return false}
if let Some(mode) = bridge_opts.mode {
if mode != "manged" {return false}
}

return true

It also seems like the function never returns an error, so remove the result and just return the single bool

Copy link
Member Author

Choose a reason for hiding this comment

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

38 has a ? that can result in an error, so I left the result

ipam_opts.insert("driver".to_string(), constants::IPAM_HOSTLOCAL.to_string());
}
}
d if d == constants::IPAM_HOSTLOCAL => {
Copy link
Member

Choose a reason for hiding this comment

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

that looks odd, is the syntax not just constants::IPAM_HOSTLOCAL => { which should match just fine?

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants