From 2ba3d3cda217d4bc21f8786cec28c35d0438e7d9 Mon Sep 17 00:00:00 2001 From: Sho SHIMIZU Date: Sun, 23 May 2021 15:50:32 +0900 Subject: [PATCH] Describe additional condition when using clusterNetwork When configuring `clsuterNetwork` in Multus CNI config, the value for `clusterNetwork` needs to match the value for `name` key in the file `clusterNetwork` setting refers to. This condition is undocumented in doc/configuration.md. This PR adds description on the condition for users to understand `clusterNetwork` config more clearly. Signed-off-by: Sho SHIMIZU --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index fd3418fce..64dea5122 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -60,7 +60,7 @@ User should chose following parameters combination (`clusterNetwork`+`defaultNet Multus will find network for clusterNetwork/defaultNetworks as following sequences: 1. CRD object for given network name, in 'kube-system' namespace -1. CNI json config file in `confDir`. Given name should be without extention, like .conf/.conflist. (e.g. "test" for "test.conf") +1. CNI json config file in `confDir`. Given name should be without extention, like .conf/.conflist. (e.g. "test" for "test.conf"). The given name for `clusterNetwork` should match the value for `name` key in the config file (e.g. `"name": "test"` in "test.conf" when `"clusterNetwork": "test"`) 1. Directory for CNI json config file. Multus will find alphabetically first file for the network 1. Multus failed to find network. Multus raise error message