docs, thick plugin: align docs with new configuration reference (#1055)

maiqueb · web-flow · commit 7ced7dd10ca4 · 2023-04-07T00:11:17.000+09:00
* config, daemon: shim socket path is not needed The shim socket dir attribute is only required for the shim (cni configuration). Thus, it can be removed from the daemon configuration. Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * config, daemon: rename socket dir attribute Now the socketDir parameter no longer stutters. Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * docs, thick plugin: align docs with new configuration reference PR #1053 - [0] - changed the thick plugin configuration to happen exclusively via the user provided config map. This PR aligns the multus documentation with the existing code. [0] - k8snetworkplumbingwg/multus-cni#1053 Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> --------- Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com>
diff --git a/cmd/multus-daemon/main.go b/cmd/multus-daemon/main.go
@@ -133,7 +133,7 @@ func main() {
 		configurationOptions = append(
 			configurationOptions,
 			config.WithCniConfigDir(multusConf.CniConfigDir),
-			config.WithSocketDir(daemonConf.DaemonSocketDir))
+			config.WithSocketDir(daemonConf.SocketDir))
 
 		var logOptionFuncs []config.LogOptionFunc
 		if multusConf.LogMaxAge != defaultMultusLogMaxAge {
@@ -226,7 +226,7 @@ func startMultusDaemon(daemonConfig *types.ControllerNetConf, stopCh chan struct
 		return fmt.Errorf("failed to run multus-daemon with root: %v, now running in uid: %s", err, user.Uid)
 	}
 
-	if err := srv.FilesystemPreRequirements(daemonConfig.DaemonSocketDir); err != nil {
+	if err := srv.FilesystemPreRequirements(daemonConfig.SocketDir); err != nil {
 		return fmt.Errorf("failed to prepare the cni-socket for communicating with the shim: %w", err)
 	}
 
@@ -243,9 +243,9 @@ func startMultusDaemon(daemonConfig *types.ControllerNetConf, stopCh chan struct
 		}, 0, stopCh)
 	}
 
-	l, err := srv.GetListener(api.SocketPath(daemonConfig.DaemonSocketDir))
+	l, err := srv.GetListener(api.SocketPath(daemonConfig.SocketDir))
 	if err != nil {
-		return fmt.Errorf("failed to start the CNI server using socket %s. Reason: %+v", api.SocketPath(daemonConfig.DaemonSocketDir), err)
+		return fmt.Errorf("failed to start the CNI server using socket %s. Reason: %+v", api.SocketPath(daemonConfig.SocketDir), err)
 	}
 
 	server.SetKeepAlivesEnabled(false)
diff --git a/deployments/multus-daemonset-thick.yml b/deployments/multus-daemonset-thick.yml
@@ -117,7 +117,7 @@ data:
         "logFile": "/tmp/multus.log",
         "binDir": "/opt/cni/bin",
         "cniDir": "/var/lib/cni/multus",
-        "daemonSocketDir": "/host/run/multus/",
+        "socketDir": "/host/run/multus/",
         "cniVersion": "0.3.1",
         "cniConfigDir": "/host/etc/cni/net.d",
         "multusConfigFile": "auto",
diff --git a/docs/thick-plugin.md b/docs/thick-plugin.md
@@ -53,38 +53,59 @@ kubectl apply -f deployments/multus-daemonset-thick.yml
 
 ### Command line parameters
 
-Multus thick plugin variant accepts the same
-[entrypoint arguments](https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/docs/how-to-use.md#entrypoint-script-parameters)
-its thin counterpart allows - with the following exceptions:
-
-- `additional-bin-dir`
-- `binDir`
-- `cleanup-config-on-exit`
-- `cniDir`
-- `multus-kubeconfig-file-host`
-- `rename-conf-file`
-- `skip-multus-binary-copy`
-
-It is important to refer that these are command line parameters to the golang
-binary; as such, they should be passed using a single dash ("-") e.g.
-`-additional-bin-dir=/opt/multus/bin`, `-multus-log-level=debug`, etc.
-
-Furthermore, it also accepts a new command line parameter, where the user
-specifies the path to the server configuration:
+The available command line parameters are:
 
 - `config`: Defaults to `"/etc/cni/net.d/multus.d/daemon-config.json"`
-- `metricsPort`: Metrics port (of multus' metric exporter), default is disable
+- `version`: Prints the daemon config version and exits
 
-### Server configuration
+### Server / Daemon configuration
 
 The server configuration is encoded in JSON, and allows the following keys:
 
 - `"chrootDir"`: Specify the directory which points to host root from the pod. See 'Chroot configuration' section for the details.
-- `"socketDir"`: Specify the location where the unix domain socket used for
-client/server communication will be located. Defaults to `"/run/multus"`.
+- `"socketDir"`: Specify the location where the unix domain socket used
+for client/server communication will be located. This is the location where the
+**Daemon** will read the configuration from. Defaults to `"/run/multus"`.
+- `"metricsPort"`: Metrics port (of multus' metric exporter); by default, no port
+is provided.
+- `"logFile"`: the path to where the daemon logs will be persisted.
+- `"logLevel"`: the logging level for the multus daemon logs.
+- `"logToStderr"`: enable this to have the daemon multus logs echoed to stderr
+as well. By default, it is disabled.
 
 In addition, you can add any configuration which is in [configuration reference](https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/docs/configuration.md#multus-cni-configuration-reference). Server configuration override multus CNI configuration (e.g. `/etc/cni/net.d/00-multus.conf`)
 
+Below you can see an example of the daemon configuration:
+```json
+{
+        "chrootDir": "/hostroot",
+        "confDir": "/host/etc/cni/net.d",
+        "logToStderr": true,
+        "logLevel": "verbose",
+        "logFile": "/tmp/multus.log",
+        "binDir": "/opt/cni/bin",
+        "cniDir": "/var/lib/cni/multus",
+        "socketDir": "/host/run/multus/",
+        "cniVersion": "0.3.1",
+        "cniConfigDir": "/host/etc/cni/net.d",
+        "multusConfigFile": "auto",
+        "multusAutoconfigDir": "/host/etc/cni/net.d"
+    }
+```
+
+### Client / Shim configuration
+
+The multus shim configuration is encoded in JSON, and essentially is just a
+regular CNI configuration, usually available in `/etc/cni/net.d/00-multus.conf`.
+
+It allows the following keys:
+
+- `"cniVersion"`: the CNI version for the Multus CNI plugin.
+- `"logFile"`:  the path to where the daemon logs will be persisted.
+- `"logLevel"`: the logging level for the multus daemon logs.
+- `"logToStderr"`: enable this to have the daemon multus logs echoed to stderr
+  as well. By default, it is disabled.
+
 #### Chroot configuration
 
 In thick plugin case, delegate CNI plugin is executed by multus-daemon from Pod, hence if the delegate CNI requires resources in container host, for example unix socket or even file, then CNI plugin is failed to execute because multus-daemon runs in Pod. Multus-daemon supports "chrootDir" option which executes delegate CNI under chroot (to container host).
diff --git a/e2e/templates/multus-daemonset-thick.yml.j2 b/e2e/templates/multus-daemonset-thick.yml.j2
@@ -90,7 +90,7 @@ data:
         "logFile": "/tmp/multus.log",
         "binDir": "/host/opt/cni/bin",
         "cniDir": "/var/lib/cni/multus",
-        "daemonSocketDir": "/host/run/multus",
+        "socketDir": "/host/run/multus",
         "cniVersion": "{{ CNI_VERSION }}",
         "cniConfigDir": "/host/etc/cni/net.d",
         "multusConfigFile": "auto",
diff --git a/pkg/server/api/shim.go b/pkg/server/api/shim.go
@@ -34,7 +34,7 @@ type ShimNetConf struct {
 	// types.NetConf
 
 	CNIVersion      string `json:"cniVersion,omitempty"`
-	MultusSocketDir string `json:"shimSocketDir"`
+	MultusSocketDir string `json:"daemonSocketDir"`
 	LogFile         string `json:"logFile,omitempty"`
 	LogLevel        string `json:"logLevel,omitempty"`
 	LogToStderr     bool   `json:"logToStderr,omitempty"`
diff --git a/pkg/server/server.go b/pkg/server/server.go
@@ -143,7 +143,7 @@ func NewCNIServer(daemonConfig *types.ControllerNetConf, serverConfig []byte) (*
 		logging.Verbosef("server configured with chroot: %s", daemonConfig.ChrootDir)
 	}
 
-	return newCNIServer(daemonConfig.DaemonSocketDir, kubeClient, exec, serverConfig)
+	return newCNIServer(daemonConfig.SocketDir, kubeClient, exec, serverConfig)
 }
 
 func newCNIServer(rundir string, kubeClient *k8s.ClientInfo, exec invoke.Exec, servConfig []byte) (*Server, error) {
diff --git a/pkg/server/thick_cni_test.go b/pkg/server/thick_cni_test.go
@@ -285,7 +285,7 @@ func referenceConfig(thickPluginSocketDir string) string {
 	"cniVersion": "0.4.0",
         "name": "node-cni-network",
         "type": "multus",
-        "shimSocketDir": "%s",
+        "daemonSocketDir": "%s",
         "defaultnetworkfile": "/tmp/foo.multus.conf",
         "defaultnetworkwaitseconds": 3,
         "delegates": [{
diff --git a/pkg/types/conf.go b/pkg/types/conf.go
@@ -428,7 +428,7 @@ const (
 // LoadDaemonNetConf loads the configuration for the multus daemon
 func LoadDaemonNetConf(config []byte) (*ControllerNetConf, error) {
 	daemonNetConf := &ControllerNetConf{
-		DaemonSocketDir: DefaultMultusRunDir,
+		SocketDir: DefaultMultusRunDir,
 	}
 	if err := json.Unmarshal(config, daemonNetConf); err != nil {
 		return nil, fmt.Errorf("failed to unmarshall the daemon configuration: %w", err)
diff --git a/pkg/types/types.go b/pkg/types/types.go
@@ -193,12 +193,7 @@ type ControllerNetConf struct {
 
 	// Option to point to the path of the unix domain socket through which the
 	// multus client / server communicate.
-	DaemonSocketDir string `json:"daemonSocketDir"`
-
-	// Option to point to the path of the unix domain socket through which the
-	// multus client / server communicate.
-	// This attribute is only relevant for the client / shim.
-	ShimSocketDir string `json:"shimSocketDir"`
+	SocketDir string `json:"socketDir"`
 
 	ConfigFileContents []byte `json:"-"`
 }

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ func main() {`
`133`	`133`	`configurationOptions = append(`
`134`	`134`	`configurationOptions,`
`135`	`135`	`config.WithCniConfigDir(multusConf.CniConfigDir),`
`136`		`- config.WithSocketDir(daemonConf.DaemonSocketDir))`
	`136`	`+ config.WithSocketDir(daemonConf.SocketDir))`
`137`	`137`
`138`	`138`	`var logOptionFuncs []config.LogOptionFunc`
`139`	`139`	`if multusConf.LogMaxAge != defaultMultusLogMaxAge {`
`@@ -226,7 +226,7 @@ func startMultusDaemon(daemonConfig *types.ControllerNetConf, stopCh chan struct`
`226`	`226`	`return fmt.Errorf("failed to run multus-daemon with root: %v, now running in uid: %s", err, user.Uid)`
`227`	`227`	`}`
`228`	`228`
`229`		`- if err := srv.FilesystemPreRequirements(daemonConfig.DaemonSocketDir); err != nil {`
	`229`	`+ if err := srv.FilesystemPreRequirements(daemonConfig.SocketDir); err != nil {`
`230`	`230`	`return fmt.Errorf("failed to prepare the cni-socket for communicating with the shim: %w", err)`
`231`	`231`	`}`
`232`	`232`
`@@ -243,9 +243,9 @@ func startMultusDaemon(daemonConfig *types.ControllerNetConf, stopCh chan struct`
`243`	`243`	`}, 0, stopCh)`
`244`	`244`	`}`
`245`	`245`
`246`		`- l, err := srv.GetListener(api.SocketPath(daemonConfig.DaemonSocketDir))`
	`246`	`+ l, err := srv.GetListener(api.SocketPath(daemonConfig.SocketDir))`
`247`	`247`	`if err != nil {`
`248`		`- return fmt.Errorf("failed to start the CNI server using socket %s. Reason: %+v", api.SocketPath(daemonConfig.DaemonSocketDir), err)`
	`248`	`+ return fmt.Errorf("failed to start the CNI server using socket %s. Reason: %+v", api.SocketPath(daemonConfig.SocketDir), err)`
`249`	`249`	`}`
`250`	`250`
`251`	`251`	`server.SetKeepAlivesEnabled(false)`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ func NewCNIServer(daemonConfig types.ControllerNetConf, serverConfig []byte) (`
`143`	`143`	`logging.Verbosef("server configured with chroot: %s", daemonConfig.ChrootDir)`
`144`	`144`	`}`
`145`	`145`
`146`		`- return newCNIServer(daemonConfig.DaemonSocketDir, kubeClient, exec, serverConfig)`
	`146`	`+ return newCNIServer(daemonConfig.SocketDir, kubeClient, exec, serverConfig)`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`func newCNIServer(rundir string, kubeClient k8s.ClientInfo, exec invoke.Exec, servConfig []byte) (Server, error) {`
Original file line number	Diff line number	Diff line change
`@@ -428,7 +428,7 @@ const (`
`428`	`428`	`// LoadDaemonNetConf loads the configuration for the multus daemon`
`429`	`429`	`func LoadDaemonNetConf(config []byte) (*ControllerNetConf, error) {`
`430`	`430`	`daemonNetConf := &ControllerNetConf{`
`431`		`- DaemonSocketDir: DefaultMultusRunDir,`
	`431`	`+ SocketDir: DefaultMultusRunDir,`
`432`	`432`	`}`
`433`	`433`	`if err := json.Unmarshal(config, daemonNetConf); err != nil {`
`434`	`434`	`return nil, fmt.Errorf("failed to unmarshall the daemon configuration: %w", err)`