Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WoozyMasta/kube-dump
Backup a Kubernetes cluster as a yaml manifest
https://github.com/WoozyMasta/kube-dump
backup backup-script backup-tool bash k8s kubectl kubernetes
Last synced: 3 months ago
JSON representation
Backup a Kubernetes cluster as a yaml manifest
- Host: GitHub
- URL: https://github.com/WoozyMasta/kube-dump
- Owner: WoozyMasta
- License: gpl-3.0
- Created: 2021-02-03T00:53:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T21:36:35.000Z (12 months ago)
- Last Synced: 2024-10-30T00:16:06.719Z (3 months ago)
- Topics: backup, backup-script, backup-tool, bash, k8s, kubectl, kubernetes
- Language: Shell
- Homepage: https://kube-dump.woozymasta.ru
- Size: 357 KB
- Stars: 324
- Watchers: 10
- Forks: 66
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Kube-dump
Backup a Kubernetes cluster as a yaml manifest.
* [Description](#description)
* [Quick Start Guides](#quick-start-guides)
* [Container Images](#container-images)
* [Dependencies](#dependencies)
* [Commands and flags](#commands-and-flags)
* [Environment variables](#environment-variables)
* [Resources default's](#resources-defaults)
* [Plans for further development](#plans-for-further-development)
## Description
With this utility you can save your cluster resources as nice yaml
manifests without unnecessary metadata.
Key features:
* Saving only those resources to which you have read access;
* Can work with a list of namespaces otherwise all available ones will be used;
* Can save both namespaced and cluster wide resources;
* You can run locally, in a container or in a cluster;
* Can archive and rotate dump archives;
* Can commit dumps to a git repository and send to a remote repository;
* You can specify a list of resources to be dumped;
* It is possible to configure via command line arguments as well as via
environment variables.
[](https://asciinema.org/a/3FfZlP011rF0gj443QnuWdNFE)
## Quick Start Guides
* [Run on a local machine](./docs/local.md)
(dependencies and a config for kubectl are required)
* [Run in container](./docs/container.md)
(docker, podman, etc. required and a config for kubectl)
* [Run in kubernetes as pod](./docs/pod.md)
(requires access to the kubernetes cluster and config for kubectl)
* [Run in kubernetes as a cron job using a service account](./docs/cronjob.md)
(requires access to the kubernetes cluster and
the ability to create a role or cluster role)
## Container Images
* [`docker pull ghcr.io/woozymasta/kube-dump:1.1.1`](https://github.com/WoozyMasta/kube-dump/pkgs/container/kube-dump)
* [`docker pull quay.io/woozymasta/kube-dump:1.1.1`](https://quay.io/repository/woozymasta/kube-dump)
* [`docker pull docker.io/woozymasta/kube-dump:1.1.1`](https://hub.docker.com/r/woozymasta/kube-dump)
## Dependencies
Required dependencies:
* [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -
Kubernetes command-line tool
* [`jq`](https://github.com/stedolan/jq) - Command-line JSON processor
* [`yq`](https://github.com/mikefarah/yq) - Command-line YAML processor
Optional dependencies:
* `curl` - Used to check kubernetes api livez probe when use serviceaccount
* `git` - Used to store backups as a git repository
* `tar` - Used to create backup archives with one of the compression libraries:
* `xz` - a lossless data compression file format based on the LZMA algorithm
* `gzip` - single-file/stream lossless data compression utility
* `bzip2` - compression program that uses the Burrows–Wheeler algorithm
## Commands and flags
```text
./kube-dump [command] [[flags]]
Available Commands:
all, dump Dump all kubernetes resources
ns, dump-namespaces Dump namespaced kubernetes resources
cls, dump-cluster Dump cluster wide kubernetes resources
The command can also be passed through the environment variable MODE.
All flags presented below have a similar variable in uppercase, with underscores
For example:
--destination-dir == DESTINATION_DIR
Flags:
-h, --help This help
-s, --silent Execute silently, suppress all stdout messages
-d, --destination-dir Path to dir for store dumps, default ./data
-f, --force-remove Delete resources in data directory before launch
--detailed Do not remove detailed state specific fields
--output-by-type Organize output into directories by resource type
--flat Organize all resources of the same type in the
same file
Kubernetes flags:
-n, --namespaces List of kubernetes namespaces
-r, --namespaced-resources List of namespaced resources
-k, --cluster-resources List of cluster resources
--kube-config Path to kubeconfig file
--kube-context The name of the kubeconfig context to use
--kube-cluster The name of the kubeconfig cluster to use
--kube-insecure-tls Skip check server's certificate for validity
Git commit flags:
-c, --git-commit Commit changes
-p, --git-push Commit changes and push to origin
-b, --git-branch Branch name
--git-commit-user Commit author username
--git-commit-email Commit author email
--git-remote-name Remote repo name, defualt is origin
--git-remote-url Remote repo URL
Archivate flags:
-a, --archivate Create archive of data dir
--archive-rotate-days Rotate archives older than N days
--archive-type Archive type xz, gz or bz2, default is tar
Example of use:
$cmd dump-namespaces -n default,dev -d /mnt/dump -spa --archive-type gz
```
## Environment variables
All environment variables are described in the [`.env`](./.env) file,
you can use them both for the container launch configuration and
directly from the [`.env`](./.env) file, it is read automatically at startup.
## Resources default's
All resources automatically discovered from the API if not pass as argument.
* List of namespaces
* List of default namespaced resources
* List of default cluster wide resources
## Plans for further development
* Sending dumps to s3 bucket;
* Sending notifications by email and webhook;
* Git-crypt to encrypt secrets;
* Bash autocomplete.