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

Design proposal for Restore hooks #2465

Merged
merged 3 commits into from
Jul 20, 2020
Merged
Changes from 1 commit
Commits
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
Next Next commit
Add design proposal for restore hooks
Signed-off-by: Marc Campbell <marc.e.campbell@gmail.com>
  • Loading branch information
marccampbell committed Jul 17, 2020
commit 5c85632099124edd2a36611cf3593b56d9382ab9
35 changes: 35 additions & 0 deletions design/restore-hooks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Restore Hooks

Velero supports Backup Hooks to execute commands at before and/or after a backup.
This enables a user to, among other things, prepare data to be backed up.
An example of this would be to attach an empty volume to a Postgres pod, use a backup hook to execute `pg_dump` from the data volume, and back up the volume containing the export.
The problem is that there's no easy or automated way to include an automated restore process.
After a restore with the example configuration above, the postgres pod will be empty, but there will be a need to manually exec in and run `pg_restore`.
This is not specific to postgres backups, but any many database engines and other applications that have application-specific utilities to back up and restore the data.
This document proposes a solution that allows a user to specify Restore Hooks, much like Backup Hooks, that can be executed during the restore process.

## Goals

- Enable custom commands to be run during a restore in order to mirror the commands that are available to the backup process.

## Non Goals

- Handling any application specific scenarios (postgres, mongo, etc)

## Background

(See introduction)

## High-Level Design

The Restore spec

## Detailed Design


## Alternatives Considered
Copy link
Contributor

Choose a reason for hiding this comment

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

A couple other related upstream efforts to consider:

https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/20190120-execution-hook-design.md
https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/20200120-generic-data-populators.md

I don't think that either of those are in a state where we'd want to change our approach here for now, but worth look at/keeping an eye on.

Copy link
Member

Choose a reason for hiding this comment

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

The execution-hook proposal is now obsolete and is being replaced by Draft ContainerNotifier Proposal



## Security Considerations

N/A