Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freepik-company/kuberecovery
Kubernetes Operator to save critical manifests to be fully deleted from the cluster
https://github.com/freepik-company/kuberecovery
disasterrecovery docker go helm kubernetes operator
Last synced: 8 days ago
JSON representation
Kubernetes Operator to save critical manifests to be fully deleted from the cluster
- Host: GitHub
- URL: https://github.com/freepik-company/kuberecovery
- Owner: freepik-company
- License: apache-2.0
- Created: 2025-01-30T12:23:44.000Z (12 days ago)
- Default Branch: main
- Last Pushed: 2025-01-31T11:49:40.000Z (11 days ago)
- Last Synced: 2025-01-31T12:27:41.549Z (11 days ago)
- Topics: disasterrecovery, docker, go, helm, kubernetes, operator
- Language: Go
- Homepage:
- Size: 325 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KubeRecovery
KubeRecovery is a Kubernetes operator that helps in recovering the resources that are deleted accidentally.
Like a recycle bin, it provides a way to recover the resources that are deleted by mistake. It is a simple
operator that watches for the resources that are deleted and provides a way to recover them.
## Motivation
Has it ever happened to you that while using `k9s`, you accidentally pressed Ctrl+D on the only secret in the cluster that
wasn’t versioned, and no matter how many times you hit Ctrl+Z, you couldn’t recover it? Or that you deleted a deployment
and have no idea which image was running at that moment?
Well, KubeRecovery is your solution. With KubeRecovery, you can recover mistakenly deleted resources as if they were in
a recycle bin.
## How it works
KubeRecovery is based on just two components:
* **RecoveryConfig**: This resource is responsible for defining which cluster resources you want to audit and recover
in case of a major disaster.
```yaml
apiVersion: kuberecovery.freepik.com/v1alpha1
kind: RecoveryConfig
metadata:
name: recoveryconfig-sample
spec:
# Resources to watch and save as RecoveryResource object when they are deleted
# apiVersion and resources * is not supported, use specific version and resource instead
# For namespaces use "*" to watch all namespaces
resourcesIncluded:
- apiVersion: "apps/v1"
resources: ["deployments"]
namespaces: ["*"]
- apiVersion: "v1"
resources: ["services"]
namespaces: ["*"]
# Resources to exclude from watching and saving as RecoveryResource object
# apiVersion * is not supported, use specific apiVersion instead
# Namespaces, names and resources regexp are supported, so you can define * to exclude all resources
# of a resource or namespace or defau* to exclude all resources that start with defau
resourcesExcluded:
- apiVersion: "v1"
resources: ["services"]
namespaces: ["kube-system"]
names: ["*"]
# Retention period for RecoveryResource objects
# Just support us, ns, ms, s, m, h and d as time units
retention:
period: 240h
```
* **RecoveryResource**: This resource is created when a resource is deleted. It contains all the necessary information
to restore the deleted resource.
```yaml
apiVersion: kuberecovery.freepik.com/v1alpha1
kind: RecoveryResource
metadata:
finalizers:
- kuberecovery.freepik.com/finalizer
# This finalizer is used to protect the resource from being deleted before the retentionUntil label date.
- kuberecovery.freepik.com/protectFinalizer
labels:
kuberecovery.freepik.com/recoveryConfig: recoveryconfig-sample
# This label is used to know when the resource is going to be deleted.
kuberecovery.freepik.com/retentionUntil: 2025-02-09T151001
# This label is used to know when the resource was saved at.
kuberecovery.freepik.com/savedAt: 2025-01-30T151001
name: recoveryconfig-sample-service-test-20250130151001
spec:
```
If any RecoveryResource is tagged with `kuberecovery.freepik.com/recover` and set to `"true"`, the deleted resource will
be automatically restored.
## Deployment
We recommend to deploy KubeRecovery operator with our [Helm registry](https://freepik-company.github.io/kuberecovery/).
## How to collaborate
This project is done on top of [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder), so read about that project
before collaborating. Of course, we are open to external collaborations for this project. For doing it you must fork the
repository, make your changes to the code and open a PR. The code will be reviewed and tested (always)
> We are developers and hate bad code. For that reason we ask you the highest quality on each line of code to improve
> this project on each iteration.
## Contributors
🧑🏽🦱[@dfradehubs](https://github.com/dfradehubs) - Daniel Fradejas
## License
Copyright 2025.
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.