Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/utkuozdemir/pv-migrate
CLI tool to easily migrate Kubernetes persistent volumes
https://github.com/utkuozdemir/pv-migrate
kubernetes migration persistent-volume-claims persistent-volumes
Last synced: about 4 hours ago
JSON representation
CLI tool to easily migrate Kubernetes persistent volumes
- Host: GitHub
- URL: https://github.com/utkuozdemir/pv-migrate
- Owner: utkuozdemir
- License: apache-2.0
- Created: 2019-02-11T22:02:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T22:14:00.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:27:30.982Z (about 1 month ago)
- Topics: kubernetes, migration, persistent-volume-claims, persistent-volumes
- Language: Go
- Homepage:
- Size: 13.6 MB
- Stars: 1,614
- Watchers: 12
- Forks: 81
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-repositories - utkuozdemir/pv-migrate - CLI tool to easily migrate Kubernetes persistent volumes (Go)
README
# pv-migrate
[](https://github.com/utkuozdemir/pv-migrate/actions/workflows/build.yml)
[](https://codecov.io/gh/utkuozdemir/pv-migrate)
[](https://goreportcard.com/report/github.com/utkuozdemir/pv-migrate)
[](https://github.com/utkuozdemir/pv-migrate/blob/master/LICENSE)
[](https://github.com/utkuozdemir/pv-migrate/network)
[](https://github.com/utkuozdemir/pv-migrate/issues)
`pv-migrate` is a CLI tool/kubectl plugin to easily migrate
the contents of one Kubernetes `PersistentVolumeClaim` to another.
---
> [!WARNING]
> I get that it can be frustrating not to hear back about the stuff you've brought up or the changes you've suggested. But honestly, for over a year now, I've hardly had any time to keep up with my personal open-source projects, including this one. I am still committed to keep this tool working and slowly move it forward, but please bear with me if I can't tackle your fixes or check out your code for a while. Thanks for your understanding.
---
## Demo
## Introduction
On Kubernetes, if you need to rename a resource (like a `Deployment`) or to move it to a different namespace,
you can simply create a copy of its manifest with the new namespace and/or name and apply it.
However, it is not as simple with `PersistentVolumeClaim` resources: They are not only metadata,
but they also store data in the underlying storage backend.
In these cases, moving the data stored in the PVC can become a problem, making migrations more difficult.
## Use Cases
:arrow_right: You have a database that has a PersistentVolumeClaim `db-data` of size `50Gi`.
Your DB grew over time, and you need more space for it.
You cannot resize the PVC because it doesn't support [volume expansion](https://kubernetes.io/blog/2018/07/12/resizing-persistent-volumes-using-kubernetes/).
Simply create a new, bigger PVC `db-data-v2` and use `pv-migrate` to copy data from `db-data` to `db-data-v2`.
:arrow_right: You need to move PersistentVolumeClaim `my-pvc` from namespace `ns-a` to namespace `ns-b`.
Simply create the PVC with the same name and manifest in `ns-b` and use `pv-migrate` to copy its content.
:arrow_right: You are moving from one cloud provider to another,
and you need to move the data from one Kubernetes cluster to the other.
Just use `pv-migrate` to copy the data **securely over the internet**.
:arrow_right: You need to change the `StorageClass` of a volume, for instance,
from a `ReadWriteOnce` one like `local-path`) to a `ReadWriteMany` like NFS.
As the `storageClass` is not editable, you can use `pv-migrate` to transfer
the data from the old PVC to the new one with the desired StorageClass.
## Highlights
- Supports in-namespace, in-cluster as well as cross-cluster migrations
- Uses rsync over SSH with a freshly generated [Ed25519](https://en.wikipedia.org/wiki/EdDSA)
or RSA keys each time to securely migrate the files
- Allows full customization of the manifests (e.g. specifying your own docker images for rsync and sshd, configuring affinity etc.)
- Supports multiple migration strategies to do the migration efficiently and fallback to other strategies when needed
- Customizable strategy order
- Supports arm32v7 (Raspberry Pi etc.) and arm64 architectures as well as amd64
- Supports completion for popular shells: bash, zsh, fish, powershell
## Installation
See [INSTALL.md](INSTALL.md) for various installation methods and shell completion configuration.
## Usage
See [USAGE.md](USAGE.md) for the CLI reference and examples.
# Star History
# Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for details.