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

Jump to bottom

Modify hook docs for clarity on displaying hook execution results #7679

Merged
merged 1 commit into from
Apr 17, 2024
Merged

Modify hook docs for clarity on displaying hook execution results #7679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions changelogs/unreleased/7679-allenxu404
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Modify hook docs for clarity on displaying hook execution results
16 changes: 16 additions & 0 deletions site/content/docs/main/backup-hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,22 @@ pre:

Note that the container must support the shell command you use.

## Backup Hook Execution Results
### Viewing Results

Velero records the execution results of hooks, allowing users to obtain this information by running the following command:

```bash
$ velero backup describe <backup name>
```

The displayed results include the number of hooks that were attempted to be executed and the number of hooks that failed execution. Any detailed failure reasons will be present in `Errors` section if applicable.

```bash
HooksAttempted: 1
HooksFailed: 0
```


[1]: api-types/backup.md
[2]: https://github.com/vmware-tanzu/velero/blob/main/examples/nginx-app/with-pv.yaml
17 changes: 17 additions & 0 deletions site/content/docs/main/restore-hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,4 +280,21 @@ postHooks:

Note that the container must support the shell command you use.

## Restore Hook Execution Results
### Viewing Results

Velero records the execution results of hooks, allowing users to obtain this information by running the following command:

```bash
$ velero restore describe <restore name>
```

The displayed results include the number of hooks that were attempted to be executed and the number of hooks that failed execution. Any detailed failure reasons will be present in `Errors` section if applicable.

```bash
HooksAttempted: 1
HooksFailed: 0
```


[1]: api-types/restore.md
Loading