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.

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

Add readme files for Backup and Restore #596

Merged
merged 33 commits into from
Jan 16, 2025

Conversation

akgalwas
Copy link
Contributor

@akgalwas akgalwas commented Jan 9, 2025

Description

Changes proposed in this pull request:

  • Added readme for Backup
  • Added readme for Restore
  • Fixed problem with switching Runtime CR to be controlled by KIM

Related issue(s)
#557

@kyma-bot kyma-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cla: yes Indicates the PR's author has signed the CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 9, 2025
@akgalwas akgalwas marked this pull request as ready for review January 10, 2025 11:15
@akgalwas akgalwas requested review from a team as code owners January 10, 2025 11:15
@kyma-bot kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 10, 2025
Disper
Disper previously approved these changes Jan 14, 2025
@kyma-bot kyma-bot added the lgtm Looks good to me! label Jan 14, 2025
@kyma-bot kyma-bot removed the lgtm Looks good to me! label Jan 14, 2025
Disper
Disper previously approved these changes Jan 15, 2025
@kyma-bot kyma-bot added the lgtm Looks good to me! label Jan 15, 2025
hack/runtime-migrator/README-rb.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rb.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rb.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rb.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rb.md Outdated Show resolved Hide resolved
| **output-path** | Path where generated report, and yamls will be saved. Directory has to exist. | `/tmp/` |
| **dry-run** | Dry-run flag. Has to be set to **false**, otherwise migrator will not apply the CRs on the KCP cluster. | `true` |
| **input-type** | Type of input to be used. Possible values: **txt** (will expect text file with one runtime identifier per line, [see the example](input/runtimeids_sample.txt)), and **json** (will expect `json` array with runtime identifiers, [see the example](input/runtimeids_sample.json)). | `json` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **input-type** | Type of input to be used. Possible values: **txt** (will expect text file with one runtime identifier per line, [see the example](input/runtimeids_sample.txt)), and **json** (will expect `json` array with runtime identifiers, [see the example](input/runtimeids_sample.json)). | `json` |
| **input-type** | Type of input to be used. Possible values: **txt** (expects a text file with one runtime identifier per line, [see the example](input/runtimeids_sample.txt)), and **json** (expects a `json` array with runtime identifiers, [see the example](input/runtimeids_sample.json)). | `json` |

| **dry-run** | Dry-run flag. Has to be set to **false**, otherwise migrator will not apply the CRs on the KCP cluster. | `true` |
| **input-type** | Type of input to be used. Possible values: **txt** (will expect text file with one runtime identifier per line, [see the example](input/runtimeids_sample.txt)), and **json** (will expect `json` array with runtime identifiers, [see the example](input/runtimeids_sample.json)). | `json` |
| **input-file-path** | Path to the file containing Runtimes to be migrated. | `/path/to/input/file` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **input-file-path** | Path to the file containing Runtimes to be migrated. | `/path/to/input/file` |
| **input-file-path** | Path to the file containing the runtimes to be migrated. | `/path/to/input/file` |

| **input-type** | Type of input to be used. Possible values: **txt** (will expect text file with one runtime identifier per line, [see the example](input/runtimeids_sample.txt)), and **json** (will expect `json` array with runtime identifiers, [see the example](input/runtimeids_sample.json)). | `json` |
| **input-file-path** | Path to the file containing Runtimes to be migrated. | `/path/to/input/file` |
| **backup-path** | Path to the directory containing backup files | `/path/to/input/file` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **backup-path** | Path to the directory containing backup files | `/path/to/input/file` |
| **backup-path** | Path to the directory containing backup files. | `/path/to/input/file` |

| **input-file-path** | Path to the file containing Runtimes to be migrated. | `/path/to/input/file` |
| **backup-path** | Path to the directory containing backup files | `/path/to/input/file` |
| **restore-crb** | Flag determining whether Cluster Role Bindings should be restored | `/path/to/backup/dir` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **restore-crb** | Flag determining whether Cluster Role Bindings should be restored | `/path/to/backup/dir` |
| **restore-crb** | Flag determining whether ClusterRoleBindings are restored. | `/path/to/backup/dir` |

| **backup-path** | Path to the directory containing backup files | `/path/to/input/file` |
| **restore-crb** | Flag determining whether Cluster Role Bindings should be restored | `/path/to/backup/dir` |
| **restore-oidc** | Flag determining whether OPenIDConnect resources should be restored | `/path/to/backup/dir` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **restore-oidc** | Flag determining whether OPenIDConnect resources should be restored | `/path/to/backup/dir` |
| **restore-oidc** | Flag determining whether OPenIDConnect resources are restored. | `/path/to/backup/dir` |

@kyma-bot kyma-bot removed the lgtm Looks good to me! label Jan 15, 2025
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rm.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rb.md Outdated Show resolved Hide resolved
hack/runtime-migrator/README-rr.md Show resolved Hide resolved
hack/runtime-migrator/README-rr.md Show resolved Hide resolved
@Disper Disper enabled auto-merge January 16, 2025 11:20
@kyma-bot kyma-bot added the lgtm Looks good to me! label Jan 16, 2025
@Disper Disper merged commit d8458fc into kyma-project:main Jan 16, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indicates the PR's author has signed the CLA. lgtm Looks good to me! size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants