forked from github/multus-cni
8ba2accb9f
* build: install the multus binary in an init container Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * build: generate kubeconfig via go Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * build: generate multus cni configuration via golang Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * build: provide a docker img for daemon based deployments We will have 2 different images (only on amd64 archs): - legacy entrypoint script based - daemonized process The `image-build` docker action is updated, to build these 2 images. There will be 2 different deployment specs, along with e2e test lanes, one for each of the aforementioned alternatives. Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * build: delegate CNI config watch loop via golang For the thick-plugin alternative, provide the watch loop for configuration regeneration via a golang binary. Over time, this binary is expected to run the control loop to watch out for pod updates. To enable current multus users to chose when they upgrade to this new deployment setup, these changes are provided in separate multus images, having a different yaml spec files. Both of these alternatives are tested e2e, since a new lane is introduced. The following libraries are introduced, along with the motivation for adding them: - dproxy: allows traversing the default network configuration arbitrarily, similar to what an X path / JSON path tool provides. Repo is available at [0]. - fsnotify: watch for changes in the default CNI configuration file. Repo is available at [1]. The config map providing the default network CNI configuration is not copied over, since originally, the user was not required to install a default network CNI plugin first, but, nowadays, this is a required step of multus. As such, it is no longer required to provide a default CNI configuration. [0] - https://github.com/koron/go-dproxy [1] - https://github.com/fsnotify/fsnotify Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * run gofmt Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * refactor: make the builder pattern more idiomatic to golang Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com> * build: update github actions to release new imgs Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com>
67 lines
2.4 KiB
Markdown
67 lines
2.4 KiB
Markdown
## Dockerfile build
|
|
|
|
This is used for distribution of Multus in a Docker image.
|
|
|
|
Typically you'd build this from the root of your Multus clone, as such:
|
|
|
|
```
|
|
$ docker build -t dougbtv/multus .
|
|
```
|
|
|
|
---
|
|
|
|
## Daemonset deployment
|
|
|
|
You may wish to deploy Multus as a daemonset, you can do so by starting with the example Daemonset shown here:
|
|
|
|
```
|
|
$ kubectl create -f ./images/multus-daemonset.yml
|
|
```
|
|
|
|
Note: The likely best practice here is to build your own image given the Dockerfile, and then push it to your preferred registry, and change the `image` fields in the Daemonset YAML to reference that image.
|
|
|
|
---
|
|
|
|
### `entrypoint.sh` parameters
|
|
|
|
The entrypoint takes named parameters for the configuration
|
|
|
|
You can get get help with the `--help` flag.
|
|
|
|
```
|
|
$ ./entrypoint.sh --help
|
|
|
|
This is an entrypoint script for Multus CNI to overlay its binary and
|
|
configuration into locations in a filesystem. The configuration & binary file
|
|
will be copied to the corresponding configuration directory. When
|
|
`--multus-conf-file=auto` is used, 00-multus.conf will be automatically
|
|
generated from the CNI configuration file of the master plugin (the first file
|
|
in lexicographical order in cni-conf-dir).
|
|
|
|
./entrypoint.sh
|
|
-h --help
|
|
--cni-conf-dir=/host/etc/cni/net.d
|
|
--multus-conf-file=/usr/src/multus-cni/images/70-multus.conf
|
|
--multus-kubeconfig-file-host=/etc/cni/net.d/multus.d/multus.kubeconfig
|
|
```
|
|
|
|
You must use an `=` to delimit the parameter name and the value. For example you may set a custom `cni-conf-dir` like so:
|
|
|
|
```
|
|
./entrypoint.sh --cni-conf-dir=/special/path/to/cni/configs/
|
|
```
|
|
|
|
Note: You'll noticed that there's a `/host/...` directory from the root for the default for both the `cni-conf-dir` and `cni-bin-dir` as it's intended for the host volumes to be mounted specially under this directory to help in the semantics of which paths belong to the host or container.
|
|
|
|
---
|
|
|
|
### Development notes
|
|
|
|
Example docker run command:
|
|
|
|
```
|
|
$ docker run -it -v /opt/cni/bin/:/host/opt/cni/bin/ -v /etc/cni/net.d/:/host/etc/cni/net.d/ --entrypoint=/bin/bash dougbtv/multus
|
|
```
|
|
|
|
Originally inspired by and is a portmanteau of the [Flannel daemonset](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml), the [Calico Daemonset](https://docs.projectcalico.org/manifests/calico.yaml), and the [Calico CNI install bash script](https://github.com/projectcalico/cni-plugin/blob/be4df4db2e47aa7378b1bdf6933724bac1f348d0/k8s-install/scripts/install-cni.sh#L104-L153).
|