Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation #1659

Merged
merged 1 commit into from
Oct 13, 2022
Merged

Updated documentation #1659

merged 1 commit into from
Oct 13, 2022

Conversation

rbrtbnfgl
Copy link
Contributor

@rbrtbnfgl rbrtbnfgl commented Oct 12, 2022

Description

Updated documentations:

  • Removed reference to unsupported project
  • Updated link to external projects
  • Added reference to K3s and RKE2
  • Added K3s as Kubernetes example with Flannel
  • Moved k8s-manifest to k8s-old-manifest since they are used on older K8s versions
  • Moved Wireguard from experimental backend as a recommended one

Todos

  • Tests
  • Documentation
  • Release note

Release Note

None required

@@ -6,8 +6,8 @@ This document tracks projects that integrate with flannel. [Join the community](

[Kubernetes](https://kubernetes.io/docs/admin/networking/#flannel): Container orchestration platform with options for [flannel as an overlay](https://kubernetes.io/docs/admin/networking/#flannel).

[Tectonic](https://coreos.com/tectonic/): CoreOS's enterprise ready, 100% pure-upstream distribution of Kubernetes.
[Canal](https://projectcalico.docs.tigera.io/getting-started/kubernetes/flannel/flannel): Policy-based networking for cloud-native apps.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This definition is weird. I would say: Kubernetes CNI plugin that uses Calico for network policies and intra-node communications and Flannel for inter-node communications.


The static names of the interfaces are `flannel-wg` and `flannel-wg-v6`. WireGuard tools like `wg show` can be used to debug interfaces and peers.

Users of kernels < 5.6 need to [install](https://www.wireguard.com/install/) a module.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you specify the module?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following the URL you should have what you need to install based on your OS. Ubuntu, debian and openSUSE have different packages to install.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aaah ok! I think the word module is confusing. What about modifying the a module by an additional wireguard package

Signed-off-by: Roberto Bonafiglia <[email protected]>
@rbrtbnfgl rbrtbnfgl merged commit f4c2d58 into flannel-io:master Oct 13, 2022
@rbrtbnfgl rbrtbnfgl deleted the fixing-docs branch October 13, 2022 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants