Skip to content

Commit

Permalink
Merge pull request #12 from ansarhun/update_readme
Browse files Browse the repository at this point in the history
update README.md with new option
  • Loading branch information
ansarhun authored Jun 29, 2024
2 parents b22b6a5 + 21bcea7 commit 2e34c78
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,14 @@ With these resources, the operator will provision the **PersistentVolumeClaim**

## ResticVolumePopulator resource

| Field | Required | Default value | Description |
|------------------|--------------------|---------------|------------------------------------------------------------------------------------------------------------------|
| secretName | :white_check_mark: | | The name of the secret containing parameters for the restic command, e.g.: `RESTIC_REPOSITORY` |
| hostname | :white_check_mark: | | The name of the host from the restic snapshot, e.g.: `volsync` for [VolSync](https://github.com/backube/volsync) |
| snapshot | | latest | The id/name of the snapshot |
| image.repository | | restic/restic | Image to use for restic restore |
| image.tag | | latest | Image tag to use for restic restore |
| Field | Required | Default value | Description |
|------------------------------|--------------------|---------------|------------------------------------------------------------------------------------------------------------------|
| secretName | :white_check_mark: | | The name of the secret containing parameters for the restic command, e.g.: `RESTIC_REPOSITORY` |
| hostname | :white_check_mark: | | The name of the host from the restic snapshot, e.g.: `volsync` for [VolSync](https://github.com/backube/volsync) |
| snapshot | | latest | The id/name of the snapshot |
| allowUninitializedRepository | | false | Allow provision from an uninitialized repository (will result in an empty PVC) |
| image.repository | | restic/restic | Image to use for restic restore |
| image.tag | | latest | Image tag to use for restic restore |

## Project status

Expand Down

0 comments on commit 2e34c78

Please sign in to comment.