Skip to content

Commit

Permalink
docs: fix contrib/cni broken link
Browse files Browse the repository at this point in the history
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 <[email protected]>

Closes: containers#761
Approved by: baude
  • Loading branch information
TristanCacqueray authored and rh-atomic-bot committed May 14, 2018
1 parent 07253fc commit f9eb421
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
15 changes: 15 additions & 0 deletions cni/README.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 3 additions & 4 deletions install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit f9eb421

Please sign in to comment.