diff --git a/README.md b/README.md index d19c619..824428d 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,9 @@ Flags: requires at least 1 arg(s), only received 0 ``` +#### Strategies +To see existing [strategies](https://github.com/BeryJu/korb/tree/main/pkg/strategies) and what they do, please check out the comments in source code of the strategy. + ### Example (Moving from PVC to PVC) ``` diff --git a/pkg/strategies/copyTwiceName.go b/pkg/strategies/copyTwiceName.go index 238ab1c..2948710 100644 --- a/pkg/strategies/copyTwiceName.go +++ b/pkg/strategies/copyTwiceName.go @@ -1,3 +1,6 @@ +// flag: copy-twice-name +// Behavior: Copy the PVC to the new Storage class and with new size and a new name, delete the old PVC, and copy it back to the old name. + package strategies import ( diff --git a/pkg/strategies/export.go b/pkg/strategies/export.go index 2272847..f64a11d 100644 --- a/pkg/strategies/export.go +++ b/pkg/strategies/export.go @@ -1,3 +1,6 @@ +// flag: export +// Behavior: Exports a tar archive of the pvc to your $pwd + package strategies import ( diff --git a/pkg/strategies/import.go b/pkg/strategies/import.go index e04085c..d35b3eb 100644 --- a/pkg/strategies/import.go +++ b/pkg/strategies/import.go @@ -1,3 +1,6 @@ +// flag: import +// Behavior: Imports a tar archive into pvc + package strategies import (