Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add strategy docs #257

Merged
merged 2 commits into from
Apr 26, 2024
Merged

docs: Add strategy docs #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc59080
docs: Add strategy docs
leon-gorissen Apr 26, 2024
e647ef3
Update pkg/strategies/import.go
leon-gorissen Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

```
Expand Down
3 changes: 3 additions & 0 deletions pkg/strategies/copyTwiceName.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 (
Expand Down
3 changes: 3 additions & 0 deletions pkg/strategies/export.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// flag: export
// Behavior: Exports a tar archive of the pvc to your $pwd

package strategies

import (
Expand Down
3 changes: 3 additions & 0 deletions pkg/strategies/import.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// flag: import
// Behavior: Imports a tar archive into pvc

package strategies

import (
Expand Down
Loading