Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guilhem/headscale-operator
A Kubernetes Operator to instanciate and control headscale instances
https://github.com/guilhem/headscale-operator
hacktoberfest kubernetes tailscale vpn wireguard
Last synced: 12 days ago
JSON representation
A Kubernetes Operator to instanciate and control headscale instances
- Host: GitHub
- URL: https://github.com/guilhem/headscale-operator
- Owner: guilhem
- License: apache-2.0
- Created: 2022-05-31T01:11:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-28T06:55:09.000Z (about 1 year ago)
- Last Synced: 2024-10-17T18:27:38.995Z (22 days ago)
- Topics: hacktoberfest, kubernetes, tailscale, vpn, wireguard
- Language: Go
- Homepage:
- Size: 125 KB
- Stars: 41
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - guilhem/headscale-operator - A Kubernetes Operator to instanciate and control headscale instances (kubernetes)
README
# headscale-operator
A Kubernetes Operator to instantiate and control headscale instances.
## Description
With _headscale-operator_ you can instantiate multiple [headscale](https://github.com/juanfont/headscale) servers for multiple purpose.
_headscale-operator_ let you manage [_namespaces_](https://github.com/juanfont/headscale/blob/main/docs/glossary.md) and _preauthkeys_.
## Getting Started
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
### Running on the cluster
1. Install Instances of Custom Resources:
```sh
kubectl apply -f config/crd/bases/
kubectl apply -f config/samples/
```
1. Build and push your image to the location specified by `IMG`:
```sh
make docker-build docker-push IMG=/headscale-operator:tag
```
1. Deploy the controller to the cluster with the image specified by `IMG`:
```sh
make deploy IMG=/headscale-operator:tag
```
### Uninstall CRDs
To delete the CRDs from the cluster:
```sh
make uninstall
```
### Undeploy controller
UnDeploy the controller to the cluster:
```sh
make undeploy
```
### How it works
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
### Test It Out
1. Install the CRDs into the cluster:
```sh
make install
```
1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
```sh
make run
```
**NOTE:** You can also run this in one step by running: `make install run`
### Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
```sh
make manifests
```
**NOTE:** Run `make --help` for more information on all potential `make` targets
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
## License
Copyright 2022 Guilhem Lettron.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.