Skip to content

Commit

Permalink
Merge pull request #1618 from rbrtbnfgl/update-documentation
Browse files Browse the repository at this point in the history
Updated documentation
  • Loading branch information
pgonin authored Jul 20, 2022
2 parents 6bdfa27 + d3655a2 commit 5a03b2e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 21 deletions.
14 changes: 4 additions & 10 deletions Documentation/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,9 @@ Then you should be able to set the ARCH as above

# Obtaining master builds

A new build of flannel is created for every commit to master. They can be obtained from [https://quay.io/repository/coreos/flannel-git](https://quay.io/repository/coreos/flannel-git?tab=tags )
A new build of flannel is created for every commit to master. They can be obtained from [https://hub.docker.com/r/flannelcni/flannel](https://hub.docker.com/r/flannelcni/flannel/tags )

* `latest` is always the current HEAD of master. Use with caution
* The image tags have a number of components e.g. `v0.7.0-109-gb366263c-amd64`
* The last release was `v0.7.0`
* This version is 109 commits newer
* The commit hash is `gb366263c`
* `latest` is always the amd64 build.
* The image tags have a number of components e.g. `v0.19.0-amd64`
* The last release was `v0.19.0`
* The platform is `amd64`

These builds can be useful when a particular commit is needed for a specific feature or bugfix.

NOTE: the image name is `quay.io/coreos/flannel-git` for master builds. *Releases* are named `quay.io/coreos/flannel` (there is no `-git` suffix).
15 changes: 4 additions & 11 deletions Documentation/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It will also monitor `etcd` for new members of the network and adjust the routes

After flannel has acquired the subnet and configured backend, it will write out an environment variable file (`/run/flannel/subnet.env` by default) with subnet address and MTU that it supports.

For more information on checking the IP range for a specific host, see [Leases and Reservations][leases].
For more information on checking the IP range for a specific host, see [Leases and Reservations](https://github.com/flannel-io/flannel/blob/master/Documentation/reservations.md).

## Multiple networks

Expand All @@ -23,17 +23,17 @@ flanneld -subnet-file /vxlan.env -etcd-prefix=/vxlan/network

1. Download a `flannel` binary.
```bash
wget https://github.com/flannel-io/flannel/releases/download/v0.13.0/flanneld-amd64 && chmod +x flanneld-amd64
wget https://github.com/flannel-io/flannel/releases/download/v0.19.0/flanneld-amd64 && chmod +x flanneld-amd64
```
2. Run the binary.
```bash
sudo ./flanneld-amd64 # it will hang waiting to talk to etcd
```
3. Run `etcd`. Follow the instructions on the [CoreOS etcd page][coreos-etcd], or, if you have docker just do
3. Run `etcd`. Follow the instructions on the [etcd page](https://etcd.io/docs/v3.5/quickstart/), or, if you have docker just do
```bash
docker run --rm --net=host quay.io/coreos/etcd
```
4. Observe that `flannel` can now talk to `etcd`, but can't find any config. So write some config. Either get `etcdctl` from the [CoreOS etcd page][coreos-etcd], or use `docker` again.
4. Observe that `flannel` can now talk to `etcd`, but can't find any config. So write some config. Either get `etcdctl` from the [etcd page](https://etcd.io/docs/v3.5/quickstart/), or use `docker` again.
```bash
docker run --rm --net=host quay.io/coreos/etcd etcdctl set /coreos.com/network/config '{ "Network": "10.5.0.0/16", "Backend": {"Type": "vxlan"}}'
```
Expand Down Expand Up @@ -104,11 +104,6 @@ source /run/flannel/subnet.env
docker network create --attachable=true --subnet=${FLANNEL_SUBNET} -o "com.docker.network.driver.mtu"=${FLANNEL_MTU} flannel
```
## CoreOS integration
CoreOS ships with flannel integrated into the distribution.
See [Configuring flannel for container networking][configuring-flannel] for more information.
## Running on Vagrant
Vagrant has a tendency to give the default interface (one with the default route) a non-unique IP (often 10.0.2.15).
Expand All @@ -117,8 +112,6 @@ This causes flannel to register multiple nodes with the same IP.
To work around this issue, use `--iface` option to specify the interface that has a unique IP.
If you're running on CoreOS, use `cloud-config` to set `coreos.flannel.interface` to `$public_ipv4`.
## Zero-downtime restarts
When running with a backend other than `udp`, the kernel is providing the data path with `flanneld` acting as the control plane.
Expand Down

0 comments on commit 5a03b2e

Please sign in to comment.