Commit Graph

91 Commits

Author SHA1 Message Date
Ahmad Zolfaghari
dec0607a94 doc: change install from file to url in readme, how-to-use
Signed-off-by: Ahmad Zolfaghari <ah8ad3@gmail.com>
2024-08-09 16:32:07 +03:30
Doug Smith
b9acfeb6b7
Adds permanent slack invite (#1083) 2023-04-27 23:07:48 +09:00
Doug Smith
e692127d19
Readme updates, includes thick-plugin-by-default installation text (#1004) 2022-12-23 00:00:08 +09:00
Eoghan Russell
1aac2431b8
Fix broken link in README (#919) 2022-09-26 23:26:25 +09:00
Jan Klare
2f12b5ce99
rephrase readme section describing thin vs thick plugin
Signed-off-by: Jan Klare <jan.klare@bisdn.de>
2022-08-24 14:45:26 +02:00
Tomofumi Hayashi
9d67fbd520 Add 4.0 document 2022-06-27 22:12:23 +09:00
Moritz Kröger
130db696ca
Update quickstart.md (#754)
* Update quickstart.md

removed unnecassary dollarsign since it kills the quick copy functionality of Code in Github

* Update README.md

* Update quickstart.md

* Update how-to-use.md

Co-authored-by: Doug Smith <douglaskippsmith@gmail.com>
2021-11-12 00:24:06 +09:00
Miguel Duarte Barroso
8ba2accb9f
Replace entrypoint script with initcontainers (#718)
* 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>
2021-10-27 08:42:37 -04:00
Tomofumi Hayashi
bf0b37e010 Change file layout and mention the supported Kubernetes version 2021-09-28 22:40:51 +09:00
张祖建
a28f5cb56c Fix typos
Signed-off-by: 张祖建 <zhangzujian.7@gmail.com>
2021-09-14 00:25:01 +09:00
Tomofumi Hayashi
118cc629cf Update organization name due to ownership change 2021-03-16 16:24:49 +09:00
Kennelly, Martin
5141eab28a Fix invite to NPWG slack
Readding NPWG slack invite mechanism.

Signed-off-by: Kennelly, Martin <martin.kennelly@intel.com>
2021-03-02 04:39:51 +09:00
Tomofumi Hayashi
02ad030899 Fix CI info 2021-02-24 15:32:46 +09:00
Kennelly, Martin
094dcbe2c2 Update Slack URL in README following renaming
Signed-off-by: Kennelly, Martin <martin.kennelly@intel.com>
2021-02-18 23:42:26 +09:00
dougbtv
d4e8699825 The readme links need to be updated after directory change.
This updates the links to point to "doc/" instead of "docs/"
2020-12-17 05:23:14 +09:00
dougbtv
28bb98f78b README typo for roll-YOUR-own 2020-06-09 15:07:19 -04:00
nicklesimba
d9d72c7a4f Added coveralls badge (#363) 2019-08-23 09:42:51 -04:00
Doug Smith
1d4ac10f3d [docs] Updates the README.md to reflect the need for a default network and removes Flannel reference. 2019-05-16 10:02:47 -04:00
Doug Smith
ce11203f5c Remove Flannel from default installation method in favor of auto-configuration 2019-05-16 10:02:47 -04:00
dougbtv
10abd05b1e [docs] Adds additional quickstart.md specific guide, some updates to usage guide 2018-11-30 00:31:39 +09:00
Tomofumi Hayashi
1a78cb5766 Update README.md and split into several child documents
Fix #154 and #139. Thank you @dougbtv for reviewing the docs!
2018-11-30 00:31:39 +09:00
Dan Williams
5ef87bfd71 CRD: interfaceRequest -> interface (v1 spec conformance)
Change the Network Attachment Selection Annotation long-form
interface name request JSON key from 'interfaceRequest' to
'interface' to conform with the V1 NPWG spec.
2018-11-09 13:20:51 +09:00
Tomofumi Hayashi
f4f187d71d Incorporate @dcbw's comment. 2018-11-09 00:15:35 +09:00
Tomofumi Hayashi
60dfae14ea Add mac/interfaceRequest section in README.md 2018-11-09 00:15:35 +09:00
Tomofumi Hayashi
5782dc1916 Fix typo in README.md 2018-11-02 22:54:39 +09:00
Tomofumi Hayashi
5871c8744a Add clusterNetwork/defaultNetwork into multus
To support CRD/file/directory, add clusterNetwork/defaultNetwork
in multus.conf file.
2018-11-02 22:54:39 +09:00
Michael Cambria
5eca507387 Fix logFile to match configuration json
The Logging Options section of README describes how to specify a file
to log to.  There is a typo, LogFile should be logFile to match the
json.

Fixes #177

Signed-off-by: Michael Cambria <mcambria@redhat.com>
2018-10-31 10:14:47 +00:00
Doug Smith
21cdfe5485 Default network readiness fix conflicts after rebase 2018-10-11 11:27:18 +09:00
Kuralamudhan Ramakrishnan
cee576c4d0
Update README.md 2018-10-10 15:29:58 +01:00
Kuralamudhan Ramakrishnan
a2022fa0d2
Update README.md 2018-10-10 15:14:28 +01:00
Kuralamudhan Ramakrishnan
adbea5a638 fixing readme file version details 2018-10-01 09:40:27 +02:00
Mathieu Rohon
a4f5fd4bf0 Add portmap capability support
Signed-off-by: Mathieu Rohon <mathieu.rohon@orange.com>
2018-10-01 06:48:24 +02:00
Nirmoy Das
635a275746 fix typo in the readme files 2018-09-12 18:09:51 +01:00
dougbtv
96d4d79d1f [docs] Remove coveralls badge from README 2018-08-28 08:56:43 +01:00
dougbtv
e43f06b61d [ci][coveralls] Adds coveralls code coverage during Travis CI run, adds CI badges 2018-08-17 17:45:19 +01:00
Kuralamudhan Ramakrishnan
ca15454d5b fixing the Network object shortname in readme.md
using `kubectl get network` throws error as follows:

```
 kubectl get network
error: the server doesn't have a resource type "network"
```

So fixing it.
2018-07-30 19:23:18 +01:00
Kuralamudhan Ramakrishnan
ed0e4b76a8
Update README.md (#110)
* Update README.md
2018-07-30 17:45:17 +01:00
dougbtv
b4a1a2ec67 [docs] README updates for v3.0 2018-07-30 15:32:12 +01:00
Doug Smith
926910af08 [docker-image] Adds a Docker image for distribution of Multus binary in a Docker image (#100) 2018-07-27 19:51:51 +09:00
Dan Williams
a4567df76a Update kubernetes.cni.cncf.io -> k8s.cni.cncf.io 2018-07-24 14:02:48 +01:00
Dan Williams
4f8c285520 k8sclient: Network -> NetworkAttachmentDefinition
To align with latest spec change clarifying the name of the CRD object.
2018-07-24 14:02:48 +01:00
dougbtv
9f7c91e56d [docs] Adds documentation for logging enhancements in #90 2018-07-20 16:06:50 +01:00
Kuralamudhan Ramakrishnan
9dbd585d04
Updating the Readme file to reflect K8s NPWG CRD changes (#80)
update readme.md - tpr deprecated in k8s 1.7
2018-05-17 21:57:10 +01:00
Tomofumi Hayashi
215ddb5a1d Refine multus config file (masterplugin and always_use_default)
This fix removes 'masterplugin' and 'always_use_default' from
multus config file. default network, defined in
/etc/cni/net.d/*conf should be master and this network should be
used as default from network plumbing working group draft.
2018-05-11 17:39:43 +01:00
dougbtv
84b09de45d [docs][npwg] Examples directory & documentation 2018-04-25 14:16:50 -04:00
dougbtv
dc111cbdac [npwg] Prototype for default network, addresses #2 2018-04-04 14:54:41 -04:00
Tomofumi Hayashi
3e611010eb Merge branch 'master' of github.com:redhat-nfvpe/multus-cni into dev/add_if_name 2018-03-14 16:42:30 +09:00
Dave
6f6a4c20e6
Remove referecne to minions
The term "minion" was changed to "node" in 2014,  The discussion and eventual deprcation is documented on 
https://github.com/kubernetes/kubernetes/issues/1111

"A node is a worker machine in Kubernetes, previously known as a minion." - https://kubernetes.io/docs/concepts/architecture/nodes/

updating the documentation to reflect correct terminology
2018-02-28 11:58:58 +00:00
Kuralamudhan Ramakrishnan
452b2ede3c
Update README.md 2018-01-04 20:58:10 +00:00
Kuralamudhan Ramakrishnan
deddbd152c
Update README.md 2018-01-04 20:50:05 +00:00