Use Travis's tag env var for latest calculation

Signed-off-by: Nolan Brubaker <brubakern@vmware.com>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Tell us about a problem you are experiencing
+
+---
+
+**What steps did you take and what happened:**
+[A clear and concise description of what the bug is, and what commands you ran.)
+
+
+**What did you expect to happen:**
+
+
+**The output of the following commands will help us better understand what's going on**:
+(Pasting long output into a [GitHub gist](https://gist.github.com) or other pastebin is fine.)
+
+* `kubectl logs deployment/velero -n velero`
+* `velero backup describe <backupname>` or `kubectl get backup/<backupname> -n velero -o yaml`
+* `velero backup logs <backupname>`
+* `velero restore describe <restorename>` or `kubectl get restore/<restorename> -n velero -o yaml`
+* `velero restore logs <restorename>`
+
+
+**Anything else you would like to add:**
+[Miscellaneous information that will assist in solving the issue.]
+
+
+**Environment:**
+
+- Velero version (use `velero version`): 
+- Kubernetes version (use `kubectl version`):
+- Kubernetes installer & version:
+- Cloud provider or hardware configuration:
+- OS (e.g. from `/etc/os-release`):

.github/ISSUE_TEMPLATE/feature-enhancement-request.md

@@ -0,0 +1,25 @@
+---
+name: Feature enhancement request
+about: Suggest an idea for this project
+
+---
+
+**Describe the problem/challenge you have**
+[A description of the current limitation/problem/challenge that you are experiencing.]
+
+
+**Describe the solution you'd like**
+[A clear and concise description of what you want to happen.]
+
+
+**Anything else you would like to add:**
+[Miscellaneous information that will assist in solving the issue.]
+
+
+**Environment:**
+
+- Velero version (use `velero version`):
+- Kubernetes version (use `kubectl version`):
+- Kubernetes installer & version:
+- Cloud provider or hardware configuration:
+- OS (e.g. from `/etc/os-release`):

.gitignore

@@ -26,9 +26,24 @@ _testmain.go
 
 debug
 
-/ark
+/velero
 .idea/
 
 .container-*
 .vimrc
 .go
+.DS_Store
+.push-*
+.vscode
+*.diff
+
+# Jekyll compiled data
+site/_site
+site/.sass-cache
+site/.jekyll
+site/.jekyll-metadata
+site/.bundle
+site/vendor
+.ruby-version
+
+.vs

.goreleaser.yml

@@ -0,0 +1,58 @@
+# Copyright 2018 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+dist: _output
+builds:
+  - main: ./cmd/velero/main.go
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - darwin
+      - windows
+    goarch:
+      - amd64
+      - arm
+      - arm64
+      - ppc64le
+    ignore:
+      # don't build arm/arm64 for darwin or windows
+      - goos: darwin
+        goarch: arm
+      - goos: darwin
+        goarch: arm64
+      - goos: darwin
+        goarch: ppc64le
+      - goos: windows
+        goarch: arm
+      - goos: windows
+        goarch: arm64
+      - goos: windows
+        goarch: ppc64le
+    ldflags:
+      - -X "github.com/heptio/velero/pkg/buildinfo.Version={{ .Tag }}" -X "github.com/heptio/velero/pkg/buildinfo.GitSHA={{ .FullCommit }}" -X "github.com/heptio/velero/pkg/buildinfo.GitTreeState={{ .Env.GIT_TREE_STATE }}"
+archives:
+  - name_template: "{{ .ProjectName }}-{{ .Tag }}-{{ .Os }}-{{ .Arch }}"
+    wrap_in_directory: true
+    files:
+      - LICENSE
+      - examples/**/*
+checksum:
+  name_template: 'CHECKSUM'
+release:
+  github:
+    owner: heptio
+    name: velero
+  draft: true
+  prerelease: auto

.travis.yml

@@ -1,6 +1,11 @@
 language: go
 
 go:
-  - 1.9.x
+  - 1.12.x
 
-script: make ci
+sudo: required
+
+services:
+  - docker
+
+script: hack/ci-check.sh

CHANGELOG.md

@@ -1,67 +1,31 @@
-# Changelog
+## Current release:
+  * [CHANGELOG-1.1.md][11]
 
-#### [v0.5.1](https://github.com/heptio/ark/tree/v0.5.1) - 2017-11-06
-Bug fixes:
-  * If a Service is headless, retain ClusterIP = None when backing up and restoring.
-  * Use the specifed --label-selector when listing backups, schedules, and restores.
-  * Restore namespace mapping functionality that was accidentally broken in 0.5.0.
-  * Always include namespaces in the backup, regardless of the --include-cluster-resources setting.
+## Development release:
+  * [Unreleased Changes][0]
 
-#### [v0.5.0](https://github.com/heptio/ark/tree/v0.5.0) - 2017-10-26
-Breaking changes:
-  * The backup tar file format has changed. Backups created using previous versions of Ark cannot be restored using v0.5.0.
-  * When backing up one or more specific namespaces, cluster-scoped resources are no longer backed up by default, with the exception of PVs that are used within the target namespace(s). Cluster-scoped resources can still be included by explicitly specifying `--include-cluster-resources`.
+## Older releases:
+  * [CHANGELOG-1.0.md][10]
+  * [CHANGELOG-0.11.md][9]
+  * [CHANGELOG-0.10.md][8]
+  * [CHANGELOG-0.9.md][7]
+  * [CHANGELOG-0.8.md][6]
+  * [CHANGELOG-0.7.md][5]
+  * [CHANGELOG-0.6.md][4]
+  * [CHANGELOG-0.5.md][3]
+  * [CHANGELOG-0.4.md][2]
+  * [CHANGELOG-0.3.md][1]
 
-New features:
-  * Add customized user-agent string for Ark CLI
-  * Switch from glog to logrus
-  * Exclude nodes from restoration
-  * Add a FAQ
-  * Record PV availability zone and use it when restoring volumes from snapshots
-  * Back up the PV associated with a PVC
-  * Add `--include-cluster-resources` flag to `ark backup create`
-  * Add `--include-cluster-resources` flag to `ark restore create`
-  * Properly support resource restore priorities across cluster-scoped and namespace-scoped resources
-  * Support `ark create ...` and `ark get ...`
-  * Make ark run as cluster-admin
-  * Add pod exec backup hooks
-  * Support cross-compilation & upgrade to go 1.9
-  
-Bug fixes:
-  * Make config change detection more robust
 
-#### [v0.4.0](https://github.com/heptio/ark/tree/v0.4.0) - 2017-09-14
-Breaking changes:
-  * Snapshotting and restoring volumes is now enabled by default
-  * The --namespaces flag for 'ark restore create' has been replaced by --include-namespaces and
-    --exclude-namespaces
-
-New features:
-  * Support for S3 SSE with KMS
-  * Cloud provider configurations are validated at startup
-  * The persistentVolumeProvider is now optional
-  * Restore objects are garbage collected
-  * Each backup now has an associated log file, viewable via 'ark backup logs'
-  * Each restore now has an associated log file, viewable via 'ark restore logs'
-  * Add --include-resources/--exclude-resources for restores
-
-Bug fixes:
-  * Only save/use iops for io1 volumes on AWS
-  * When restoring, try to retrieve the Backup directly from object storage if it's not found
-  * When syncing Backups from object storage to Kubernetes, don't return at the first error
-    encountered
-  * More closely match how kubectl performs kubeconfig resolution
-  * Increase default Azure API request timeout to 2 minutes
-  * Update Azure diskURI to match diskName
-
-#### [v0.3.3](https://github.com/heptio/ark/tree/v0.3.3) - 2017-08-10
-  * Treat the first field in a schedule's cron expression as minutes, not seconds
-
-#### [v0.3.2](https://github.com/heptio/ark/tree/v0.3.2) - 2017-08-07
-  * Add client-go auth provider plugins for Azure, GCP, OIDC
-
-#### [v0.3.1](https://github.com/heptio/ark/tree/v0.3.1) - 2017-08-03
-  * Fix Makefile VERSION
-
-#### [v0.3.0](https://github.com/heptio/ark/tree/v0.3.0) - 2017-08-03
-  * Initial Release
+[11]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-1.1.md
+[10]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-1.0.md
+[9]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.11.md
+[8]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.10.md
+[7]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.9.md
+[6]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.8.md
+[5]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.7.md
+[4]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.6.md
+[3]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.5.md
+[2]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.4.md
+[1]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.3.md
+[0]: https://github.com/heptio/velero/blob/master/changelogs/unreleased

CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
-# Heptio Ark Community Code of Conduct
+# Velero Community Code of Conduct
 
 ## Contributor Code of Conduct
 

CONTRIBUTING.md

@@ -1,11 +1,23 @@
 # Contributing
+
+## CHANGELOG 
+
+Authors are expected to include a changelog file with their pull requests. The changelog file
+should be a new file created in the `changelogs/unreleased` folder. The file should follow the
+naming convention of `pr-username` and the contents of the file should be your text for the
+changelog.
+
+    velero/changelogs/unreleased   <- folder
+        000-username            <- file
+
+
 ## DCO Sign off
 
 All authors to the project retain copyright to their work. However, to ensure
 that they are only submitting work that they have rights to, we are requiring
 everyone to acknowledge this by signing their work.
 
-Any copyright notices in this repo should specify the authors as "the Heptio Ark project contributors".
+Any copyright notices in this repo should specify the authors as "the Velero contributors".
 
 To sign your work, just add a line like this at the end of your commit message:
 

Dockerfile-fsfreeze-pause

@@ -0,0 +1,19 @@
+# Copyright 2018, 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:bionic
+
+LABEL maintainer="Steve Kriss <krisss@vmware.com>"
+
+ENTRYPOINT ["/bin/bash", "-c", "while true; do sleep 10000; done"]

Dockerfile-fsfreeze-pause-ppc64le

@@ -0,0 +1,19 @@
+# Copyright 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:bionic
+
+LABEL maintainer="Steve Kriss <krisss@vmware.com>"
+
+ENTRYPOINT ["/bin/bash", "-c", "while true; do sleep 10000; done"]

Dockerfile-velero

@@ -0,0 +1,33 @@
+# Copyright 2017, 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:bionic
+
+LABEL maintainer="Steve Kriss <krisss@vmware.com>"
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends ca-certificates wget bzip2 && \
+    wget --quiet https://github.com/restic/restic/releases/download/v0.9.4/restic_0.9.4_linux_amd64.bz2 && \
+    bunzip2 restic_0.9.4_linux_amd64.bz2 && \
+    mv restic_0.9.4_linux_amd64 /usr/bin/restic && \
+    chmod +x /usr/bin/restic && \
+    apt-get remove -y wget bzip2 && \
+    rm -rf /var/lib/apt/lists/*
+
+
+ADD /bin/linux/amd64/velero /velero
+
+USER nobody:nobody
+
+ENTRYPOINT ["/velero"]

Dockerfile-velero-ppc64le

@@ -0,0 +1,32 @@
+# Copyright 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:bionic
+
+LABEL maintainer="Steve Kriss <krisss@vmware.com>"
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends ca-certificates wget && \
+    wget --quiet https://oplab9.parqtec.unicamp.br/pub/ppc64el/restic/restic-0.9.4 && \
+    mv restic-0.9.4 /usr/bin/restic && \
+    chmod +x /usr/bin/restic && \
+    apt-get remove -y wget && \
+    rm -rf /var/lib/apt/lists/*
+
+
+ADD /bin/linux/ppc64le/velero /velero
+
+USER nobody:nobody
+
+ENTRYPOINT ["/velero"]

Dockerfile-velero-restic-restore-helper

@@ -0,0 +1,23 @@
+# Copyright 2018, 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:bionic
+
+LABEL maintainer="Steve Kriss <krisss@vmware.com>"
+
+ADD /bin/linux/amd64/velero-restic-restore-helper .
+
+USER nobody:nobody
+
+ENTRYPOINT [ "/velero-restic-restore-helper" ]

Dockerfile-velero-restic-restore-helper-ppc64le

@@ -0,0 +1,23 @@
+# Copyright 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ubuntu:bionic
+
+LABEL maintainer="Steve Kriss <krisss@vmware.com>"
+
+ADD /bin/linux/ppc64le/velero-restic-restore-helper .
+
+USER nobody:nobody
+
+ENTRYPOINT [ "/velero-restic-restore-helper" ]

Dockerfile.alpine

@@ -1,25 +0,0 @@
-# Copyright 2017 the Heptio Ark project contributors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-FROM alpine:3.6
-
-MAINTAINER Andy Goldstein <andy@heptio.com>
-
-RUN apk add --no-cache ca-certificates
-
-ADD /bin/linux/amd64/ark /ark
-
-USER nobody:nobody
-
-ENTRYPOINT ["/ark"]

Gopkg.toml

@@ -20,81 +20,115 @@
 #  name = "github.com/x/y"
 #  version = "2.4.0"
 
-required = [
-  "k8s.io/kubernetes/cmd/libs/go2idl/client-gen",
-  "k8s.io/kubernetes/cmd/libs/go2idl/lister-gen",
-  "k8s.io/kubernetes/cmd/libs/go2idl/informer-gen"
-]
+[prune]
+  unused-packages = true
+  non-go = true
+  go-tests = true
 
+#
+# Kubernetes packages
+#
+
+[[constraint]]
+  name = "k8s.io/kubernetes"
+  version = "~1.14"
+
+[[constraint]]
+  name = "k8s.io/client-go"
+  version = "kubernetes-1.14.0"
+
+[[constraint]]
+  name = "k8s.io/apimachinery"
+  version = "kubernetes-1.14.0"
+
+[[constraint]]
+  name = "k8s.io/api"
+  version = "kubernetes-1.14.0"
+
+[[constraint]]
+  name = "k8s.io/apiextensions-apiserver"
+  version = "kubernetes-1.14.0"
+
+# k8s.io/client-go kubernetes-1.14.0 uses v1.1.4
+[[override]]
+  name = "github.com/json-iterator/go"
+  version = "=1.1.4"
+
+#
+# Cloud provider packages
+#
+[[constraint]]
+  name = "github.com/aws/aws-sdk-go"
+  version = "1.13.12"
+
+[[constraint]]
+  name = "github.com/Azure/azure-sdk-for-go"
+  version = "~21.4.0"
+
+# k8s.io/client-go kubernetes-1.14.0 uses v11.1.2
+[[constraint]]
+  name = "github.com/Azure/go-autorest"
+  version = "11.1.2"
 
 [[constraint]]
   name = "cloud.google.com/go"
   version = "0.11.0"
 
 [[constraint]]
-  name = "github.com/Azure/azure-sdk-for-go"
-  version = "~10.2.1-beta"
-
-[[constraint]]
-  name = "github.com/Azure/go-autorest"
-  version = "~8.1.x"
-
-[[constraint]]
-  name = "github.com/aws/aws-sdk-go"
-  version = "1.10.26"
+  name = "google.golang.org/api"
+  version = "~v0.3.2"
 
 [[constraint]]
+  name = "golang.org/x/oauth2"
   branch = "master"
-  name = "github.com/golang/glog"
 
+#
+# Third party packages
+#
 [[constraint]]
   name = "github.com/robfig/cron"
   revision = "df38d32658d8788cd446ba74db4bb5375c4b0cb3"
 
 [[constraint]]
   name = "github.com/satori/go.uuid"
-  version = "1.1.0"
+  version = "~1.2.0"
 
 [[constraint]]
-  name = "github.com/satori/uuid"
-  version = "1.1.0"
-
-[[constraint]]
-  branch = "master"
   name = "github.com/spf13/afero"
+  branch = "master"
 
 [[constraint]]
-  branch = "master"
   name = "github.com/spf13/cobra"
+  version = "0.0.3"
 
 [[constraint]]
   name = "github.com/spf13/pflag"
-  version = "1.0.0"
+  version = "1.0.2"
 
 [[constraint]]
   name = "github.com/stretchr/testify"
-  branch = "master"
+  version = "~1.2.2"
 
 [[constraint]]
-  branch = "master"
-  name = "golang.org/x/oauth2"
+  name = "github.com/hashicorp/go-plugin"
+  revision = "a1bc61569a26c0f65865932c0d55743b0567c494"
 
 [[constraint]]
-  branch = "master"
-  name = "google.golang.org/api"
+  name = "github.com/golang/protobuf"
+  version = "~v1.3.1"
 
 [[constraint]]
-  name = "k8s.io/apimachinery"
-  revision = "1fd2e63a9a370677308a42f24fd40c86438afddf"
+  name = "google.golang.org/grpc"
+  version = "~v1.19.0"
 
 [[constraint]]
-  name = "k8s.io/client-go"
-  version = "~4.0"
+  name = "github.com/joho/godotenv"
+  version = "~v1.3.0"
 
 [[constraint]]
-  name = "k8s.io/kubernetes"
-  version = "~1.7"
+  name = "github.com/gobwas/glob"
+  version = "~v0.2.3"
 
 [[override]]
-  name = "github.com/russross/blackfriday"
-  revision = "93622da34e54fb6529bfb7c57e710f37a8d9cbd8"
+  name = "golang.org/x/sys"
+  branch = "master"

Makefile

@@ -1,6 +1,6 @@
 # Copyright 2016 The Kubernetes Authors.
 #
-# Modifications Copyright 2017 the Heptio Ark contributors.
+# Modifications Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,27 +15,30 @@
 # limitations under the License.
 
 # The binary to build (just the basename).
-BIN := ark
+BIN ?= velero
 
 # This repo's root import path (under GOPATH).
-PKG := github.com/heptio/ark
+PKG := github.com/heptio/velero
 
 # Where to push the docker image.
 REGISTRY ?= gcr.io/heptio-images
 
 # Which architecture to build - see $(ALL_ARCH) for options.
+# if the 'local' rule is being run, detect the ARCH from 'go env'
+# if it wasn't specified by the caller.
+local : ARCH ?= $(shell go env GOOS)-$(shell go env GOARCH)
 ARCH ?= linux-amd64
 
 VERSION ?= master
 
+TAG_LATEST ?= false
+
 ###
 ### These variables should not need tweaking.
 ###
 
-SRC_DIRS := cmd pkg # directories which hold app source (not vendored)
-
-CLI_PLATFORMS := linux-amd64 linux-arm linux-arm64 darwin-amd64 windows-amd64
-CONTAINER_PLATFORMS := linux-amd64 linux-arm linux-arm64
+CLI_PLATFORMS := linux-amd64 linux-arm linux-arm64 darwin-amd64 windows-amd64 linux-ppc64le
+CONTAINER_PLATFORMS := linux-amd64 linux-arm linux-arm64 linux-ppc64le
 
 platform_temp = $(subst -, ,$(ARCH))
 GOOS = $(word 1, $(platform_temp))
@@ -44,7 +47,7 @@ GOARCH = $(word 2, $(platform_temp))
 # TODO(ncdc): support multiple image architectures once gcr.io supports manifest lists
 # Set default base image dynamically for each arch
 ifeq ($(GOARCH),amd64)
-		DOCKERFILE ?= Dockerfile.alpine
+		DOCKERFILE ?= Dockerfile-$(BIN)
 endif
 #ifeq ($(GOARCH),arm)
 #		DOCKERFILE ?= Dockerfile.arm #armel/busybox
@@ -52,15 +55,18 @@ endif
 #ifeq ($(GOARCH),arm64)
 #		DOCKERFILE ?= Dockerfile.arm64 #aarch64/busybox
 #endif
+ifeq ($(GOARCH),ppc64le)
+                DOCKERFILE ?= Dockerfile-$(BIN)-ppc64le
+endif
 
-IMAGE := $(REGISTRY)/$(BIN)
-
-BUILD_IMAGE ?= gcr.io/heptio-images/golang:1.9-alpine3.6
+IMAGE = $(REGISTRY)/$(BIN)
 
 # If you want to build all binaries, see the 'all-build' rule.
 # If you want to build all containers, see the 'all-container' rule.
 # If you want to build AND push all containers, see the 'all-push' rule.
-all: build
+all:
+	@$(MAKE) build
+	@$(MAKE) build BIN=velero-restic-restore-helper
 
 build-%:
 	@$(MAKE) --no-print-directory ARCH=$* build
@@ -77,11 +83,20 @@ all-build: $(addprefix build-, $(CLI_PLATFORMS))
 
 #all-push: $(addprefix push-, $(CONTAINER_PLATFORMS))
 
+local: build-dirs
+	GOOS=$(GOOS) \
+	GOARCH=$(GOARCH) \
+	VERSION=$(VERSION) \
+	PKG=$(PKG) \
+	BIN=$(BIN) \
+	OUTPUT_DIR=$$(pwd)/_output/bin/$(GOOS)/$(GOARCH) \
+	./hack/build.sh
+
 build: _output/bin/$(GOOS)/$(GOARCH)/$(BIN)
 
 _output/bin/$(GOOS)/$(GOARCH)/$(BIN): build-dirs
 	@echo "building: $@"
-	@$(MAKE) shell CMD="-c '\
+	$(MAKE) shell CMD="-c '\
 		GOOS=$(GOOS) \
 		GOARCH=$(GOARCH) \
 		VERSION=$(VERSION) \
@@ -92,39 +107,72 @@ _output/bin/$(GOOS)/$(GOARCH)/$(BIN): build-dirs
 
 TTY := $(shell tty -s && echo "-t")
 
+BUILDER_IMAGE := velero-builder
+
 # Example: make shell CMD="date > datefile"
-shell: build-dirs
+shell: build-dirs build-image
+	@# the volume bind-mount of $PWD/vendor/k8s.io/api is needed for code-gen to
+	@# function correctly (ref. https://github.com/kubernetes/kubernetes/pull/64567)
 	@docker run \
+		-e GOFLAGS \
 		-i $(TTY) \
 		--rm \
 		-u $$(id -u):$$(id -g) \
-		-v "$$(pwd)/.go/pkg:/go/pkg" \
-		-v "$$(pwd)/.go/src:/go/src" \
-		-v "$$(pwd)/.go/std:/go/std" \
-		-v "$$(pwd):/go/src/$(PKG)" \
-		-v "$$(pwd)/_output/bin:/output" \
-		-v "$$(pwd)/.go/std/$(GOOS)/$(GOARCH):/usr/local/go/pkg/$(GOOS)_$(GOARCH)_static" \
+		-v "$$(pwd)/vendor/k8s.io/api:/go/src/k8s.io/api:delegated" \
+		-v "$$(pwd)/.go/pkg:/go/pkg:delegated" \
+		-v "$$(pwd)/.go/std:/go/std:delegated" \
+		-v "$$(pwd):/go/src/$(PKG):delegated" \
+		-v "$$(pwd)/_output/bin:/output:delegated" \
+		-v "$$(pwd)/.go/std/$(GOOS)/$(GOARCH):/usr/local/go/pkg/$(GOOS)_$(GOARCH)_static:delegated" \
+		-v "$$(pwd)/.go/go-build:/.cache/go-build:delegated" \
 		-w /go/src/$(PKG) \
-		$(BUILD_IMAGE) \
+		$(BUILDER_IMAGE) \
 		/bin/sh $(CMD)
 
 DOTFILE_IMAGE = $(subst :,_,$(subst /,_,$(IMAGE))-$(VERSION))
 
+# Use a slightly customized build/push targets since we don't have a Go binary to build for the fsfreeze image
+build-fsfreeze: BIN = fsfreeze-pause
+build-fsfreeze:
+	@cp $(DOCKERFILE)  _output/.dockerfile-$(BIN).alpine
+	@docker build --pull -t $(IMAGE):$(VERSION) -f _output/.dockerfile-$(BIN).alpine _output
+	@docker images -q $(IMAGE):$(VERSION) > .container-$(DOTFILE_IMAGE)
+
+push-fsfreeze: BIN = fsfreeze-pause
+push-fsfreeze:
+	@docker push $(IMAGE):$(VERSION)
+ifeq ($(TAG_LATEST), true)
+	docker tag $(IMAGE):$(VERSION) $(IMAGE):latest
+	docker push $(IMAGE):latest
+endif
+	@docker images -q $(REGISTRY)/fsfreeze-pause:$(VERSION) > .container-$(DOTFILE_IMAGE)
+
+all-containers:
+	$(MAKE) container
+	$(MAKE) container BIN=velero-restic-restore-helper
+	$(MAKE) build-fsfreeze
+
 container: verify test .container-$(DOTFILE_IMAGE) container-name
 .container-$(DOTFILE_IMAGE): _output/bin/$(GOOS)/$(GOARCH)/$(BIN) $(DOCKERFILE)
-	@cp $(DOCKERFILE) _output/.dockerfile-$(GOOS)-$(GOARCH)
-	@docker build -t $(IMAGE):$(VERSION) -f _output/.dockerfile-$(GOOS)-$(GOARCH) _output
+	@cp $(DOCKERFILE) _output/.dockerfile-$(BIN)-$(GOOS)-$(GOARCH)
+	@docker build --pull -t $(IMAGE):$(VERSION) -f _output/.dockerfile-$(BIN)-$(GOOS)-$(GOARCH) _output
 	@docker images -q $(IMAGE):$(VERSION) > $@
 
 container-name:
 	@echo "container: $(IMAGE):$(VERSION)"
 
+all-push:
+	$(MAKE) push
+	$(MAKE) push BIN=velero-restic-restore-helper
+	$(MAKE) push-fsfreeze
+
+
 push: .push-$(DOTFILE_IMAGE) push-name
 .push-$(DOTFILE_IMAGE): .container-$(DOTFILE_IMAGE)
-ifeq ($(findstring gcr.io,$(REGISTRY)),gcr.io)
-	@gcloud docker -- push $(IMAGE):$(VERSION)
-else
 	@docker push $(IMAGE):$(VERSION)
+ifeq ($(TAG_LATEST), true)
+	docker tag $(IMAGE):$(VERSION) $(IMAGE):latest
+	docker push $(IMAGE):latest
 endif
 	@docker images -q $(IMAGE):$(VERSION) > $@
 
@@ -134,56 +182,72 @@ push-name:
 SKIP_TESTS ?=
 test: build-dirs
 ifneq ($(SKIP_TESTS), 1)
-	@$(MAKE) shell CMD="-c 'hack/test.sh $(SRC_DIRS)'"
+	@$(MAKE) shell CMD="-c 'hack/test.sh $(WHAT)'"
 endif
 
-fmt:
-	@$(MAKE) shell CMD="-c 'hack/update-fmt.sh'"
+test-local: build-dirs
+ifneq ($(SKIP_TESTS), 1)
+	hack/test.sh $(WHAT)
+endif
 
 verify:
 ifneq ($(SKIP_TESTS), 1)
 	@$(MAKE) shell CMD="-c 'hack/verify-all.sh'"
 endif
 
-update: fmt
+update:
 	@$(MAKE) shell CMD="-c 'hack/update-all.sh'"
 
-release: all-tar-bin checksum
-
-checksum:
-	@cd _output/release; \
-	sha256sum *.tar.gz > CHECKSUM; \
-	cat CHECKSUM; \
-	sha256sum CHECKSUM
-
-all-tar-bin: $(addprefix tar-bin-, $(CLI_PLATFORMS))
-
-tar-bin-%:
-	@$(MAKE) ARCH=$* tar-bin
-
-tar-bin: build
-	mkdir -p _output/release
-
-# We do the subshell & wildcard ls so we can pick up $(BIN).exe for windows
-	(cd _output/bin/$(GOOS)/$(GOARCH) && ls $(BIN)*) | \
-		tar \
-			-C _output/bin/$(GOOS)/$(GOARCH) \
-			--files-from=- \
-			-zcf _output/release/$(BIN)-$(GOOS)-$(GOARCH).tar.gz
-
 build-dirs:
 	@mkdir -p _output/bin/$(GOOS)/$(GOARCH)
-	@mkdir -p .go/src/$(PKG) .go/pkg .go/bin .go/std/$(GOOS)/$(GOARCH)
+	@mkdir -p .go/src/$(PKG) .go/pkg .go/bin .go/std/$(GOOS)/$(GOARCH) .go/go-build
 
-clean: container-clean bin-clean
+build-image:
+	cd hack/build-image && docker build --pull -t $(BUILDER_IMAGE) .
 
-container-clean:
+clean:
 	rm -rf .container-* _output/.dockerfile-* .push-*
-
-bin-clean:
 	rm -rf .go _output
+	docker rmi $(BUILDER_IMAGE)
 
-ci:
-	hack/verify-all.sh
-	hack/test.sh $(SRC_DIRS)
-	GOOS=$(GOOS) GOARCH=$(GOARCH) VERSION=$(VERSION) PKG=$(PKG) BIN=$(BIN) ./hack/build.sh
+ci: all verify test
+
+changelog:
+	hack/changelog.sh
+
+release:
+	hack/goreleaser.sh
+
+serve-docs:
+	docker run \
+	--rm \
+	-v "$$(pwd)/site:/srv/jekyll" \
+	-it -p 4000:4000 \
+	jekyll/jekyll \
+	jekyll serve --livereload --incremental
+
+# gen-docs generates a new versioned docs directory under site/docs. It follows
+# the following process:
+#   1. Copies the contents of the most recently tagged docs directory into the new
+#      directory, to establish a useful baseline to diff against.
+#   2. Adds all copied content from step 1 to git's staging area via 'git add'.
+#   3. Replaces the contents of the new docs directory with the contents of the
+#      'master' docs directory, updating any version-specific links (e.g. to a
+#      specific branch of the GitHub repository) to use the new version
+#   4. Copies the previous version's ToC file and runs 'git add' to establish
+#      a useful baseline to diff against.
+#   5. Replaces the content of the new ToC file with the master ToC.
+#   6. Update site/_config.yml and site/_data/toc-mapping.yml to include entries
+#      for the new version.
+#
+# The unstaged changes in the working directory can now easily be diff'ed against the
+# staged changes using 'git diff' to review all docs changes made since the previous 
+# tagged version. Once the unstaged changes are ready, they can be added to the
+# staging area using 'git add' and then committed.
+#
+# To run gen-docs: "NEW_DOCS_VERSION=v1.1.0 make gen-docs"
+#
+# **NOTE**: there are additional manual steps required to finalize the process of generating
+# a new versioned docs site. The full process is documented in site/README-JEKYLL.md.
+gen-docs:
+	@hack/gen-docs.sh

README.md

@@ -1,212 +1,80 @@
-# Heptio Ark
-
-**Maintainers:** [Heptio][0]
+![100]
 
 [![Build Status][1]][2]
 
 ## Overview
-Heptio Ark is a utility for managing disaster recovery, specifically for your [Kubernetes][14] cluster resources and persistent volumes. It provides a simple, configurable, and operationally robust way to back up and restore applications and PVs from a series of checkpoints. This allows you to better automate in the following scenarios:
 
-* **Disaster recovery** with reduced TTR (time to respond), in the case of:
-    * Infrastructure loss
-    * Data corruption
-    * Service outages
+Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. Velero lets you:
 
-* **Cross-cloud-provider migration** for Kubernetes API objects (cross-cloud-provider migration of persistent volume snapshots not yet supported)
+* Take backups of your cluster and restore in case of loss.
+* Migrate cluster resources to other clusters.
+* Replicate your production cluster to development and testing clusters.
 
-* **Dev and testing environment setup (+ CI)**, via replication of prod environment
+Velero consists of:
 
-More concretely, Heptio Ark combines an in-cluster service with a CLI that allows you to record both:
-1. *Configurable subsets of Kubernetes API objects* -- as tarballs stored in object storage
-2. *Disk snapshots of Persistent Volumes* -- via the cloud provider APIs
+* A server that runs on your cluster
+* A command-line client that runs locally
 
-Heptio Ark currently supports the [AWS][15], [GCP][16], and [Azure][17] cloud provider platforms.
+You can run Velero in clusters on a cloud provider or on-premises. For detailed information, see [Compatible Storage Providers][99].
 
-## Quickstart
+## Installation
 
-This guide gets Ark up and running on your cluster, and goes through an example using the following:
-* **Minio, an S3-compatible storage service** that runs locally on your cluster. This is the storage service where backup files are uploaded. *Note that Ark is intended to run on a cloud provider--we are using Minio here to keep the example convenient and self-contained.*
+We strongly recommend that you use an [official release][6] of Velero. The tarballs for each release contain the
+`velero` command-line client. Follow the [installation instructions][28] to get started.
 
-* **A sample nginx app** under the `nginx-example` namespace, used to demonstrate Ark's backup and restore functionality.
+_The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!_
 
-Note that this example *does not* include a demonstration of PV disk snapshots, because that feature requires integration with a cloud provider API. For snapshotting examples and instructions specific to AWS, GCP, and Azure, see [Cloud Provider Specifics][23].
+## More information
 
-### 0. Prerequisites
+[The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Velero, and more.
 
-* *You should have access to an up-and-running Kubernetes cluster (minimum version 1.7).* If you do not have a cluster, [choose a setup solution][9] from the official Kubernetes docs.
-
-* *You will need to have a DNS server set up on your cluster for the example files to work.* You can check this with `kubectl get svc -l k8s-app=kube-dns --namespace=kube-system`. If said service does not exist, [these instructions][12] may help.
-
-* *You should have `kubectl` installed.* If not, follow the instructions for [installing via Homebrew (MacOS)][10] or [building the binary (Linux)][11].
-
-### 1. Download
-Clone or fork the Heptio Ark repo:
-```
-git clone git@github.com:heptio/ark.git
-```
-
-> NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs.
->
-> To ensure that you are working off a specific release, `git checkout <VERSION_TAG>` where `<VERSION_TAG>` is the appropriate tag for the Ark version you wish to use (e.g. "v0.3.3"). You should `git checkout master` only if you're planning on [building the Ark image from scratch][7].
-
-### 2. Setup
-
-There are two types of Ark instances that work in tandem:
-1. **Ark server**: Runs persistently on the cluster.
-2. **Ark client**: Launched by the user whenever they want to initiate an operation (e.g. a backup).
-
-To get the server started on your cluster (as well as the local storage service), execute the following commands in Ark's root directory:
-
-```
-kubectl apply -f examples/common/00-prereqs.yaml
-kubectl apply -f examples/minio/
-kubectl apply -f examples/common/10-deployment.yaml
-```
-
-*NOTE: If you encounter an error related to Config creation, wait for a minute and run the command again. (The Config CRD does not always finish registering in time.)*
-
-Now deploy the example nginx app:
-```
-kubectl apply -f examples/nginx-app/base.yaml
-```
-
-Check to see that both the Ark and nginx deployments have been successfully created:
-```
-kubectl get deployments -l component=ark --namespace=heptio-ark
-kubectl get deployments --namespace=nginx-example
-```
-
-Finally, install the Ark client somehwere in your `$PATH`:
-* [Download a pre-built release][26], or
-* [Build it from scratch][7]
-
-
-### 3. Back up and restore
-First, create a backup specifically for any object matching the `app=nginx` label selector:
-
-```
-ark backup create nginx-backup --selector app=nginx
-```
-
-Now you can mimic a disaster with the following:
-```
-kubectl delete namespace nginx-example
-```
-Oh no! The nginx deployment and service are both gone, as you can see (though you may have to wait a minute or two for the namespace be fully cleaned up):
-```
-kubectl get deployments --namespace=nginx-example
-kubectl get services --namespace=nginx-example
-```
-Neither commands should yield any results. However, because Ark has your back(up), you can run this command:
-```
-ark restore create nginx-backup
-```
-
-To check on the status of the Restore:
-```
-ark restore get
-```
-
-The output should look something like the table below:
-```
-NAME                          BACKUP         STATUS      WARNINGS   ERRORS    CREATED                         SELECTOR
-nginx-backup-20170727200524   nginx-backup   Completed   0          0         2017-07-27 20:05:24 +0000 UTC   <none>
-```
-
-If the Restore's `STATUS` column is "Completed", and `WARNINGS` and `ERRORS` are both zero, the restore is a success. All of the objects in the `nginx-example` namespace should be just as they were before.
-
-Otherwise, if there are warnings or errors indicated, you can run the following command to look at them in more detail:
-```
-ark restore get <RESTORE NAME> -o yaml
-```
-See the [debugging documentation][18] for more details.
-
-*NOTE*: In the example files, the `storage` volume is defined via `hostPath` for better visibility. If you're curious to see the [structure of the backup files][13] firsthand, you can find the compressed results in `/tmp/minio/ark/nginx-backup`.
-
-### 4. Tear Down
-Using the following command, you can remove all Kubernetes objects associated with this example:
-```
-kubectl delete -f examples/common/
-kubectl delete -f examples/minio/
-kubectl delete -f examples/nginx-app/base.yaml
-```
-
-## Architecture
-
-Each of Heptio Ark's operations (Backups, Schedules, and Restores) are custom resources themselves, defined using [CRDs][20]. Their accompanying [custom controllers][21] handle them when they are submitted to the Kubernetes API server.
-
-As mentioned before, Ark runs in two different modes:
-
-* **Ark client**: Allows you to query, create, and delete the Ark resources as desired.
-
-* **Ark server**: Runs all of the Ark controllers. Each controller watches its respective custom resource for API operations, performs validation, and handles the majority of the cloud API logic (e.g. interfacing with object storage and persistent volumes).
-
-Looking at a specific example--an `ark backup create test-backup` command triggers the following operations:
-
-![19]
-
-1. The *ark client* makes a call to the Kubernetes API server, creating a `Backup` custom resource (which is stored in [etcd][22]).
-
-2. The `BackupController` sees that a new `Backup` has been created, and validates it.
-
-3. Once validation passes, the `BackupController` begins the backup process. It collects data by querying the Kubernetes API Server for resources.
-
-4. Once the data has been aggregated, the `BackupController` makes a call to the object storage service (e.g. Amazon S3) to upload the backup file.
-
-5. By default, Ark also makes disk snapshots of any persistent volumes, using the appropriate cloud service API. (This can be disabled via the option `--snapshot-volumes=false`)
-
-## Further documentation
-
- To learn more about Heptio Ark operations and their applications, see the [`/docs` directory][3].
+Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of Velero.
 
 ## Troubleshooting
 
-If you encounter any problems that the documentation does not address, [file an issue][4] or talk to us on the [Kubernetes Slack team][25] channel `#ark-dr`.
+If you encounter issues, review the [troubleshooting docs][30], [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server.
 
 ## Contributing
 
 Thanks for taking the time to join our community and start contributing!
 
-Feedback and discussion is available on [the mailing list][24].
+Feedback and discussion are available on [the mailing list][24].
 
-#### Before you start
+### Before you start
 
 * Please familiarize yourself with the [Code of Conduct][8] before contributing.
 * See [CONTRIBUTING.md][5] for instructions on the developer certificate of origin that we require.
+* Read how [we're using ZenHub][26] for project and roadmap planning
 
-#### Pull requests
+### Pull requests
 
 * We welcome pull requests. Feel free to dig through the [issues][4] and jump in.
 
-
 ## Changelog
 
 See [the list of releases][6] to find out about feature changes.
 
-[0]: https://github.com/heptio
-[1]: https://jenkins.i.heptio.com/buildStatus/icon?job=ark-master
-[2]: https://jenkins.i.heptio.com/job/ark-master/
-[3]: /docs
-[4]: https://github.com/heptio/ark/issues
-[5]: /CONTRIBUTING.md
-[6]: /CHANGELOG.md
-[7]: /docs/build-from-scratch.md
-[8]: /CODE_OF_CONDUCT.md
+[1]: https://travis-ci.org/heptio/velero.svg?branch=master
+[2]: https://travis-ci.org/heptio/velero
+
+[4]: https://github.com/heptio/velero/issues
+[5]: https://github.com/heptio/velero/blob/master/CONTRIBUTING.md
+[6]: https://github.com/heptio/velero/releases
+
+[8]: https://github.com/heptio/velero/blob/master/CODE_OF_CONDUCT.md
 [9]: https://kubernetes.io/docs/setup/
 [10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
 [11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
 [12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md
-[13]: /docs/output-file-format.md
 [14]: https://github.com/kubernetes/kubernetes
-[15]: https://aws.amazon.com/
-[16]: https://cloud.google.com/
-[17]: https://azure.microsoft.com/
-[18]: /docs/debugging-restores.md
-[19]: /docs/img/backup-process.png
-[20]: https://kubernetes.io/docs/concepts/api-extension/custom-resources/#customresourcedefinitions
-[21]: https://kubernetes.io/docs/concepts/api-extension/custom-resources/#custom-controllers
-[22]: https://github.com/coreos/etcd
-[23]: /docs/cloud-provider-specifics.md
-[24]: http://j.hept.io/ark-list
-[25]: http://slack.kubernetes.io/
-[26]: https://github.com/heptio/ark/releases
+
+[24]: https://groups.google.com/forum/#!forum/projectvelero
+[25]: https://kubernetes.slack.com/messages/velero
+[26]: https://velero.io/docs/zenhub
+
+[28]: https://velero.io/docs/install-overview
+[29]: https://velero.io/docs/
+[30]: https://velero.io/docs/troubleshooting
+
+[99]: https://velero.io/docs/support-matrix
+[100]: /site/docs/master/img/velero.png

SUPPORT.md

@@ -1,5 +1,5 @@
-# Ark Support
+# Velero Support
 
-Thanks for trying out Ark! We welcome all feedback, please consider joining our mailing list: 
+Thanks for trying out Velero! We welcome all feedback, please consider joining our mailing list: 
 
-- [Mailing List](http://j.hept.io/ark-list)
+- [Mailing List](https://groups.google.com/forum/#!forum/projectvelero)

changelogs/CHANGELOG-0.10.md

@@ -0,0 +1,261 @@
+  - [v0.10.2](#v0102)
+  - [v0.10.1](#v0101)
+  - [v0.10.0](#v0100)
+
+## v0.10.2
+#### 2019-02-28
+
+### Download
+- https://github.com/heptio/ark/releases/tag/v0.10.2
+
+### Changes
+  * upgrade restic to v0.9.4 & replace --hostname flag with --host (#1156, @skriss)
+  * use 'restic stats' instead of 'restic check' to determine if repo exists (#1171, @skriss)
+  * Fix concurrency bug in code ensuring restic repository exists (#1235, @skriss)
+
+## v0.10.1
+#### 2019-01-10
+
+### Download
+- https://github.com/heptio/ark/releases/tag/v0.10.1
+
+### Changes
+  * Fix minio setup job command (#1118, @acbramley)
+  * Add debugging-install link in doc get-started.md (#1131, @hex108)
+  * `ark version`: show full git SHA & combine git tree state indicator with git SHA line (#1124, @skriss)
+  * Delete spec.priority in pod restore action (#879, @mwieczorek)
+  * Allow to use AWS Signature v1 for creating signed AWS urls (#811, @bashofmann)
+  * add multizone/regional support to gcp (#765, @wwitzel3)
+  * Fixed the newline output when deleting a schedule. (#1120, @jwhitcraft)
+  * Remove obsolete make targets and rename 'make goreleaser' to 'make release' (#1114, @skriss)
+  * Update to go 1.11 (#1069, @gliptak)
+  * Update CHANGELOGs (#1063, @wwitzel3)
+  * Initialize empty schedule metrics on server init (#1054, @cbeneke)
+  * Added brew reference (#1051, @omerlh)
+  * Remove default token from all service accounts (#1048, @ncdc)
+  * Add pprof support to the Ark server (#234, @ncdc)
+
+## v0.10.0
+#### 2018-11-15
+
+### Download
+- https://github.com/heptio/ark/releases/tag/v0.10.0
+
+### Highlights
+- We've introduced two new custom resource definitions, `BackupStorageLocation` and `VolumeSnapshotLocation`, that replace the `Config` CRD from
+previous versions. As part of this, you may now configure more than one possible location for where backups and snapshots are stored, and when you
+create a `Backup` you can select the location where you'd like that particular backup to be stored. See the [Locations documentation][2] for an overview
+of this feature.
+- Ark's plugin system has been significantly refactored to improve robustness and ease of development. Plugin processes are now automatically restarted
+if they unexpectedly terminate. Additionally, plugin binaries can now contain more than one plugin implementation (e.g. and object store *and* a block store,
+or many backup item actions).
+- The sync process, which ensures that Backup custom resources exist for each backup in object storage, has been revamped to run much more frequently (once
+per minute rather than once per hour), to use significantly fewer cloud provider API calls, and to not generate spurious Kubernetes API errors.
+- Ark can now be configured to store all data under a prefix within an object storage bucket. This means that you no longer need a separate bucket per Ark
+instance; you can now have all of your clusters' Ark backups go into a single bucket, with each cluster having its own prefix/subdirectory
+within that bucket.
+- Restic backup data is now automatically stored within the same bucket/prefix as the rest of the Ark data. A separate bucket is no longer required (or allowed).
+- Ark resources (backups, restores, schedules) can now be bulk-deleted through the `ark` CLI, using the `--all` or `--selector` flags, or by specifying 
+multiple resource names as arguments to the `delete` commands.
+- The `ark` CLI now supports waiting for backups and restores to complete with the `--wait` flag for `ark backup create` and `ark restore create`
+- Restores can be created directly from the most recent backup for a schedule, using `ark restore create --from-schedule SCHEDULE_NAME`
+
+### Breaking Changes
+
+Heptio Ark v0.10 contains a number of breaking changes.  Upgrading will require some additional steps beyond just updating your client binary and your
+container image tag. We've provided a [detailed set of instructions][1] to help you with the upgrade process. **Please read and follow these instructions 
+carefully to ensure a successful upgrade!**
+
+- The `Config` CRD has been replaced by `BackupStorageLocation` and `VolumeSnapshotLocation` CRDs. 
+- The interface for external plugins (object/block stores, backup/restore item actions) has changed. If you have authored any custom plugins, they'll 
+need to be updated for v0.10.
+    - The [`ObjectStore.ListCommonPrefixes`](https://github.com/heptio/ark/blob/master/pkg/cloudprovider/object_store.go#L50) signature has changed to add a `prefix` parameter.
+    - Registering plugins has changed. Create a new plugin server with the `NewServer` function, and register plugins with the appropriate functions. See the [`Server`](https://github.com/heptio/ark/blob/master/pkg/plugin/server.go#L37) interface for details.
+- The organization of Ark data in object storage has changed. Existing data will need to be moved around to conform to the new layout.
+
+### All Changes
+-   [b9de44ff](https://github.com/heptio/ark/commit/b9de44ff)	update docs to reference config/ dir within release tarballs
+-   [eace0255](https://github.com/heptio/ark/commit/eace0255)	goreleaser: update example image tags to match version being released
+-   [cff02159](https://github.com/heptio/ark/commit/cff02159)	add rbac content, rework get-started for NodePort and publicUrl, add versioning information
+-   [fa14255e](https://github.com/heptio/ark/commit/fa14255e)	add content for docs issue 819
+-   [22959071](https://github.com/heptio/ark/commit/22959071)	add doc explaining locations
+-   [e5556fe6](https://github.com/heptio/ark/commit/e5556fe6)	Added qps and burst to server's client
+-   [9ae861c9](https://github.com/heptio/ark/commit/9ae861c9)	Support a separate URL base for pre-signed URLs
+-   [698420b6](https://github.com/heptio/ark/commit/698420b6)	Update storage-layout-reorg-v0.10.md
+-   [6c9e1f18](https://github.com/heptio/ark/commit/6c9e1f18)	lower some noisy logs to debug level
+-   [318fd8a8](https://github.com/heptio/ark/commit/318fd8a8)	add troubleshooting for loadbalancer restores
+-   [defb8aa8](https://github.com/heptio/ark/commit/defb8aa8)	remove code that checks directly for a backup from restore controller
+-   [7abe1156](https://github.com/heptio/ark/commit/7abe1156)	Move clearing up of metadata before plugin's actions
+-   [ec013e6f](https://github.com/heptio/ark/commit/ec013e6f)	Document upgrading plugins in the deployment
+-   [d6162e94](https://github.com/heptio/ark/commit/d6162e94)	fix goreleaser bugs
+-   [a15df276](https://github.com/heptio/ark/commit/a15df276)	Add correct link and change role
+-   [46bed015](https://github.com/heptio/ark/commit/46bed015)	add 0.10 breaking changes warning to readme in master
+-   [e3a7d6a2](https://github.com/heptio/ark/commit/e3a7d6a2)	add content for issue 994
+-   [400911e9](https://github.com/heptio/ark/commit/400911e9)	address docs issue #978
+-   [b818cc27](https://github.com/heptio/ark/commit/b818cc27)	don't require a default provider VSL if there's only 1
+-   [90638086](https://github.com/heptio/ark/commit/90638086)	v0.10 changelog
+-   [6e2166c4](https://github.com/heptio/ark/commit/6e2166c4)	add docs page on versions and upgrading
+-   [18b434cb](https://github.com/heptio/ark/commit/18b434cb)	goreleaser scripts for building/creating a release on a workstation
+-   [bb65d67a](https://github.com/heptio/ark/commit/bb65d67a)	update restic prerequisite with min k8s version
+-   [b5a2ccd5](https://github.com/heptio/ark/commit/b5a2ccd5)	Silence git detached HEAD advice in build container
+-   [67749141](https://github.com/heptio/ark/commit/67749141)	instructions for upgrading to v0.10
+-   [516422c2](https://github.com/heptio/ark/commit/516422c2)	sync controller: fill in missing .spec.storageLocation
+- 	[195e6aaf](https://github.com/heptio/ark/commit/195e6aaf)	fix bug preventing PV snapshots from v0.10 backups from restoring
+- 	[bca58516](https://github.com/heptio/ark/commit/bca58516)	Run 'make update' to update formatting
+- 	[573ce7d0](https://github.com/heptio/ark/commit/573ce7d0)	Update formatting script
+- 	[90d9be59](https://github.com/heptio/ark/commit/90d9be59)	support restoring/deleting legacy backups with .status.volumeBackups
+- 	[ef194972](https://github.com/heptio/ark/commit/ef194972)	rename variables #967
+- 	[6d4e702c](https://github.com/heptio/ark/commit/6d4e702c)	fix broken link
+- 	[596eea1b](https://github.com/heptio/ark/commit/596eea1b)	restore storageclasses before pvs and pvcs
+- 	[f014cab1](https://github.com/heptio/ark/commit/f014cab1)	backup describer: show snapshot summary by default, details optionally
+- 	[8acc66d0](https://github.com/heptio/ark/commit/8acc66d0)	remove pvProviderExists param from NewRestoreController
+- 	[57ce590f](https://github.com/heptio/ark/commit/57ce590f)	create a struct for multiple return of same type in restore_contoroller #967
+- 	[028fafb6](https://github.com/heptio/ark/commit/028fafb6)	Corrected grammatical  error
+- 	[db856aff](https://github.com/heptio/ark/commit/db856aff)	Specify return arguments
+- 	[9952dfb0](https://github.com/heptio/ark/commit/9952dfb0)	Address #424: Add CRDs to list of prioritized resources
+- 	[cf2c2714](https://github.com/heptio/ark/commit/cf2c2714)	fix bugs in GetBackupVolumeSnapshots and add test
+- 	[ec124673](https://github.com/heptio/ark/commit/ec124673)	remove all references to Config from docs/examples
+- 	[c36131a0](https://github.com/heptio/ark/commit/c36131a0)	remove Config-related code
+- 	[406b50a7](https://github.com/heptio/ark/commit/406b50a7)	update restore process using snapshot locations
+- 	[268080ad](https://github.com/heptio/ark/commit/268080ad)	avoid panics if can't get block store during deletion
+- 	[4a03370f](https://github.com/heptio/ark/commit/4a03370f)	update backup deletion controller for snapshot locations
+- 	[38c72b8c](https://github.com/heptio/ark/commit/38c72b8c)	include snapshot locations in created schedule's backup spec
+- 	[0ec2de55](https://github.com/heptio/ark/commit/0ec2de55)	azure: update blockstore to allow storing snaps in different resource group
+- 	[35bb533c](https://github.com/heptio/ark/commit/35bb533c)	close gzip writer before uploading volumesnapshots file
+- 	[da9ed38c](https://github.com/heptio/ark/commit/da9ed38c)	store volume snapshot info as JSON in backup storage
+- 	[e24248e0](https://github.com/heptio/ark/commit/e24248e0)	add --volume-snapshot-locations flag to ark backup create
+- 	[df07b7dc](https://github.com/heptio/ark/commit/df07b7dc)	update backup code to work with volume snapshot locations
+- 	[4af89fa8](https://github.com/heptio/ark/commit/4af89fa8)	add unit test for getDefaultVolumeSnapshotLocations
+- 	[02f50b9c](https://github.com/heptio/ark/commit/02f50b9c)	add default-volume-snapshot-locations to server cmd
+- 	[1aa712d2](https://github.com/heptio/ark/commit/1aa712d2)	Default and validate VolumeSnapshotLocations
+- 	[bbf76985](https://github.com/heptio/ark/commit/bbf76985)	add create CLI command for snapshot locations
+- 	[aeb221ea](https://github.com/heptio/ark/commit/aeb221ea)	Add printer for snapshot locations
+- 	[ffc612ac](https://github.com/heptio/ark/commit/ffc612ac)	Add volume snapshot CLI get command
+- 	[f20342aa](https://github.com/heptio/ark/commit/f20342aa)	Add VolumeLocation and Snapshot.
+- 	[7172db8a](https://github.com/heptio/ark/commit/7172db8a)	upgrade to restic v0.9.3
+- 	[99adc4fa](https://github.com/heptio/ark/commit/99adc4fa)	Remove broken references to docs that are not existing
+- 	[474efde6](https://github.com/heptio/ark/commit/474efde6)	Fixed relative link for image
+- 	[41735154](https://github.com/heptio/ark/commit/41735154)	don't require a default backup storage location to exist
+- 	[0612c5de](https://github.com/heptio/ark/commit/0612c5de)	templatize error message in DeleteOptions
+- 	[66bcbc05](https://github.com/heptio/ark/commit/66bcbc05)	add support for bulk deletion to ark schedule delete
+- 	[3af43b49](https://github.com/heptio/ark/commit/3af43b49)	add azure-specific code to support multi-location restic
+- 	[d009163b](https://github.com/heptio/ark/commit/d009163b)	update restic to support multiple backup storage locations
+- 	[f4c99c77](https://github.com/heptio/ark/commit/f4c99c77)	Change link for the support matrix
+- 	[91e45d56](https://github.com/heptio/ark/commit/91e45d56)	Fix broken storage providers link
+- 	[ed0eb865](https://github.com/heptio/ark/commit/ed0eb865)	fix backup storage location example YAMLs
+- 	[eb709b8f](https://github.com/heptio/ark/commit/eb709b8f)	only sync a backup location if it's changed since last sync
+- 	[af3af1b5](https://github.com/heptio/ark/commit/af3af1b5)	clarify Azure resource group usage in docs
+- 	[9fdf8513](https://github.com/heptio/ark/commit/9fdf8513)	Minor code cleanup
+- 	[2073e15a](https://github.com/heptio/ark/commit/2073e15a)	Fix formatting for live site
+- 	[0fc3e8d8](https://github.com/heptio/ark/commit/0fc3e8d8)	add documentation on running Ark on-premises
+- 	[e46e89cb](https://github.com/heptio/ark/commit/e46e89cb)	have restic share main Ark bucket
+- 	[42b54586](https://github.com/heptio/ark/commit/42b54586)	refactor to make valid dirs part of an object store layout
+- 	[8bc7e4f6](https://github.com/heptio/ark/commit/8bc7e4f6)	store backups & restores in backups/, restores/ subdirs in obj storage
+- 	[e3232b7e](https://github.com/heptio/ark/commit/e3232b7e)	add support for bulk deletion to ark restore delete
+- 	[17be71e1](https://github.com/heptio/ark/commit/17be71e1)	remove deps used for docs gen
+- 	[20635106](https://github.com/heptio/ark/commit/20635106)	remove script for generating docs
+- 	[6fd9ea9d](https://github.com/heptio/ark/commit/6fd9ea9d)	remove cli reference docs and related scripts
+- 	[4833607a](https://github.com/heptio/ark/commit/4833607a)	Fix infinite sleep in fsfreeze container
+- 	[7668bfd4](https://github.com/heptio/ark/commit/7668bfd4)	Add links for Portworx plugin support
+- 	[468006e6](https://github.com/heptio/ark/commit/468006e6)	Fix Portworx name in doc
+- 	[e6b44539](https://github.com/heptio/ark/commit/e6b44539)	Make fsfreeze image building consistent
+- 	[fcd27a13](https://github.com/heptio/ark/commit/fcd27a13)	get a new metadata accessor after calling backup item actions
+- 	[ffef86e3](https://github.com/heptio/ark/commit/ffef86e3)	Adding support for the AWS_CLUSTER_NAME env variable allowing to claim volumes ownership
+- 	[cda3dff8](https://github.com/heptio/ark/commit/cda3dff8)	Document single binary plugins
+- 	[f049e078](https://github.com/heptio/ark/commit/f049e078)	Remove ROADMAP.md, update ZenHub link to Ark board
+- 	[94617b30](https://github.com/heptio/ark/commit/94617b30)	convert all controllers to use genericController, logContext -> log
+- 	[779cb428](https://github.com/heptio/ark/commit/779cb428)	Document SignatureDoesNotMatch error and triaging
+- 	[7d8813a9](https://github.com/heptio/ark/commit/7d8813a9)	move ObjectStore mock into pkg/cloudprovider/mocks
+- 	[f0edf733](https://github.com/heptio/ark/commit/f0edf733)	add a BackupStore to pkg/persistence that supports prefixes
+- 	[af64069d](https://github.com/heptio/ark/commit/af64069d)	create pkg/persistence and move relevant code from pkg/cloudprovider into it
+- 	[29d75d72](https://github.com/heptio/ark/commit/29d75d72)	move object and block store interfaces to their own files
+- 	[211aa7b7](https://github.com/heptio/ark/commit/211aa7b7)	Set schedule labels to subsequent backups
+- 	[d34994cb](https://github.com/heptio/ark/commit/d34994cb)	set azure restic env vars based on default backup location's config
+- 	[a50367f1](https://github.com/heptio/ark/commit/a50367f1)	Regenerate CLI docs
+- 	[7bc27bbb](https://github.com/heptio/ark/commit/7bc27bbb)	Pin cobra version
+- 	[e94277ac](https://github.com/heptio/ark/commit/e94277ac)	Update pflag version
+- 	[df69b274](https://github.com/heptio/ark/commit/df69b274)	azure: update documentation and examples
+- 	[cb321db2](https://github.com/heptio/ark/commit/cb321db2)	azure: refactor to not use helpers/ pkg, validate all env/config inputs
+- 	[9d7ea748](https://github.com/heptio/ark/commit/9d7ea748)	azure: support different RGs/storage accounts per backup location
+- 	[cd4e9f53](https://github.com/heptio/ark/commit/cd4e9f53)	azure: fix for breaking change in blob.GetSASURI
+- 	[a440029c](https://github.com/heptio/ark/commit/a440029c)	bump Azure SDK version and include storage mgmt package
+- 	[b31e25bf](https://github.com/heptio/ark/commit/b31e25bf)	server: remove unused code, replace deprecated func
+- 	[729d7339](https://github.com/heptio/ark/commit/729d7339)	controllers: take a newPluginManager func in constructors
+- 	[6445dbf1](https://github.com/heptio/ark/commit/6445dbf1)	Update examples and docs for backup locations
+- 	[133dc185](https://github.com/heptio/ark/commit/133dc185)	backup sync: process the default location first
+- 	[7a1e6d16](https://github.com/heptio/ark/commit/7a1e6d16)	generic controller: allow controllers with only a resync func
+- 	[6f7bfe54](https://github.com/heptio/ark/commit/6f7bfe54)	remove Config CRD's BackupStorageProvider & other obsolete code
+- 	[bd4d97b9](https://github.com/heptio/ark/commit/bd4d97b9)	move server's defaultBackupLocation into config struct
+- 	[0e94fa37](https://github.com/heptio/ark/commit/0e94fa37)	update sync controller for backup locations
+- 	[2750aa71](https://github.com/heptio/ark/commit/2750aa71)	Use backup storage location during restore
+- 	[20f89fbc](https://github.com/heptio/ark/commit/20f89fbc)	use the default backup storage location for restic
+- 	[833a6307](https://github.com/heptio/ark/commit/833a6307)	Add storage location to backup get/describe
+- 	[cf7c8587](https://github.com/heptio/ark/commit/cf7c8587)	download request: fix setting of log level for plugin manager
+- 	[3234124a](https://github.com/heptio/ark/commit/3234124a)	backup deletion: fix setting of log level in plugin manager
+- 	[74043ab4](https://github.com/heptio/ark/commit/74043ab4)	download request controller: fix bug in determining expiration
+- 	[7007f198](https://github.com/heptio/ark/commit/7007f198)	refactor download request controller test and add test cases
+- 	[8f534615](https://github.com/heptio/ark/commit/8f534615)	download request controller: use backup location for object store
+- 	[bab08ed1](https://github.com/heptio/ark/commit/bab08ed1)	backup deletion controller: use backup location for object store
+- 	[c6f488f7](https://github.com/heptio/ark/commit/c6f488f7)	Use backup location in the backup controller
+- 	[06b5af44](https://github.com/heptio/ark/commit/06b5af44)	add create and get CLI commands for backup locations
+- 	[adbcd370](https://github.com/heptio/ark/commit/adbcd370)	add --default-backup-storage-location flag to server cmd
+- 	[2a34772e](https://github.com/heptio/ark/commit/2a34772e)	Add --storage-location argument to create commands
+- 	[56f16170](https://github.com/heptio/ark/commit/56f16170)	Correct metadata for BackupStorageLocationList
+- 	[345c3c39](https://github.com/heptio/ark/commit/345c3c39)	Generate clients for BackupStorageLocation
+- 	[a25eb032](https://github.com/heptio/ark/commit/a25eb032)	Add BackupStorageLocation API type
+- 	[575c4ddc](https://github.com/heptio/ark/commit/575c4ddc)	apply annotations on single line, no restore mode
+- 	[030ea6c0](https://github.com/heptio/ark/commit/030ea6c0)	minor word updates and command wrapping
+- 	[d32f8dbb](https://github.com/heptio/ark/commit/d32f8dbb)	Update hooks/fsfreeze example
+- 	[342a1c64](https://github.com/heptio/ark/commit/342a1c64)	add an ark bug command
+- 	[9c11ba90](https://github.com/heptio/ark/commit/9c11ba90)	Add DigitalOcean to S3-compatible backup providers
+- 	[ea50ebf2](https://github.com/heptio/ark/commit/ea50ebf2)	Fix map merging logic
+- 	[9508e4a2](https://github.com/heptio/ark/commit/9508e4a2)	Switch Config CRD elements to server flags
+- 	[0c3ac67b](https://github.com/heptio/ark/commit/0c3ac67b)	start using a namespaced label on restored objects, deprecate old label
+- 	[6e53aa03](https://github.com/heptio/ark/commit/6e53aa03)	Bring back 'make local'
+- 	[5acccaa7](https://github.com/heptio/ark/commit/5acccaa7)	add bulk deletion support to ark backup delete
+- 	[3aa241a7](https://github.com/heptio/ark/commit/3aa241a7)	Preserve node ports during restore when annotations hold specification.
+- 	[c5f5862c](https://github.com/heptio/ark/commit/c5f5862c)	Add --wait support to ark backup create
+- 	[eb6f742b](https://github.com/heptio/ark/commit/eb6f742b)	Document CRD not found errors
+- 	[fb4d507c](https://github.com/heptio/ark/commit/fb4d507c)	Extend doc about synchronization
+- 	[e7bb5926](https://github.com/heptio/ark/commit/e7bb5926)	Add --wait support to `ark restore create`
+- 	[8ce513ac](https://github.com/heptio/ark/commit/8ce513ac)	Only delete unused backup if they are complete
+- 	[1c26fbde](https://github.com/heptio/ark/commit/1c26fbde)	remove SnapshotService, replace with direct BlockStore usage
+- 	[13051218](https://github.com/heptio/ark/commit/13051218)	Refactor plugin management
+- 	[74dbf387](https://github.com/heptio/ark/commit/74dbf387)	Add restore failed phase and metrics
+- 	[8789ae5c](https://github.com/heptio/ark/commit/8789ae5c)	update testify to latest released version
+- 	[fe9d61a9](https://github.com/heptio/ark/commit/fe9d61a9)	Add schedule command info to quickstart
+- 	[ca5656c2](https://github.com/heptio/ark/commit/ca5656c2)	fix bug preventing backup item action item updates from saving
+- 	[d2e629f5](https://github.com/heptio/ark/commit/d2e629f5)	Delete backups from etcd if they're not in storage
+- 	[625ba481](https://github.com/heptio/ark/commit/625ba481)	Fix ZenHub link on Readme.md
+- 	[dcae6eb0](https://github.com/heptio/ark/commit/dcae6eb0)	Update gcp-config.md
+- 	[06d6665a](https://github.com/heptio/ark/commit/06d6665a)	check s3URL scheme upon AWS ObjectStore Init()
+- 	[cc359f6e](https://github.com/heptio/ark/commit/cc359f6e)	Add contributor docs for our ZenHub usage
+- 	[f6204562](https://github.com/heptio/ark/commit/f6204562)	cleanup service account action log statement
+- 	[450fa72f](https://github.com/heptio/ark/commit/450fa72f)	Initialize schedule Prometheus metrics to have them created beforehand (see https://prometheus.io/docs/practices/instrumentation/#avoid-missing-metrics)
+- 	[39c4267a](https://github.com/heptio/ark/commit/39c4267a)	Clarify that object storage should per-cluster
+- 	[78cbdf95](https://github.com/heptio/ark/commit/78cbdf95)	delete old deletion requests for backup when processing a new one
+- 	[85a61b8e](https://github.com/heptio/ark/commit/85a61b8e)	return nil error if 404 encountered when deleting snapshots
+- 	[a2a7dbda](https://github.com/heptio/ark/commit/a2a7dbda)	fix tagging latest by using make's ifeq
+- 	[b4a52e45](https://github.com/heptio/ark/commit/b4a52e45)	Add commands for context to the bug template
+- 	[3efe6770](https://github.com/heptio/ark/commit/3efe6770)	Update Ark library code to work with Kubernetes 1.11
+- 	[7e8c8c69](https://github.com/heptio/ark/commit/7e8c8c69)	Add some basic troubleshooting commands
+- 	[d1955120](https://github.com/heptio/ark/commit/d1955120)	require namespace for backups/etc. to exist at server startup
+- 	[683f7afc](https://github.com/heptio/ark/commit/683f7afc)	switch to using .status.startTimestamp for sorting backups
+- 	[b71a37db](https://github.com/heptio/ark/commit/b71a37db)	Record backup completion time before uploading
+- 	[217084cd](https://github.com/heptio/ark/commit/217084cd)	Add example ark version command to issue templates
+- 	[040788bb](https://github.com/heptio/ark/commit/040788bb)	Add minor improvements and aws example<Plug>delimitMateCR
+- 	[5b89f7b6](https://github.com/heptio/ark/commit/5b89f7b6)	Skip backup sync if it already exists in k8s
+- 	[c6050845](https://github.com/heptio/ark/commit/c6050845)	restore controller: switch to 'c' for receiver name
+- 	[706ae07d](https://github.com/heptio/ark/commit/706ae07d)	enable a schedule to be provided as the source for a restore
+- 	[aea68414](https://github.com/heptio/ark/commit/aea68414)	fix up Slack link in troubleshooting on master branch
+- 	[bb8e2e91](https://github.com/heptio/ark/commit/bb8e2e91)	Document how to run the Ark server locally
+- 	[dc84e591](https://github.com/heptio/ark/commit/dc84e591)	Remove outdated namespace deletion content
+- 	[23abbc9a](https://github.com/heptio/ark/commit/23abbc9a)	fix paths
+- 	[f0426538](https://github.com/heptio/ark/commit/f0426538)	use posix-compliant conditional for checking TAG_LATEST
+- 	[cf336d80](https://github.com/heptio/ark/commit/cf336d80)	Added new templates
+- 	[795dc262](https://github.com/heptio/ark/commit/795dc262)	replace pkg/restore's osFileSystem with pkg/util/filesystem's
+- 	[eabef085](https://github.com/heptio/ark/commit/eabef085)	Update generated Ark code based on the 1.11 k8s.io/code-generator script
+- 	[f5eac0b4](https://github.com/heptio/ark/commit/f5eac0b4)	Update vendored library code for Kubernetes 1.11
+
+[1]: https://heptio.github.io/velero/v0.10.0/upgrading-to-v0.10
+[2]: locations.md

changelogs/CHANGELOG-0.11.md

@@ -0,0 +1,32 @@
+## v0.11.1
+#### 2019-05-17
+
+### Download
+- https://github.com/heptio/velero/releases/tag/v0.11.1
+
+### Highlights
+* Added the `velero migrate-backups` command to migrate legacy Ark backup metadata to the current Velero format in object storage. This command needs to be run in preparation for upgrading to v1.0, **if** you have backups that were originally created prior to v0.11 (i.e. when the project was named Ark).
+
+## v0.11.0
+#### 2019-02-28
+
+### Download
+- https://github.com/heptio/velero/releases/tag/v0.11.0
+
+### Highlights
+* Heptio Ark is now Velero! This release is the first one to use the new name. For details on the changes and how to migrate to v0.11, see the [migration instructions][1]. **Please follow the instructions to ensure a successful upgrade to v0.11.**
+* Restic has been upgraded to v0.9.4, which brings significantly faster restores thanks to a new multi-threaded restorer.
+* Velero now waits for terminating namespaces and persistent volumes to delete before attempting to restore them, rather than trying and failing to restore them while they're being deleted.
+
+### All Changes
+* Fix concurrency bug in code ensuring restic repository exists (#1235, @skriss)
+* Wait for PVs and namespaces to delete before attempting to restore them. (#826, @nrb)
+* Set the zones for GCP regional disks on restore. This requires the `compute.zones.get` permission on the GCP serviceaccount in order to work correctly. (#1200, @nrb)
+* Renamed Heptio Ark to Velero. Changed internal imports, environment variables, and binary name. (#1184, @nrb)
+* use 'restic stats' instead of 'restic check' to determine if repo exists (#1171, @skriss)
+* upgrade restic to v0.9.4 & replace --hostname flag with --host (#1156, @skriss)
+* Clarify restore log when object unchanged (#1153, @daved)
+* Add backup-version file in backup tarball. (#1117, @wwitzel3)
+* add ServerStatusRequest CRD and show server version in `ark version` output (#1116, @skriss)
+
+[1]: https://heptio.github.io/velero/v0.11.0/migrating-to-velero

changelogs/CHANGELOG-0.3.md

@@ -0,0 +1,39 @@
+- [v0.3.3](#v033)
+- [v0.3.2](#v032)
+- [v0.3.1](#v031)
+- [v0.3.0](#v030)
+
+## v0.3.3
+#### 2017-08-10
+### Download
+  - https://github.com/heptio/ark/tree/v0.3.3
+
+### Bug Fixes
+  * Treat the first field in a schedule's cron expression as minutes, not seconds
+
+
+## v0.3.2
+#### 2017-08-07
+### Download
+  - https://github.com/heptio/ark/tree/v0.3.2
+
+### New Features
+  * Add client-go auth provider plugins for Azure, GCP, OIDC
+
+
+## v0.3.1
+#### 2017-08-03
+### Download
+  - https://github.com/heptio/ark/tree/v0.3.1
+
+### Bug Fixes
+  * Fix Makefile VERSION
+
+
+## v0.3.0
+#### 2017-08-03
+### Download
+  - https://github.com/heptio/ark/tree/v0.3.0
+
+### All New Features
+  *  Initial Release

changelogs/CHANGELOG-0.4.md

@@ -0,0 +1,29 @@
+- [v0.4.0](#v040)
+
+## v0.4.0
+#### 2017-09-14
+### Download
+  - https://github.com/heptio/ark/tree/v0.4.0
+
+### Breaking changes
+  * Snapshotting and restoring volumes is now enabled by default
+  * The --namespaces flag for 'ark restore create' has been replaced by --include-namespaces and
+    --exclude-namespaces
+
+### New features
+  * Support for S3 SSE with KMS
+  * Cloud provider configurations are validated at startup
+  * The persistentVolumeProvider is now optional
+  * Restore objects are garbage collected
+  * Each backup now has an associated log file, viewable via 'ark backup logs'
+  * Each restore now has an associated log file, viewable via 'ark restore logs'
+  * Add --include-resources/--exclude-resources for restores
+
+### Bug fixes
+  * Only save/use iops for io1 volumes on AWS
+  * When restoring, try to retrieve the Backup directly from object storage if it's not found
+  * When syncing Backups from object storage to Kubernetes, don't return at the first error
+    encountered
+  * More closely match how kubectl performs kubeconfig resolution
+  * Increase default Azure API request timeout to 2 minutes
+  * Update Azure diskURI to match diskName

changelogs/CHANGELOG-0.5.md

@@ -0,0 +1,41 @@
+- [v0.5.1](#v051)
+- [v0.5.0](#v050)
+
+## v0.5.1
+#### 2017-11-06
+### Download
+  - https://github.com/heptio/ark/tree/v0.5.1
+
+### Bug fixes
+  * If a Service is headless, retain ClusterIP = None when backing up and restoring.
+  * Use the specifed --label-selector when listing backups, schedules, and restores.
+  * Restore namespace mapping functionality that was accidentally broken in 0.5.0.
+  * Always include namespaces in the backup, regardless of the --include-cluster-resources setting.
+
+
+## v0.5.0
+#### 2017-10-26
+### Download
+  - https://github.com/heptio/ark/tree/v0.5.0
+
+### Breaking changes
+  * The backup tar file format has changed. Backups created using previous versions of Ark cannot be restored using v0.5.0.
+  * When backing up one or more specific namespaces, cluster-scoped resources are no longer backed up by default, with the exception of PVs that are used within the target namespace(s). Cluster-scoped resources can still be included by explicitly specifying `--include-cluster-resources`.
+
+### New features
+  * Add customized user-agent string for Ark CLI
+  * Switch from glog to logrus
+  * Exclude nodes from restoration
+  * Add a FAQ
+  * Record PV availability zone and use it when restoring volumes from snapshots
+  * Back up the PV associated with a PVC
+  * Add `--include-cluster-resources` flag to `ark backup create`
+  * Add `--include-cluster-resources` flag to `ark restore create`
+  * Properly support resource restore priorities across cluster-scoped and namespace-scoped resources
+  * Support `ark create ...` and `ark get ...`
+  * Make ark run as cluster-admin
+  * Add pod exec backup hooks
+  * Support cross-compilation & upgrade to go 1.9
+  
+### Bug fixes
+  * Make config change detection more robust

changelogs/CHANGELOG-0.6.md

@@ -0,0 +1,31 @@
+- [v0.6.0](#v060)
+
+## v0.6.0
+#### 2017-11-30
+### Download
+  - https://github.com/heptio/ark/tree/v0.6.0
+
+### Highlights
+  * **Plugins** - We now support user-defined plugins that can extend Ark functionality to meet your custom backup/restore needs without needing to be compiled into the core binary. We support pluggable block and object stores as well as per-item backup and restore actions that can execute arbitrary logic, including modifying the items being backed up or restored. For more information see the [documentation](docs/plugins.md), which includes a reference to a fully-functional sample plugin repository. (#174 #188 #206 #213 #215 #217 #223 #226)
+  * **Describers** - The Ark CLI now includes `describe` commands for `backups`, `restores`, and `schedules` that provide human-friendly representations of the relevant API objects.
+
+### Breaking Changes
+  * The config object format has changed. In order to upgrade to v0.6.0, the config object will have to be updated to match the new format. See the [examples](examples) and [documentation](docs/config-definition.md) for more information.
+  * The restore object format has changed. The `warnings` and `errors` fields are now ints containing the counts, while full warnings and errors are now stored in the object store instead of etcd. Restore objects created prior to v.0.6.0 should be deleted, or a new bucket used, and the old restore objects deleted from Kubernetes (`kubectl -n heptio-ark delete restore --all`).
+
+### All New Features
+  * Add `ark plugin add` and `ark plugin remove` commands #217, @skriss
+  * Add plugin support for block/object stores, backup/restore item actions #174 #188 #206 #213 #215 #223 #226, @skriss @ncdc
+  * Improve Azure deployment instructions #216, @ncdc
+  * Change default TTL for backups to 30 days #204, @nrb
+  * Improve logging for backups and restores #199, @ncdc
+  * Add `ark backup describe`, `ark schedule describe` #196, @ncdc
+  * Add `ark restore describe` and move restore warnings/errors to object storage #173 #201 #202, @ncdc
+  * Upgrade to client-go v5.0.1, kubernetes v1.8.2 #157, @ncdc
+  * Add Travis CI support #165 #166, @ncdc
+
+### Bug Fixes
+  * Fix log location hook prefix stripping #222, @ncdc
+  * When running `ark backup download`, remove file if there's an error #154, @ncdc
+  * Update documentation for AWS KMS Key alias support #163, @lli-hiya
+  * Remove clock from `volume_snapshot_action` #137, @athampy

changelogs/CHANGELOG-0.7.md

@@ -0,0 +1,30 @@
+- [v0.7.1](#v071)
+- [v0.7.0](#v070)
+
+## v0.7.1
+#### 2018-02-22
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.7.1
+
+### Bug Fixes:
+  * Run the Ark server in its own namespace, separate from backups/schedules/restores/config (#322, @ncdc)
+
+
+## v0.7.0
+#### 2018-02-15
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.7.0
+
+### New Features:
+  * Run the Ark server in any namespace (#272, @ncdc)
+  * Add ability to delete backups and their associated data (#252, @skriss)
+  * Support both pre and post backup hooks (#243, @ncdc)
+
+### Bug Fixes / Other Changes:
+  * Switch from Update() to Patch() when updating Ark resources (#241, @skriss)
+  * Don't fail the backup if a PVC is not bound to a PV (#256, @skriss)
+  * Restore serviceaccounts prior to workload controllers (#258, @ncdc)
+  * Stop removing annotations from PVs when restoring them (#263, @skriss)
+  * Update GCP client libraries (#249, @skriss)
+  * Clarify backup and restore creation messages (#270, @nrb)
+  * Update S3 bucket creation docs for us-east-1 (#285, @lypht)

changelogs/CHANGELOG-0.8.md

@@ -0,0 +1,100 @@
+- [v0.8.3](#v083)
+- [v0.8.2](#v082)
+- [v0.8.1](#v081)
+- [v0.8.0](#v080)
+
+## v0.8.3
+#### 2018-06-29
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.8.3
+
+### Bug Fixes:
+  * Don't restore backup and restore resources to avoid possible data corruption (#622, @ncdc)
+
+
+## v0.8.2
+#### 2018-06-01
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.8.2
+
+### Bug Fixes:
+  * Don't crash when a persistent volume claim is missing spec.volumeName (#520, @ncdc)
+
+
+## v0.8.1
+#### 2018-04-23
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.8.1
+
+### Bug Fixes:
+  * Azure: allow pre-v0.8.0 backups with disk snapshots to be restored and deleted (#446 #449, @skriss)
+
+
+## v0.8.0
+#### 2018-04-19
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.8.0
+
+### Highlights:
+  * Backup deletion has been completely revamped to make it simpler and less error-prone. As a user, you still use the `ark backup delete` command to request deletion of a backup and its associated cloud
+  resources; behind the scenes, we've switched to using a new `DeleteBackupRequest` Custom Resource and associated controller for processing deletion requests.
+  * We've reduced the number of required fields in the Ark config. For Azure, `location` is no longer required, and for GCP, `project` is not needed.
+  * Ark now copies tags from volumes to snapshots during backup, and from snapshots to new volumes during restore. 
+
+### Breaking Changes:
+  * Ark has moved back to a single namespace (`heptio-ark` by default) as part of #383.
+
+### All New Features:
+  * Add global `--kubecontext` flag to Ark CLI (#296, @blakebarnett)
+  * Azure: support cross-resource group restores of volumes (#356 #378, @skriss)
+  * AWS/Azure/GCP: copy tags from volumes to snapshots, and from snapshots to volumes (#341, @skriss)
+  * Replace finalizer for backup deletion with `DeleteBackupRequest` custom resource & controller (#383 #431, @ncdc @nrb)
+  * Don't log warnings during restore if an identical object already exists in the cluster (#405, @nrb)
+  * Add bash & zsh completion support (#384, @containscafeine)
+  
+### Bug Fixes / Other Changes:
+  * Error from the Ark CLI if attempting to restore a non-existent backup (#302, @ncdc)
+  * Enable running the Ark server locally for development purposes (#334, @ncdc)
+  * Add examples to `ark schedule create` documentation (#331, @lypht)
+  * GCP: Remove `project` requirement from Ark config (#345, @skriss)
+  * Add `--from-backup` flag to `ark restore create` and allow custom restore names (#342 #409, @skriss)
+  * Azure: remove `location` requirement from Ark config (#344, @skriss)
+  * Add documentation/examples for storing backups in IBM Cloud Object Storage (#321, @roytman)
+  * Reduce verbosity of hooks logging (#362, @skriss)
+  * AWS: Add minimal IAM policy to documentation (#363 #419, @hopkinsth)
+  * Don't restore events (#374, @sanketjpatel)
+  * Azure: reduce API polling interval from 60s to 5s (#359, @skriss)
+  * Switch from hostPath to emptyDir volume type for minio example (#386, @containscafeine)
+  * Add limit ranges as a prioritized resource for restores (#392, @containscafeine)
+  * AWS: Add documentation on using Ark with kube2iam (#402, @domderen)
+  * Azure: add node selector so Ark pod is scheduled on a linux node (#415, @ffd2subroutine)
+  * Error from the Ark CLI if attempting to get logs for a non-existent restore (#391, @containscafeine)
+  * GCP: Add minimal IAM policy to documentation (#429, @skriss @jody-frankowski)
+
+### Upgrading from v0.7.1:
+  Ark v0.7.1 moved the Ark server deployment into a separate namespace, `heptio-ark-server`. As of v0.8.0 we've
+  returned to a single namespace, `heptio-ark`, for all Ark-related resources. If you're currently running v0.7.1,
+  here are the steps you can take to upgrade:
+
+1. Execute the steps from the **Credentials and configuration** section for your cloud:
+    * [AWS](https://heptio.github.io/velero/v0.8.0/aws-config#credentials-and-configuration)
+    * [Azure](https://heptio.github.io/velero/v0.8.0/azure-config#credentials-and-configuration)
+    * [GCP](https://heptio.github.io/velero/v0.8.0/gcp-config#credentials-and-configuration)
+
+    When you get to the secret creation step, if you don't have your `credentials-ark` file handy, 
+    you can copy the existing secret from your `heptio-ark-server` namespace into the `heptio-ark` namespace:
+    ```bash
+    kubectl get secret/cloud-credentials -n heptio-ark-server --export -o json | \
+      jq '.metadata.namespace="heptio-ark"' | \
+      kubectl apply -f -
+    ```
+
+2. You can now safely delete the `heptio-ark-server` namespace:
+    ```bash
+    kubectl delete namespace heptio-ark-server
+    ```
+
+3. Execute the commands from the **Start the server** section for your cloud:
+    * [AWS](https://heptio.github.io/velero/v0.8.0/aws-config#start-the-server)
+    * [Azure](https://heptio.github.io/velero/v0.8.0/azure-config#start-the-server)
+    * [GCP](https://heptio.github.io/velero/v0.8.0/gcp-config#start-the-server)

changelogs/CHANGELOG-0.9.md

@@ -0,0 +1,181 @@
+  - [v0.9.11](#v0911)
+  - [v0.9.10](#v0910)
+  - [v0.9.9](#v099)
+  - [v0.9.8](#v098)
+  - [v0.9.7](#v097)
+  - [v0.9.6](#v096)
+  - [v0.9.5](#v095)
+  - [v0.9.4](#v094)
+  - [v0.9.3](#v093)
+  - [v0.9.2](#v092)
+  - [v0.9.1](#v091)
+  - [v0.9.0](#v090)
+
+## v0.9.11
+#### 2018-11-08
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.11
+
+### Bug Fixes
+  * Fix bug preventing PV snapshots from being restored (#1040, @ncdc)
+
+
+## v0.9.10
+#### 2018-11-01
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.10
+
+### Bug Fixes
+  * restore storageclasses before pvs and pvcs (#594, @shubheksha)
+  * AWS: Ensure that the order returned by ListObjects is consistent (#999, @bashofmann)
+  * Add CRDs to list of prioritized resources (#424, @domenicrosati)
+  * Verify PV doesn't exist before creating new volume (#609, @nrb)
+  * Update README.md - Grammar mistake corrected (#1018, @midhunbiju)
+
+
+## v0.9.9
+#### 2018-10-24
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.9
+
+### Bug Fixes
+  * Check if initContainers key exists before attempting to remove volume mounts. (#927, @skriss)
+
+
+## v0.9.8
+#### 2018-10-18
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.8
+
+### Bug Fixes
+  * Discard service account token volume mounts from init containers on restore (#910, @james-powis)
+  * Support --include-cluster-resources flag when creating schedule (#942, @captjt)
+  * Remove logic to get a GCP project (#926, @shubheksha)
+  * Only try to back up PVCs linked PV if the PVC's phase is Bound (#920, @skriss)
+  * Claim ownership of new AWS volumes on Kubernetes cluster being restored into (#801, @ljakimczuk)
+  * Remove timeout check when taking snapshots (#928, @carlisia)
+
+
+## v0.9.7
+#### 2018-10-04
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.7
+
+### Bug Fixes
+  * Preserve explicitly-specified node ports during restore (#712, @timoreimann)
+  * Enable restoring resources with ownerReference set (#837, @mwieczorek)
+  * Fix error when restoring ExternalName services (#869, @shubheksha)
+  * remove restore log helper for accurate line numbers (#891, @skriss)
+  * Display backup StartTimestamp in `ark backup get` output (#894, @marctc)
+  * Fix restic restores when using namespace mappings (#900, @skriss)
+
+
+## v0.9.6
+#### 2018-09-21
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.6
+
+### Bug Fixes
+  * Discard service account tokens from non-default service accounts on restore (#843, @james-powis)
+  * Update Docker images to use `alpine:3.8` (#852, @nrb)
+
+
+## v0.9.5
+#### 2018-09-17
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.5
+
+### Bug Fixes
+  * Fix issue causing restic restores not to work (#834, @skriss)
+
+
+## v0.9.4
+#### 20180-09-05
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.4
+
+### Bug Fixes
+  * Terminate plugin clients to resolve memory leaks (#797, @skriss)
+  * Fix nil map errors when merging annotations (#812, @nrb)
+
+
+## v0.9.3
+#### 2018-08-10
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.3
+### Bug Fixes
+  * Initalize Prometheus metrics when creating a new schedule (#689, @lemaral)
+
+
+## v0.9.2
+#### 2018-07-26
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.2) - 2018-07-26
+
+### Bug Fixes:
+  * Fix issue where modifications made by backup item actions were not being saved to backup tarball (#704, @skriss)
+
+
+## v0.9.1
+#### 2018-07-23
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.1
+
+### Bug Fixes:
+  * Require namespace for Ark's CRDs to already exist at server startup (#676, @skriss)
+  * Require all Ark CRDs to exist at server startup (#683, @skriss)
+  * Fix `latest` tagging in Makefile (#690, @skriss)
+  * Make Ark compatible with clusters that don't have the `rbac.authorization.k8s.io/v1` API group (#682, @nrb)
+  * Don't consider missing snapshots an error during backup deletion, limit backup deletion requests per backup to 1 (#687, @skriss)
+
+
+## v0.9.0
+#### 2018-07-06
+### Download
+  - https://github.com/heptio/ark/releases/tag/v0.9.0
+
+### Highlights:
+  * Ark now has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic](https://github.com/restic/restic).
+    This provides users an out-of-the-box solution for backing up and restoring almost any type of Kubernetes volume, whether or not it has snapshot support
+    integrated with Ark. For more information, see the [documentation](https://github.com/heptio/ark/blob/master/docs/restic.md).
+  * Support for Prometheus metrics has been added! View total number of backup attempts (including success or failure), total backup size in bytes, and backup
+    durations. More metrics coming in future releases!
+
+### All New Features:
+  * Add restic support (#508 #532 #533 #534 #535 #537 #540 #541 #545 #546 #547 #548 #555 #557 #561 #563 #569 #570 #571 #606 #608 #610 #621 #631 #636, @skriss)
+  * Add prometheus metrics (#531 #551 #564, @ashish-amarnath @nrb)
+  * When backing up a service account, include cluster roles/cluster role bindings that reference it (#470, @skriss)
+  * When restoring service accounts, copy secrets/image pull secrets into the target cluster even if the service account already exists (#403, @nrb)
+
+### Bug Fixes / Other Changes:
+  * Upgrade to Kubernetes 1.10 dependencies (#417, @skriss)
+  * Upgrade to go 1.10 and alpine 3.7 (#456, @skriss)
+  * Display no excluded resources/namespaces as `<none>` rather than `*` (#453, @nrb)
+  * Skip completed jobs and pods when restoring (#463, @nrb)
+  * Set namespace correctly when syncing backups from object storage (#472, @skriss)
+  * When building on macOS, bind-mount volumes with delegated config (#478, @skriss)
+  * Add replica sets and daemonsets to cohabitating resources so they're not backed up twice (#482 #485, @skriss)
+  * Shut down the Ark server gracefully on SIGINT/SIGTERM (#483, @skriss)
+  * Only back up resources that support GET and DELETE in addition to LIST and CREATE (#486, @nrb)
+  * Show a better error message when trying to get an incomplete restore's logs (#496, @nrb)
+  * Stop processing when setting a backup deletion request's phase to `Deleting` fails (#500, @nrb)
+  * Add library code to install Ark's server components (#437 #506, @marpaia)
+  * Properly handle errors when backing up additional items (#512, @carlpett)
+  * Run post hooks even if backup actions fail (#514, @carlpett)
+  * GCP: fail backup if upload to object storage fails (#510, @nrb)
+  * AWS: don't require `region` as part of backup storage provider config (#455, @skriss)
+  * Ignore terminating resources while doing a backup (#526, @yastij)
+  * Log to stdout instead of stderr (#553, @ncdc)
+  * Move sample minio deployment's config to an emptyDir (#566, @runyontr)
+  * Add `omitempty` tag to optional API fields (@580, @nikhita)
+  * Don't restore PVs with a reclaim policy of `Delete` and no snapshot (#613, @ncdc)
+  * Don't restore mirror pods (#619, @ncdc)
+
+### Docs Contributors:
+  * @gianrubio
+  * @castrojo
+  * @dhananjaysathe
+  * @c-knowles
+  * @mattkelly
+  * @ae-v
+  * @hamidzr

changelogs/CHANGELOG-1.0.md

@@ -0,0 +1,139 @@
+## v1.0.0
+#### 2019-05-20
+
+### Highlights
+- We've added a new command, `velero install`, to make it easier to get up and running with Velero. This CLI command replaces the static YAML installation files that were previously part of release tarballs. See the updated [install instructions][3] for more information.
+- We've made a number of improvements to the plugin framework:
+    - we've reorganized the relevant packages to minimize the import surface for plugin authors
+    - all plugins are now wrapped in panic handlers that will report information on panics back to Velero
+    - Velero's `--log-level` flag is now passed to plugin implementations
+    - Errors logged within plugins are now annotated with the file/line of where the error occurred
+    - Restore item actions can now optionally return a list of additional related items that should be restored
+    - Restore item actions can now indicate that an item *should not* be restored
+- For Azure installation, the `cloud-credentials` secret can now be created from a file containing a list of environment variables. Note that `velero install` always uses this method of providing credentials for Azure. For more details, see [Run on Azure][0].
+- We've added a new phase, `PartiallyFailed`, for both backups and restores. This new phase is used for backups/restores that successfully process some but not all of their items.
+- We removed all legacy Ark references, including API types, prometheus metrics, restic & hook annotations, etc.
+- The restic integration remains a **beta feature**. Please continue to try it out and provide feedback, and we'll be working over the next couple of releases to bring it to GA.
+
+### Breaking Changes
+
+#### API
+* All legacy Ark data types and pre-1.0 compatibility code has been removed. Users should migrate any backups created pre-v0.11.0 with the `velero migrate-backups` command, available in [v0.11.1][2].
+
+#### Image
+* The base container image has been switched to `ubuntu:bionic`
+
+#### Labels/Annotations/Metrics
+* The "ark" annotations for specifying hooks are no longer supported, and have been replaced with "velero"-based equivalents.
+* The "ark" annotation for specifying restic backups is no longer supported, and has been replaced with a "velero"-based equivalent.
+* The "ark" prometheus metrics no longer exist, and have been replaced with "velero"-based equivalents.
+
+#### Plugin Development
+* `BlockStore` plugins are now named `VolumeSnapshotter` plugins
+* Plugin APIs have moved to reduce the import surface:
+    * Plugin gRPC servers live in `github.com/heptio/velero/pkg/plugin/framework`
+    * Plugin interface types live in `github.com/heptio/velero/pkg/plugin/velero`
+* RestoreItemAction interface now takes the original item from the backup as a parameter
+* RestoreItemAction plugins can now return additional items to restore
+* RestoreItemAction plugins can now skip restoring an item
+* Plugins may now send stack traces with errors to the Velero server, so that the errors may be put into the server log
+* Plugins must now be "namespaced," using `example.domain.com/plugin-name` format
+    * For external ObjectStore and VolumeSnapshotter plugins. this name will also be the provider name in BackupStorageLoction and VolumeSnapshotLocation objects
+* `--log-level` flag is now passed to all plugins
+
+#### Validation
+* Configs for Azure, AWS, and GCP are now checked for invalid or extra keys, and the server is halted if any are found
+
+### Download
+- https://github.com/heptio/velero/releases/tag/v1.0.0
+
+### Container Image
+`gcr.io/heptio-images/velero:v1.0.0`
+
+### Documentation
+https://velero.io/docs/v1.0.0/
+
+### Upgrading
+To upgrade from a previous version of Velero, see our [upgrade instructions][1].
+
+### All Changes
+* Change base images to ubuntu:bionic (#1488, @skriss)
+* Expose the timestamp of the last successful backup in a gauge (#1448, @fabito)
+* check backup existence before download (#1447, @fabito)
+* Use `latest` image tag if no version information is provided at build time (#1439, @nrb)
+* switch from `restic stats` to `restic snapshots` for checking restic repository existence (#1416, @skriss)
+* GCP: add optional 'project' config to volume snapshot location for if snapshots are in a different project than the IAM account (#1405, @skriss)
+* Disallow bucket names starting with '-' (#1407, @nrb)
+* Shorten label values when they're longer than 63 characters (#1392, @anshulc)
+* Fail backup if it already exists in object storage. (#1390, @ncdc,carlisia)
+* Add PartiallyFailed phase for backups, log + continue on errors during backup process (#1386, @skriss)
+* Remove deprecated "hooks" for backups (they've been replaced by "pre hooks") (#1384, @skriss)
+* Restic repo ensurer: return error if new repository does not become ready within a minute, and fix channel closing/deletion (#1367, @skriss)
+* Support non-namespaced names for built-in plugins (#1366, @nrb)
+* Change container base images to debian:stretch-slim and upgrade to go 1.12 (#1365, @skriss)
+* Azure: allow credentials to be provided in a .env file (path specified by $AZURE_CREDENTIALS_FILE), formatted like (#1364, @skriss):
+    ```
+    AZURE_TENANT_ID=${AZURE_TENANT_ID}
+    AZURE_SUBSCRIPTION_ID=${AZURE_SUBSCRIPTION_ID}
+    AZURE_CLIENT_ID=${AZURE_CLIENT_ID}
+    AZURE_CLIENT_SECRET=${AZURE_CLIENT_SECRET}
+    AZURE_RESOURCE_GROUP=${AZURE_RESOURCE_GROUP} 
+    ```
+* Instantiate the plugin manager with the per-restore logger so plugin logs are captured in the per-restore log (#1358, @skriss)
+* Add gauge metrics for number of existing backups and restores (#1353, @fabito)
+* Set default TTL for backups (#1352, @vorar)
+* Validate that there can't be any duplicate plugin name, and that the name format is `example.io/name`. (#1339, @carlisia)
+* AWS/Azure/GCP: fail fast if unsupported keys are provided in BackupStorageLocation/VolumeSnapshotLocation config (#1338, @skriss)
+* `velero backup logs` & `velero restore logs`: show helpful error message if backup/restore does not exist or is not finished processing (#1337, @skriss)
+* Add support for allowing a RestoreItemAction to skip item restore. (#1336, @sseago)
+* Improve error message around invalid S3 URLs, and gracefully handle trailing backslashes. (#1331, @skriss)
+* Set backup's start timestamp before patching it to InProgress so start times display in `velero backup get` while in progress (#1330, @skriss)
+* Added ability to dynamically disable controllers (#1326, @amanw)
+* Remove deprecated code in preparation for v1.0 release (#1323, @skriss):
+    - remove ark.heptio.com API group
+    - remove support for reading ark-backup.json files from object storage
+    - remove Ark field from RestoreResult type
+    - remove support for "hook.backup.ark.heptio.com/..." annotations for specifying hooks
+    - remove support for $HOME/.config/ark/ client config directory
+    - remove support for restoring Azure snapshots using short snapshot ID formats in backup metadata
+    - stop applying "velero-restore" label to restored resources and remove it from the API pkg
+    - remove code that strips the "gc.ark.heptio.com" finalizer from backups
+    - remove support for "backup.ark.heptio.com/..." annotations for requesting restic backups
+    - remove "ark"-prefixed prometheus metrics
+    - remove VolumeBackups field and related code from Backup's status
+* Rename BlockStore plugin to VolumeSnapshotter (#1321, @skriss)
+* Bump plugin ProtocolVersion to version 2 (#1319, @carlisia)
+* Remove Warning field from restore item action output (#1318, @skriss)
+* Fix for #1312, use describe to determine if AWS EBS snapshot is encrypted and explicitly pass that value in EC2 CreateVolume call. (#1316, @mstump)
+* Allow restic restore helper image name to be optionally specified via ConfigMap (#1311, @skriss)
+* Compile only once to lower the initialization cost for regexp.MustCompile. (#1306, @pei0804)
+* Enable restore item actions to return additional related items to be restored; have pods return PVCs and PVCs return PVs (#1304, @skriss)
+* Log error locations from plugin logger, and don't overwrite them in the client logger if they exist already (#1301, @skriss)
+* Send stack traces from plugin errors to Velero via gRPC so error location info can be logged (#1300, @skriss)
+* Azure: restore volumes in the original region's zone (#1298, @sylr)
+* Check for and exclude hostPath-based persistent volumes from restic backup (#1297, @skriss)
+* Make resticrepositories non-restorable resources (#1296, @skriss)
+* Gracefully handle failed API groups from the discovery API (#1293, @fabito)
+* Add `velero install` command for basic use cases. (#1287, @nrb)
+* Collect 3 new metrics: backup_deletion_{attempt|failure|success}_total (#1280, @fabito)
+* Pass --log-level flag to internal/external plugins, matching Velero server's log level (#1278, @skriss)
+* AWS EBS Volume IDs now contain AZ (#1274, @tsturzl)
+* Add panic handlers to all server-side plugin methods (#1270, @skriss)
+* Move all the interfaces and associated types necessary to implement all of the Velero plugins to under the new package `velero`. (#1264, @carlisia)
+* Update `velero restore` to not open every single file open during extraction of the data (#1261, @asaf)
+* Remove restore code that waits for a PV to become Available (#1254, @skriss)
+* Improve `describe` output
+* Move Phase to right under Metadata(name/namespace/label/annotations)
+* Move Validation errors: section right after Phase: section and only show it if the item has a phase of FailedValidation
+* For restores move Warnings and Errors under Validation errors. Leave their display as is. (#1248, @DheerajSShetty)
+* Don't remove storage class from a persistent volume when restoring it (#1246, @skriss)
+* Need to defer closing the the ReadCloser in ObjectStoreGRPCServer.GetObject (#1236, @DheerajSShetty)
+* Update Kubernetes dependencies to match v1.12, and update Azure SDK to v19.0.0 (GA) (#1231, @skriss)
+* Remove pkg/util/collections/map_utils.go, replace with structured API types and apimachinery's unstructured helpers (#1146, @skriss)
+* Add original resource (from backup) to restore item action interface (#1123, @mwieczorek)
+
+
+[0]: https://velero.io/docs/v1.0.0/azure-config
+[1]: https://velero.io/docs/v1.0.0/upgrade-to-1.0
+[2]: https://github.com/heptio/velero/releases/tag/v0.11.1
+[3]: https://velero.io/docs/v1.0.0/install-overview

changelogs/CHANGELOG-1.1.md

@@ -0,0 +1,100 @@
+## v1.1.0
+#### 2019-08-22
+
+### Download
+- https://github.com/heptio/velero/releases/tag/v1.1.0
+
+### Container Image
+`gcr.io/heptio-images/velero:v1.1.0`
+
+### Documentation
+https://velero.io/docs/v1.1.0/
+
+### Upgrading
+
+**If you are running Velero in a non-default namespace**, i.e. any namespace other than `velero`, manual intervention is required when upgrading to v1.1. See [upgrading to v1.1](https://velero.io/docs/v1.1.0/upgrade-to-1.1/) for details.
+
+### Highlights
+
+#### Improved Restic Support
+
+A big focus of our work this cycle was continuing to improve support for restic. To that end, we’ve fixed the following bugs:
+
+
+- Prior to version 1.1, restic backups could be delayed or failed due to long-lived locks on the repository. Now, Velero removes stale locks from restic repositories every 5 minutes, ensuring they do not interrupt normal operations.  
+- Previously, the PodVolumeBackup custom resources that represented a restic backup within a cluster were not synchronized between clusters, making it unclear what restic volumes were available to restore into a new cluster. In version 1.1, these resources are synced into clusters, so they are more visible to you when you are trying to restore volumes.  
+- Originally, Velero would not validate the host path in which volumes were mounted on a given node. If a node did not expose the filesystem correctly, you wouldn’t know about it until a backup failed. Now, Velero’s restic server will validate that the directory structure is correct on startup, providing earlier feedback when it’s not.  
+- Velero’s restic support is intended to work on a broad range of volume types. With the general release of the [Container Storage Interface API](https://kubernetes.io/blog/2019/01/15/container-storage-interface-ga/), Velero can now use restic to back up CSI volumes.  
+
+Along with our bug fixes, we’ve provided an easier way to move restic backups between storage providers. Different providers often have different StorageClasses, requiring user intervention to make restores successfully complete.
+
+To make cross-provider moves simpler, we’ve introduced a StorageClass remapping plug-in. It allows you to automatically translate one StorageClass on PersistentVolumeClaims and PersistentVolumes to another. You can read more about it in our [documentation](https://velero.io/docs/v1.1.0/restore-reference/#changing-pv-pvc-storage-classes).
+
+#### Quality-of-Life Improvements
+
+We’ve also made several other enhancements to Velero that should benefit all users.
+
+Users sometimes ask about recommendations for Velero’s resource allocation within their cluster. To help with this concern, we’ve added default resource requirements to the Velero Deployment and restic init containers, along with configurable requests and limits for the restic DaemonSet. All these values can be adjusted if your environment requires it.
+
+We’ve also taken some time to improve Velero for the future by updating the Deployment and DaemonSet to use the apps/v1 API group, which will be the [default in Kubernetes 1.16](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.16.md#action-required-3). This change means that `velero install` and the `velero plugin` commands will require Kubernetes 1.9 or later to work. Existing Velero installs will continue to work without needing changes, however.
+
+In order to help you better understand what resources have been backed up, we’ve added a list of resources in the `velero backup describe --details` command. This change makes it easier to inspect a backup without having to download and extract it.
+
+In the same vein, we’ve added the ability to put custom tags on cloud-provider snapshots. This approach should provide a better way to keep track of the resources being created in your cloud account. To add a label to a snapshot at backup time, use the `--labels` argument in the `velero backup create` command.
+
+Our final change for increasing visibility into your Velero installation is the `velero plugin get` command. This command will report all the plug-ins within the Velero deployment..
+
+Velero has previously used a restore-only flag on the server to control whether a cluster could write backups to object storage. With Velero 1.1, we’ve now moved the restore-only behavior into read-only BackupStorageLocations. This move means that the Velero server can use a BackupStorageLocation as a source to restore from, but not for backups, while still retaining the ability to back up to other configured locations. In the future, the `--restore-only` flag will be removed in favor of configuring read-only BackupStorageLocations.
+
+#### Community Contributions
+
+We appreciate all community contributions, whether they be pull requests, bug reports, feature requests, or just questions. With this release, we wanted to draw attention to a few contributions in particular:
+
+For users of node-based IAM authentication systems such as kube2iam, `velero install` now supports the `--pod-annotations` argument for applying necessary annotations at install time. This support should make `velero install` more flexible for scenarios that do not use Secrets for access to their cloud buckets and volumes. You can read more about how to use this new argument in our [AWS documentation](https://velero.io/docs/v1.1.0/aws-config/#alternative-setup-permissions-using-kube2iam). Huge thanks to [Traci Kamp](https://github.com/tlkamp) for this contribution.
+
+Structured logging is important for any application, and Velero is no different. Starting with version 1.1, the Velero server can now output its logs in a JSON format, allowing easier parsing and ingestion. Thank you to [Donovan Carthew](https://github.com/carthewd) for this feature.
+
+AWS supports multiple profiles for accessing object storage, but in the past Velero only used the default. With v.1.1, you can set the `profile` key on yourBackupStorageLocation to specify an alternate profile. If no profile is set, the default one is used, making this change backward compatible. Thanks [Pranav Gaikwad](https://github.com/pranavgaikwad) for this change.
+
+Finally, thanks to testing by [Dylan Murray](https://github.com/dymurray) and [Scott Seago](https://github.com/sseago), an issue with running Velero in non-default namespaces was found in our beta version for this release. If you’re running Velero in a namespace other than `velero`, please follow the [upgrade instructions](https://velero.io/docs/v1.1.0/upgrade-to-1.1/).
+
+### All Changes
+  * Add the prefix to BSL config map so that object stores can use it when initializing (#1767, @betta1)
+  * Use `VELERO_NAMESPACE` to determine what namespace Velero server is running in. For any v1.0 installations using a different namespace, the `VELERO_NAMESPACE` environment variable will need to be set to the correct namespace. (#1748, @nrb)
+  * support setting CPU/memory requests with unbounded limits using velero install (#1745, @prydonius)
+  * sort output of resource list in `velero backup describe --details` (#1741, @prydonius)
+  * adds the ability to define custom tags to be added to snapshots by specifying custom labels on the Backup CR with the velero backup create --labels flag (#1729, @prydonius)
+  * Restore restic volumes from PodVolumeBackups CRs (#1723, @carlisia)
+  * properly restore PVs backed up with restic and a reclaim policy of "Retain" (#1713, @skriss)
+  * Make `--secret-file` flag on `velero install` optional, add `--no-secret` flag for explicit confirmation (#1699, @nrb)
+  * Add low cpu/memory limits to the restic init container. This allows for restoration into namespaces with quotas defined. (#1677, @nrb)
+  * Adds configurable CPU/memory requests and limits to the restic DaemonSet generated by velero install. (#1710, @prydonius)
+  * remove any stale locks from restic repositories every 5m (#1708, @skriss)
+  * error if backup storage location's Bucket field also contains a prefix, and gracefully handle leading/trailing slashes on Bucket and Prefix fields. (#1694, @skriss)
+  * enhancement: allow option to choose JSON log output  (#1654, @carthewd)
+  * Adds configurable CPU/memory requests and limits to the Velero Deployment generated by velero install. (#1678, @prydonius)
+  * Store restic PodVolumeBackups in obj storage & use that as source of truth like regular backups. (#1577, @carlisia)
+  * Update Velero Deployment to use apps/v1 API group. `velero install` and `velero plugin add/remove` commands will now require Kubernetes 1.9+ (#1673, @nrb)
+  * Respect the --kubecontext and --kubeconfig arugments for `velero install`. (#1656, @nrb)
+  * add plugin for updating PV & PVC storage classes on restore based on a config map (#1621, @skriss)
+  * Add restic support for CSI volumes (#1615, @nrb)
+  * bug fix: Fixed namespace usage with cli command 'version' (#1630, @jwmatthews)
+  * enhancement: allow users to specify additional Velero/Restic pod annotations on the command line with the pod-annotations flag. (#1626, @tlkamp)
+  * adds validation for pod volumes hostPath mount on restic server startup (#1616, @prydonius)
+  * enable support for ppc64le architecture (#1605, @prajyot)
+  * bug fix: only restore additional items returned from restore item actions if they match the restore's namespace/resource selectors (#1612, @skriss)
+  * add startTimestamp and completionTimestamp to PodVolumeBackup and PodVolumeRestore status fields (#1609, @prydonius)
+  * bug fix: respect namespace selector when determining which restore item actions to run (#1607, @skriss)
+  * ensure correct backup item actions run with namespace selector (#1601, @prydonius)
+  * allows excluding resources from backups with the `velero.io/exclude-from-backup=true` label (#1588, @prydonius)
+  * ensures backup item action modifications to an item's namespace/name are saved in the file path in the tarball (#1587, @prydonius)
+  * Hides `velero server` and `velero restic server` commands from the list of available commands as these are not intended for use by the velero CLI user. (#1561, @prydonius)
+  * remove dependency on glog, update to klog (#1559, @skriss)
+  * move issue-template-gen from docs/ to hack/ (#1558, @skriss)
+  * fix panic when processing DeleteBackupRequest objects without labels (#1556, @prydonius)
+  * support for multiple AWS profiles (#1548, @pranavgaikwad)
+  * Add CLI command to list (get) all Velero plugins (#1535, @carlisia)
+  * Added author as a tag on blog post.  Should fix 404 error when trying to follow link as specified in issue #1522. (#1522, @coonsd)
+  * Allow individual backup storage locations to be read-only (#1517, @skriss)
+  * Stop returning an error when a restic volume is empty since it is a valid scenario. (#1480, @carlisia)
+  * add ability to use wildcard in includes/excludes (#1428, @guilhem)

changelogs/unreleased/1781-s12chung

@@ -0,0 +1 @@
+fix error formatting due interpreting % as printf formatted strings

cmd/ark/main.go

@@ -1,36 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package main
-
-import (
-	"os"
-	"path/filepath"
-
-	"github.com/golang/glog"
-
-	"github.com/heptio/ark/pkg/cmd"
-	"github.com/heptio/ark/pkg/cmd/ark"
-)
-
-func main() {
-	defer glog.Flush()
-
-	baseName := filepath.Base(os.Args[0])
-
-	err := ark.NewCommand(baseName).Execute()
-	cmd.CheckError(err)
-}

cmd/velero-restic-restore-helper/main.go

@@ -0,0 +1,77 @@
+/*
+Copyright 2018 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"time"
+)
+
+func main() {
+	if len(os.Args) != 2 {
+		fmt.Fprintln(os.Stderr, "ERROR: exactly one argument must be provided, the restore's UID")
+		os.Exit(1)
+	}
+
+	ticker := time.NewTicker(time.Second)
+	defer ticker.Stop()
+
+	for {
+		select {
+		case <-ticker.C:
+			if done() {
+				fmt.Println("All restic restores are done")
+				return
+			}
+		}
+	}
+}
+
+// done returns true if for each directory under /restores, a file exists
+// within the .velero/ subdirectory whose name is equal to os.Args[1], or
+// false otherwise
+func done() bool {
+	children, err := ioutil.ReadDir("/restores")
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "ERROR reading /restores directory: %s\n", err)
+		return false
+	}
+
+	for _, child := range children {
+		if !child.IsDir() {
+			fmt.Printf("%s is not a directory, skipping.\n", child.Name())
+			continue
+		}
+
+		doneFile := filepath.Join("/restores", child.Name(), ".velero", os.Args[1])
+
+		if _, err := os.Stat(doneFile); os.IsNotExist(err) {
+			fmt.Printf("Not found: %s\n", doneFile)
+			return false
+		} else if err != nil {
+			fmt.Fprintf(os.Stderr, "ERROR looking for %s: %s\n", doneFile, err)
+			return false
+		}
+
+		fmt.Printf("Found %s", doneFile)
+	}
+
+	return true
+}

cmd/velero/main.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2017, 2019 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package main
+
+import (
+	"os"
+	"path/filepath"
+
+	"k8s.io/klog"
+
+	"github.com/heptio/velero/pkg/cmd"
+	"github.com/heptio/velero/pkg/cmd/velero"
+)
+
+func main() {
+	defer klog.Flush()
+
+	baseName := filepath.Base(os.Args[0])
+
+	err := velero.NewCommand(baseName).Execute()
+	cmd.CheckError(err)
+}

design/_template.md

@@ -0,0 +1,48 @@
+# Design proposal template (replace with your proposal's title)
+
+Status: {Draft,Accepted,Declined}
+
+One to two sentences that describes the goal of this proposal.
+The reader should be able to tell by the title, and the opening paragraph, if this document is relevant to them.
+
+_Note_: The preferred style for design documents is one sentence per line.
+*Do not wrap lines*.
+This aids in review of the document as changes to a line are not obscured by the reflowing those changes caused and has a side effect of avoiding debate about one or two space after a period.
+
+## Goals
+
+- A short list of things which will be accomplished by implementing this proposal.
+- Two things is ok.
+- Three is pushing it.
+- More than three goals suggests that the proposal's scope is too large.
+
+## Non Goals
+
+- A short list of items which are:
+- a. out of scope
+- b. follow on items which are deliberately excluded from this proposal.
+
+## Background
+
+One to two paragraphs of exposition to set the context for this proposal.
+
+## High-Level Design
+
+One to two paragraphs that describe the high level changes that will be made to implement this proposal.
+
+## Detailed Design
+
+A detailed design describing how the changes to the product should be made.
+
+The names of types, fields, interfaces, and methods should be agreed on here, not debated in code review.
+The same applies to changes in CRDs, YAML examples, and so on.
+
+Ideally the changes should be made in sequence so that the work required to implement this design can be done incrementally, possibly in parallel.
+
+## Alternatives Considered
+
+If there are alternative high level or detailed designs that were not pursued they should be called out here with a brief explanation of why they were not pursued.
+
+## Security Considerations
+
+If this proposal has an impact to the security of the product, its users, or data stored or transmitted via the product, they must be addressed here.

design/backup-resource-list.md

@@ -0,0 +1,96 @@
+# Expose list of backed up resources in backup details
+
+Status: Accepted
+
+To increase the visibility of what a backup might contain, this document proposes storing metadata about backed up resources in object storage and adding a new section to the detailed backup description output to list them.
+
+## Goals
+
+- Include a list of backed up resources as metadata in the bucket
+- Enable users to get a view of what resources are included in a backup using the Velero CLI
+
+## Non Goals
+
+- Expose the full manifests of the backed up resources
+
+## Background
+
+As reported in [#396](https://github.com/heptio/velero/issues/396), the information reported in a `velero backup describe <name> --details` command is fairly limited, and does not easily describe what resources a backup contains.
+In order to see what a backup might contain, a user would have to download the backup tarball and extract it.
+This makes it difficult to keep track of different backups in a cluster.
+
+## High-Level Design
+
+After performing a backup, a new file will be created that contains the list of the resources that have been included in the backup.
+This file will be persisted in object storage alongside the backup contents and existing metadata.
+
+A section will be added to the output of `velero backup describe <name> --details` command to view this metadata.
+
+## Detailed Design
+
+### Metadata file
+
+This metadata will be in JSON (or YAML) format so that it can be easily inspected from the bucket outside of Velero tooling, and will contain the API resource and group, namespaces and names of the resources:
+
+```
+apps/v1/Deployment:
+- default/database
+- default/wordpress
+v1/Service:
+- default/database
+- default/wordpress
+v1/Secret:
+- default/database-root-password
+- default/database-user-password
+v1/ConfigMap:
+- default/database
+v1/PersistentVolume:
+- my-pv
+```
+
+The filename for this metadata will be `<backup name>-resource-list.json.gz`.
+The top-level key is the string form of the `schema.GroupResource` type that we currently keep track of in the backup controller code path.
+
+### Changes in Backup controller
+
+The Backupper currently initialises a map to track the `backedUpItems` (https://github.com/heptio/velero/blob/1594bdc8d0132f548e18ffcc1db8c4cd2b042726/pkg/backup/backup.go#L269), this is passed down through GroupBackupper, ResourceBackupper and ItemBackupper where ItemBackupper records each backed up item.
+This property will be moved to the [Backup request struct](https://github.com/heptio/velero/blob/16910a6215cbd8f0bde385dba9879629ebcbcc28/pkg/backup/request.go#L11), allowing the BackupController to access it after a successful backup.
+
+`backedUpItems` currently uses the `schema.GroupResource` as a key for the resource.
+In order to record the API group, version and kind for the resource, this key will be constructed from the object's `schema.GroupVersionKind` in the format `{group}/{version}/{kind}` (e.g. `apps/v1/Deployment`).
+
+The `backedUpItems` map is kept as a flat structure internally for quick lookup.
+When the backup is ready to upload, `backedUpItems` will be converted to a nested structure representing the metadata file above, grouped by `schema.GroupVersionKind`.
+After converting to the right format, it can be passed to the `persistBackup` function to persist the file in object storage.
+
+### Changes to DownloadRequest CRD and processing
+
+A new `DownloadTargetKind` "BackupResourceList" will be added to the DownloadRequest CR.
+
+The `GetDownloadURL` function in the `persistence` package will be updated to handle this new DownloadTargetKind to enable the Velero client to fetch the metadata from the bucket.
+
+### Changes to `velero backup describe <name> --details`
+
+This command will need to be updated to fetch the metadata from the bucket using the `Stream` method used in other commands.
+The file will be read in memory and displayed in the output of the command.
+Depending on the format the metadata is stored in, it may need processing to print in a more human-readable format.
+If we choose to store the metadata in YAML, it can likely be directly printed out.
+
+If the metadata file does not exist, this is an older backup and we cannot display the list of resources that were backed up.
+
+## Open Questions
+
+## Alternatives Considered
+
+### Fetch backup contents archive and walkthrough to list contents
+
+Instead of recording new metadata about what resources have been backed up, we could simply download the backup contents archive and walkthrough it to list the contents everytime `velero backup describe <name> --details` is run.
+
+The advantage of this approach is that we don't need to change any backup procedures as we already have this content, and we will also be able to list resources for older backups.
+Additionally, if we wanted to expose more information about the backed up resources, we can do so without having to update what we store in the metadata.
+
+The disadvantages are:
+- downloading the whole backup archive will be larger than just downloading a smaller file with metadata
+- reduces the metadata available in the bucket that users might want to inspect outside of Velero tooling (though this is not an explicit requirement)
+
+## Security Considerations

design/feature-flags.md

@@ -0,0 +1,71 @@
+# Feature Flags
+
+Status: Accepted
+
+Some features may take a while to get fully implemented, and we don't necessarily want to have long-lived feature branches
+A simple feature flag implementation allows code to be merged into master, but not used unless a flag is set.
+
+## Goals
+
+- Allow unfinished features to be present in Velero releases, but only enabled when the associated flag is set.
+
+## Non Goals
+
+- A robust feature flag library.
+
+## Background
+
+When considering the [CSI integration work](https://github.com/heptio/velero/pull/1661), the timelines involved presented a problem in balancing a release and longer-running feature work.
+A simple implementation of feature flags can help protect unfinished code while allowing the rest of the changes to ship.
+
+## High-Level Design
+
+A new command line flag, `--features` will be added to the root `velero` command.
+
+`--features` will accept a comma-separated list of features, such as `--features EnableCSI,Replication`.
+Each feature listed will correspond to a key in a map in `pkg/features/features.go` defining whether a feature should be enabled.
+
+Any code implementing the feature would then import the map and look up the key's value.
+
+For the Velero client, a `features` key can be added to the `config.json` file for more convenient client invocations.
+
+## Detailed Design
+
+A new `features` package will be introduced with these basic structs:
+
+```go
+type FeatureFlagSet struct {
+    flags map[string]bool
+}
+
+type Flags interface {
+    // Enabled reports whether or not the specified flag is found.
+    Enabled(name string) bool
+
+    // Enable adds the specified flags to the list of enabled flags.
+    Enable(names ...string)
+
+    // All returns all enabled features
+    All() []string
+}
+
+// NewFeatureFlagSet initializes and populates a new FeatureFlagSet
+func NewFeatureFlagSet(flags ...string) FeatureFlagSet
+```
+
+When parsing the `--features` flag, the entire `[]string` will be passed to `NewFeatureFlagSet`.
+Additional features can be added with the `Enable` function.
+Parsed features will be printed as an `Info` level message on server start up.
+
+No verification of features will be done in order to keep the implementation minimal.
+
+On the client side, `--features` and the `features` key in `config.json` file will be additive, resulting in the union of both.
+
+To disable a feature, the server must be stopped and restarted with a modified `--features` list.
+Similarly, the client process must be stopped and restarted without features.
+
+## Alternatives Considered
+Omitted
+
+## Security Considerations
+Omitted

design/pv-cloning.md

@@ -0,0 +1,54 @@
+# Cloning PVs While Remapping Namespaces
+
+Status: Approved
+
+Velero supports restoring resources into different namespaces than they were backed up from.
+This enables a user to, among other things, clone a namespace within a cluster.
+However, if the namespace being cloned uses persistent volume claims, Velero cannot currently create a second copy of the original persistent volume when restoring.
+This limitation is documented in detail in [issue #192](https://github.com/heptio/velero/issues/192).
+This document proposes a solution that allows new copies of persistent volumes to be created during a namespace clone.
+
+## Goals
+
+- Enable persistent volumes to be cloned when using `velero restore create --namespace-mappings ...` to create a second copy of a namespace within a cluster.
+
+## Non Goals
+
+- Cloning of persistent volumes in any scenario other than when using `velero restore create --namespace-mappings ...` flag.
+- [CSI-based cloning](https://kubernetes.io/docs/concepts/storage/volume-pvc-datasource/).
+
+## Background
+
+(Omitted, see introduction)
+
+## High-Level Design
+
+During a restore, Velero will detect that it needs to assign a new name to a persistent volume being restored if and only if both of the following conditions are met:
+- the persistent volume is claimed by a persistent volume claim in a namespace that's being remapped using `velero restore create --namespace-mappings ...`
+- a persistent volume already exists in the cluster with the original name
+
+If these conditions exist, Velero will give the persistent volume a new arbitrary name before restoring it.
+It will also update the `spec.volumeName` of the related persistent volume claim. 
+
+## Detailed Design
+
+In `pkg/restore/restore.go`, around [line 872](https://github.com/heptio/velero/blob/master/pkg/restore/restore.go#L872), Velero has special-case code for persistent volumes.
+This code will be updated to check for the two preconditions described in the previous section.
+If the preconditions are met, the object will be given a new name.
+The persistent volume will also be annotated with the original name, e.g. `velero.io/original-pv-name=NAME`.
+Importantly, the name change will occur **before** [line 890](https://github.com/heptio/velero/blob/master/pkg/restore/restore.go#L890), where Velero checks to see if it should restore the persistent volume.
+Additionally, the old and new persistent volume names will be recorded in a new field that will be added to the `context` struct, `renamedPVs map[string]string`.
+
+In the special-case code for persistent volume claims starting on [line 987](https://github.com/heptio/velero/blob/master/pkg/restore/restore.go#L987), Velero will check to see if the claimed persistent volume has been renamed by looking in `ctx.renamedPVs`.
+If so, Velero will update the persistent volume claim's `spec.volumeName` to the new name.
+
+## Alternatives Considered
+
+One alternative approach is to add a new CLI flag and API field for restores, e.g. `--clone-pvs`, that a user could provide to indicate they want to create copies of persistent volumes.
+This approach would work fine, but it does require the user to be aware of this flag/field and to properly specify it when needed.
+It seems like a better UX to detect the typical conditions where this behavior is needed, and to automatically apply it.
+Additionally, the design proposed here does not preclude such a flag/field from being added later, if it becomes necessary to cover other use cases.
+
+## Security Considerations
+
+N/A

design/restic-backup-and-restore-progress.md

@@ -0,0 +1,116 @@
+# Progress reporting for restic backups and restores
+
+Status: Accepted
+
+During long-running restic backups/restores, there is no visibility into what (if anything) is happening, making it hard to know if the backup/restore is making progress or hung, how long the operation might take, etc.
+We should capture progress during restic operations and make it user-visible so that it's easier to reason about.
+This document proposes an approach for capturing progress of backup and restore operations and exposing this information to users.
+
+## Goals
+
+- Provide basic visibility into restic operations to inform users about their progress.
+
+## Non Goals
+
+- Capturing progress for non-restic backups and restores.
+
+## Background
+
+(Omitted, see introduction)
+
+## High-Level Design
+
+### restic backup progress
+
+The `restic backup` command provides progress reporting to stdout in JSON format, which includes the completion percentage of the backup.
+This progress will be read on some interval and the PodVolumeBackup Custom Resource's (CR) status will be updated with this information.
+
+### restic restore progress
+
+The `restic stats` command returns the total size of a backup.
+This can be compared with the total size the volume periodically to calculate the completion percentage of the restore.
+The PodVolumeRestore CR's status will be updated with this information.
+
+## Detailed Design
+
+## Changes to PodVolumeBackup and PodVolumeRestore Status type
+
+A new `Progress` field will be added to PodVolumeBackupStatus and PodVolumeRestoreStatus of type `PodVolumeOperationProgress`:
+
+```
+type PodVolumeOperationProgress struct {
+  TotalBytes int64
+  BytesDone int64
+}
+```
+
+### restic backup progress
+
+restic added support for [streaming JSON output for the `restic backup` command](https://github.com/restic/restic/pull/1944) in 0.9.5.
+Our current images ship restic 0.9.4, and so the Dockerfile will be updated to pull the new version: https://github.com/heptio/velero/blob/af4b9373fc73047f843cd4bc3648603d780c8b74/Dockerfile-velero#L21.
+With the `--json` flag, `restic backup` outputs single lines of JSON reporting the status of the backup:
+
+```
+{"message_type":"status","percent_done":0,"total_files":1,"total_bytes":21424504832}
+{"message_type":"status","action":"scan_finished","item":"","duration":0.219241873,"data_size":49461329920,"metadata_size":0,"total_files":10}
+{"message_type":"status","percent_done":0,"total_files":10,"total_bytes":49461329920,"current_files":["/file3"]}
+{"message_type":"status","percent_done":0.0003815984736061056,"total_files":10,"total_bytes":49461329920,"bytes_done":18874368,"current_files":["/file1","/file3"]}
+{"message_type":"status","percent_done":0.0011765952936188255,"total_files":10,"total_bytes":49461329920,"bytes_done":58195968,"current_files":["/file1","/file3"]}
+{"message_type":"status","percent_done":0.0019503921984312064,"total_files":10,"total_bytes":49461329920,"bytes_done":96468992,"current_files":["/file1","/file3"]}
+{"message_type":"status","percent_done":0.0028089887640449437,"total_files":10,"total_bytes":49461329920,"bytes_done":138936320,"current_files":["/file1","/file3"]}
+```
+
+The [command factory for backup](https://github.com/heptio/velero/blob/af4b9373fc73047f843cd4bc3648603d780c8b74/pkg/restic/command_factory.go#L37) will be updated to include the `--json` flag.
+The code to run the `restic backup` command (https://github.com/heptio/velero/blob/af4b9373fc73047f843cd4bc3648603d780c8b74/pkg/controller/pod_volume_backup_controller.go#L241) will be changed to include a Goroutine that reads from the command's stdout stream.
+The implementation of this will largely follow [@jmontleon's PoC](https://github.com/fusor/velero/pull/4/files) of this.
+The Goroutine will periodically read the stream (every 10 seconds) and get the last printed status line, which will be convered to JSON.
+If `bytes_done` is empty, restic has not finished scanning the volume and hasn't calculated the `total_bytes`.
+In this case, we will not update the PodVolumeBackup and instead will wait for the next iteration.
+Once we get a non-zero value for `bytes_done`, the `bytes_done` and `total_bytes` properties will be read and the PodVolumeBackup will be patched to update `status.Progress.BytesDone` and `status.Progress.TotalBytes` respectively.
+
+Once the backup has completed successfully, the PodVolumeBackup will be patched to set `status.Progress.BytesDone = status.Progress.TotalBytes`.
+This is done since the main thread may cause early termination of the Goroutine once the operation has finished, preventing a final update to the `BytesDone` property.
+
+### restic restore progress
+
+The `restic stats <snapshot_id> --json` command provides information about the size of backups:
+
+```
+{"total_size":10558111744,"total_file_count":11}
+```
+
+Before beginning the restore operation, we can use the output of `restic stats` to get the total size of the backup.
+The PodVolumeRestore will be patched to set `status.Progress.TotalBytes` to the total size of the backup.
+
+The code to run the `restic restore` command will be changed to include a Goroutine that periodically (every 10 seconds) gets the current size of the volume.
+To get the current size of the volume, we will recursively walkthrough all files in the volume to accumulate the total size.
+The current total size is the number of bytes transferred so far and the PodVolumeRestore will be patched to update `status.Progress.BytesDone`.
+
+Once the restore has completed successfully, the PodVolumeRestore will be patched to set `status.Progress.BytesDone = status.Progress.TotalBytes`.
+This is done since the main thread may cause early termination of the Goroutine once the operation has finished, preventing a final update to the `BytesDone` property.
+
+### Velero CLI changes
+
+The output that describes detailed information about [PodVolumeBackups](https://github.com/heptio/velero/blob/559d62a2ec99f7a522924348fc4a173a0699813a/pkg/cmd/util/output/backup_describer.go#L349) and [PodVolumeRestores](https://github.com/heptio/velero/blob/559d62a2ec99f7a522924348fc4a173a0699813a/pkg/cmd/util/output/restore_describer.go#L160) will be updated to calculate and display a completion percentage from `status.Progress.TotalBytes` and `status.Progress.BytesDone` if available.
+
+## Open Questions
+
+- Can we assume that the volume we are restoring in will be empty? Can it contain other artefacts?
+  - Based on discussion in this PR, we are okay making the assumption that the PVC is empty and will proceed with the above proposed approach.
+
+## Alternatives Considered
+
+### restic restore progress
+
+If we cannot assume that the volume we are restoring into will be empty, we can instead use the output from `restic snapshot` to get the list of files in the backup.
+This can then be used to calculate the current total size of just those files in the volume, so that we avoid considering any other files unrelated to the backup.
+The above proposed approach is simpler than this one, as we don't need to keep track of each file in the backup, but this will be more robust if the volume could contain other files not included in the backup.
+It's possible that certain volume types may contain hidden files that could attribute to the total size of the volume, though these should be small enough that the BytesDone calculation will only be slightly inflated.
+
+Another option is to contribute progress reporting similar to `restic backup` for `restic restore` upstream.
+This may take more time, but would give us a more native view on the progress of a restore.
+There are several issues about this already in the restic repo (https://github.com/restic/restic/issues/426, https://github.com/restic/restic/issues/1154), and what looks like an abandoned attempt (https://github.com/restic/restic/pull/2003) which we may be able to pick up.
+
+## Security Considerations
+
+N/A

docs/README.md

@@ -1,31 +0,0 @@
-# Table of Contents
-
-## User Guide
-
-* [Concepts][1]
-* [Build from scratch][0]
-* [Cloud provider specifics][9]
-* [Debugging restores][4]
-* [FAQ][10]
-
-## Reference
-* [CLI reference][2]
-* [Config definition][5]
-* [Output file format][6]
-* [Sample YAML files][3]
-
-## Scenarios
-* [Disaster recovery][7]
-* [Cluster migration][8]
-
-[0]: build-from-scratch.md
-[1]: concepts.md
-[2]: cli-reference
-[3]: /examples
-[4]: debugging-restores.md
-[5]: config-definition.md
-[6]: output-file-format.md
-[7]: use-cases.md#disaster-recovery
-[8]: use-cases.md#cluster-migration
-[9]: cloud-provider-specifics.md
-[10]: faq.md

docs/generate/ark.go

@@ -1,39 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package main
-
-import (
-	"log"
-	"os"
-
-	"github.com/heptio/ark/pkg/cmd/ark"
-	"github.com/spf13/cobra/doc"
-)
-
-func main() {
-	cmdName := os.Args[1]
-	outputDir := os.Args[2]
-
-	cmd := ark.NewCommand(cmdName)
-	// Remove auto-generated timestamps
-	cmd.DisableAutoGenTag = true
-
-	err := doc.GenMarkdownTree(cmd, outputDir)
-	if err != nil {
-		log.Fatal(err)
-	}
-}

examples/README.md

@@ -1,12 +1,11 @@
 # Examples
 
-The YAML config files in this directory can be used to quickly deploy a containerized Ark deployment.
+This directory contains sample YAML config files that can be used for exploring Velero.
 
-* `common/`: Contains manifests to set up Ark. Can be used across cloud provider platforms. (Note that Azure requires its own deployment file due to its unique way of loading credentials).
+* `minio/`: Used in the [Quickstart][0] to set up [Minio][1], a local S3-compatible object storage service. It provides a convenient way to test Velero without tying you to a specific cloud provider.
 
-* `minio/`: Used in the [Quickstart][1] to set up [Minio][0], a local S3-compatible object storage service. It provides a convenient way to test Ark without tying you to a specific cloud provider.
+* `nginx-app/`: A sample nginx app that can be used to test backups and restores.
 
-* `aws/`, `azure/`, `gcp/`: Contains manifests specific to the given cloud provider's setup.
 
-[0]: https://github.com/minio/minio
-[1]: /README.md#quickstart
+[0]: /docs/get-started.md
+[1]: https://github.com/minio/minio

examples/aws/00-ark-config.yaml

@@ -1,31 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: ark.heptio.com/v1
-kind: Config
-metadata:
-  namespace: heptio-ark
-  name: default
-persistentVolumeProvider:
-  aws:
-    region: <YOUR_REGION>
-backupStorageProvider:
-  bucket: <YOUR_BUCKET>
-  aws:
-    region: <YOUR_REGION>
-backupSyncPeriod: 30m
-gcSyncPeriod: 30m
-scheduleSyncPeriod: 1m
-restoreOnlyMode: false

examples/azure/00-ark-deployment.yaml

@@ -1,39 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: apps/v1beta1
-kind: Deployment
-metadata:
-  namespace: heptio-ark
-  name: ark
-spec:
-  replicas: 1
-  template:
-    metadata:
-      labels:
-        component: ark
-    spec:
-      restartPolicy: Always
-      serviceAccountName: ark
-      containers:
-        - name: ark
-          image: gcr.io/heptio-images/ark:latest
-          command:
-            - /ark
-          args:
-            - server
-          envFrom:
-            - secretRef:
-                name: cloud-credentials

examples/azure/10-ark-config.yaml

@@ -1,31 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: ark.heptio.com/v1
-kind: Config
-metadata:
-  namespace: heptio-ark
-  name: default
-persistentVolumeProvider:
-  azure:
-    location: <YOUR_LOCATION>
-    apiTimeout: <YOUR_TIMEOUT>
-backupStorageProvider:
-  bucket: <YOUR_BUCKET>
-  azure: {}
-backupSyncPeriod: 30m
-gcSyncPeriod: 30m
-scheduleSyncPeriod: 1m
-restoreOnlyMode: false

examples/common/00-prereqs.yaml

@@ -1,152 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: apiextensions.k8s.io/v1beta1
-kind: CustomResourceDefinition
-metadata:
-  name: backups.ark.heptio.com
-  labels:
-    component: ark
-spec:
-  group: ark.heptio.com
-  version: v1
-  scope: Namespaced
-  names:
-    plural: backups
-    kind: Backup
-
----
-apiVersion: apiextensions.k8s.io/v1beta1
-kind: CustomResourceDefinition
-metadata:
-  name: schedules.ark.heptio.com
-  labels:
-    component: ark
-spec:
-  group: ark.heptio.com
-  version: v1
-  scope: Namespaced
-  names:
-    plural: schedules
-    kind: Schedule
-
----
-apiVersion: apiextensions.k8s.io/v1beta1
-kind: CustomResourceDefinition
-metadata:
-  name: restores.ark.heptio.com
-  labels:
-    component: ark
-spec:
-  group: ark.heptio.com
-  version: v1
-  scope: Namespaced
-  names:
-    plural: restores
-    kind: Restore
-
----
-apiVersion: apiextensions.k8s.io/v1beta1
-kind: CustomResourceDefinition
-metadata:
-  name: configs.ark.heptio.com
-  labels:
-    component: ark
-spec:
-  group: ark.heptio.com
-  version: v1
-  scope: Namespaced
-  names:
-    plural: configs
-    kind: Config
-
----
-apiVersion: apiextensions.k8s.io/v1beta1
-kind: CustomResourceDefinition
-metadata:
-  name: downloadrequests.ark.heptio.com
-  labels:
-    component: ark
-spec:
-  group: ark.heptio.com
-  version: v1
-  scope: Namespaced
-  names:
-    plural: downloadrequests
-    kind: DownloadRequest
-
----
-apiVersion: v1
-kind: Namespace
-metadata:
-  name: heptio-ark
-
----
-apiVersion: v1
-kind: ServiceAccount
-metadata:
-  name: ark
-  namespace: heptio-ark
-  labels:
-    component: ark
-
----
-apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: ClusterRoleBinding
-metadata:
-  name: ark
-  labels:
-    component: ark
-subjects:
-  - kind: ServiceAccount
-    namespace: heptio-ark
-    name: ark
-roleRef:
-  kind: ClusterRole
-  name: cluster-admin
-  apiGroup: rbac.authorization.k8s.io
-
----
-apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: Role
-metadata:
-  namespace: heptio-ark
-  name: ark
-  labels:
-    component: ark
-rules:
-  - apiGroups:
-      - ark.heptio.com
-    verbs:
-      - "*"
-    resources:
-      - "*"
-
----
-apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: RoleBinding
-metadata:
-  namespace: heptio-ark
-  name: ark
-  labels:
-    component: ark
-subjects:
-  - kind: ServiceAccount
-    namespace: heptio-ark
-    name: ark
-roleRef:
-  kind: Role
-  name: ark
-  apiGroup: rbac.authorization.k8s.io

examples/common/10-deployment.yaml

@@ -1,46 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: apps/v1beta1
-kind: Deployment
-metadata:
-  namespace: heptio-ark
-  name: ark
-spec:
-  replicas: 1
-  template:
-    metadata:
-      labels:
-        component: ark
-    spec:
-      restartPolicy: Always
-      serviceAccountName: ark
-      containers:
-        - name: ark
-          image: gcr.io/heptio-images/ark:latest
-          command:
-            - /ark
-          args:
-            - server
-          volumeMounts:
-            - name: cloud-credentials
-              mountPath: /credentials
-          env:
-            - name: AWS_SHARED_CREDENTIALS_FILE
-              value: /credentials/cloud
-      volumes:
-        - name: cloud-credentials
-          secret:
-            secretName: cloud-credentials

examples/common/README.md

@@ -1,14 +0,0 @@
-# File Structure
-
-## 00-prereqs.yaml
-
-This file contains the prerequisites necessary to run the Ark server:
-
-- `heptio-ark` namespace
-- `ark` service account
-- RBAC rules to grant permissions to the `ark` service account
-- CRDs for the Ark-specific resources (Backup, Schedule, Restore, Config)
-
-## 10-deployment.yaml
-
-This deploys Ark and be used for AWS, GCP, and Minio. *Note that it cannot be used for Azure.*

examples/gcp/00-ark-config.yaml

@@ -1,30 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: ark.heptio.com/v1
-kind: Config
-metadata:
-  namespace: heptio-ark
-  name: default
-persistentVolumeProvider:
-  gcp:
-    project: <YOUR_PROJECT>
-backupStorageProvider:
-  bucket: <YOUR_BUCKET>
-  gcp: {}
-backupSyncPeriod: 30m
-gcSyncPeriod: 30m
-scheduleSyncPeriod: 1m
-restoreOnlyMode: false

examples/minio/00-minio-deployment.yaml

@@ -1,4 +1,4 @@
-# Copyright 2017 Heptio Inc.
+# Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,16 +13,25 @@
 # limitations under the License.
 
 ---
-apiVersion: apps/v1beta1
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: velero
+
+---
+apiVersion: apps/v1
 kind: Deployment
 metadata:
-  namespace: heptio-ark
+  namespace: velero
   name: minio
   labels:
     component: minio
 spec:
   strategy:
     type: Recreate
+  selector:
+    matchLabels:
+      component: minio
   template:
     metadata:
       labels:
@@ -30,8 +39,9 @@ spec:
     spec:
       volumes:
       - name: storage
-        hostPath:
-          path: /tmp/minio
+        emptyDir: {}
+      - name: config
+        emptyDir: {}
       containers:
       - name: minio
         image: minio/minio:latest
@@ -39,6 +49,7 @@ spec:
         args:
         - server
         - /storage
+        - --config-dir=/config
         env:
         - name: MINIO_ACCESS_KEY
           value: "minio"
@@ -49,16 +60,21 @@ spec:
         volumeMounts:
         - name: storage
           mountPath: "/storage"
+        - name: config
+          mountPath: "/config"
 
 ---
 apiVersion: v1
 kind: Service
 metadata:
-  namespace: heptio-ark
+  namespace: velero
   name: minio
   labels:
     component: minio
 spec:
+  # ClusterIP is recommended for production environments.
+  # Change to NodePort if needed per documentation,
+  # but only if you run Minio in a test/trial environment, for example with Minikube.
   type: ClusterIP
   ports:
     - port: 9000
@@ -67,25 +83,11 @@ spec:
   selector:
     component: minio
 
----
-apiVersion: v1
-kind: Secret
-metadata:
-  namespace: heptio-ark
-  name: cloud-credentials
-  labels:
-    component: minio
-stringData:
-  cloud: |
-    [default]
-    aws_access_key_id = minio
-    aws_secret_access_key = minio123
-
 ---
 apiVersion: batch/v1
 kind: Job
 metadata:
-  namespace: heptio-ark
+  namespace: velero
   name: minio-setup
   labels:
     component: minio
@@ -95,6 +97,9 @@ spec:
       name: minio-setup
     spec:
       restartPolicy: OnFailure
+      volumes:
+      - name: config
+        emptyDir: {}
       containers:
       - name: mc
         image: minio/mc:latest
@@ -102,4 +107,7 @@ spec:
         command:
         - /bin/sh
         - -c
-        - "mc config host add ark http://minio:9000 minio minio123 && mc mb -p ark/ark"
+        - "mc --config-dir=/config config host add velero http://minio:9000 minio minio123 && mc --config-dir=/config mb -p velero/velero"
+        volumeMounts:
+        - name: config
+          mountPath: "/config"

examples/minio/10-ark-config.yaml

@@ -1,30 +0,0 @@
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
----
-apiVersion: ark.heptio.com/v1
-kind: Config
-metadata:
-  namespace: heptio-ark
-  name: default
-backupStorageProvider:
-  bucket: ark
-  aws:
-    region: minio
-    s3ForcePathStyle: true
-    s3Url: http://minio:9000
-backupSyncPeriod: 1m
-gcSyncPeriod: 1m
-scheduleSyncPeriod: 1m
-restoreOnlyMode: false

examples/nginx-app/README.md

@@ -4,12 +4,12 @@ This directory contains manifests for two versions of a sample Nginx app under t
 
 ## `base.yaml`
 
-This is the most basic version of the Nginx app, which can be used to test Ark's backup and restore functionality.
+This is the most basic version of the Nginx app, which can be used to test Velero's backup and restore functionality.
 
 *This can be deployed as is.*
 
 ## `with-pv.yaml`
 
-This sets up an Nginx app that logs to a persistent volume, so that Ark's PV snapshotting functionality can also be tested.
+This sets up an Nginx app that logs to a persistent volume, so that Velero's PV snapshotting functionality can also be tested.
 
 *This requires you to first replace the placeholder value `<YOUR_STORAGE_CLASS_NAME>`.*

examples/nginx-app/base.yaml

@@ -1,4 +1,4 @@
-# Copyright 2017 Heptio Inc.
+# Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,13 +21,16 @@ metadata:
     app: nginx
 
 ---
-apiVersion: apps/v1beta1
+apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: nginx-deployment
   namespace: nginx-example
 spec:
   replicas: 2
+  selector:
+    matchLabels:
+      app: nginx
   template:
     metadata:
       labels:

examples/nginx-app/with-pv.yaml

@@ -1,4 +1,4 @@
-# Copyright 2017 Heptio Inc.
+# Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,7 +29,7 @@ metadata:
   labels:
     app: nginx
 spec:
-  storageClassName: <YOUR_STORAGE_CLASS_NAME>
+  # storageClassName: <YOUR_STORAGE_CLASS_NAME>
   accessModes:
     - ReadWriteOnce
   resources:
@@ -37,17 +37,25 @@ spec:
       storage: 50Mi
 
 ---
-apiVersion: apps/v1beta1
+apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: nginx-deployment
   namespace: nginx-example
 spec:
   replicas: 1
+  selector:
+    matchLabels:
+      app: nginx
   template:
     metadata:
       labels:
         app: nginx
+      annotations:
+        pre.hook.backup.velero.io/container: fsfreeze
+        pre.hook.backup.velero.io/command: '["/sbin/fsfreeze", "--freeze", "/var/log/nginx"]'
+        post.hook.backup.velero.io/container: fsfreeze
+        post.hook.backup.velero.io/command: '["/sbin/fsfreeze", "--unfreeze", "/var/log/nginx"]'
     spec:
       volumes:
         - name: nginx-logs
@@ -62,6 +70,14 @@ spec:
           - mountPath: "/var/log/nginx"
             name: nginx-logs
             readOnly: false
+      - image: gcr.io/heptio-images/fsfreeze-pause:latest
+        name: fsfreeze
+        securityContext:
+          privileged: true
+        volumeMounts:
+          - mountPath: "/var/log/nginx"
+            name: nginx-logs
+            readOnly: false
 
 ---
 apiVersion: v1

hack/boilerplate.go.txt

@@ -0,0 +1,15 @@
+/*
+Copyright the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/

hack/build-image/Dockerfile

@@ -0,0 +1,26 @@
+# Copyright 2018 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM golang:1.12
+
+RUN mkdir -p /go/src/k8s.io && \
+    cd /go/src/k8s.io && \
+    git config --global advice.detachedHead false && \
+    git clone -b kubernetes-1.14.0 https://github.com/kubernetes/code-generator && \
+    git clone -b kubernetes-1.14.0 https://github.com/kubernetes/apimachinery && \
+    go get golang.org/x/tools/cmd/goimports && \
+    cd /go/src/golang.org/x/tools && \
+    git checkout 40a48ad93fbe707101afb2099b738471f70594ec && \
+    go install ./cmd/goimports && \
+    echo chmod -R a+w /go

hack/build.sh

@@ -41,7 +41,7 @@ fi
 
 export CGO_ENABLED=0
 
-GIT_SHA=$(git describe --tags --always)
+GIT_SHA=$(git rev-parse HEAD)
 GIT_DIRTY=$(git status --porcelain 2> /dev/null)
 if [[ -z "${GIT_DIRTY}" ]]; then
   GIT_TREE_STATE=clean
@@ -61,7 +61,7 @@ if [[ "${GOOS}" = "windows" ]]; then
   OUTPUT="${OUTPUT}.exe"
 fi
 
-go build -i \
+go build \
     -o ${OUTPUT} \
     -installsuffix "static" \
     -ldflags "${LDFLAGS}" \

hack/changelog.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Copyright 2018 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+CHANGELOG_PATH='changelogs/unreleased'
+UNRELEASED=$(ls -t ${CHANGELOG_PATH})
+echo -e "Generating CHANGELOG markdown from ${CHANGELOG_PATH}\n"
+for entry in $UNRELEASED
+do
+    IFS=$'-' read -ra pruser <<<"$entry"
+    contents=$(cat ${CHANGELOG_PATH}/${entry})
+    echo "  * ${contents} (#${pruser[0]}, @${pruser[1]})"
+done
+echo -e "\nCopy and paste the list above in to the appropriate CHANGELOG file."
+echo "Be sure to run: git rm ${CHANGELOG_PATH}/*"

hack/ci-check.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# If we're doing push build, as opposed to a PR, always run make ci
+if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
+    make ci
+    # Exit script early, returning make ci's error
+    exit $?
+fi
+
+# Only run `make ci` if files outside of the site directory changed in the branch
+# In a PR build, $TRAVIS_BRANCH is the destination branch.
+if [[ $(git diff --name-only $TRAVIS_BRANCH | grep --invert-match site/) ]]; then
+  make ci
+else
+  echo "Skipping make ci since nothing outside of site directory changed."
+  exit 0
+fi

hack/dep-save.sh

@@ -1,21 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-dep ensure $@
-dep prune
-
-# remove files we don't want
-find vendor \( -name BUILD -o -name .travis.yml -o -name '*_test.go' \) -exec rm {} \;

hack/gcr-push.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+# Return value is written into LATEST
+LATEST=false
+function is_latest_release() {
+    # If the tag has alpha, beta or rc in it, it's not "latest"
+    if [[ "$TRAVIS_TAG" == *"beta"* || "$TRAVIS_TAG" == *"alpha"* || "$TRAVIS_TAG" == *"rc"* ]]; then
+        LATEST=false
+    else
+        LATEST=true
+    fi
+}
+
+# Always publish for master
+if [ "$BRANCH" == "master" ]; then
+    VERSION="$BRANCH" make all-containers all-push
+fi
+
+# Publish when TRAVIS_TAG is defined.
+if [ ! -z "$TRAVIS_TAG" ]; then
+    # Check if this is the latest release.
+    is_latest_release
+
+    VERSION="$TRAVIS_TAG" TAG_LATEST="$LATEST" make all-containers all-push
+fi

hack/gen-docs.sh

@@ -0,0 +1,108 @@
+#!/bin/bash
+
+# Copyright 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# gen-docs.sh is used for the "make gen-docs" target. See additional
+# documentation in the Makefile.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+# don't run if there's already a directory for the target docs version
+if [[ -d site/docs/$NEW_DOCS_VERSION ]]; then
+    echo "ERROR: site/docs/$NEW_DOCS_VERSION already exists"
+    exit 1
+fi
+
+# get the alphabetically last item in site/docs to use as PREVIOUS_DOCS_VERSION
+# if not explicitly specified by the user
+if [[ -z "${PREVIOUS_DOCS_VERSION:-}" ]]; then
+    echo "PREVIOUS_DOCS_VERSION was not specified, getting the latest version"
+    PREVIOUS_DOCS_VERSION=$(ls -1 site/docs/ | tail -n 1)
+fi
+
+# make a copy of the previous versioned docs dir
+echo "Creating copy of docs directory site/docs/$PREVIOUS_DOCS_VERSION in site/docs/$NEW_DOCS_VERSION"
+cp -r site/docs/${PREVIOUS_DOCS_VERSION}/ site/docs/${NEW_DOCS_VERSION}/
+
+# 'git add' the previous version's docs as-is so we get a useful diff when we copy the master docs in
+echo "Running 'git add' for previous version's doc contents to use as a base for diff"
+git add site/docs/${NEW_DOCS_VERSION}
+
+# now copy the contents of site/docs/master into the same directory so we can get a nice
+# git diff of what changed since previous version
+echo "Copying site/docs/master/ to site/docs/${NEW_DOCS_VERSION}/"
+rm -rf site/docs/${NEW_DOCS_VERSION}/ && cp -r site/docs/master/ site/docs/${NEW_DOCS_VERSION}/
+
+# make a copy of the previous versioned ToC
+NEW_DOCS_TOC="$(echo ${NEW_DOCS_VERSION} | tr . -)-toc"
+PREVIOUS_DOCS_TOC="$(echo ${PREVIOUS_DOCS_VERSION} | tr . -)-toc"
+
+echo "Creating copy of site/_data/$PREVIOUS_DOCS_TOC.yml at site/_data/$NEW_DOCS_TOC.yml"
+cp site/_data/$PREVIOUS_DOCS_TOC.yml site/_data/$NEW_DOCS_TOC.yml
+
+# 'git add' the previous version's ToC content as-is so we get a useful diff when we copy the master ToC in
+echo "Running 'git add' for previous version's ToC to use as a base for diff"
+git add site/_data/$NEW_DOCS_TOC.yml
+
+# now copy the master ToC so we can get a nice git diff of what changed since previous version
+echo "Copying site/_data/master-toc.yml to site/_data/$NEW_DOCS_TOC.yml"
+rm site/_data/$NEW_DOCS_TOC.yml && cp site/_data/master-toc.yml site/_data/$NEW_DOCS_TOC.yml
+
+# replace known version-specific links -- the sed syntax is slightly different in OS X and Linux,
+# so check which OS we're running on.
+if [[ $(uname) == "Darwin" ]]; then
+    echo "[OS X] updating version-specific links"
+    find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://velero.io/docs/master|https://velero.io/docs/$NEW_DOCS_VERSION|g"
+    find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://github.com/heptio/velero/blob/master|https://github.com/heptio/velero/blob/$NEW_DOCS_VERSION|g"
+
+    echo "[OS X] Updating latest version in _config.yml"
+    sed -i '' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" site/_config.yml
+
+    # newlines and lack of indentation are requirements for this sed syntax
+    # which is doing an append
+    echo "[OS X] Adding latest version to versions list in _config.yml"
+    sed -i '' "/- master/a\\
+- ${NEW_DOCS_VERSION}
+" site/_config.yml
+
+    echo "[OS X] Adding ToC mapping entry"
+    sed -i '' "/master: master-toc/a\\
+${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}
+" site/_data/toc-mapping.yml
+
+else
+    echo "[Linux] updating version-specific links"
+    find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://velero.io/docs/master|https://velero.io/docs/$NEW_DOCS_VERSION|g"
+    find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://github.com/heptio/velero/blob/master|https://github.com/heptio/velero/blob/$NEW_DOCS_VERSION|g"
+
+    echo "[Linux] Updating latest version in _config.yml"
+    sed -i'' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" site/_config.yml
+    
+    echo "[Linux] Adding latest version to versions list in _config.yml"
+    sed -i'' "/- master/a - ${NEW_DOCS_VERSION}" site/_config.yml
+    
+    echo "[Linux] Adding ToC mapping entry"
+    sed -i'' "/master: master-toc/a ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}" site/_data/toc-mapping.yml
+fi
+
+echo "Success! site/docs/$NEW_DOCS_VERSION has been created."
+echo ""
+echo "The next steps are:"
+echo "  1. Consult site/README-JEKYLL.md for further manual steps required to finalize the new versioned docs generation."
+echo "  2. Run a 'git diff' to review all changes made to the docs since the previous version."
+echo "  3. Make any manual changes/corrections necessary."
+echo "  4. Run 'git add' to stage all unstaged changes, then 'git commit'."

hack/generate-proto.sh

@@ -0,0 +1,23 @@
+#!/bin/bash -e
+#
+# Copyright 2017 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+HACK_DIR=$(dirname "${BASH_SOURCE}")
+
+echo "Running protoc"
+
+protoc pkg/plugin/proto/*.proto --go_out=plugins=grpc:pkg/plugin/generated/ -I pkg/plugin/proto/
+
+echo "Success!"

hack/goreleaser.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+# Copyright 2018 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+if [[ -z "${GITHUB_TOKEN}" ]]; then
+    echo "GITHUB_TOKEN must be set"
+    exit 1
+fi
+
+# TODO derive this from the major+minor version
+if [ -z "${RELEASE_NOTES_FILE}" ]; then
+    echo "RELEASE_NOTES_FILE must be set"
+    exit 1
+fi
+
+GIT_DIRTY=$(git status --porcelain 2> /dev/null)
+if [[ -z "${GIT_DIRTY}" ]]; then
+    export GIT_TREE_STATE=clean
+else
+    export GIT_TREE_STATE=dirty
+fi
+
+# $PUBLISH must explicitly be set to 'true' for goreleaser
+# to publish the release to GitHub.
+if [[ "${PUBLISH:-}" != "true" ]]; then
+    goreleaser release \
+        --rm-dist \
+        --release-notes="${RELEASE_NOTES_FILE}" \
+        --skip-publish
+else
+    goreleaser release \
+        --rm-dist \
+        --release-notes="${RELEASE_NOTES_FILE}"
+fi

hack/issue-template-gen/main.go

@@ -0,0 +1,45 @@
+/*
+Copyright 2018 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// This code renders the IssueTemplate string in pkg/cmd/cli/bug/bug.go to
+// .github/ISSUE_TEMPLATE/bug_report.md via the hack/update-generated-issue-template.sh script.
+
+package main
+
+import (
+	"log"
+	"os"
+	"text/template"
+
+	"github.com/heptio/velero/pkg/cmd/cli/bug"
+)
+
+func main() {
+	outTemplateFilename := os.Args[1]
+	outFile, err := os.OpenFile(outTemplateFilename, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer outFile.Close()
+	tmpl, err := template.New("ghissue").Parse(bug.IssueTemplate)
+	if err != nil {
+		log.Fatal(err)
+	}
+	err = tmpl.Execute(outFile, bug.VeleroBugInfo{})
+	if err != nil {
+		log.Fatal(err)
+	}
+}

hack/test.sh

@@ -20,36 +20,20 @@ set -o pipefail
 
 export CGO_ENABLED=0
 
-TARGETS=$(for d in "$@"; do echo ./$d/...; done)
+TARGETS=(
+  ./cmd/...
+  ./pkg/...
+)
 
-echo "Running tests:"
-go test -i -installsuffix "static" ${TARGETS}
-go test -installsuffix "static" -timeout 60s ${TARGETS}
-echo
-
-echo -n "Checking gofmt: "
-ERRS=$(find "$@" -type f -name \*.go | xargs gofmt -l 2>&1 || true)
-if [ -n "${ERRS}" ]; then
-    echo "FAIL - the following files need to be gofmt'ed:"
-    for e in ${ERRS}; do
-        echo "    $e"
-    done
-    echo
-    exit 1
+if [[ ${#@} -ne 0 ]]; then
+  TARGETS=("$@")
 fi
-echo "PASS"
-echo
 
-# TODO(ncdc): there are govet failures in the generated clientset and the log error location hook
-# that prevent us from running vet at this time.
-#
-# echo -n "Checking go vet: "
-# ERRS=$(go vet ${TARGETS} 2>&1 || true)
-# if [ -n "${ERRS}" ]; then
-#     echo "FAIL"
-#     echo "${ERRS}"
-#     echo
-#     exit 1
-# fi
-# echo "PASS"
-# echo
+echo "Running tests:" "${TARGETS[@]}"
+
+if [[ -n "${GOFLAGS:-}" ]]; then
+  echo "GOFLAGS: ${GOFLAGS}"
+fi
+
+go test -installsuffix "static" -timeout 60s "${TARGETS[@]}"
+echo "Success!"

hack/update-all.sh

@@ -1,6 +1,6 @@
 #!/bin/bash -e
 #
-# Copyright 2017 the Heptio Ark contributors.
+# Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

hack/update-fmt.sh

@@ -1,6 +1,6 @@
-#!/bin/bash -e
+#!/bin/bash
 #
-# Copyright 2017 the Heptio Ark contributors.
+# Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,11 +14,54 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-HACK_DIR=$(dirname "${BASH_SOURCE}")
+set -o errexit
+set -o nounset
+set -o pipefail
 
-echo "Updating formatting"
+if [[ ${1:-} == '--verify' ]]; then
+  # List file diffs that need formatting updates
+  MODE='-d'
+  ACTION='Verifying'
+else
+  # Write formatting updates to files
+  MODE='-w'
+  ACTION='Updating'
+fi
 
-gofmt -w=true $(find . -type f -name "*.go" -not -path "./vendor/*" -not -path "./pkg/generated/*")
-goimports -w=true -d $(find . -type f -name "*.go" -not -path "./vendor/*" -not -path "./pkg/generated/*")
+if ! command -v goimports > /dev/null; then
+  echo 'goimports is missing - please run "go get golang.org/x/tools/cmd/goimports"'
+  exit 1
+fi
 
-echo "Success!"
+files="$(find . -type f -name '*.go' -not -path './vendor/*' -not -path './site/*' -not -path './pkg/generated/*' -not -name 'zz_generated*')"
+echo "${ACTION} gofmt"
+for file in ${files}; do
+  output=$(gofmt "${MODE}" -s "${file}")
+  if [[ -n "${output}" ]]; then
+    VERIFY_FMT_FAILED=1
+    echo "${output}"
+  fi
+done
+if [[ -n "${VERIFY_FMT_FAILED:-}" ]]; then
+  echo "${ACTION} gofmt - failed! Please run 'make update'."
+else
+  echo "${ACTION} gofmt - done!"
+fi
+
+echo "${ACTION} goimports"
+for file in ${files}; do
+  output=$(goimports "${MODE}" -local github.com/heptio/velero "${file}")
+  if [[ -n "${output}" ]]; then
+    VERIFY_IMPORTS_FAILED=1
+    echo "${output}"
+  fi
+done
+if [[ -n "${VERIFY_IMPORTS_FAILED:-}" ]]; then
+  echo "${ACTION} goimports - failed! Please run 'make update'."
+else
+  echo "${ACTION} goimports - done!"
+fi
+
+if [[ -n "${VERIFY_FMT_FAILED:-}" || -n "${VERIFY_IMPORTS_FAILED:-}" ]]; then
+  exit 1
+fi

hack/update-generated-clientsets.sh

@@ -1,60 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-ARK_ROOT=$(dirname ${BASH_SOURCE})/..
-BIN=${ARK_ROOT}/_output/bin
-mkdir -p ${BIN}
-go build -o ${BIN}/client-gen ./vendor/k8s.io/kubernetes/cmd/libs/go2idl/client-gen
-
-OUTPUT_BASE=""
-if [[ -z "${GOPATH}" ]]; then
-  OUTPUT_BASE="${HOME}/go/src"
-else
-  OUTPUT_BASE="${GOPATH}/src"
-fi
-
-verify=""
-for i in "$@"; do
-  if [[ $i == "--verify-only" ]]; then
-    verify=1
-    break
-  fi
-done
-
-if [[ -z ${verify} ]]; then
-  echo "Updating generated clientsets"
-
-  find ${ARK_ROOT}/pkg/generated/clientset \
-    \( \
-      -name '*.go' -and \
-      \( \
-        ! -name '*_expansion.go' \
-        -or \
-        -name generated_expansion.go \
-      \) \
-    \) -exec rm {} \;
-fi
-
-${BIN}/client-gen \
-  --go-header-file /dev/null \
-  --output-base ${OUTPUT_BASE} \
-  --input-base github.com/heptio/ark/pkg/apis \
-  --clientset-path github.com/heptio/ark/pkg/generated \
-  --input ark/v1 \
-  --clientset-name clientset \
-  $@
-
-echo "Success!"

hack/update-generated-crd-code.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+#
+# Copyright 2017 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+set -o xtrace
+
+if [[ -z "${GOPATH}" ]]; then
+  GOPATH=~/go
+fi
+
+if [[ ! -d "${GOPATH}/src/k8s.io/code-generator" ]]; then
+  echo "k8s.io/code-generator missing from GOPATH"
+  exit 1
+fi
+
+cd ${GOPATH}/src/k8s.io/code-generator
+
+./generate-groups.sh \
+  all \
+  github.com/heptio/velero/pkg/generated \
+  github.com/heptio/velero/pkg/apis \
+  "velero:v1" \
+  --go-header-file ${GOPATH}/src/github.com/heptio/velero/hack/boilerplate.go.txt \
+  $@

hack/update-generated-docs.sh

@@ -1,37 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-ARK_ROOT=$(dirname ${BASH_SOURCE})/..
-BIN=${ARK_ROOT}/_output/bin
-mkdir -p ${BIN}
-
-echo "Updating generated docs"
-
-go build -o ${BIN}/docs-gen ./docs/generate/ark.go
-
-if [[ $# -gt 1 ]]; then
-  echo "usage: ${BASH_SOURCE} [DIRECTORY]"
-  exit 1
-fi
-
-OUTPUT_DIR="$@"
-if [[ -z "${OUTPUT_DIR}" ]]; then
-  OUTPUT_DIR=${ARK_ROOT}/docs/cli-reference
-fi
-
-${BIN}/docs-gen ark ${OUTPUT_DIR}
-
-echo "Success!"

hack/update-generated-informers.sh

@@ -1,55 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-ARK_ROOT=$(dirname ${BASH_SOURCE})/..
-BIN=${ARK_ROOT}/_output/bin
-mkdir -p ${BIN}
-
-echo "Updating generated informers"
-
-go build -o ${BIN}/informer-gen ./vendor/k8s.io/kubernetes/cmd/libs/go2idl/informer-gen
-
-OUTPUT_BASE=""
-if [[ -z "${GOPATH}" ]]; then
-  OUTPUT_BASE="${HOME}/go/src"
-else
-  OUTPUT_BASE="${GOPATH}/src"
-fi
-
-verify=""
-for i in "$@"; do
-  if [[ $i == "--verify-only" ]]; then
-    verify=1
-    break
-  fi
-done
-
-if [[ -z ${verify} ]]; then
-  rm -rf ${ARK_ROOT}/pkg/generated/informers
-fi
-
-${BIN}/informer-gen \
-  --logtostderr \
-  --go-header-file /dev/null \
-  --output-base ${OUTPUT_BASE} \
-  --input-dirs github.com/heptio/ark/pkg/apis/ark/v1 \
-  --output-package github.com/heptio/ark/pkg/generated/informers \
-  --listers-package github.com/heptio/ark/pkg/generated/listers \
-  --internal-clientset-package github.com/heptio/ark/pkg/generated/clientset \
-  --versioned-clientset-package github.com/heptio/ark/pkg/generated/clientset \
-  $@
-
-echo "Success!"

hack/update-generated-issue-template.sh

@@ -0,0 +1,36 @@
+#!/bin/bash -e
+#
+# Copyright 2018, 2019 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+VELERO_ROOT=$(dirname ${BASH_SOURCE})/..
+BIN=${VELERO_ROOT}/_output/bin
+
+mkdir -p ${BIN}
+
+echo "Updating generated Github issue template"
+go build -o ${BIN}/issue-tmpl-gen ./hack/issue-template-gen/main.go
+
+if [[ $# -gt 1 ]]; then
+  echo "usage: ${BASH_SOURCE} [OUTPUT_FILE]"
+  exit 1
+fi
+
+OUTPUT_ISSUE_FILE="$1"
+if [[ -z "${OUTPUT_ISSUE_FILE}" ]]; then
+  OUTPUT_ISSUE_FILE=${VELERO_ROOT}/.github/ISSUE_TEMPLATE/bug_report.md
+fi
+
+${BIN}/issue-tmpl-gen ${OUTPUT_ISSUE_FILE} 
+echo "Success!"

hack/update-generated-listers.sh

@@ -1,60 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-ARK_ROOT=$(dirname ${BASH_SOURCE})/..
-BIN=${ARK_ROOT}/_output/bin
-mkdir -p ${BIN}
-
-echo "Updating generated listers"
-
-go build -o ${BIN}/lister-gen ./vendor/k8s.io/kubernetes/cmd/libs/go2idl/lister-gen
-
-OUTPUT_BASE=""
-if [[ -z "${GOPATH}" ]]; then
-  OUTPUT_BASE="${HOME}/go/src"
-else
-  OUTPUT_BASE="${GOPATH}/src"
-fi
-
-verify=""
-for i in "$@"; do
-  if [[ $i == "--verify-only" ]]; then
-    verify=1
-    break
-  fi
-done
-
-if [[ -z ${verify} ]]; then
-  find ${ARK_ROOT}/pkg/generated/listers \
-    \( \
-      -name '*.go' -and \
-      \( \
-        ! -name '*_expansion.go' \
-        -or \
-        -name generated_expansion.go \
-      \) \
-    \) -exec rm {} \;
-fi
-
-${BIN}/lister-gen \
-  --logtostderr \
-  --go-header-file /dev/null \
-  --output-base ${OUTPUT_BASE} \
-  --input-dirs github.com/heptio/ark/pkg/apis/ark/v1 \
-  --output-package github.com/heptio/ark/pkg/generated/listers \
-  $@
-
-echo "Success!"

hack/verify-all.sh

@@ -1,6 +1,6 @@
 #!/bin/bash -e
 #
-# Copyright 2017 the Heptio Ark contributors.
+# Copyright 2017 the Velero contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

hack/verify-fmt.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+#
+# Copyright 2017 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+HACK_DIR=$(dirname "${BASH_SOURCE[0]}")
+"${HACK_DIR}"/update-fmt.sh --verify

hack/verify-generated-clientsets.sh

@@ -1,27 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-HACK_DIR=$(dirname "${BASH_SOURCE}")
-
-echo "Verifying generated clientsets"
-
-if ! output=$(${HACK_DIR}/update-generated-clientsets.sh --verify-only 2>&1); then
-  echo "FAILURE: verification of clientsets failed:"
-  echo "${output}"
-  exit 1
-fi
-
-echo "Success!"

hack/verify-generated-crd-code.sh

@@ -0,0 +1,19 @@
+#!/bin/bash -e
+#
+# Copyright 2017 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+HACK_DIR=$(dirname "${BASH_SOURCE}")
+
+${HACK_DIR}/update-generated-crd-code.sh --verify-only

hack/verify-generated-docs.sh

@@ -1,41 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-ARK_ROOT=$(dirname ${BASH_SOURCE})/..
-HACK_DIR=$(dirname "${BASH_SOURCE}")
-DOCS_DIR=${ARK_ROOT}/docs/cli-reference
-TMP_DIR="$(mktemp -d)"
-
-trap cleanup INT TERM HUP EXIT
-
-cleanup() {
-  rm -rf ${TMP_DIR}
-}
-
-echo "Verifying generated docs"
-
-${HACK_DIR}/update-generated-docs.sh ${TMP_DIR} > /dev/null
-
-exclude_file="README.md"
-output=$(echo "`diff -r ${DOCS_DIR} ${TMP_DIR}`" | sed "/${exclude_file}/d")
-
-if [[ -n "${output}" ]] ; then
-    echo "FAILURE: verification of docs failed:"
-    echo "${output}"
-    exit 1
-fi
-
-echo "Success!"

hack/verify-generated-informers.sh

@@ -1,27 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-HACK_DIR=$(dirname "${BASH_SOURCE}")
-
-echo "Verifying generated informers"
-
-if ! output=$(${HACK_DIR}/update-generated-informers.sh --verify-only 2>&1); then
-  echo "FAILURE: verification of informers failed:"
-  echo "${output}"
-  exit 1
-fi
-
-echo "Success!"

hack/verify-generated-issue-template.sh

@@ -0,0 +1,39 @@
+#!/bin/bash -e
+#
+# Copyright 2018 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+VELERO_ROOT=$(dirname ${BASH_SOURCE})/..
+HACK_DIR=$(dirname "${BASH_SOURCE}")
+ISSUE_TEMPLATE_FILE=${VELERO_ROOT}/.github/ISSUE_TEMPLATE/bug_report.md
+OUT_TMP_FILE="$(mktemp -d)"/bug_report.md
+
+
+trap cleanup INT TERM HUP EXIT
+
+cleanup() {
+  rm -rf ${TMP_DIR}
+}
+
+echo "Verifying generated Github issue template"
+${HACK_DIR}/update-generated-issue-template.sh ${OUT_TMP_FILE} > /dev/null
+output=$(echo "`diff ${ISSUE_TEMPLATE_FILE} ${OUT_TMP_FILE}`")
+
+if [[ -n "${output}" ]] ; then
+    echo "FAILURE: verification of generated template failed:"
+    echo "${output}"
+    exit 1
+fi
+
+echo "Success!"

hack/verify-generated-listers.sh

@@ -1,27 +0,0 @@
-#!/bin/bash -e
-#
-# Copyright 2017 Heptio Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-HACK_DIR=$(dirname "${BASH_SOURCE}")
-
-echo "Verifying generated listers"
-
-if ! output=$(${HACK_DIR}/update-generated-listers.sh --verify-only 2>&1); then
-  echo "FAILURE: verification of listers failed:"
-  echo "${output}"
-  exit 1
-fi
-
-echo "Success!"

netlify.toml

@@ -0,0 +1,4 @@
+[build]
+  base = "site/"
+  command = "jekyll build"
+  publish = "site/_site"

pkg/apis/ark/v1/backup.go

@@ -1,204 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package v1
-
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-// BackupSpec defines the specification for an Ark backup.
-type BackupSpec struct {
-	// IncludedNamespaces is a slice of namespace names to include objects
-	// from. If empty, all namespaces are included.
-	IncludedNamespaces []string `json:"includedNamespaces"`
-
-	// ExcludedNamespaces contains a list of namespaces that are not
-	// included in the backup.
-	ExcludedNamespaces []string `json:"excludedNamespaces"`
-
-	// IncludedResources is a slice of resource names to include
-	// in the backup. If empty, all resources are included.
-	IncludedResources []string `json:"includedResources"`
-
-	// ExcludedResources is a slice of resource names that are not
-	// included in the backup.
-	ExcludedResources []string `json:"excludedResources"`
-
-	// LabelSelector is a metav1.LabelSelector to filter with
-	// when adding individual objects to the backup. If empty
-	// or nil, all objects are included. Optional.
-	LabelSelector *metav1.LabelSelector `json:"labelSelector"`
-
-	// SnapshotVolumes specifies whether to take cloud snapshots
-	// of any PV's referenced in the set of objects included
-	// in the Backup.
-	SnapshotVolumes *bool `json:"snapshotVolumes"`
-
-	// TTL is a time.Duration-parseable string describing how long
-	// the Backup should be retained for.
-	TTL metav1.Duration `json:"ttl"`
-
-	// IncludeClusterResources specifies whether cluster-scoped resources
-	// should be included for consideration in the backup.
-	IncludeClusterResources *bool `json:"includeClusterResources"`
-
-	// Hooks represent custom behaviors that should be executed at different phases of the backup.
-	Hooks BackupHooks `json:"hooks"`
-}
-
-// BackupHooks contains custom behaviors that should be executed at different phases of the backup.
-type BackupHooks struct {
-	// Resources are hooks that should be executed when backing up individual instances of a resource.
-	Resources []BackupResourceHookSpec `json:"resources"`
-}
-
-// BackupResourceHookSpec defines one or more BackupResourceHooks that should be executed based on
-// the rules defined for namespaces, resources, and label selector.
-type BackupResourceHookSpec struct {
-	// Name is the name of this hook.
-	Name string `json:"name"`
-	// IncludedNamespaces specifies the namespaces to which this hook spec applies. If empty, it applies
-	// to all namespaces.
-	IncludedNamespaces []string `json:"includedNamespaces"`
-	// ExcludedNamespaces specifies the namespaces to which this hook spec does not apply.
-	ExcludedNamespaces []string `json:"excludedNamespaces"`
-	// IncludedResources specifies the resources to which this hook spec applies. If empty, it applies
-	// to all resources.
-	IncludedResources []string `json:"includedResources"`
-	// ExcludedResources specifies the resources to which this hook spec does not apply.
-	ExcludedResources []string `json:"excludedResources"`
-	// LabelSelector, if specified, filters the resources to which this hook spec applies.
-	LabelSelector *metav1.LabelSelector `json:"labelSelector"`
-	// Hooks is a list of BackupResourceHooks to execute.
-	Hooks []BackupResourceHook `json:"hooks"`
-}
-
-// BackupResourceHook defines a hook for a resource.
-type BackupResourceHook struct {
-	// Exec defines an exec hook.
-	Exec *ExecHook `json:"exec"`
-}
-
-// ExecHook is a hook that uses the pod exec API to execute a command in a container in a pod.
-type ExecHook struct {
-	// Container is the container in the pod where the command should be executed. If not specified,
-	// the pod's first container is used.
-	Container string `json:"container"`
-	// Command is the command and arguments to execute.
-	Command []string `json:"command"`
-	// OnError specifies how Ark should behave if it encounters an error executing this hook.
-	OnError HookErrorMode `json:"onError"`
-	// Timeout defines the maximum amount of time Ark should wait for the hook to complete before
-	// considering the execution a failure.
-	Timeout metav1.Duration `json:"timeout"`
-}
-
-// HookErrorMode defines how Ark should treat an error from a hook.
-type HookErrorMode string
-
-const (
-	// HookErrorModeContinue means that an error from a hook is acceptable, and the backup can
-	// proceed.
-	HookErrorModeContinue HookErrorMode = "Continue"
-	// HookErrorModeFail means that an error from a hook is problematic, and the backup should be in
-	// error.
-	HookErrorModeFail HookErrorMode = "Fail"
-)
-
-// BackupPhase is a string representation of the lifecycle phase
-// of an Ark backup.
-type BackupPhase string
-
-const (
-	// BackupPhaseNew means the backup has been created but not
-	// yet processed by the BackupController.
-	BackupPhaseNew BackupPhase = "New"
-
-	// BackupPhaseFailedValidation means the backup has failed
-	// the controller's validations and therefore will not run.
-	BackupPhaseFailedValidation BackupPhase = "FailedValidation"
-
-	// BackupPhaseInProgress means the backup is currently executing.
-	BackupPhaseInProgress BackupPhase = "InProgress"
-
-	// BackupPhaseCompleted means the backup has run successfully without
-	// errors.
-	BackupPhaseCompleted BackupPhase = "Completed"
-
-	// BackupPhaseFailed mean the backup ran but encountered an error that
-	// prevented it from completing successfully.
-	BackupPhaseFailed BackupPhase = "Failed"
-)
-
-// BackupStatus captures the current status of an Ark backup.
-type BackupStatus struct {
-	// Version is the backup format version.
-	Version int `json:"version"`
-
-	// Expiration is when this Backup is eligible for garbage-collection.
-	Expiration metav1.Time `json:"expiration"`
-
-	// Phase is the current state of the Backup.
-	Phase BackupPhase `json:"phase"`
-
-	// VolumeBackups is a map of PersistentVolume names to
-	// information about the backed-up volume in the cloud
-	// provider API.
-	VolumeBackups map[string]*VolumeBackupInfo `json:"volumeBackups"`
-
-	// ValidationErrors is a slice of all validation errors (if
-	// applicable).
-	ValidationErrors []string `json:"validationErrors"`
-}
-
-// VolumeBackupInfo captures the required information about
-// a PersistentVolume at backup time to be able to restore
-// it later.
-type VolumeBackupInfo struct {
-	// SnapshotID is the ID of the snapshot taken in the cloud
-	// provider API of this volume.
-	SnapshotID string `json:"snapshotID"`
-
-	// Type is the type of the disk/volume in the cloud provider
-	// API.
-	Type string `json:"type"`
-
-	// AvailabilityZone is the where the volume is provisioned
-	// in the cloud provider.
-	AvailabilityZone string `json:"availabilityZone,omitempty"`
-
-	// Iops is the optional value of provisioned IOPS for the
-	// disk/volume in the cloud provider API.
-	Iops *int64 `json:"iops,omitempty"`
-}
-
-// +genclient=true
-
-// Backup is an Ark resource that respresents the capture of Kubernetes
-// cluster state at a point in time (API objects and associated volume state).
-type Backup struct {
-	metav1.TypeMeta   `json:",inline"`
-	metav1.ObjectMeta `json:"metadata"`
-
-	Spec   BackupSpec   `json:"spec"`
-	Status BackupStatus `json:"status,omitempty"`
-}
-
-// BackupList is a list of Backups.
-type BackupList struct {
-	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata"`
-	Items           []Backup `json:"items"`
-}

pkg/apis/ark/v1/config.go

@@ -1,112 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package v1
-
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-// ConfigList is a list of Configs.
-type ConfigList struct {
-	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata"`
-
-	Items []Config `json:"items"`
-}
-
-// +genclient=true
-
-// Config is an Ark resource that captures configuration information to be
-// used for running the Ark server.
-type Config struct {
-	metav1.TypeMeta   `json:",inline"`
-	metav1.ObjectMeta `json:"metadata"`
-
-	// PersistentVolumeProvider is the configuration information for the cloud where
-	// the cluster is running and has PersistentVolumes to snapshot or restore. Optional.
-	PersistentVolumeProvider *CloudProviderConfig `json:"persistentVolumeProvider"`
-
-	// BackupStorageProvider is the configuration information for the cloud where
-	// Ark backups are stored in object storage. This may be a different cloud than
-	// where the cluster is running.
-	BackupStorageProvider ObjectStorageProviderConfig `json:"backupStorageProvider"`
-
-	// BackupSyncPeriod is how often the BackupSyncController runs to ensure all
-	// Ark backups in object storage exist as Backup API objects in the cluster.
-	BackupSyncPeriod metav1.Duration `json:"backupSyncPeriod"`
-
-	// GCSyncPeriod is how often the GCController runs to delete expired backup
-	// API objects and corresponding backup files in object storage.
-	GCSyncPeriod metav1.Duration `json:"gcSyncPeriod"`
-
-	// ScheduleSyncPeriod is how often the ScheduleController runs to check for
-	// new backups that should be triggered based on schedules.
-	ScheduleSyncPeriod metav1.Duration `json:"scheduleSyncPeriod"`
-
-	// ResourcePriorities is an ordered slice of resources specifying the desired
-	// order of resource restores. Any resources not in the list will be restored
-	// alphabetically after the prioritized resources.
-	ResourcePriorities []string `json:"resourcePriorities"`
-
-	// RestoreOnlyMode is whether Ark should run in a mode where only restores
-	// are allowed; backups, schedules, and garbage-collection are all disabled.
-	RestoreOnlyMode bool `json:"restoreOnlyMode"`
-}
-
-// CloudProviderConfig is configuration information about how to connect
-// to a particular cloud. Only one of the members (AWS, GCP, Azure) may
-// be present.
-type CloudProviderConfig struct {
-	// AWS is configuration information for connecting to AWS.
-	AWS *AWSConfig `json:"aws"`
-
-	// GCP is configuration information for connecting to GCP.
-	GCP *GCPConfig `json:"gcp"`
-
-	// Azure is configuration information for connecting to Azure.
-	Azure *AzureConfig `json:"azure"`
-}
-
-// ObjectStorageProviderConfig is configuration information for connecting to
-// a particular bucket in object storage to access Ark backups.
-type ObjectStorageProviderConfig struct {
-	// CloudProviderConfig is the configuration information for the cloud where
-	// Ark backups are stored in object storage.
-	CloudProviderConfig `json:",inline"`
-
-	// Bucket is the name of the bucket in object storage where Ark backups
-	// are stored.
-	Bucket string `json:"bucket"`
-}
-
-// AWSConfig is configuration information for connecting to AWS.
-type AWSConfig struct {
-	Region           string `json:"region"`
-	DisableSSL       bool   `json:"disableSSL"`
-	S3ForcePathStyle bool   `json:"s3ForcePathStyle"`
-	S3Url            string `json:"s3Url"`
-	KMSKeyID         string `json:"kmsKeyId"`
-}
-
-// GCPConfig is configuration information for connecting to GCP.
-type GCPConfig struct {
-	Project string `json:"project"`
-}
-
-// AzureConfig is configuration information for connecting to Azure.
-type AzureConfig struct {
-	Location   string          `json:"location"`
-	APITimeout metav1.Duration `json:"apiTimeout"`
-}

pkg/apis/ark/v1/constants.go

@@ -1,40 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package v1
-
-const (
-	// DefaultNamespace is the Kubernetes namespace that is used by default for
-	// the Ark server and API objects.
-	DefaultNamespace = "heptio-ark"
-
-	// ResourcesDir is a top-level directory expected in backups which contains sub-directories
-	// for each resource type in the backup.
-	ResourcesDir = "resources"
-
-	// RestoreLabelKey is the label key that's applied to all resources that
-	// are created during a restore. This is applied for ease of identification
-	// of restored resources. The value will be the restore's name.
-	RestoreLabelKey = "ark-restore"
-
-	// ClusterScopedDir is the name of the directory containing cluster-scoped
-	// resources within an Ark backup.
-	ClusterScopedDir = "cluster"
-
-	// NamespaceScopedDir is the name of the directory containing namespace-scoped
-	// resource within an Ark backup.
-	NamespaceScopedDir = "namespaces"
-)

pkg/apis/ark/v1/doc.go

@@ -1,19 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-// Package v1 is the v1 version of the API.
-// +groupName=ark.heptio.com
-package v1

pkg/apis/ark/v1/register.go

@@ -1,59 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package v1
-
-import (
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
-)
-
-var (
-	// SchemeBuilder collects the scheme builder functions for the Ark API
-	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
-
-	// AddToScheme applies the SchemeBuilder functions to a specified scheme
-	AddToScheme = SchemeBuilder.AddToScheme
-)
-
-// GroupName is the group name for the Ark API
-const GroupName = "ark.heptio.com"
-
-// SchemeGroupVersion is the GroupVersion for the Ark API
-var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}
-
-// Resource gets an Ark GroupResource for a specified resource
-func Resource(resource string) schema.GroupResource {
-	return SchemeGroupVersion.WithResource(resource).GroupResource()
-}
-
-func addKnownTypes(scheme *runtime.Scheme) error {
-	scheme.AddKnownTypes(SchemeGroupVersion,
-		&Backup{},
-		&BackupList{},
-		&Schedule{},
-		&ScheduleList{},
-		&Restore{},
-		&RestoreList{},
-		&Config{},
-		&ConfigList{},
-		&DownloadRequest{},
-		&DownloadRequestList{},
-	)
-	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
-	return nil
-}

pkg/apis/ark/v1/restore.go

@@ -1,138 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package v1
-
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-// RestoreSpec defines the specification for an Ark restore.
-type RestoreSpec struct {
-	// BackupName is the unique name of the Ark backup to restore
-	// from.
-	BackupName string `json:"backupName"`
-
-	// IncludedNamespaces is a slice of namespace names to include objects
-	// from. If empty, all namespaces are included.
-	IncludedNamespaces []string `json:"includedNamespaces"`
-
-	// ExcludedNamespaces contains a list of namespaces that are not
-	// included in the restore.
-	ExcludedNamespaces []string `json:"excludedNamespaces"`
-
-	// IncludedResources is a slice of resource names to include
-	// in the restore. If empty, all resources in the backup are included.
-	IncludedResources []string `json:"includedResources"`
-
-	// ExcludedResources is a slice of resource names that are not
-	// included in the restore.
-	ExcludedResources []string `json:"excludedResources"`
-
-	// NamespaceMapping is a map of source namespace names
-	// to target namespace names to restore into. Any source
-	// namespaces not included in the map will be restored into
-	// namespaces of the same name.
-	NamespaceMapping map[string]string `json:"namespaceMapping"`
-
-	// LabelSelector is a metav1.LabelSelector to filter with
-	// when restoring individual objects from the backup. If empty
-	// or nil, all objects are included. Optional.
-	LabelSelector *metav1.LabelSelector `json:"labelSelector"`
-
-	// RestorePVs specifies whether to restore all included
-	// PVs from snapshot (via the cloudprovider).
-	RestorePVs *bool `json:"restorePVs"`
-
-	// IncludeClusterResources specifies whether cluster-scoped resources
-	// should be included for consideration in the restore. If null, defaults
-	// to true.
-	IncludeClusterResources *bool `json:"includeClusterResources"`
-}
-
-// RestorePhase is a string representation of the lifecycle phase
-// of an Ark restore
-type RestorePhase string
-
-const (
-	// RestorePhaseNew means the restore has been created but not
-	// yet processed by the RestoreController
-	RestorePhaseNew RestorePhase = "New"
-
-	// RestorePhaseFailedValidation means the restore has failed
-	// the controller's validations and therefore will not run.
-	RestorePhaseFailedValidation RestorePhase = "FailedValidation"
-
-	// RestorePhaseInProgress means the restore is currently executing.
-	RestorePhaseInProgress RestorePhase = "InProgress"
-
-	// RestorePhaseCompleted means the restore has finished executing.
-	// Any relevant warnings or errors will be captured in the Status.
-	RestorePhaseCompleted RestorePhase = "Completed"
-)
-
-// RestoreStatus captures the current status of an Ark restore
-type RestoreStatus struct {
-	// Phase is the current state of the Restore
-	Phase RestorePhase `json:"phase"`
-
-	// ValidationErrors is a slice of all validation errors (if
-	// applicable)
-	ValidationErrors []string `json:"validationErrors"`
-
-	// Warnings is a collection of all warning messages that were
-	// generated during execution of the restore
-	Warnings RestoreResult `json:"warnings"`
-
-	// Errors is a collection of all error messages that were
-	// generated during execution of the restore
-	Errors RestoreResult `json:"errors"`
-}
-
-// RestoreResult is a collection of messages that were generated
-// during execution of a restore. This will typically store either
-// warning or error messages.
-type RestoreResult struct {
-	// Ark is a slice of messages related to the operation of Ark
-	// itself (for example, messages related to connecting to the
-	// cloud, reading a backup file, etc.)
-	Ark []string `json:"ark"`
-
-	// Cluster is a slice of messages related to restoring cluster-
-	// scoped resources.
-	Cluster []string `json:"cluster"`
-
-	// Namespaces is a map of namespace name to slice of messages
-	// related to restoring namespace-scoped resources.
-	Namespaces map[string][]string `json:"namespaces"`
-}
-
-// +genclient=true
-
-// Restore is an Ark resource that represents the application of
-// resources from an Ark backup to a target Kubernetes cluster.
-type Restore struct {
-	metav1.TypeMeta   `json:",inline"`
-	metav1.ObjectMeta `json:"metadata"`
-
-	Spec   RestoreSpec   `json:"spec"`
-	Status RestoreStatus `json:"status,omitempty"`
-}
-
-// RestoreList is a list of Restores.
-type RestoreList struct {
-	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata"`
-	Items           []Restore `json:"items"`
-}

pkg/apis/ark/v1/schedule.go

@@ -1,81 +0,0 @@
-/*
-Copyright 2017 Heptio Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-package v1
-
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-// ScheduleSpec defines the specification for an Ark schedule
-type ScheduleSpec struct {
-	// Template is the definition of the Backup to be run
-	// on the provided schedule
-	Template BackupSpec `json:"template"`
-
-	// Schedule is a Cron expression defining when to run
-	// the Backup.
-	Schedule string `json:"schedule"`
-}
-
-// SchedulePhase is a string representation of the lifecycle phase
-// of an Ark schedule
-type SchedulePhase string
-
-const (
-	// SchedulePhaseNew means the schedule has been created but not
-	// yet processed by the ScheduleController
-	SchedulePhaseNew SchedulePhase = "New"
-
-	// SchedulePhaseEnabled means the schedule has been validated and
-	// will now be triggering backups according to the schedule spec.
-	SchedulePhaseEnabled SchedulePhase = "Enabled"
-
-	// SchedulePhaseFailedValidation means the schedule has failed
-	// the controller's validations and therefore will not trigger backups.
-	SchedulePhaseFailedValidation SchedulePhase = "FailedValidation"
-)
-
-// ScheduleStatus captures the current state of an Ark schedule
-type ScheduleStatus struct {
-	// Phase is the current phase of the Schedule
-	Phase SchedulePhase `json:"phase"`
-
-	// LastBackup is the last time a Backup was run for this
-	// Schedule schedule
-	LastBackup metav1.Time `json:"lastBackup"`
-
-	// ValidationErrors is a slice of all validation errors (if
-	// applicable)
-	ValidationErrors []string `json:"validationErrors"`
-}
-
-// +genclient=true
-
-// Schedule is an Ark resource that represents a pre-scheduled or
-// periodic Backup that should be run.
-type Schedule struct {
-	metav1.TypeMeta   `json:",inline"`
-	metav1.ObjectMeta `json:"metadata"`
-
-	Spec   ScheduleSpec   `json:"spec"`
-	Status ScheduleStatus `json:"status,omitempty"`
-}
-
-// ScheduleList is a list of Schedules.
-type ScheduleList struct {
-	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata"`
-	Items           []Schedule `json:"items"`
-}

pkg/apis/velero/v1/backup.go

@@ -0,0 +1,230 @@
+/*
+Copyright 2017, 2019 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// BackupSpec defines the specification for a Velero backup.
+type BackupSpec struct {
+	// IncludedNamespaces is a slice of namespace names to include objects
+	// from. If empty, all namespaces are included.
+	IncludedNamespaces []string `json:"includedNamespaces"`
+
+	// ExcludedNamespaces contains a list of namespaces that are not
+	// included in the backup.
+	ExcludedNamespaces []string `json:"excludedNamespaces"`
+
+	// IncludedResources is a slice of resource names to include
+	// in the backup. If empty, all resources are included.
+	IncludedResources []string `json:"includedResources"`
+
+	// ExcludedResources is a slice of resource names that are not
+	// included in the backup.
+	ExcludedResources []string `json:"excludedResources"`
+
+	// LabelSelector is a metav1.LabelSelector to filter with
+	// when adding individual objects to the backup. If empty
+	// or nil, all objects are included. Optional.
+	LabelSelector *metav1.LabelSelector `json:"labelSelector"`
+
+	// SnapshotVolumes specifies whether to take cloud snapshots
+	// of any PV's referenced in the set of objects included
+	// in the Backup.
+	SnapshotVolumes *bool `json:"snapshotVolumes,omitempty"`
+
+	// TTL is a time.Duration-parseable string describing how long
+	// the Backup should be retained for.
+	TTL metav1.Duration `json:"ttl"`
+
+	// IncludeClusterResources specifies whether cluster-scoped resources
+	// should be included for consideration in the backup.
+	IncludeClusterResources *bool `json:"includeClusterResources"`
+
+	// Hooks represent custom behaviors that should be executed at different phases of the backup.
+	Hooks BackupHooks `json:"hooks"`
+
+	// StorageLocation is a string containing the name of a BackupStorageLocation where the backup should be stored.
+	StorageLocation string `json:"storageLocation"`
+
+	// VolumeSnapshotLocations is a list containing names of VolumeSnapshotLocations associated with this backup.
+	VolumeSnapshotLocations []string `json:"volumeSnapshotLocations"`
+}
+
+// BackupHooks contains custom behaviors that should be executed at different phases of the backup.
+type BackupHooks struct {
+	// Resources are hooks that should be executed when backing up individual instances of a resource.
+	Resources []BackupResourceHookSpec `json:"resources"`
+}
+
+// BackupResourceHookSpec defines one or more BackupResourceHooks that should be executed based on
+// the rules defined for namespaces, resources, and label selector.
+type BackupResourceHookSpec struct {
+	// Name is the name of this hook.
+	Name string `json:"name"`
+	// IncludedNamespaces specifies the namespaces to which this hook spec applies. If empty, it applies
+	// to all namespaces.
+	IncludedNamespaces []string `json:"includedNamespaces"`
+	// ExcludedNamespaces specifies the namespaces to which this hook spec does not apply.
+	ExcludedNamespaces []string `json:"excludedNamespaces"`
+	// IncludedResources specifies the resources to which this hook spec applies. If empty, it applies
+	// to all resources.
+	IncludedResources []string `json:"includedResources"`
+	// ExcludedResources specifies the resources to which this hook spec does not apply.
+	ExcludedResources []string `json:"excludedResources"`
+	// LabelSelector, if specified, filters the resources to which this hook spec applies.
+	LabelSelector *metav1.LabelSelector `json:"labelSelector,omitempty"`
+	// PreHooks is a list of BackupResourceHooks to execute prior to storing the item in the backup.
+	// These are executed before any "additional items" from item actions are processed.
+	PreHooks []BackupResourceHook `json:"pre,omitempty"`
+	// PostHooks is a list of BackupResourceHooks to execute after storing the item in the backup.
+	// These are executed after all "additional items" from item actions are processed.
+	PostHooks []BackupResourceHook `json:"post,omitempty"`
+}
+
+// BackupResourceHook defines a hook for a resource.
+type BackupResourceHook struct {
+	// Exec defines an exec hook.
+	Exec *ExecHook `json:"exec"`
+}
+
+// ExecHook is a hook that uses the pod exec API to execute a command in a container in a pod.
+type ExecHook struct {
+	// Container is the container in the pod where the command should be executed. If not specified,
+	// the pod's first container is used.
+	Container string `json:"container"`
+	// Command is the command and arguments to execute.
+	Command []string `json:"command"`
+	// OnError specifies how Velero should behave if it encounters an error executing this hook.
+	OnError HookErrorMode `json:"onError"`
+	// Timeout defines the maximum amount of time Velero should wait for the hook to complete before
+	// considering the execution a failure.
+	Timeout metav1.Duration `json:"timeout"`
+}
+
+// HookErrorMode defines how Velero should treat an error from a hook.
+type HookErrorMode string
+
+const (
+	// HookErrorModeContinue means that an error from a hook is acceptable, and the backup can
+	// proceed.
+	HookErrorModeContinue HookErrorMode = "Continue"
+	// HookErrorModeFail means that an error from a hook is problematic, and the backup should be in
+	// error.
+	HookErrorModeFail HookErrorMode = "Fail"
+)
+
+// BackupPhase is a string representation of the lifecycle phase
+// of a Velero backup.
+type BackupPhase string
+
+const (
+	// BackupPhaseNew means the backup has been created but not
+	// yet processed by the BackupController.
+	BackupPhaseNew BackupPhase = "New"
+
+	// BackupPhaseFailedValidation means the backup has failed
+	// the controller's validations and therefore will not run.
+	BackupPhaseFailedValidation BackupPhase = "FailedValidation"
+
+	// BackupPhaseInProgress means the backup is currently executing.
+	BackupPhaseInProgress BackupPhase = "InProgress"
+
+	// BackupPhaseCompleted means the backup has run successfully without
+	// errors.
+	BackupPhaseCompleted BackupPhase = "Completed"
+
+	// BackupPhasePartiallyFailed means the backup has run to completion
+	// but encountered 1+ errors backing up individual items.
+	BackupPhasePartiallyFailed BackupPhase = "PartiallyFailed"
+
+	// BackupPhaseFailed means the backup ran but encountered an error that
+	// prevented it from completing successfully.
+	BackupPhaseFailed BackupPhase = "Failed"
+
+	// BackupPhaseDeleting means the backup and all its associated data are being deleted.
+	BackupPhaseDeleting BackupPhase = "Deleting"
+)
+
+// BackupStatus captures the current status of a Velero backup.
+type BackupStatus struct {
+	// Version is the backup format version.
+	Version int `json:"version"`
+
+	// Expiration is when this Backup is eligible for garbage-collection.
+	Expiration metav1.Time `json:"expiration"`
+
+	// Phase is the current state of the Backup.
+	Phase BackupPhase `json:"phase"`
+
+	// ValidationErrors is a slice of all validation errors (if
+	// applicable).
+	ValidationErrors []string `json:"validationErrors"`
+
+	// StartTimestamp records the time a backup was started.
+	// Separate from CreationTimestamp, since that value changes
+	// on restores.
+	// The server's time is used for StartTimestamps
+	StartTimestamp metav1.Time `json:"startTimestamp"`
+
+	// CompletionTimestamp records the time a backup was completed.
+	// Completion time is recorded even on failed backups.
+	// Completion time is recorded before uploading the backup object.
+	// The server's time is used for CompletionTimestamps
+	CompletionTimestamp metav1.Time `json:"completionTimestamp"`
+
+	// VolumeSnapshotsAttempted is the total number of attempted
+	// volume snapshots for this backup.
+	VolumeSnapshotsAttempted int `json:"volumeSnapshotsAttempted"`
+
+	// VolumeSnapshotsCompleted is the total number of successfully
+	// completed volume snapshots for this backup.
+	VolumeSnapshotsCompleted int `json:"volumeSnapshotsCompleted"`
+
+	// Warnings is a count of all warning messages that were generated during
+	// execution of the backup. The actual warnings are in the backup's log
+	// file in object storage.
+	Warnings int `json:"warnings"`
+
+	// Errors is a count of all error messages that were generated during
+	// execution of the backup.  The actual errors are in the backup's log
+	// file in object storage.
+	Errors int `json:"errors"`
+}
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// Backup is a Velero resource that respresents the capture of Kubernetes
+// cluster state at a point in time (API objects and associated volume state).
+type Backup struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   BackupSpec   `json:"spec"`
+	Status BackupStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// BackupList is a list of Backups.
+type BackupList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+	Items           []Backup `json:"items"`
+}

pkg/apis/velero/v1/backup_storage_location.go

@@ -0,0 +1,109 @@
+/*
+Copyright 2018 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// BackupStorageLocation is a location where Velero stores backup objects.
+type BackupStorageLocation struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   BackupStorageLocationSpec   `json:"spec"`
+	Status BackupStorageLocationStatus `json:"status"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// BackupStorageLocationList is a list of BackupStorageLocations.
+type BackupStorageLocationList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+	Items           []BackupStorageLocation `json:"items"`
+}
+
+// StorageType represents the type of storage that a backup location uses.
+// ObjectStorage must be non-nil, since it is currently the only supported StorageType.
+type StorageType struct {
+	ObjectStorage *ObjectStorageLocation `json:"objectStorage,omitempty"`
+}
+
+// ObjectStorageLocation specifies the settings necessary to connect to a provider's object storage.
+type ObjectStorageLocation struct {
+	// Bucket is the bucket to use for object storage.
+	Bucket string `json:"bucket"`
+
+	// Prefix is the path inside a bucket to use for Velero storage. Optional.
+	Prefix string `json:"prefix"`
+}
+
+// BackupStorageLocationSpec defines the specification for a Velero BackupStorageLocation.
+type BackupStorageLocationSpec struct {
+	// Provider is the provider of the backup storage.
+	Provider string `json:"provider"`
+
+	// Config is for provider-specific configuration fields.
+	Config map[string]string `json:"config"`
+
+	StorageType `json:",inline"`
+
+	// AccessMode defines the permissions for the backup storage location.
+	AccessMode BackupStorageLocationAccessMode `json:"accessMode,omitempty"`
+}
+
+// BackupStorageLocationPhase is the lifecyle phase of a Velero BackupStorageLocation.
+type BackupStorageLocationPhase string
+
+const (
+	// BackupStorageLocationPhaseAvailable means the location is available to read and write from.
+	BackupStorageLocationPhaseAvailable BackupStorageLocationPhase = "Available"
+
+	// BackupStorageLocationPhaseUnavailable means the location is unavailable to read and write from.
+	BackupStorageLocationPhaseUnavailable BackupStorageLocationPhase = "Unavailable"
+)
+
+// BackupStorageLocationAccessMode represents the permissions for a BackupStorageLocation.
+type BackupStorageLocationAccessMode string
+
+const (
+	// BackupStorageLocationAccessModeReadOnly represents read-only access to a BackupStorageLocation.
+	BackupStorageLocationAccessModeReadOnly BackupStorageLocationAccessMode = "ReadOnly"
+
+	// BackupStorageLocationAccessModeReadWrite represents read and write access to a BackupStorageLocation.
+	BackupStorageLocationAccessModeReadWrite BackupStorageLocationAccessMode = "ReadWrite"
+)
+
+// TODO(2.0): remove the AccessMode field from BackupStorageLocationStatus.
+
+// BackupStorageLocationStatus describes the current status of a Velero BackupStorageLocation.
+type BackupStorageLocationStatus struct {
+	Phase              BackupStorageLocationPhase `json:"phase,omitempty"`
+	LastSyncedRevision types.UID                  `json:"lastSyncedRevision,omitempty"`
+	LastSyncedTime     metav1.Time                `json:"lastSyncedTime,omitempty"`
+
+	// AccessMode is an unused field.
+	//
+	// Deprecated: there is now an AccessMode field on the Spec and this field
+	// will be removed entirely as of v2.0.
+	AccessMode BackupStorageLocationAccessMode `json:"accessMode,omitempty"`
+}

pkg/apis/velero/v1/constants.go

@@ -0,0 +1,39 @@
+/*
+Copyright 2017 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+const (
+	// DefaultNamespace is the Kubernetes namespace that is used by default for
+	// the Velero server and API objects.
+	DefaultNamespace = "velero"
+
+	// ResourcesDir is a top-level directory expected in backups which contains sub-directories
+	// for each resource type in the backup.
+	ResourcesDir = "resources"
+
+	// MetadataDir is a top-level directory expected in backups which contains
+	// files that store metadata about the backup, such as the backup version.
+	MetadataDir = "metadata"
+
+	// ClusterScopedDir is the name of the directory containing cluster-scoped
+	// resources within a Velero backup.
+	ClusterScopedDir = "cluster"
+
+	// NamespaceScopedDir is the name of the directory containing namespace-scoped
+	// resource within a Velero backup.
+	NamespaceScopedDir = "namespaces"
+)

pkg/apis/velero/v1/delete_backup_request.go

@@ -0,0 +1,65 @@
+/*
+Copyright 2018 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+// DeleteBackupRequestSpec is the specification for which backups to delete.
+type DeleteBackupRequestSpec struct {
+	BackupName string `json:"backupName"`
+}
+
+// DeleteBackupRequestPhase represents the lifecycle phase of a DeleteBackupRequest.
+type DeleteBackupRequestPhase string
+
+const (
+	// DeleteBackupRequestPhaseNew means the DeleteBackupRequest has not been processed yet.
+	DeleteBackupRequestPhaseNew DeleteBackupRequestPhase = "New"
+	// DeleteBackupRequestPhaseInProgress means the DeleteBackupRequest is being processed.
+	DeleteBackupRequestPhaseInProgress DeleteBackupRequestPhase = "InProgress"
+	// DeleteBackupRequestPhaseProcessed means the DeleteBackupRequest has been processed.
+	DeleteBackupRequestPhaseProcessed DeleteBackupRequestPhase = "Processed"
+)
+
+// DeleteBackupRequestStatus is the current status of a DeleteBackupRequest.
+type DeleteBackupRequestStatus struct {
+	// Phase is the current state of the DeleteBackupRequest.
+	Phase DeleteBackupRequestPhase `json:"phase"`
+	// Errors contains any errors that were encountered during the deletion process.
+	Errors []string `json:"errors"`
+}
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// DeleteBackupRequest is a request to delete one or more backups.
+type DeleteBackupRequest struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   DeleteBackupRequestSpec   `json:"spec"`
+	Status DeleteBackupRequestStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// DeleteBackupRequestList is a list of DeleteBackupRequests.
+type DeleteBackupRequestList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+	Items           []DeleteBackupRequest `json:"items"`
+}

pkg/apis/velero/v1/doc.go

@@ -0,0 +1,21 @@
+/*
+Copyright 2017 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// +k8s:deepcopy-gen=package
+
+// Package v1 is the v1 version of the API.
+// +groupName=velero.io
+package v1

pkg/apis/velero/v1/download_request.go

@@ -1,5 +1,5 @@
 /*
-Copyright 2017 Heptio Inc.
+Copyright 2017 the Velero contributors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -28,9 +28,12 @@ type DownloadRequestSpec struct {
 type DownloadTargetKind string
 
 const (
-	DownloadTargetKindBackupLog      DownloadTargetKind = "BackupLog"
-	DownloadTargetKindBackupContents DownloadTargetKind = "BackupContents"
-	DownloadTargetKindRestoreLog     DownloadTargetKind = "RestoreLog"
+	DownloadTargetKindBackupLog             DownloadTargetKind = "BackupLog"
+	DownloadTargetKindBackupContents        DownloadTargetKind = "BackupContents"
+	DownloadTargetKindBackupVolumeSnapshots DownloadTargetKind = "BackupVolumeSnapshots"
+	DownloadTargetKindBackupResourceList    DownloadTargetKind = "BackupResourceList"
+	DownloadTargetKindRestoreLog            DownloadTargetKind = "RestoreLog"
+	DownloadTargetKindRestoreResults        DownloadTargetKind = "RestoreResults"
 )
 
 // DownloadTarget is the specification for what kind of file to download, and the name of the
@@ -64,7 +67,8 @@ type DownloadRequestStatus struct {
 	Expiration metav1.Time `json:"expiration"`
 }
 
-// +genclient=true
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // DownloadRequest is a request to download an artifact from backup object storage, such as a backup
 // log file.
@@ -76,6 +80,8 @@ type DownloadRequest struct {
 	Status DownloadRequestStatus `json:"status,omitempty"`
 }
 
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
 // DownloadRequestList is a list of DownloadRequests.
 type DownloadRequestList struct {
 	metav1.TypeMeta `json:",inline"`

pkg/apis/velero/v1/labels_annotations.go

@@ -0,0 +1,50 @@
+/*
+Copyright 2018 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+const (
+	// BackupNameLabel is the label key used to identify a backup by name.
+	BackupNameLabel = "velero.io/backup-name"
+
+	// BackupUIDLabel is the label key used to identify a backup by uid.
+	BackupUIDLabel = "velero.io/backup-uid"
+
+	// RestoreNameLabel is the label key used to identify a restore by name.
+	RestoreNameLabel = "velero.io/restore-name"
+
+	// ScheduleNameLabel is the label key used to identify a schedule by name.
+	ScheduleNameLabel = "velero.io/schedule-name"
+
+	// RestoreUIDLabel is the label key used to identify a restore by uid.
+	RestoreUIDLabel = "velero.io/restore-uid"
+
+	// PodUIDLabel is the label key used to identify a pod by uid.
+	PodUIDLabel = "velero.io/pod-uid"
+
+	// PodVolumeOperationTimeoutAnnotation is the annotation key used to apply
+	// a backup/restore-specific timeout value for pod volume operations (i.e.
+	// restic backups/restores).
+	PodVolumeOperationTimeoutAnnotation = "velero.io/pod-volume-timeout"
+
+	// StorageLocationLabel is the label key used to identify the storage
+	// location of a backup.
+	StorageLocationLabel = "velero.io/storage-location"
+
+	// ResticVolumeNamespaceLabel is the label key used to identify which
+	// namespace a restic repository stores pod volume backups for.
+	ResticVolumeNamespaceLabel = "velero.io/volume-namespace"
+)

pkg/apis/velero/v1/pod_volume_backup.go

@@ -0,0 +1,103 @@
+/*
+Copyright 2018 the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	corev1api "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// PodVolumeBackupSpec is the specification for a PodVolumeBackup.
+type PodVolumeBackupSpec struct {
+	// Node is the name of the node that the Pod is running on.
+	Node string `json:"node"`
+
+	// Pod is a reference to the pod containing the volume to be backed up.
+	Pod corev1api.ObjectReference `json:"pod"`
+
+	// Volume is the name of the volume within the Pod to be backed
+	// up.
+	Volume string `json:"volume"`
+
+	// BackupStorageLocation is the name of the backup storage location
+	// where the restic repository is stored.
+	BackupStorageLocation string `json:"backupStorageLocation"`
+
+	// RepoIdentifier is the restic repository identifier.
+	RepoIdentifier string `json:"repoIdentifier"`
+
+	// Tags are a map of key-value pairs that should be applied to the
+	// volume backup as tags.
+	Tags map[string]string `json:"tags"`
+}
+
+// PodVolumeBackupPhase represents the lifecycle phase of a PodVolumeBackup.
+type PodVolumeBackupPhase string
+
+const (
+	PodVolumeBackupPhaseNew        PodVolumeBackupPhase = "New"
+	PodVolumeBackupPhaseInProgress PodVolumeBackupPhase = "InProgress"
+	PodVolumeBackupPhaseCompleted  PodVolumeBackupPhase = "Completed"
+	PodVolumeBackupPhaseFailed     PodVolumeBackupPhase = "Failed"
+)
+
+// PodVolumeBackupStatus is the current status of a PodVolumeBackup.
+type PodVolumeBackupStatus struct {
+	// Phase is the current state of the PodVolumeBackup.
+	Phase PodVolumeBackupPhase `json:"phase"`
+
+	// Path is the full path within the controller pod being backed up.
+	Path string `json:"path"`
+
+	// SnapshotID is the identifier for the snapshot of the pod volume.
+	SnapshotID string `json:"snapshotID"`
+
+	// Message is a message about the pod volume backup's status.
+	Message string `json:"message"`
+
+	// StartTimestamp records the time a backup was started.
+	// Separate from CreationTimestamp, since that value changes
+	// on restores.
+	// The server's time is used for StartTimestamps
+	StartTimestamp metav1.Time `json:"startTimestamp"`
+
+	// CompletionTimestamp records the time a backup was completed.
+	// Completion time is recorded even on failed backups.
+	// Completion time is recorded before uploading the backup object.
+	// The server's time is used for CompletionTimestamps
+	CompletionTimestamp metav1.Time `json:"completionTimestamp"`
+}
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+type PodVolumeBackup struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec   PodVolumeBackupSpec   `json:"spec"`
+	Status PodVolumeBackupStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// PodVolumeBackupList is a list of PodVolumeBackups.
+type PodVolumeBackupList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+	Items           []PodVolumeBackup `json:"items"`
+}