https://github.com/gravitational/wormhole/

Wireguard based overlay network CNI plugin for kubernetes
https://github.com/gravitational/wormhole/

Last synced: 3 months ago
JSON representation

Wireguard based overlay network CNI plugin for kubernetes

• Host: GitHub
• URL: https://github.com/gravitational/wormhole/
• Owner: gravitational
• License: apache-2.0
• Archived: true
• Created: 2018-10-22T14:53:41.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-28T21:43:47.000Z (over 1 year ago)
• Last Synced: 2024-08-02T02:14:39.318Z (3 months ago)
• Language: Go
• Homepage:
• Size: 38.1 MB
• Stars: 518
• Watchers: 47
• Forks: 18
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - Gravitational Wormhole - WireGuard^® for Kubernetes. (Security / Programming Languages)

README

        
# Gravitational Wormhole

> **Warning**

> 

> Wormhole was archived 2023-07-01, as Teleport no longer supports Gravity.

>

> Please see our [Gravitational is Teleport](https://goteleport.com/blog/gravitational-is-teleport/)

> blog post for more information.

Wormhole is a [CNI plugin](https://github.com/containernetworking/cni) that creates an encrypted overlay network for [kubernetes](https://kubernetes.io) clusters.

[WireGuard](https://www.wireguard.com) is a Fast, Modern, Secure VPN tunnel.

Wormhole uses WireGuard to create a simple and secure high performance encrypted overlay network for kubernetes clusters, that is easy to manage and troubleshoot.

Wormhole does not implement network policy, instead we recommend to use [calico](https://github.com/projectcalico/calico) or [kube-router](https://github.com/cloudnativelabs/kube-router) as network policy controllers.

## Getting Started

### System Requirements

1. [WireGuard](https://www.wireguard.com/install/) is installed on each node in you're cluster.

2. A Kubernetes cluster with IPAM enabled (--pod-network-cidr= when using kubeadm based install)

### Install (Kubeadm Cluster)

```console

kubectl apply -f https://raw.githubusercontent.com/gravitational/wormhole/master/docs/kube-wormhole.yaml

```

Note: The kubeadm cluster must be initialized with (--pod-network-cidr / --service-cidr) to enable IPAM

### Install (Generic)

```console

kubectl apply -f https://raw.githubusercontent.com/gravitational/wormhole/master/docs/generic-wormhole.yaml

```

Note: Replace the --overlay-cidr flag in the daemonset with the overlay-cidr that matches you're network

Note: Kubernetes IPAM must be enabled (--cluster-cidr / --allocate-node-cidrs on kube-controller-manager)

## Troubleshooting

See [troubleshooting.md](docs/troubleshooting.md)

## Test

```

go run mage.go test:all

```

## More Information

- [Wormhole RFC](docs/rfcs/0001-spec.md)