Update Pre/Post hooks example. #795
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Wayne Witzel III <[email protected]>
wwitzel3
force-pushed
the
hooks-with-pv
branch
from
d9b25e3
to
d32f8db
Compare
carlisia
reviewed
Aug 27, 2018
docs/hooks.md
Outdated
| The Ark [example/nginx-app/with-pv.yaml][2] serves as an example of adding the pre and post hook annotations directly | ||
| to your declarative deployment. Below is an example of what updating an object in place might look like. | ||
|
|
||
| Place Ark in to restore only mode. By placing Ark in restore only mode you prevent Ark backups from running |
There was a problem hiding this comment.
The to here is extraneous.
docs/hooks.md
Outdated
|
|
||
| Place Ark in to restore only mode. By placing Ark in restore only mode you prevent Ark backups from running | ||
| while you are adding the annotations and avoid the condition where the pre hook freezes the file system, but | ||
| there is no post hook setup to unfreeze the file system. |
docs/hooks.md
Outdated
| The Ark [example/nginx-app/with-pv.yaml][2] serves as an example of adding the pre and post hook annotations directly | ||
| to your declarative deployment. Below is an example of what updating an object in place might look like. | ||
|
|
||
| Place Ark in to restore only mode. By placing Ark in restore only mode you prevent Ark backups from running |
There was a problem hiding this comment.
s/By placing Ark in restore only mode you prevent/This will prevent
docs/hooks.md
Outdated
| kubectl annotate pod -n nginx-example -l app=nginx post.hook.backup.ark.heptio.com/command='["/sbin/fsfreeze", "--unfreeze", "/var/log/nginx"]' | ||
| kubectl annotate pod -n nginx-example -l app=nginx post.hook.backup.ark.heptio.com/containr=fsfreeze | ||
|
|
||
| Finally remove Ark from restore only mode and test the pre and post hooks by creating a backup. You can use the Ark logs to verify that the pre and post |
nrb
reviewed
Aug 27, 2018
docs/hooks.md
Outdated
|
|
||
| Now you patch your deployment with the required annotations. | ||
|
|
||
| kubectl annotate pod -n nginx-example -l app=nginx pre.hook.backup.ark.heptio.com/command='["/sbin/fsfreeze", "--freeze", "/var/log/nginx"]' |
There was a problem hiding this comment.
I think these commands should be wrapper in triple backticks, to make them code snippets.
wwitzel3
force-pushed
the
hooks-with-pv
branch
from
3b1dd51
to
37853ba
Compare
Signed-off-by: Wayne Witzel III <[email protected]>
wwitzel3
force-pushed
the
hooks-with-pv
branch
from
37853ba
to
030ea6c
Compare
skriss
reviewed
Aug 27, 2018
docs/hooks.md
Outdated
| Now you patch your pod with the required annotations. | ||
|
|
||
| ```shell | ||
| kubectl annotate pod -n nginx-example -l app=nginx pre.hook.backup.ark.heptio.com/command='["/sbin/fsfreeze", "--freeze", "/var/log/nginx"]' |
There was a problem hiding this comment.
You could apply all of these annotations in a single kubectl call, e.g. kubectl annotate pod a=b c=d ... -- which I think would remove the need to flip ark into restore-only mode and back. I think that'd be preferable since although I get the restore-only mode thing, it distracts a little from the main point
wwitzel3
force-pushed
the
hooks-with-pv
branch
from
b2d9e74
to
658c6d5
Compare
|
This probably addresses #245 as well. |
skriss
reviewed
Aug 27, 2018
docs/hooks.md
Outdated
| kubectl annotate pod -n nginx-example -l app=nginx post.hook.backup.ark.heptio.com/containr=fsfreeze | ||
| kubectl annotate pod -n nginx-example -l app=nginx \ | ||
| pre.hook.backup.ark.heptio.com/command='["/sbin/fsfreeze", "--freeze", "/var/log/nginx"]' \ | ||
| pre.hook.backup.ark.heptio.com/containr=fsfreeze \ |
skriss
reviewed
Aug 27, 2018
docs/hooks.md
Outdated
| pre.hook.backup.ark.heptio.com/command='["/sbin/fsfreeze", "--freeze", "/var/log/nginx"]' \ | ||
| pre.hook.backup.ark.heptio.com/containr=fsfreeze \ | ||
| post.hook.backup.ark.heptio.com/command='["/sbin/fsfreeze", "--unfreeze", "/var/log/nginx"]' \ | ||
| post.hook.backup.ark.heptio.com/containr=fsfreeze |
Signed-off-by: Wayne Witzel III <[email protected]>
wwitzel3
force-pushed
the
hooks-with-pv
branch
from
658c6d5
to
575c4dd
Compare
skriss
reviewed
Aug 29, 2018
docs/hooks.md
Outdated
| [1]: api-types/backup.md | ||
| [2]: https://github.com/heptio/ark/blob/master/examples/nginx-app/with-pv.yaml |
There was a problem hiding this comment.
just use examples/nginx-app/with-pv.yaml -- makes things work properly with GH pages/multiple versions of the docs
|
otherwise I think LGTM |
Signed-off-by: Wayne Witzel III <[email protected]>
wwitzel3
force-pushed
the
hooks-with-pv
branch
from
8cb6aee
to
a8c42ab
Compare
|
Merging since there's an LGTM and the other comments appear to have been addressed. |
nrb
pushed a commit
to nrb/velero
that referenced
this pull request
Sep 7, 2018
Rolls up changes from vmware-tanzu#795 and vmware-tanzu#823 Signed-off-by: Nolan Brubaker <[email protected]>
nrb
pushed a commit
to nrb/velero
that referenced
this pull request
Sep 7, 2018
This change puts docs from vmware-tanzu#795 and vmware-tanzu#823 on the live docs site. Signed-off-by: Nolan Brubaker <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates our pre/post hook docs and extends it with an fsfreeze example.