diff --git a/docs/how-to-use.md b/docs/how-to-use.md index 09197162b..e0be32367 100644 --- a/docs/how-to-use.md +++ b/docs/how-to-use.md @@ -551,7 +551,7 @@ Typically, you'd modified the daemonset YAML itself to specify these parameters. For example, the `command` and `args` parameters in the `containers` section of the DaemonSet may look something like: ``` - command: ["/entrypoint.sh"] + command: ["/thin_entrypoint"] args: - "--multus-conf-file=auto" - "--namespace-isolation=true" @@ -590,7 +590,7 @@ The `--multus-conf-file` is one of two options; it can be set to a source file t The automatic configuration option is used to automatically generate Multus configurations given existing on-disk CNI configurations for your default network. -In the case that `--multus-conf-file=auto` -- The entrypoint script will look at the `--multus-autoconfig-dir` (by default, the same as the `--cni-conf-dir`). Multus will wait (600 seconds) until there's a CNI configuration file there, and it will take the alphabetically first configuration there, and it will wrap that configuration into a Multus configuration. +In the case that `--multus-conf-file=auto` -- The entrypoint script will look at the `--multus-autoconfig-dir` (by default, the same as the `--cni-conf-dir`). Multus will and take the alphabetically first configuration there, and it will wrap that configuration into a Multus configuration. --multus-autoconfig-dir=/host/etc/cni/net.d @@ -619,6 +619,11 @@ In some cases, the original CNI configuration that the Multus configuration was --cleanup-config-on-exit=true +Additionally, when specifying `--cleanup-config-on-exit=true` (valid only when using `--multus-conf-file=auto`) the entrypoint script will watch for changes of the +master CNI configuration and kubeconfig. when such change detected, the script will re-genereate Multus configuration. Watch can be skipped by setting: + + --skip-config-watch + Additionally when using CRIO, you may wish to have the CNI config file that's used as the source for `--multus-conf-file=auto` renamed. This boolean option when set to true automatically renames the file with a `.old` suffix to the original filename. --rename-conf-file=true