cloudflare-tunnel-operator

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

cloudflare-tunnel-operator

★ 44 Open GitHub ↗

A kubernetes operator for creating Cloudflare tunnels in a cluster

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]
[![Artifact Hub][artifact-hub-shield]][artifact-hub-url]
[![Go][go-shield]][go-url]
[![Release][release-shield]][release-url]
<br />

<h1 align="center">Cloudflare Tunnel Operator</h1>

<p align="center">
  Kubernetes operator to run Cloudflare Tunnels
  <br />
  <a href="https://github.com/beezlabs-org/cloudflare-tunnel-operator"><strong>Explore the docs »</strong></a>
  <br />
  <br />
  <a href="https://github.com/beezlabs-org/cloudflare-tunnel-operator/issues">Report Bug</a>
  ·
  <a href="https://github.com/beezlabs-org/cloudflare-tunnel-operator/issues">Request Feature</a>
</p>

## About this project

[Cloudflare Tunnels](https://www.cloudflare.com/en-gb/products/tunnel/) allows us to access systems behind a firewall 
or ones without a static IP among other things. This can be incredibly useful for people running their own home servers 
as it enables them to expose applications running on those servers to the internet without needing to port forward
or pay for a static IP.

But what about those running home Kubernetes clusters? One could run the tunnel application like any other application
on Kubernetes but creating and destroying tunnels would either involve changing the config file in the cluster or
using the Cloudflare Tunnel dashboard. This is certainly a valid way but might not be the ideal way, especially if you
live and breathe [GitOps](https://www.weave.works/technologies/gitops/).

That is where this project comes in. It allows you to create custom resources for Cloudflare Tunnels in your Kubernetes
cluster. This means that the Tunnel will be active as long as your custom resource exists and will be updated if your
custom resource is updated.

### Built With

- [Kubebuilder](https://book.kubebuilder.io/)
- [cloudflared](https://github.com/cloudflare/cloudflared/)
- [cloudflare-go](https://github.com/cloudflare/cloudflare-go/)

## For Users

Using this operator is pretty much similar to how other operators are deployed.

### Prerequisites

### Installation

### Usage

One can optionally push to a local NPM repository using the optional Verdaccio package repository.

## For Developers

## Roadmap

The current roadmap consists of trying to include components from existing projects into this library.

## Contributing

Contributions can be made with access to the repository.

## License

Licensed under the Apache License, Version 2.0. Copyright Beez Innovation Labs Pvt Ltd.

## Contact

Sayak Mukhopadhyay - [SayakMukhopadhyay](https://github.com/SayakMukhopadhyay) - sayak@beezlabs.com

[contributors-shield]: https://shields.beezlabs.app/github/contributors/beezlabs-org/cloudflare-tunnel-operator?style=for-the-badge
[contributors-url]: https://github.com/beezlabs-org/cloudflare-tunnel-operator
[forks-shield]: https://shields.beezlabs.app/github/forks/beezlabs-org/cloudflare-tunnel-operator?style=for-the-badge
[forks-url]: https://github.com/beezlabs-org/cloudflare-tunnel-operator/network/members
[stars-shield]: https://shields.beezlabs.app/github/stars/beezlabs-org/cloudflare-tunnel-operator?style=for-the-badge
[stars-url]: https://github.com/beezlabs-org/cloudflare-tunnel-operator/stargazers
[issues-shield]: https://shields.beezlabs.app/github/issues/beezlabs-org/cloudflare-tunnel-operator?style=for-the-badge
[issues-url]: https://github.com/beezlabs-org/cloudflare-tunnel-operator/issues
[license-shield]: https://shields.beezlabs.app/github/license/beezlabs-org/cloudflare-tunnel-operator?style=for-the-badge
[license-url]: https://github.com/beezlabs-org/cloudflare-tunnel-operator/blob/master/LICENSE
[artifact-hub-shield]: https://shields.beezlabs.app/static/v1?label=Artifact%20Hub&message=beezlabs&color=417598&logo=artifacthub&style=for-the-badge
[artifact-hub-url]: https://artifacthub.io/packages/helm/beezlabs/cloudflare-tunnel-operator
[go-shield]: https://shields.beezlabs.app/github/go-mod/go-version/beezlabs-org/cloudflare-tunnel-operator?style=for-the-badge
[go-url]: https://go.dev/
[release-shield]: https://shields.beezlabs.app/github/v/release/beezlabs-org/cloudflare-tunnel-operator?sort=semver&style=for-the-badge
[release-url]: https://github.com/beezlabs-org/cloudflare-tunnel-operator/releases/latest

cloudflare-tunnel-operator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README