diff options
author | Tristan Cacqueray <tdecacqu@redhat.com> | 2018-05-13 02:43:31 +0000 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-05-14 13:30:39 +0000 |
commit | f9eb421348bcb582907e60a9b4496239cbd2e92d (patch) | |
tree | 6fa1e59d0b2bac4859547bc35d08cc69d1ae7b76 | |
parent | 07253fc8af77a5f19f5661aaee2c1008da79611c (diff) | |
download | podman-f9eb421348bcb582907e60a9b4496239cbd2e92d.tar.gz podman-f9eb421348bcb582907e60a9b4496239cbd2e92d.tar.bz2 podman-f9eb421348bcb582907e60a9b4496239cbd2e92d.zip |
docs: fix contrib/cni broken link
This change updates the install.md documentation to reference the new
cni directory location. This change also restores the previously
deleted README.md with updated instructions.
Signed-off-by: Tristan Cacqueray <tdecacqu@redhat.com>
Closes: #761
Approved by: baude
-rw-r--r-- | cni/README.md | 15 | ||||
-rw-r--r-- | install.md | 7 |
2 files changed, 18 insertions, 4 deletions
diff --git a/cni/README.md b/cni/README.md new file mode 100644 index 000000000..d35bc4111 --- /dev/null +++ b/cni/README.md @@ -0,0 +1,15 @@ +## `cni` ## + +There are a wide variety of different [CNI][cni] network configurations. This +directory just contains an example configuration that can be used as the +basis for your own configuration. + +To use this configuration, place it in `/etc/cni/net.d` (or the directory +specified by `cni_config_dir` in your `libpod.conf`). + +In addition, you need to install the [CNI plugins][cni] necessary into +`/opt/cni/bin` (or the directory specified by `cni_plugin_dir`). The +two plugins necessary for the example CNI configurations are `portmap` and +`bridge`. + +[cni]: https://github.com/containernetworking/plugins diff --git a/install.md b/install.md index 332053238..9dc96f2ac 100644 --- a/install.md +++ b/install.md @@ -12,10 +12,9 @@ The latest version of `conmon` is expected to be installed on the system. Conmon #### Setup CNI networking -A proper description of setting up CNI networking is given in the -[`contrib/cni` README](contrib/cni/README.md). But the gist is that you need to -have some basic network configurations enabled and CNI plugins installed on -your system. +A proper description of setting up CNI networking is given in the [`cni` README](cni/README.md). +But the gist is that you need to have some basic network configurations enabled and +CNI plugins installed on your system. ### Build and Run Dependencies |