Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 3.22 KB

INSTALL.md

File metadata and controls

110 lines (79 loc) · 3.22 KB
Raw

Installation

There are various installation methods for different use cases.

Using Homebrew (MacOS/Linux)

If you have homebrew, the installation is as simple as:

brew tap utkuozdemir/pv-migrate
brew install pv-migrate

Using Scoop (Windows)

If you use Scoop package manager on Windows, run the following commands in a command prompt (CMD/Powershell):

scoop bucket add pv-migrate https://github.com/utkuozdemir/scoop-pv-migrate.git
scoop install pv-migrate/pv-migrate

Using krew

  1. Install krew.
  2. Install pv-migrate plugin:
$ kubectl krew update 
$ kubectl krew install pv-migrate

By downloading the binaries (MacOS/Linux/Windows)

  1. Go to the releases and download the latest release archive for your platform.
  2. Extract the archive.
  3. Move the binary to somewhere in your PATH.

Sample steps for MacOS:

$ VERSION=<VERSION_TAG>
$ wget https://github.com/utkuozdemir/pv-migrate/releases/download/${VERSION}/pv-migrate_${VERSION}_darwin_x86_64.tar.gz
$ tar -xvzf pv-migrate_${VERSION}_darwin_x86_64.tar.gz
$ mv pv-migrate /usr/local/bin
$ pv-migrate --help

Running directly in Docker container

Alternatively, you can use the official Docker images that come with the pv-migrate binary pre-installed:

docker run --rm -it utkuozdemir/pv-migrate:<IMAGE_TAG> pv-migrate --source <source-pvc> --dest <dest-pvc> ...

Installing Shell Completion

If you install pv-migrate using Homebrew, completions for bash, zsh and fish will be installed for you - you don't need to do anything further.

Completions are not supported when pv-migrate is installed using krew - see here.

If you have installed pv-migrate by directly downloading the binaries, run pv-migrate completion --help and follow the instructions.
Here's the sample output of instructions:

To load completions:

Bash:

  $ source <(pv-migrate completion bash)

  # To load completions for each session, execute once:
  # Linux:
  $ pv-migrate completion bash > /etc/bash_completion.d/pv-migrate
  # macOS:
  $ pv-migrate completion bash > /usr/local/etc/bash_completion.d/pv-migrate

Zsh:

  # If shell completion is not already enabled in your environment,
  # you will need to enable it.  You can execute the following once:

  $ echo "autoload -U compinit; compinit" >> ~/.zshrc

  # To load completions for each session, execute once:
  $ pv-migrate completion zsh > "${fpath[1]}/_pv-migrate"

  # You will need to start a new shell for this setup to take effect.

fish:

  $ pv-migrate completion fish | source

  # To load completions for each session, execute once:
  $ pv-migrate completion fish > ~/.config/fish/completions/pv-migrate.fish

PowerShell:

  PS> pv-migrate completion powershell | Out-String | Invoke-Expression

  # To load completions for every new session, run:
  PS> pv-migrate completion powershell > pv-migrate.ps1
  # and source this file from your PowerShell profile.

Usage:
  pv-migrate completion [bash|zsh|fish|powershell]

Flags:
  -h, --help   help for completion