diff --git a/.gitignore b/.gitignore index ce7f78aa7..983475a64 100644 --- a/.gitignore +++ b/.gitignore @@ -38,14 +38,8 @@ Tiltfile .vscode *.diff -# Jekyll compiled data -site/_site -site/.sass-cache -site/.jekyll -site/.jekyll-metadata -site/.jekyll-cache -site/.bundle -site/vendor -.ruby-version +# Hugo compiled data +site/public +site/resources .vs diff --git a/Makefile b/Makefile index e31140500..22154ad3d 100644 --- a/Makefile +++ b/Makefile @@ -36,6 +36,8 @@ BUILDER_IMAGE_TAG := $(shell git log -1 --pretty=%h hack/build-image/Dockerfile) BUILDER_IMAGE := $(REGISTRY)/build-image:$(BUILDER_IMAGE_TAG) BUILDER_IMAGE_CACHED := $(shell docker images -q ${BUILDER_IMAGE} 2>/dev/null ) +HUGO_IMAGE := hugo-builder + # 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. @@ -264,6 +266,9 @@ push-build-image: @# credentials needed to accomplish this. docker push $(BUILDER_IMAGE) +build-image-hugo: + cd site && docker build --pull -t $(HUGO_IMAGE) . + clean: # if we have a cached image then use it to run go clean --modcache # this test checks if we there is an image id in the BUILDER_IMAGE_CACHED variable. @@ -272,6 +277,7 @@ ifneq ($(strip $(BUILDER_IMAGE_CACHED)),) docker rmi -f $(BUILDER_IMAGE) || true endif rm -rf .go _output + docker rmi $(HUGO_IMAGE) .PHONY: modules @@ -314,14 +320,13 @@ release: PUBLISH=$(PUBLISH) \ ./hack/goreleaser.sh'" -serve-docs: +serve-docs: build-image-hugo docker run \ --rm \ - -v "$$(pwd)/site:/srv/jekyll" \ - -it -p 4000:4000 \ - jekyll/jekyll \ - jekyll serve --livereload --incremental - + -v "$$(pwd)/site:/srv/hugo" \ + -it -p 1313:1313 \ + $(HUGO_IMAGE) \ + hugo server --bind=0.0.0.0 --enableGitInfo=false # 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 @@ -333,7 +338,7 @@ serve-docs: # 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 +# 6. Update site/config.yaml 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 diff --git a/changelogs/unreleased/2720-tbatard b/changelogs/unreleased/2720-tbatard new file mode 100644 index 000000000..65bba985b --- /dev/null +++ b/changelogs/unreleased/2720-tbatard @@ -0,0 +1 @@ +Migrate site from Jekyll to Hugo \ No newline at end of file diff --git a/hack/gen-docs.sh b/hack/gen-docs.sh index 1a508aefd..664e0bb1c 100755 --- a/hack/gen-docs.sh +++ b/hack/gen-docs.sh @@ -1,6 +1,6 @@ #!/bin/bash -# Copyright 2019 the Velero contributors. +# Copyright 2020 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,88 +21,94 @@ set -o errexit set -o nounset set -o pipefail +DOCS_DIRECTORY=site/content/docs +DATA_DOCS_DIRECTORY=site/data/docs +CONFIG_FILE=site/config.yaml +MAIN_BRANCH=main + # 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" +if [[ -d $DOCS_DIRECTORY/$NEW_DOCS_VERSION ]]; then + echo "ERROR: $DOCS_DIRECTORY/$NEW_DOCS_VERSION already exists" exit 1 fi -# get the alphabetically last item in site/docs to use as PREVIOUS_DOCS_VERSION +# get the alphabetically last item in $DOCS_DIRECTORY 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) + PREVIOUS_DOCS_VERSION=$(ls -1 $DOCS_DIRECTORY/ | 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}/ +echo "Creating copy of docs directory $DOCS_DIRECTORY/$PREVIOUS_DOCS_VERSION in $DOCS_DIRECTORY/$NEW_DOCS_VERSION" +cp -r $DOCS_DIRECTORY/${PREVIOUS_DOCS_VERSION}/ $DOCS_DIRECTORY/${NEW_DOCS_VERSION}/ -# 'git add' the previous version's docs as-is so we get a useful diff when we copy the main docs in +# 'git add' the previous version's docs as-is so we get a useful diff when we copy the $MAIN_BRANCH 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} +git add -f $DOCS_DIRECTORY/${NEW_DOCS_VERSION} -# now copy the contents of site/docs/main into the same directory so we can get a nice +# now copy the contents of $DOCS_DIRECTORY/$MAIN_BRANCH into the same directory so we can get a nice # git diff of what changed since previous version -echo "Copying site/docs/main/ to site/docs/${NEW_DOCS_VERSION}/" -rm -rf site/docs/${NEW_DOCS_VERSION}/ && cp -r site/docs/main/ site/docs/${NEW_DOCS_VERSION}/ +echo "Copying $DOCS_DIRECTORY/$MAIN_BRANCH/ to $DOCS_DIRECTORY/${NEW_DOCS_VERSION}/" +rm -rf $DOCS_DIRECTORY/${NEW_DOCS_VERSION}/ && cp -r $DOCS_DIRECTORY/$MAIN_BRANCH/ $DOCS_DIRECTORY/${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 +echo "Creating copy of $DATA_DOCS_DIRECTORY/$PREVIOUS_DOCS_TOC.yml at $DATA_DOCS_DIRECTORY/$NEW_DOCS_TOC.yml" +cp $DATA_DOCS_DIRECTORY/$PREVIOUS_DOCS_TOC.yml $DATA_DOCS_DIRECTORY/$NEW_DOCS_TOC.yml -# 'git add' the previous version's ToC content as-is so we get a useful diff when we copy the main ToC in +# 'git add' the previous version's ToC content as-is so we get a useful diff when we copy the $MAIN_BRANCH 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 +git add $DATA_DOCS_DIRECTORY/$NEW_DOCS_TOC.yml -# now copy the main ToC so we can get a nice git diff of what changed since previous version -echo "Copying site/_data/main-toc.yml to site/_data/$NEW_DOCS_TOC.yml" -rm site/_data/$NEW_DOCS_TOC.yml && cp site/_data/main-toc.yml site/_data/$NEW_DOCS_TOC.yml +# now copy the $MAIN_BRANCH ToC so we can get a nice git diff of what changed since previous version +echo "Copying $DATA_DOCS_DIRECTORY/$MAIN_BRANCH-toc.yml to $DATA_DOCS_DIRECTORY/$NEW_DOCS_TOC.yml" +rm $DATA_DOCS_DIRECTORY/$NEW_DOCS_TOC.yml && cp $DATA_DOCS_DIRECTORY/$MAIN_BRANCH-toc.yml $DATA_DOCS_DIRECTORY/$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/main|https://velero.io/docs/$VELERO_VERSION|g" - find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://github.com/vmware-tanzu/velero/blob/main|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g" + find $DOCS_DIRECTORY/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://velero.io/docs/$MAIN_BRANCH|https://velero.io/docs/$VELERO_VERSION|g" + find $DOCS_DIRECTORY/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://github.com/vmware-tanzu/velero/blob/$MAIN_BRANCH|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g" + find $DOCS_DIRECTORY/${NEW_DOCS_VERSION} -type f -name "_index.md" | xargs sed -i '' "s|version: $MAIN_BRANCH|version: $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 + echo "[OS X] Updating latest version in $CONFIG_FILE" + sed -i '' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" $CONFIG_FILE # 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 '' "/- main/a\\ -- ${NEW_DOCS_VERSION} -" site/_config.yml + echo "[OS X] Adding latest version to versions list in $CONFIG_FILE" + sed -i '' "/- $MAIN_BRANCH/a\\ +\ \ \ \ - ${NEW_DOCS_VERSION} +" $CONFIG_FILE echo "[OS X] Adding ToC mapping entry" - sed -i '' "/main: main-toc/a\\ + sed -i '' "/$MAIN_BRANCH: $MAIN_BRANCH-toc/a\\ ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC} -" site/_data/toc-mapping.yml +" $DATA_DOCS_DIRECTORY/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/main|https://velero.io/docs/$VELERO_VERSION|g" - find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://github.com/vmware-tanzu/velero/blob/main|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g" + find $DOCS_DIRECTORY/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://velero.io/docs/$MAIN_BRANCH|https://velero.io/docs/$VELERO_VERSION|g" + find $DOCS_DIRECTORY/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://github.com/vmware-tanzu/velero/blob/$MAIN_BRANCH|https://github.com/vmware-tanzu/velero/blob/$VELERO_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] Updating latest version in $CONFIG_FILE" + sed -i'' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" $CONFIG_FILE - echo "[Linux] Adding latest version to versions list in _config.yml" - sed -i'' "/- main/a - ${NEW_DOCS_VERSION}" site/_config.yml + echo "[Linux] Adding latest version to versions list in $CONFIG_FILE" + sed -i'' "/- $MAIN_BRANCH/a - ${NEW_DOCS_VERSION}" $CONFIG_FILE echo "[Linux] Adding ToC mapping entry" - sed -i'' "/main: main-toc/a ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}" site/_data/toc-mapping.yml + sed -i'' "/$MAIN_BRANCH: $MAIN_BRANCH-toc/a ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}" $DATA_DOCS_DIRECTORY/toc-mapping.yml fi -echo "Success! site/docs/$NEW_DOCS_VERSION has been created." +echo "Success! $DOCS_DIRECTORY/$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 " 1. Consult site/README-HUGO.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'." diff --git a/netlify.toml b/netlify.toml index 759cf11f7..834f7dacf 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,10 +1,12 @@ [build] base = "site/" - command = "jekyll build" - publish = "site/_site" + command = "hugo --gc --minify --baseURL $BASE_URL" + publish = "site/public" -# Using the * -> :splat rule should redirect anything under master to the matching file under main -[[redirects]] - from = "/docs/master/*" - to = "/docs/main/:splat" +[context.production.environment] + HUGO_VERSION = "0.73.0" + BASE_URL = "https://velero.io" +[context.deploy-preview.environment] + HUGO_VERSION = "0.73.0" + BASE_URL = "https://deploy-preview-2720--velero.netlify.app" \ No newline at end of file diff --git a/site/Dockerfile b/site/Dockerfile new file mode 100644 index 000000000..0915036ac --- /dev/null +++ b/site/Dockerfile @@ -0,0 +1,9 @@ +FROM ubuntu:20.04 + +RUN apt update +RUN apt install -y hugo + +WORKDIR /srv/hugo + +EXPOSE 1313 + diff --git a/site/Gemfile b/site/Gemfile deleted file mode 100644 index 8baea09e7..000000000 --- a/site/Gemfile +++ /dev/null @@ -1,12 +0,0 @@ -source 'https://rubygems.org' -gem 'jekyll', '~> 4.1.0' -gem 'jekyll-feed', '~> 0.13.0' -gem 'jekyll-optional-front-matter', '~> 0.3.2' -gem 'jekyll-paginate', '~> 1.1' -gem 'jekyll-readme-index', '~> 0.3.0' -gem 'jekyll-redirect-from', '~> 0.16.0' -gem 'jekyll-relative-links', '~> 0.6.1' -gem 'jekyll-sitemap', '~> 1.4' -gem 'jekyll-titles-from-headings', '~> 0.5.3' -gem 'jekyll-seo-tag', '~> 2.6', '>= 2.6.1' -gem 'jemoji' diff --git a/site/Gemfile.lock b/site/Gemfile.lock deleted file mode 100644 index d317325e8..000000000 --- a/site/Gemfile.lock +++ /dev/null @@ -1,116 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (6.0.3.1) - concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (>= 0.7, < 2) - minitest (~> 5.1) - tzinfo (~> 1.1) - zeitwerk (~> 2.2, >= 2.2.2) - addressable (2.7.0) - public_suffix (>= 2.0.2, < 5.0) - colorator (1.1.0) - concurrent-ruby (1.1.6) - em-websocket (0.5.1) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) - eventmachine (1.2.7) - ffi (1.13.1) - forwardable-extended (2.6.0) - gemoji (3.0.1) - html-pipeline (2.13.0) - activesupport (>= 2) - nokogiri (>= 1.4) - http_parser.rb (0.6.0) - i18n (1.8.3) - concurrent-ruby (~> 1.0) - jekyll (4.1.0) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 1.0) - jekyll-sass-converter (~> 2.0) - jekyll-watch (~> 2.0) - kramdown (~> 2.1) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (~> 0.4.0) - pathutil (~> 0.9) - rouge (~> 3.0) - safe_yaml (~> 1.0) - terminal-table (~> 1.8) - jekyll-feed (0.13.0) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) - jekyll-redirect-from (0.16.0) - jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-sass-converter (2.1.0) - sassc (> 2.0.1, < 3.0) - jekyll-seo-tag (2.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - jemoji (0.12.0) - gemoji (~> 3.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0, < 5.0) - kramdown (2.3.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.3) - listen (3.2.1) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.4.0) - mini_portile2 (2.4.0) - minitest (5.14.1) - nokogiri (1.10.9) - mini_portile2 (~> 2.4.0) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (4.0.5) - rb-fsevent (0.10.4) - rb-inotify (0.10.1) - ffi (~> 1.0) - rexml (3.2.4) - rouge (3.20.0) - safe_yaml (1.0.5) - sassc (2.4.0) - ffi (~> 1.9) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - tzinfo (1.2.7) - thread_safe (~> 0.1) - unicode-display_width (1.7.0) - zeitwerk (2.3.0) - -PLATFORMS - ruby - -DEPENDENCIES - jekyll (~> 4.1.0) - jekyll-feed (~> 0.13.0) - jekyll-optional-front-matter (~> 0.3.2) - jekyll-paginate (~> 1.1) - jekyll-readme-index (~> 0.3.0) - jekyll-redirect-from (~> 0.16.0) - jekyll-relative-links (~> 0.6.1) - jekyll-seo-tag (~> 2.6, >= 2.6.1) - jekyll-sitemap (~> 1.4) - jekyll-titles-from-headings (~> 0.5.3) - jemoji - -BUNDLED WITH - 2.1.4 diff --git a/site/README-HUGO.md b/site/README-HUGO.md new file mode 100644 index 000000000..d384a57f3 --- /dev/null +++ b/site/README-HUGO.md @@ -0,0 +1,46 @@ +# Running in Docker + +To run this site in a Docker container, you can use `make serve-docs` from the root directory. + +# Dependencies for MacOS + +Install the following for an easy to use dev environment: + +* `brew install hugo` + +# Dependencies for Linux +If you are running a build on Ubuntu you will need the following packages: +* hugo + + +# Local Development +1. Clone down your own fork, or clone the main repo `git clone https://github.com/vmware-tanzu/velero` and add your own remote. +1. `cd velero/site` +1. Serve the site and watch for markup/sass changes `hugo serve`. +1. View your website at http://127.0.0.1:1313/ +1. Commit any changes and push everything to your fork. +1. Once you're ready, submit a PR of your changes. Netlify will automatically generate a preview of your changes. + +# Jetbrains IDE setup (IntelliJ, Goland, etc) +1. Install the `Hugo Integration` plugin: https://plugins.jetbrains.com/plugin/13215-hugo-integration + - Under `Preferences...` -> `Plugins` +1. Create a new configuration: + - Click `Edit Configurations...` + - Click the `+` button to create a new configuration and select `Hugo` + - Select `hugo serve` and make sure it is running under the `site` directory + - Save and run the new Configuration + - View your website at http://127.0.0.1:1313/ + - Any changes in `site` will reload the website automatically + +# Adding a New Docs Version + +To add a new set of versioned docs to go with a new Velero release: + +1. In the root of the repository, run: + + ```bash + # set to the appropriate version numbers + NEW_DOCS_VERSION=vX.Y VELERO_VERSION=vX.Y.Z make gen-docs + ``` + +1. [Pre-release only] In `site/config.yaml`, revert the change to the `latest` field, so the pre-release docs do not become the default. diff --git a/site/README-JEKYLL.md b/site/README-JEKYLL.md deleted file mode 100644 index 413ccdf62..000000000 --- a/site/README-JEKYLL.md +++ /dev/null @@ -1,49 +0,0 @@ -# Running in Docker - -To run this site in a Docker container, you can use `make serve-docs` from the root directory. - -# Dependencies for MacOS - -Install the following for an easy to use dev environment: - -* `brew install rbenv` -* `rbenv install 2.6.3` -* `gem install bundler` - -# Dependencies for Linux -If you are running a build on Ubuntu you will need the following packages: -* ruby -* ruby-dev -* ruby-bundler -* build-essential -* zlib1g-dev -* nginx (or apache2) - - -# Local Development -1. Install Jekyll and plug-ins in one fell swoop. `gem install github-pages` -This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc. -2. Clone down your own fork, or clone the main repo `git clone https://github.com/vmware-tanzu/velero` and add your own remote. -3. `cd velero/site` -4. `rbenv local 2.6.3` -5. `bundle install` -6. Serve the site and watch for markup/sass changes `jekyll serve --livereload --incremental`. You may need to run `bundle exec jekyll serve --livereload --incremental`. -7. View your website at http://127.0.0.1:4000/ -8. Commit any changes and push everything to your fork. -9. Once you're ready, submit a PR of your changes. Netlify will automatically generate a preview of your changes. - - -# Adding a New Docs Version - -To add a new set of versioned docs to go with a new Velero release: - -1. In the root of the repository, run: - - ```bash - # set to the appropriate version numbers - NEW_DOCS_VERSION=vX.Y VELERO_VERSION=vX.Y.Z make gen-docs - ``` - -1. In `site/_config.yml`, under the `defaults` field, add an entry for the new version just under `main` by copying the most recent version's entry and updating the version numbers. - -1. [Pre-release only] In `site/_config.yml`, revert the change to the `latest` field, so the pre-release docs do not become the default. diff --git a/site/_config.yml b/site/_config.yml deleted file mode 100644 index 1752e0b94..000000000 --- a/site/_config.yml +++ /dev/null @@ -1,233 +0,0 @@ -# Site settings -title: Velero -email: -author: Velero Authors -description: Backup and migrate Kubernetes resources and persistent volumes -#url: velero.io -logo: Velero.svg -twitter: - username: projectvelero - card: summary -vm_logo: vm-logo.png -gh_repo: https://github.com/vmware-tanzu/velero -markdown: kramdown -hero: - background-color: med-blue -footer: - title: Getting Started - content: To help you get started, see the documentation. - cta_title: '' - cta_url: /docs - cta_text: Documentation - vm-link: http://vmware.github.io/ - -footer_social_links: - Twitter: - fa_icon: fab fa-twitter - url: https://twitter.com/projectvelero - Slack: - fa_icon: fab fa-slack - url: https://kubernetes.slack.com/messages/velero - Google Groups: - fa_icon: fas fa-users - url: https://groups.google.com/forum/#!forum/projectvelero - RSS: - fa_icon: fa fa-rss - url: feed.xml - GitHub: - fa_icon: fab fa-github - url: https://github.com/vmware-tanzu/velero - -defaults: - - scope: - path: "" # an empty string here means all files in the project - type: "posts" - values: - layout: "posts" - - scope: - path: "" - type: "pages" - values: - layout: "default" - - scope: - path: docs/main - values: - version: main - gh: https://github.com/vmware-tanzu/velero/tree/main - layout: "docs" - - scope: - path: docs/v1.4 - values: - version: v1.4 - gh: https://github.com/vmware-tanzu/velero/tree/v1.4.0 - layout: "docs" - - scope: - path: docs/v1.3.2 - values: - version: v1.3.2 - gh: https://github.com/vmware-tanzu/velero/tree/v1.3.2 - layout: "docs" - - scope: - path: docs/v1.3.1 - values: - version: v1.3.1 - gh: https://github.com/vmware-tanzu/velero/tree/v1.3.1 - layout: "docs" - - scope: - path: docs/v1.3.0 - values: - version: v1.3.0 - gh: https://github.com/vmware-tanzu/velero/tree/v1.3.0 - layout: "docs" - - scope: - path: docs/v1.2.0 - values: - version: v1.2.0 - gh: https://github.com/vmware-tanzu/velero/tree/v1.2.0 - layout: "docs" - - scope: - path: docs/v1.1.0 - values: - version: v1.1.0 - gh: https://github.com/vmware-tanzu/velero/tree/v1.1.0 - layout: "docs" - - scope: - path: docs/v1.0.0 - values: - version: v1.0.0 - gh: https:/github.com/vmware-tanzu/velero/tree/v1.0.0 - layout: "docs" - - scope: - path: docs/v0.11.0 - values: - version: v0.11.0 - gh: https:/github.com/vmware-tanzu/velero/tree/v0.11.0 - layout: "docs" - - scope: - path: docs/v0.10.0 - values: - version: v0.10.0 - gh: https:/github.com/vmware-tanzu/velero/tree/v0.10.0 - layout: "docs" - - scope: - path: docs/v0.9.0 - values: - version: v0.9.0 - gh: https:/github.com/vmware-tanzu/velero/tree/v0.9.0 - layout: "docs" - - scope: - path: docs/v0.8.1 - values: - version: v0.8.1 - gh: https:/github.com/vmware-tanzu/velero/tree/v0.8.1 - layout: "docs" - - scope: - path: docs/v0.8.0 - values: - version: v0.8.0 - gh: https:/github.com/vmware-tanzu/velero/tree/v0.8.0 - layout: "docs" - - scope: - path: docs/v0.7.1 - values: - version: v0.7.1 - gh: https://github.com/vmware-tanzu/velero/tree/v0.7.1 - layout: "docs" - - scope: - path: docs/v0.7.0 - values: - version: v0.7.0 - gh: https://github.com/vmware-tanzu/velero/tree/v0.7.0 - layout: "docs" - - scope: - path: docs/v0.6.0 - values: - version: v0.6.0 - gh: https://github.com/vmware-tanzu/velero/tree/v0.6.0 - layout: "docs" - - scope: - path: docs/v0.5.0 - values: - version: v0.5.0 - gh: https://github.com/vmware-tanzu/velero/tree/v0.5.0 - layout: "docs" - - scope: - path: docs/v0.4.0 - values: - version: v0.4.0 - gh: https://github.com/vmware-tanzu/velero/tree/v0.4.0 - layout: "docs" - - scope: - path: docs/v0.3.0 - values: - version: v0.3.0 - gh: https://github.com/vmware-tanzu/velero/tree/v0.3.0 - layout: "docs" - -page_gen: - - data: shortlinks - template: redirect - name: key - dir: docs - -collections: - - contributors - - casestudies - - plugin-list - -versioning: true -latest: v1.4 -versions: -- main -- v1.4 -- v1.3.2 -- v1.3.1 -- v1.3.0 -- v1.2.0 -- v1.1.0 -- v1.0.0 -- v0.11.0 -- v0.10.0 -- v0.9.0 -- v0.8.1 -- v0.8.0 -- v0.7.1 -- v0.7.0 -- v0.6.0 -- v0.5.0 -- v0.4.0 -- v0.3.0 - -# Build settings -permalink: /blog/:title/ -sass: - sass_dir: css - style: :compressed - -# Use the following plug-ins -plugins: - - jekyll-readme-index # use README.md as index.html - - jekyll-sitemap # Create a sitemap using the official Jekyll sitemap gem - - jekyll-feed # Create an Atom feed using the official Jekyll feed gem - - jekyll-relative-links # Used to auto generate md links to html links - - jekyll-optional-front-matter # Parse Markdown files that do not have front-matter callouts - - jekyll-titles-from-headings # pull the page title from the first Markdown heading when none is specified. - - jekyll-paginate # pagination object for collections (e.g. posts) - - jekyll-redirect-from - - jekyll-seo-tag - - jemoji - -# Include these subdirectories -include: - - CONTRIBUTING.md - - README.md - -# Exclude these files from your production _site -exclude: - - Gemfile - - Gemfile.lock - - README-JEKYLL.md - - LICENSE - - CNAME - - Runbook.docx - - '*.sh' diff --git a/site/_data/new-IA.yml b/site/_data/new-IA.yml deleted file mode 100644 index d22230805..000000000 --- a/site/_data/new-IA.yml +++ /dev/null @@ -1,48 +0,0 @@ -toc: - - title: Introduction - subfolderitems: - - page: About Ark - url: /index.html - - page: Getting started - url: /quickstart - - page: How Ark works - url: /about - - title: Run Ark - subfolderitems: - - page: Create a backup - url: /run-backup - - page: Restore from backup - url: /restore - - title: Customize Ark - subfolderitems: - - page: Build from source - url: /build-from-scratch - - page: Extend - url: /extend - - page: Extend with plugins - url: /plugins - - page: Extend with hooks - url: /hooks - - title: Reference - subfolderitems: - - page: Backup file format - url: /output-file-format - - page: API types - url: /api-types - - title: Tutorials - subfolderitems: - - page: Disaster Recovery - url: /use-cases - - page: Cluster migration - url: /use-cases.html#cluster-migration - - title: Troubleshooting - subfolderitems: - - page: Troubleshooting - url: /troubleshooting - - page: Troubleshoot an install or setup - url: /debugging-install - - page: Troubleshoot a backup delete - url: /debugging-deletes - - page: Troubleshoot a restore - url: /debugging-restores - diff --git a/site/_data/shortlinks.yml b/site/_data/shortlinks.yml deleted file mode 100644 index 10d335da1..000000000 --- a/site/_data/shortlinks.yml +++ /dev/null @@ -1,24 +0,0 @@ -- title: Troubleshooting - key: troubleshooting - destination: troubleshooting -- title: Supported Providers - key: supported-providers - destination: supported-providers -- title: ZenHub - key: zenhub - destination: zenhub -- title: Install Overview - key: install-overview - destination: basic-install -- title: Start Contributing - key: start-contributing - destination: start-contributing -- title: Customize Installation - key: customize-installation - destination: customize-installation -- title: Frequently Asked Questions - key: faq - destination: faq -- title: Container Storage Interface Snapshot Support in Velero - key: csi - destination: csi diff --git a/site/_includes/blog-posts-tag.html b/site/_includes/blog-posts-tag.html deleted file mode 100644 index 6b444bf79..000000000 --- a/site/_includes/blog-posts-tag.html +++ /dev/null @@ -1,13 +0,0 @@ -
-{% for post in site.tags[page.tag] %} - {% include blog-post-card.html %} - {% if limit > 0 and forloop.index >= limit %} - {% break %} - {% endif %} - {% assign row = forloop.index | modulo: 3 %} - {% if row == 0 %} -
-
- {% endif %} -{% endfor %} -
diff --git a/site/_includes/blog-posts.html b/site/_includes/blog-posts.html deleted file mode 100644 index a088202a6..000000000 --- a/site/_includes/blog-posts.html +++ /dev/null @@ -1,13 +0,0 @@ -
-{% for post in site.posts %} - {% include blog-post-card.html %} - {% if limit > 0 and forloop.index >= limit %} - {% break %} - {% endif %} - {% assign row = forloop.index | modulo: 3 %} -{% if row == 0 %} -
-
-{% endif %} -{% endfor %} -
diff --git a/site/_includes/case-studies-alternating.html b/site/_includes/case-studies-alternating.html deleted file mode 100644 index 76225030e..000000000 --- a/site/_includes/case-studies-alternating.html +++ /dev/null @@ -1,26 +0,0 @@ -{{casestudy_background}} -
- {% for casestudy in site.casestudies %} -
- {% if casestudy.icon %} -
- {{ casestudy.title }} -
- {% endif %} -
-
- {% if casestudy.title != blank %} -
{{ casestudy.title }}
- {% endif %} -

{{ casestudy.content | markdownify }}

- {% for link in casestudy.links %} - {{ link[0] }} - {% endfor %} -
-
-
- {% if limit > 0 and forloop.index >= limit %} - {% break %} - {% endif %} - {% endfor %} -
diff --git a/site/_includes/case-studies.html b/site/_includes/case-studies.html deleted file mode 100644 index f2c18d99d..000000000 --- a/site/_includes/case-studies.html +++ /dev/null @@ -1,21 +0,0 @@ -
-{% for casestudy in site.casestudies %} -
-
- {% if casestudy.title != blank %} -
{{ casestudy.title }}
- {% endif %} - {% if casestudy.subtitle != blank %} -
{{ casestudy.subtitle }}
- {% endif %} -

{{ casestudy.content | markdownify }}

- {% for link in casestudy.links %} - {{ link[0] }} - {% endfor %} -
-
- {% if limit > 0 and forloop.index >= limit %} - {% break %} - {% endif %} -{% endfor %} -
diff --git a/site/_includes/contributors.html b/site/_includes/contributors.html deleted file mode 100644 index 3fa7c3ce6..000000000 --- a/site/_includes/contributors.html +++ /dev/null @@ -1,26 +0,0 @@ -
-
-

The {{ site.title }} Team

-
-
-
-
-

{{ site.title }} is released as open source software and provides community support through our GitHub project page. - If you encounter an issue or have a question, feel free to reach out on the GitHub issues page for {{ site.title }}.

-

The Velero project team welcomes contributions from the community, please see our contributing documentation. -

-
-
-
- {% for person in site.contributors %} -
-
- Person -
-
{{ person.first_name }} {{ person.last_name }}
- {{ person.content | markdownify }} -
-
-
- {% endfor %} -
diff --git a/site/_includes/footer.html b/site/_includes/footer.html deleted file mode 100644 index bfbfc9c3a..000000000 --- a/site/_includes/footer.html +++ /dev/null @@ -1,52 +0,0 @@ -
-
-
-
-
{{ site.footer.title }}
-

{{ site.footer.content }}

-
-
-

{{ site.footer.cta_title }}

- {{ site.footer.cta_text }} -
-
-
-
- - - - - - - - - - - diff --git a/site/_includes/head-docs.html b/site/_includes/head-docs.html deleted file mode 100644 index 213090e9e..000000000 --- a/site/_includes/head-docs.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - {% seo %} - diff --git a/site/_includes/head.html b/site/_includes/head.html deleted file mode 100644 index a085e3f8e..000000000 --- a/site/_includes/head.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - {{ site.title }} {{page.title}} - {% seo %} - diff --git a/site/_includes/nav.html b/site/_includes/nav.html deleted file mode 100644 index f60bbd0b6..000000000 --- a/site/_includes/nav.html +++ /dev/null @@ -1,24 +0,0 @@ - diff --git a/site/_includes/plugins.html b/site/_includes/plugins.html deleted file mode 100644 index 94e0ad69c..000000000 --- a/site/_includes/plugins.html +++ /dev/null @@ -1,81 +0,0 @@ -
-
-
- {% for plugin in site.plugin-list %} -
-
-
- {% if plugin.supported-by-velero-team == "true" %} - {% if plugin.link.size > 0 %} -
{{ plugin.title }}
- {% else %} -
{{ plugin.title }}
- {% endif %} -

{{ plugin.content }}

- {% if plugin.object-storage %} - - {% endif %} - {% if plugin.volumesnapshotter %} - - {% endif %} - {% if plugin.local-storage %} - - {% endif %} - {% if plugin.supported-by-velero-team %} - - {% endif %} - {% if plugin.BackupItemAction %} - - {% endif %} - {% if plugin.RestoreItemAction %} - - {% endif %} - {% endif %} -
-
-
-
- {% if plugin.supported-by-velero-team != "true" && plugin.prototype != "true" %} - {% if plugin.link.size > 0 %} -
{{ plugin.title }}
- {% else %} -
{{ plugin.title }}
- {% endif %} -

{{ plugin.content }}

- {% if plugin.object-storage %} - - {% endif %} - {% if plugin.volumesnapshotter %} - - {% endif %} - {% if plugin.local-storage %} - - {% endif %} - {% if plugin.supported-by-velero-team %} - - {% endif %} - {% if plugin.BackupItemAction %} - - {% endif %} - {% if plugin.RestoreItemAction %} - - {% endif %} - {% if plugin.beta %} - - {% endif %} - {% endif %} -
-
-
- {% if limit > 0 and forloop.index >= limit %} - {% break %} - {% endif %} - {% assign row = forloop.index | modulo: 3 %} - {% if row == 0 %} -
-
- {% endif %} - {% endfor %} -
-
-
diff --git a/site/_includes/related-posts.html b/site/_includes/related-posts.html deleted file mode 100644 index 418b12048..000000000 --- a/site/_includes/related-posts.html +++ /dev/null @@ -1,10 +0,0 @@ -
Related Content
-
- {% for category in site.categories limit:1 %} - - {% for post in category[1] limit:2 %} - {% include blog-post-card.html %} - - {% endfor %} - {% endfor %} -
diff --git a/site/_includes/version-warning.html b/site/_includes/version-warning.html deleted file mode 100644 index d7c16ad66..000000000 --- a/site/_includes/version-warning.html +++ /dev/null @@ -1,26 +0,0 @@ -{% if page.version != site.latest %} - -{% endif %} diff --git a/site/_includes/versions.html b/site/_includes/versions.html deleted file mode 100644 index 26c735506..000000000 --- a/site/_includes/versions.html +++ /dev/null @@ -1,21 +0,0 @@ -
-
- {% if site.versioning %} - -
- {% assign original_version = page.version | prepend: '/' | append: '/' %} - {% assign latest_url = page.url | replace: page.version, site.latest | relative_url %} - - - {% for version in site.versions %} - {% assign new_version = version | prepend: '/' | append: '/' %} - {{ version }} - {% endfor %} -
- {% else %} - {{ site.latest }} - {% endif %} -
-
diff --git a/site/_layouts/default.html b/site/_layouts/default.html deleted file mode 100644 index 3c78e95cd..000000000 --- a/site/_layouts/default.html +++ /dev/null @@ -1,15 +0,0 @@ - - -{% include head.html %} - - -
-
- {% include site-header.html %} - {{ content }} - {% include footer.html %} -
-
- - - diff --git a/site/_layouts/docs.html b/site/_layouts/docs.html deleted file mode 100644 index 0848ee49b..000000000 --- a/site/_layouts/docs.html +++ /dev/null @@ -1,62 +0,0 @@ - - -{% include head-docs.html %} -{% if page.version != "main" %} - - -{% endif %} -{% if page.name != "README.md" %} - {{ site.title }} Docs - {{page.title}} -{% endif %} -{% if page.name == "README.md" %} - {{ site.title }} Docs - Overview -{% endif %} - - -
-
- {% include site-header.html %} -
-
-
-

Documentation

-
-
-
-
-
-
-
- {% include versions.html %} -
-
- - - -
- {% include nav.html %} -
-
- {% include version-warning.html %} -
- {{ content }} -
-
-
-
-
- {% include footer.html %} -
-
- - - - - diff --git a/site/_layouts/page.html b/site/_layouts/page.html deleted file mode 100644 index c48723eb1..000000000 --- a/site/_layouts/page.html +++ /dev/null @@ -1,28 +0,0 @@ - - -{% include head.html %} - - -
-
- {% include site-header.html %} -
-
-
-

{{ page.title }}

-
-
-
-
-
-
- {{ content }} -
-
-
- {% include footer.html %} -
-
- - - diff --git a/site/_layouts/posts.html b/site/_layouts/posts.html deleted file mode 100644 index a9a86d810..000000000 --- a/site/_layouts/posts.html +++ /dev/null @@ -1,55 +0,0 @@ - - -{% include head.html %} - - -
-
- {% include site-header.html %} -
-
-
-

{{ page.title }}

-
-
-
-
-
-
-
-
- {% if page.author_avatar %} -
- {{ page.author_name }} -
- {% endif %} - -
- {{ page.author_name }} -
-
- -
- {{ page.date | date: "%B %d, %Y" }} -
-
- -
- {{ content }} -
-
-
-
- -
-
- {% include related-posts.html %} -
-
- - {% include footer.html %} -
-
- - - diff --git a/site/_layouts/redirect.html b/site/_layouts/redirect.html deleted file mode 100644 index 9ff421b31..000000000 --- a/site/_layouts/redirect.html +++ /dev/null @@ -1,15 +0,0 @@ - - - - {% if page.dir contains "/docs/" %} - - - Redirecting to docs... - - -Redirecting to {{ page.destination }}. If it doesn't load, click here. - - - {% endif %} diff --git a/site/_layouts/tag-index.html b/site/_layouts/tag-index.html deleted file mode 100644 index ac3eb3440..000000000 --- a/site/_layouts/tag-index.html +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default -type: standard -caption: 'Tag Index' -id: blog ---- -
-
-
-

{{ page.title }}

-
-
-
-
-
-
- {% include blog-posts-tag.html %} -
-
-
diff --git a/site/_plugins/data_page_generator.rb b/site/_plugins/data_page_generator.rb deleted file mode 100644 index 787ac3a22..000000000 --- a/site/_plugins/data_page_generator.rb +++ /dev/null @@ -1,135 +0,0 @@ -# coding: utf-8 -# Generate pages from individual records in yml files -# (c) 2014-2016 Adolfo Villafiorita -# Distributed under the conditions of the MIT License - -module Jekyll - - module Sanitizer - # strip characters and whitespace to create valid filenames, also lowercase - def sanitize_filename(name) - if(name.is_a? Integer) - return name.to_s - end - return name.tr( - "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÑñÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž", - "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz" -).downcase.strip.gsub(' ', '-').gsub(/[^\w.-]/, '') - end - end - - # this class is used to tell Jekyll to generate a page - class DataPage < Page - include Sanitizer - - # - site and base are copied from other plugins: to be honest, I am not sure what they do - # - # - `index_files` specifies if we want to generate named folders (true) or not (false) - # - `dir` is the default output directory - # - `data` is the data defined in `_data.yml` of the record for which we are generating a page - # - `name` is the key in `data` which determines the output filename - # - `template` is the name of the template for generating the page - # - `extension` is the extension for the generated file - def initialize(site, base, index_files, dir, data, name, template, extension) - @site = site - @base = base - - # @dir is the directory where we want to output the page - # @name is the name of the page to generate - # - # the value of these variables changes according to whether we - # want to generate named folders or not - if data[name] == nil - puts "error (datapage_gen). empty value for field '#{name}' in record #{data}" - else - filename = sanitize_filename(data[name]).to_s - - @dir = dir + (index_files ? "/" + filename + "/" : "") - @name = (index_files ? "index" : filename) + "." + extension.to_s - - self.process(@name) - self.read_yaml(File.join(base, '_layouts'), template + ".html") - self.data['title'] = data[name] - # add all the information defined in _data for the current record to the - # current page (so that we can access it with liquid tags) - self.data.merge!(data) - end - end - end - - class DataPagesGenerator < Generator - safe true - - # generate loops over _config.yml/page_gen invoking the DataPage - # constructor for each record for which we want to generate a page - - def generate(site) - # page_gen_dirs determines whether we want to generate index pages - # (name/index.html) or standard files (name.html). This information - # is passed to the DataPage constructor, which sets the @dir variable - # as required by this directive - index_files = site.config['page_gen-dirs'] == true - - # data contains the specification of the data for which we want to generate - # the pages (look at the README file for its specification) - data = site.config['page_gen'] - if data - data.each do |data_spec| - index_files_for_this_data = data_spec['index_files'] != nil ? data_spec['index_files'] : index_files - template = data_spec['template'] || data_spec['data'] - name = data_spec['name'] - dir = data_spec['dir'] || data_spec['data'] - extension = data_spec['extension'] || "html" - - if site.layouts.key? template - # records is the list of records defined in _data.yml - # for which we want to generate different pages - records = nil - data_spec['data'].split('.').each do |level| - if records.nil? - records = site.data[level] - else - records = records[level] - end - end - - # apply filtering conditions: - # - filter requires the name of a boolean field - # - filter_condition evals a ruby expression - records = records.select { |r| r[data_spec['filter']] } if data_spec['filter'] - records = records.select { |record| eval(data_spec['filter_condition']) } if data_spec['filter_condition'] - - records.each do |record| - site.pages << DataPage.new(site, site.source, index_files_for_this_data, dir, record, name, template, extension) - end - else - puts "error (datapage_gen). could not find template #{template}" if not site.layouts.key? template - end - end - end - end - end - - module DataPageLinkGenerator - include Sanitizer - - # use it like this: {{input | datapage_url: dir}} - # to generate a link to a data_page. - # - # the filter is smart enough to generate different link styles - # according to the data_page-dirs directive ... - # - # ... however, the filter is not smart enough to support different - # extensions for filenames. - # - # Thus, if you use the `extension` feature of this plugin, you - # need to generate the links by hand - def datapage_url(input, dir) - extension = Jekyll.configuration({})['page_gen-dirs'] ? '/' : '.html' - "#{dir}/#{sanitize_filename(input)}#{extension}" - end - end - -end - -Liquid::Template.register_filter(Jekyll::DataPageLinkGenerator) diff --git a/site/_plugins/tag_page_generator.rb b/site/_plugins/tag_page_generator.rb deleted file mode 100644 index 1b16aa2d1..000000000 --- a/site/_plugins/tag_page_generator.rb +++ /dev/null @@ -1,32 +0,0 @@ -module Jekyll - - class TagPage < Page - def initialize(site, base, dir, tag) - @site = site - @base = base - @dir = dir - @name = 'index.html' - - self.process(@name) - self.read_yaml(File.join(base, '_layouts'), 'tag-index.html') - self.data['tag'] = tag - - tag_title_prefix = site.config['tag_title_prefix'] || 'Posts by ' - self.data['title'] = "#{tag_title_prefix}#{tag}" - end - end - - class TagPageGenerator < Generator - safe true - - def generate(site) - if site.layouts.key? 'tag-index' - dir = site.config['tag_dir'] || 'tags' - site.tags.keys.each do |tag| - site.pages << TagPage.new(site, site.source, File.join(dir, tag), tag) - end - end - end - end - - end \ No newline at end of file diff --git a/site/_plugins/youtube.rb b/site/_plugins/youtube.rb deleted file mode 100644 index e322446aa..000000000 --- a/site/_plugins/youtube.rb +++ /dev/null @@ -1,123 +0,0 @@ -# Title: YouTube plugin for Jekyll -# Description: Liquid tag to generate a YouTube embed. -# Authors: -# - Joey Hoer (@joeyhoer | https://joeyhoer.com) -# -# Link: https://developers.google.com/youtube/player_parameters#Parameters -# -# Syntax: {% youtube [video_id] [width] [height] [query_param:value]... %} -# -# Examples: -# {% youtube dQw4w9WgXcQ %} -# {% youtube dQw4w9WgXcQ 600 rel:0 modestbranding:1 %} -# - -module Jekyll - class YouTube < Liquid::Tag - - ## Constants - - @@ATTRIBUTES = %w( - autoplay - cc_load_policy - color - controls - disablekb - enablejsapi - end - fs - hl - iv_load_policy - list - listType - loop - modestbranding - origin - playlist - playsinline - rel - showinfo - start - widget_referrer - ) - - @ytid = nil - @width = '' - @height = '' - - def initialize(tag_name, markup, tokens) - @content=markup - - @config = {} - - # Override configuration with values defined within _config.yml - if Jekyll.configuration({}).has_key?('youtube') - config = Jekyll.configuration({})['youtube'] - override_config(config) - end - - params = markup.split - - if params.shift =~ /(?:(?:https?:\/\/)?(?:www.)?(?:youtube.com\/(?:embed\/|watch\?v=)|youtu.be\/)?(\S+)(?:\?rel=\d)?)/i - @video_id = $1 - end - - @width = (params[0].to_i > 0) ? params.shift.to_i : 560 - @height = (params[0].to_i > 0) ? params.shift.to_i : (@width / 16.0 * 9).ceil - - if params.size > 0 - # Override configuration with parameters defined within Liquid tag - config = {} # Reset local config - params.each do |param| - param = param.gsub /\s+/, '' # Remove whitespaces - key, value = param.split(':',2) # Split first occurrence of ':' only - config["#{key}"] = value - end - override_config(config) - end - - super - end - - def override_config(config) - config.each{ |key,value| @config[key] = value } - end - - def render(context) - ouptut = super - - if !@video_id - @video_id = "#{context[@content.strip]}" - end - - if @video_id - template_path = File.join(Dir.pwd, "_includes", "youtube.html") - if File.exist?(template_path) - site = context.registers[:site] - - partial = File.read(template_path) - template = Liquid::Template.parse(partial) - - template.render!(({"video_id" => @video_id, "width" => @width, "height" => @height, "query_string" => render_query_string()}).merge(site.site_payload)) - else - "" - end - else - puts "YouTube Embed: Error processing input, expected syntax {% youtube video_id [width] [height] [data-attr:value] %}" - end - end - - def render_query_string - result = [] - @config.each do |key,value| - if @@ATTRIBUTES.include?(key.to_s) - result << "#{key}=#{value}" - end - end - return (!(result.empty?) ? '?' : '') + result.join('&') - end - - end -end - -Liquid::Template.register_tag('youtube', Jekyll::YouTube) diff --git a/site/_scss/_styles.scss b/site/assets/_scss/_styles.scss similarity index 100% rename from site/_scss/_styles.scss rename to site/assets/_scss/_styles.scss diff --git a/site/_scss/bootstrap-4.1.3/_alert.scss b/site/assets/_scss/bootstrap-4.1.3/_alert.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_alert.scss rename to site/assets/_scss/bootstrap-4.1.3/_alert.scss diff --git a/site/_scss/bootstrap-4.1.3/_badge.scss b/site/assets/_scss/bootstrap-4.1.3/_badge.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_badge.scss rename to site/assets/_scss/bootstrap-4.1.3/_badge.scss diff --git a/site/_scss/bootstrap-4.1.3/_breadcrumb.scss b/site/assets/_scss/bootstrap-4.1.3/_breadcrumb.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_breadcrumb.scss rename to site/assets/_scss/bootstrap-4.1.3/_breadcrumb.scss diff --git a/site/_scss/bootstrap-4.1.3/_button-group.scss b/site/assets/_scss/bootstrap-4.1.3/_button-group.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_button-group.scss rename to site/assets/_scss/bootstrap-4.1.3/_button-group.scss diff --git a/site/_scss/bootstrap-4.1.3/_buttons.scss b/site/assets/_scss/bootstrap-4.1.3/_buttons.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_buttons.scss rename to site/assets/_scss/bootstrap-4.1.3/_buttons.scss diff --git a/site/_scss/bootstrap-4.1.3/_card.scss b/site/assets/_scss/bootstrap-4.1.3/_card.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_card.scss rename to site/assets/_scss/bootstrap-4.1.3/_card.scss diff --git a/site/_scss/bootstrap-4.1.3/_carousel.scss b/site/assets/_scss/bootstrap-4.1.3/_carousel.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_carousel.scss rename to site/assets/_scss/bootstrap-4.1.3/_carousel.scss diff --git a/site/_scss/bootstrap-4.1.3/_close.scss b/site/assets/_scss/bootstrap-4.1.3/_close.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_close.scss rename to site/assets/_scss/bootstrap-4.1.3/_close.scss diff --git a/site/_scss/bootstrap-4.1.3/_code.scss b/site/assets/_scss/bootstrap-4.1.3/_code.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_code.scss rename to site/assets/_scss/bootstrap-4.1.3/_code.scss diff --git a/site/_scss/bootstrap-4.1.3/_custom-forms.scss b/site/assets/_scss/bootstrap-4.1.3/_custom-forms.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_custom-forms.scss rename to site/assets/_scss/bootstrap-4.1.3/_custom-forms.scss diff --git a/site/_scss/bootstrap-4.1.3/_dropdown.scss b/site/assets/_scss/bootstrap-4.1.3/_dropdown.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_dropdown.scss rename to site/assets/_scss/bootstrap-4.1.3/_dropdown.scss diff --git a/site/_scss/bootstrap-4.1.3/_forms.scss b/site/assets/_scss/bootstrap-4.1.3/_forms.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_forms.scss rename to site/assets/_scss/bootstrap-4.1.3/_forms.scss diff --git a/site/_scss/bootstrap-4.1.3/_functions.scss b/site/assets/_scss/bootstrap-4.1.3/_functions.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_functions.scss rename to site/assets/_scss/bootstrap-4.1.3/_functions.scss diff --git a/site/_scss/bootstrap-4.1.3/_grid.scss b/site/assets/_scss/bootstrap-4.1.3/_grid.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_grid.scss rename to site/assets/_scss/bootstrap-4.1.3/_grid.scss diff --git a/site/_scss/bootstrap-4.1.3/_images.scss b/site/assets/_scss/bootstrap-4.1.3/_images.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_images.scss rename to site/assets/_scss/bootstrap-4.1.3/_images.scss diff --git a/site/_scss/bootstrap-4.1.3/_input-group.scss b/site/assets/_scss/bootstrap-4.1.3/_input-group.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_input-group.scss rename to site/assets/_scss/bootstrap-4.1.3/_input-group.scss diff --git a/site/_scss/bootstrap-4.1.3/_jumbotron.scss b/site/assets/_scss/bootstrap-4.1.3/_jumbotron.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_jumbotron.scss rename to site/assets/_scss/bootstrap-4.1.3/_jumbotron.scss diff --git a/site/_scss/bootstrap-4.1.3/_list-group.scss b/site/assets/_scss/bootstrap-4.1.3/_list-group.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_list-group.scss rename to site/assets/_scss/bootstrap-4.1.3/_list-group.scss diff --git a/site/_scss/bootstrap-4.1.3/_media.scss b/site/assets/_scss/bootstrap-4.1.3/_media.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_media.scss rename to site/assets/_scss/bootstrap-4.1.3/_media.scss diff --git a/site/_scss/bootstrap-4.1.3/_mixins.scss b/site/assets/_scss/bootstrap-4.1.3/_mixins.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_mixins.scss rename to site/assets/_scss/bootstrap-4.1.3/_mixins.scss diff --git a/site/_scss/bootstrap-4.1.3/_modal.scss b/site/assets/_scss/bootstrap-4.1.3/_modal.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_modal.scss rename to site/assets/_scss/bootstrap-4.1.3/_modal.scss diff --git a/site/_scss/bootstrap-4.1.3/_nav.scss b/site/assets/_scss/bootstrap-4.1.3/_nav.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_nav.scss rename to site/assets/_scss/bootstrap-4.1.3/_nav.scss diff --git a/site/_scss/bootstrap-4.1.3/_navbar.scss b/site/assets/_scss/bootstrap-4.1.3/_navbar.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_navbar.scss rename to site/assets/_scss/bootstrap-4.1.3/_navbar.scss diff --git a/site/_scss/bootstrap-4.1.3/_pagination.scss b/site/assets/_scss/bootstrap-4.1.3/_pagination.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_pagination.scss rename to site/assets/_scss/bootstrap-4.1.3/_pagination.scss diff --git a/site/_scss/bootstrap-4.1.3/_popover.scss b/site/assets/_scss/bootstrap-4.1.3/_popover.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_popover.scss rename to site/assets/_scss/bootstrap-4.1.3/_popover.scss diff --git a/site/_scss/bootstrap-4.1.3/_print.scss b/site/assets/_scss/bootstrap-4.1.3/_print.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_print.scss rename to site/assets/_scss/bootstrap-4.1.3/_print.scss diff --git a/site/_scss/bootstrap-4.1.3/_progress.scss b/site/assets/_scss/bootstrap-4.1.3/_progress.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_progress.scss rename to site/assets/_scss/bootstrap-4.1.3/_progress.scss diff --git a/site/_scss/bootstrap-4.1.3/_reboot.scss b/site/assets/_scss/bootstrap-4.1.3/_reboot.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_reboot.scss rename to site/assets/_scss/bootstrap-4.1.3/_reboot.scss diff --git a/site/_scss/bootstrap-4.1.3/_root.scss b/site/assets/_scss/bootstrap-4.1.3/_root.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_root.scss rename to site/assets/_scss/bootstrap-4.1.3/_root.scss diff --git a/site/_scss/bootstrap-4.1.3/_tables.scss b/site/assets/_scss/bootstrap-4.1.3/_tables.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_tables.scss rename to site/assets/_scss/bootstrap-4.1.3/_tables.scss diff --git a/site/_scss/bootstrap-4.1.3/_tooltip.scss b/site/assets/_scss/bootstrap-4.1.3/_tooltip.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_tooltip.scss rename to site/assets/_scss/bootstrap-4.1.3/_tooltip.scss diff --git a/site/_scss/bootstrap-4.1.3/_transitions.scss b/site/assets/_scss/bootstrap-4.1.3/_transitions.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_transitions.scss rename to site/assets/_scss/bootstrap-4.1.3/_transitions.scss diff --git a/site/_scss/bootstrap-4.1.3/_type.scss b/site/assets/_scss/bootstrap-4.1.3/_type.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_type.scss rename to site/assets/_scss/bootstrap-4.1.3/_type.scss diff --git a/site/_scss/bootstrap-4.1.3/_utilities.scss b/site/assets/_scss/bootstrap-4.1.3/_utilities.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_utilities.scss rename to site/assets/_scss/bootstrap-4.1.3/_utilities.scss diff --git a/site/_scss/bootstrap-4.1.3/_variables.scss b/site/assets/_scss/bootstrap-4.1.3/_variables.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/_variables.scss rename to site/assets/_scss/bootstrap-4.1.3/_variables.scss diff --git a/site/_scss/bootstrap-4.1.3/bootstrap-grid.scss b/site/assets/_scss/bootstrap-4.1.3/bootstrap-grid.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/bootstrap-grid.scss rename to site/assets/_scss/bootstrap-4.1.3/bootstrap-grid.scss diff --git a/site/_scss/bootstrap-4.1.3/bootstrap-reboot.scss b/site/assets/_scss/bootstrap-4.1.3/bootstrap-reboot.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/bootstrap-reboot.scss rename to site/assets/_scss/bootstrap-4.1.3/bootstrap-reboot.scss diff --git a/site/_scss/bootstrap-4.1.3/bootstrap.scss b/site/assets/_scss/bootstrap-4.1.3/bootstrap.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/bootstrap.scss rename to site/assets/_scss/bootstrap-4.1.3/bootstrap.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_alert.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_alert.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_alert.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_alert.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_background-variant.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_background-variant.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_background-variant.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_background-variant.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_badge.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_badge.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_badge.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_badge.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_border-radius.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_border-radius.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_border-radius.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_border-radius.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_box-shadow.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_box-shadow.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_box-shadow.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_box-shadow.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_breakpoints.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_breakpoints.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_breakpoints.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_breakpoints.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_buttons.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_buttons.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_buttons.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_buttons.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_caret.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_caret.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_caret.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_caret.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_clearfix.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_clearfix.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_clearfix.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_clearfix.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_float.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_float.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_float.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_float.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_forms.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_forms.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_forms.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_forms.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_gradients.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_gradients.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_gradients.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_gradients.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_grid-framework.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_grid-framework.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_grid-framework.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_grid-framework.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_grid.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_grid.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_grid.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_grid.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_hover.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_hover.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_hover.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_hover.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_image.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_image.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_image.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_image.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_list-group.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_list-group.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_list-group.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_list-group.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_lists.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_lists.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_lists.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_lists.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_nav-divider.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_nav-divider.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_nav-divider.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_nav-divider.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_pagination.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_pagination.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_pagination.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_pagination.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_reset-text.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_reset-text.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_reset-text.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_reset-text.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_resize.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_resize.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_resize.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_resize.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_screen-reader.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_screen-reader.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_screen-reader.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_screen-reader.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_size.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_size.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_size.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_size.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_table-row.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_table-row.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_table-row.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_table-row.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_text-emphasis.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_text-emphasis.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_text-emphasis.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_text-emphasis.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_text-hide.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_text-hide.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_text-hide.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_text-hide.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_text-truncate.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_text-truncate.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_text-truncate.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_text-truncate.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_transition.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_transition.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_transition.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_transition.scss diff --git a/site/_scss/bootstrap-4.1.3/mixins/_visibility.scss b/site/assets/_scss/bootstrap-4.1.3/mixins/_visibility.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/mixins/_visibility.scss rename to site/assets/_scss/bootstrap-4.1.3/mixins/_visibility.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_align.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_align.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_align.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_align.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_background.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_background.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_background.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_background.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_borders.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_borders.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_borders.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_borders.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_clearfix.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_clearfix.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_clearfix.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_clearfix.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_display.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_display.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_display.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_display.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_embed.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_embed.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_embed.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_embed.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_flex.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_flex.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_flex.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_flex.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_float.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_float.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_float.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_float.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_position.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_position.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_position.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_position.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_screenreaders.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_screenreaders.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_screenreaders.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_screenreaders.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_shadows.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_shadows.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_shadows.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_shadows.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_sizing.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_sizing.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_sizing.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_sizing.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_spacing.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_spacing.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_spacing.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_spacing.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_text.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_text.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_text.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_text.scss diff --git a/site/_scss/bootstrap-4.1.3/utilities/_visibility.scss b/site/assets/_scss/bootstrap-4.1.3/utilities/_visibility.scss similarity index 100% rename from site/_scss/bootstrap-4.1.3/utilities/_visibility.scss rename to site/assets/_scss/bootstrap-4.1.3/utilities/_visibility.scss diff --git a/site/_scss/site/common/_core.scss b/site/assets/_scss/site/common/_core.scss similarity index 100% rename from site/_scss/site/common/_core.scss rename to site/assets/_scss/site/common/_core.scss diff --git a/site/_scss/site/common/_fonts.scss b/site/assets/_scss/site/common/_fonts.scss similarity index 100% rename from site/_scss/site/common/_fonts.scss rename to site/assets/_scss/site/common/_fonts.scss diff --git a/site/_scss/site/common/_type.scss b/site/assets/_scss/site/common/_type.scss similarity index 100% rename from site/_scss/site/common/_type.scss rename to site/assets/_scss/site/common/_type.scss diff --git a/site/_scss/site/layouts/_container.scss b/site/assets/_scss/site/layouts/_container.scss similarity index 100% rename from site/_scss/site/layouts/_container.scss rename to site/assets/_scss/site/layouts/_container.scss diff --git a/site/_scss/site/layouts/_docsearch.scss b/site/assets/_scss/site/layouts/_docsearch.scss similarity index 100% rename from site/_scss/site/layouts/_docsearch.scss rename to site/assets/_scss/site/layouts/_docsearch.scss diff --git a/site/_scss/site/layouts/_documentation.scss b/site/assets/_scss/site/layouts/_documentation.scss similarity index 100% rename from site/_scss/site/layouts/_documentation.scss rename to site/assets/_scss/site/layouts/_documentation.scss diff --git a/site/_scss/site/objects/_alternating-cards.scss b/site/assets/_scss/site/objects/_alternating-cards.scss similarity index 100% rename from site/_scss/site/objects/_alternating-cards.scss rename to site/assets/_scss/site/objects/_alternating-cards.scss diff --git a/site/_scss/site/objects/_button.scss b/site/assets/_scss/site/objects/_button.scss similarity index 100% rename from site/_scss/site/objects/_button.scss rename to site/assets/_scss/site/objects/_button.scss diff --git a/site/_scss/site/objects/_card.scss b/site/assets/_scss/site/objects/_card.scss similarity index 100% rename from site/_scss/site/objects/_card.scss rename to site/assets/_scss/site/objects/_card.scss diff --git a/site/_scss/site/objects/_footer.scss b/site/assets/_scss/site/objects/_footer.scss similarity index 100% rename from site/_scss/site/objects/_footer.scss rename to site/assets/_scss/site/objects/_footer.scss diff --git a/site/_scss/site/objects/_header.scss b/site/assets/_scss/site/objects/_header.scss similarity index 100% rename from site/_scss/site/objects/_header.scss rename to site/assets/_scss/site/objects/_header.scss diff --git a/site/_scss/site/objects/_home-hero.scss b/site/assets/_scss/site/objects/_home-hero.scss similarity index 100% rename from site/_scss/site/objects/_home-hero.scss rename to site/assets/_scss/site/objects/_home-hero.scss diff --git a/site/_scss/site/objects/_post.scss b/site/assets/_scss/site/objects/_post.scss similarity index 100% rename from site/_scss/site/objects/_post.scss rename to site/assets/_scss/site/objects/_post.scss diff --git a/site/_scss/site/objects/_section.scss b/site/assets/_scss/site/objects/_section.scss similarity index 100% rename from site/_scss/site/objects/_section.scss rename to site/assets/_scss/site/objects/_section.scss diff --git a/site/_scss/site/objects/_thumbnail-grid.scss b/site/assets/_scss/site/objects/_thumbnail-grid.scss similarity index 100% rename from site/_scss/site/objects/_thumbnail-grid.scss rename to site/assets/_scss/site/objects/_thumbnail-grid.scss diff --git a/site/_scss/site/settings/_variables.scss b/site/assets/_scss/site/settings/_variables.scss similarity index 100% rename from site/_scss/site/settings/_variables.scss rename to site/assets/_scss/site/settings/_variables.scss diff --git a/site/_scss/site/utilities/_image.scss b/site/assets/_scss/site/utilities/_image.scss similarity index 100% rename from site/_scss/site/utilities/_image.scss rename to site/assets/_scss/site/utilities/_image.scss diff --git a/site/_scss/site/utilities/_type.scss b/site/assets/_scss/site/utilities/_type.scss similarity index 100% rename from site/_scss/site/utilities/_type.scss rename to site/assets/_scss/site/utilities/_type.scss diff --git a/site/assets/styles.scss b/site/assets/styles.scss new file mode 100644 index 000000000..5f16874c2 --- /dev/null +++ b/site/assets/styles.scss @@ -0,0 +1 @@ +@import './_scss/styles'; diff --git a/site/blog.html b/site/blog.html deleted file mode 100644 index a662ca3e1..000000000 --- a/site/blog.html +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default -title: Blog -description: Velero Blog -id: blog ---- -
-
-
-

{{ page.title }}

-
-
-
-
-
-
- {% include blog-posts.html %} -
-
-
diff --git a/site/config.yaml b/site/config.yaml new file mode 100644 index 000000000..f365c4d27 --- /dev/null +++ b/site/config.yaml @@ -0,0 +1,105 @@ +#baseURL: "https://velero.io/" +disablePathToLower: true +languageCode: en-us +DefaultContentLanguage: "en" +title: Velero +frontmatter: + date: [":filename", ":default"] +params: + author: Velero Authors + vm_logo: vm-logo.png + logo: Velero.svg + hero: + backgroundColor: med-blue + versioning: true + latest: v1.4 + versions: + - main + - v1.4 + - v1.3.2 + - v1.3.1 + - v1.3.0 + - v1.2.0 + - v1.1.0 + - v1.0.0 + - v0.11.0 + - v0.10.0 + - v0.9.0 + - v0.8.1 + - v0.8.0 + - v0.7.1 + - v0.7.0 + - v0.6.0 + - v0.5.0 + - v0.4.0 + - v0.3.0 + gh_repo: https://github.com/vmware-tanzu/velero + footer: + title: Getting Started + content: To help you get started, see the documentation. + cta_title: '' + cta_url: /docs + cta_text: Documentation + vm_link: http://vmware.github.io/ + footer_social_links: + - title: Twitter + fa_icon: fab fa-twitter + url: https://twitter.com/projectvelero + - title: Slack + fa_icon: fab fa-slack + url: https://kubernetes.slack.com/messages/velero + - title: Google Groups + fa_icon: fas fa-users + url: https://groups.google.com/forum/#!forum/projectvelero + - title: RSS + fa_icon: fa fa-rss + url: blog/index.xml + - title: GitHub + fa_icon: fab fa-github + url: https://github.com/vmware-tanzu/velero +minify: + disableCSS: false + disableHTML: false + disableJS: false + disableJSON: false + disableSVG: false + disableXML: true + minifyOutput: false + tdewolff: + css: + decimals: -1 + keepCSS2: true + html: + keepConditionalComments: true + keepDefaultAttrVals: true + keepDocumentTags: true + keepEndTags: true + keepQuotes: true + keepWhitespace: false + js: {} + json: {} + svg: + decimals: -1 + xml: + keepWhitespace: false +enableRobotsTXT: true +enableGitInfo: true +permalinks: + posts: "/blog/:slug/" +outputs: + home: ["HTML"] + section: ["HTML"] + page: ["HTML"] + taxonomy: ["HTML"] + term: ["HTML"] +markup: + highlight: + codeFences: true + guessSyntax: true + hl_Lines: "" + lineNoStart: 1 + lineNos: false + lineNumbersInTable: true + noClasses: true + style: monokai + tabWidth: 4 diff --git a/site/content/_index.md b/site/content/_index.md new file mode 100644 index 000000000..6c28432d3 --- /dev/null +++ b/site/content/_index.md @@ -0,0 +1,38 @@ +--- +id: home +description: Backup and migrate Kubernetes resources and persistent volumes +backgrounds: + case_study: light-blue + team: dark-blue +hero: + banner: /img/heroes/velero.svg + headline: Backup and migrate Kubernetes resources and persistent volumes + content: Velero is an open source tool to safely backup and restore, perform disaster recovery, and migrate Kubernetes cluster resources and persistent volumes. + cta_link1: + text: Latest Release Information + url: /blog/velero-1.4-community-wave/ + cta_link2: + text: Download Velero + url: https://github.com/vmware-tanzu/velero/releases/latest + promo1: + icon: /img/disaster-recover-icon.svg + title: Disaster Recovery + content: Reduces time to recovery in case of infrastructure loss, data corruption, and/or service outages. + promo2: + icon: /img/data-migration-icon.svg + title: Data Migration + content: Enables cluster portability by easily migrating Kubernetes resources from one cluster to another​. + promo3: + icon: /img/data-protection-icon.svg + title: Data Protection + content: Offers key data protection features such as scheduled backups, retention schedules, and pre or post-backup hooks for custom actions. +secondary_ctas: + cta1: + title: Introduction to Velero + url: /blog/Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters/ + content: Learn about Velero and how to protect your Kubernetes resources and volumes. + cta2: + title: How Do You Use Velero? + url: https://github.com/vmware-tanzu/velero/issues/1327 + content: See how Velero is helping others and tell the world how you use Velero. +--- \ No newline at end of file diff --git a/site/content/casestudies/index.md b/site/content/casestudies/index.md new file mode 100644 index 000000000..3d65eaa0f --- /dev/null +++ b/site/content/casestudies/index.md @@ -0,0 +1,3 @@ +--- +headless: true +--- \ No newline at end of file diff --git a/site/_casestudies/sample1.md b/site/content/casestudies/sample1.md similarity index 100% rename from site/_casestudies/sample1.md rename to site/content/casestudies/sample1.md diff --git a/site/_casestudies/sample2.md b/site/content/casestudies/sample2.md similarity index 100% rename from site/_casestudies/sample2.md rename to site/content/casestudies/sample2.md diff --git a/site/_casestudies/sample3.md b/site/content/casestudies/sample3.md similarity index 100% rename from site/_casestudies/sample3.md rename to site/content/casestudies/sample3.md diff --git a/site/community.md b/site/content/community/_index.md similarity index 99% rename from site/community.md rename to site/content/community/_index.md index 3af776b42..94448baea 100644 --- a/site/community.md +++ b/site/content/community/_index.md @@ -1,5 +1,4 @@ --- -layout: page title: Community description: Velero Community id: community diff --git a/site/_contributors/01-nolan-brubaker.md b/site/content/contributors/01-nolan-brubaker.md similarity index 100% rename from site/_contributors/01-nolan-brubaker.md rename to site/content/contributors/01-nolan-brubaker.md diff --git a/site/_contributors/02-ashish-amarnath.md b/site/content/contributors/02-ashish-amarnath.md similarity index 100% rename from site/_contributors/02-ashish-amarnath.md rename to site/content/contributors/02-ashish-amarnath.md diff --git a/site/_contributors/02-carlisia-campos.md b/site/content/contributors/02-carlisia-campos.md similarity index 100% rename from site/_contributors/02-carlisia-campos.md rename to site/content/contributors/02-carlisia-campos.md diff --git a/site/_contributors/04-tim-hinderliter.md b/site/content/contributors/04-tim-hinderliter.md similarity index 100% rename from site/_contributors/04-tim-hinderliter.md rename to site/content/contributors/04-tim-hinderliter.md diff --git a/site/_contributors/05-stephanie-bauman.md b/site/content/contributors/05-stephanie-bauman.md similarity index 100% rename from site/_contributors/05-stephanie-bauman.md rename to site/content/contributors/05-stephanie-bauman.md diff --git a/site/content/contributors/index.md b/site/content/contributors/index.md new file mode 100644 index 000000000..3d65eaa0f --- /dev/null +++ b/site/content/contributors/index.md @@ -0,0 +1,3 @@ +--- +headless: true +--- \ No newline at end of file diff --git a/site/docs/main/README.md b/site/content/docs/main/_index.md similarity index 98% rename from site/docs/main/README.md rename to site/content/docs/main/_index.md index 49e9bdf23..230fb20b9 100644 --- a/site/docs/main/README.md +++ b/site/content/docs/main/_index.md @@ -1,3 +1,6 @@ +--- +version: main +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v1.3.0/api-types/README.md b/site/content/docs/main/api-types/README.md similarity index 88% rename from site/docs/v1.3.0/api-types/README.md rename to site/content/docs/main/api-types/README.md index 2ba83cc5e..54c23544d 100644 --- a/site/docs/v1.3.0/api-types/README.md +++ b/site/content/docs/main/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/main/api-types/backup.md b/site/content/docs/main/api-types/backup.md similarity index 99% rename from site/docs/main/api-types/backup.md rename to site/content/docs/main/api-types/backup.md index e0addb97a..d8bcf1cba 100644 --- a/site/docs/main/api-types/backup.md +++ b/site/content/docs/main/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/main/api-types/backupstoragelocation.md b/site/content/docs/main/api-types/backupstoragelocation.md similarity index 97% rename from site/docs/main/api-types/backupstoragelocation.md rename to site/content/docs/main/api-types/backupstoragelocation.md index f77e538b1..c5e1d4157 100644 --- a/site/docs/main/api-types/backupstoragelocation.md +++ b/site/content/docs/main/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/main/api-types/restore.md b/site/content/docs/main/api-types/restore.md similarity index 98% rename from site/docs/main/api-types/restore.md rename to site/content/docs/main/api-types/restore.md index 2044d4725..cc76e7f3a 100644 --- a/site/docs/main/api-types/restore.md +++ b/site/content/docs/main/api-types/restore.md @@ -1,4 +1,7 @@ -# Restore API Type +--- +title: "Restore API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.2.0/api-types/schedule.md b/site/content/docs/main/api-types/schedule.md similarity index 99% rename from site/docs/v1.2.0/api-types/schedule.md rename to site/content/docs/main/api-types/schedule.md index ec7e471a6..7b3139bf9 100644 --- a/site/docs/v1.2.0/api-types/schedule.md +++ b/site/content/docs/main/api-types/schedule.md @@ -1,4 +1,7 @@ -# Schedule API Type +--- +title: "Schedule API Type" +layout: docs +--- ## Use diff --git a/site/docs/main/api-types/volumesnapshotlocation.md b/site/content/docs/main/api-types/volumesnapshotlocation.md similarity index 96% rename from site/docs/main/api-types/volumesnapshotlocation.md rename to site/content/docs/main/api-types/volumesnapshotlocation.md index 8f3588dcb..aef5f4053 100644 --- a/site/docs/main/api-types/volumesnapshotlocation.md +++ b/site/content/docs/main/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/main/backup-reference.md b/site/content/docs/main/backup-reference.md similarity index 95% rename from site/docs/main/backup-reference.md rename to site/content/docs/main/backup-reference.md index e1f26dcf2..232c05761 100644 --- a/site/docs/main/backup-reference.md +++ b/site/content/docs/main/backup-reference.md @@ -1,4 +1,7 @@ -# Backup Reference +--- +title: "Backup Reference" +layout: docs +--- ## Exclude Specific Items from Backup diff --git a/site/docs/v1.4/basic-install.md b/site/content/docs/main/basic-install.md similarity index 98% rename from site/docs/v1.4/basic-install.md rename to site/content/docs/main/basic-install.md index 064d2e6c3..8ce2ff4b0 100644 --- a/site/docs/v1.4/basic-install.md +++ b/site/content/docs/main/basic-install.md @@ -1,4 +1,7 @@ -# Basic Install +--- +title: "Basic Install" +layout: docs +--- - [Basic Install](#basic-install) - [Prerequisites](#prerequisites) diff --git a/site/docs/main/build-from-source.md b/site/content/docs/main/build-from-source.md similarity index 99% rename from site/docs/main/build-from-source.md rename to site/content/docs/main/build-from-source.md index 52d6d04dc..f35f2a99a 100644 --- a/site/docs/main/build-from-source.md +++ b/site/content/docs/main/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- ## Prerequisites diff --git a/site/docs/main/code-standards.md b/site/content/docs/main/code-standards.md similarity index 99% rename from site/docs/main/code-standards.md rename to site/content/docs/main/code-standards.md index 7c5081dca..369708b8e 100644 --- a/site/docs/main/code-standards.md +++ b/site/content/docs/main/code-standards.md @@ -1,4 +1,7 @@ -# Code Standards +--- +title: "Code Standards" +layout: docs +--- ## Adding a changelog diff --git a/site/docs/main/contributions/ibm-config.md b/site/content/docs/main/contributions/ibm-config.md similarity index 98% rename from site/docs/main/contributions/ibm-config.md rename to site/content/docs/main/contributions/ibm-config.md index 700b3a760..cda4e210c 100644 --- a/site/docs/main/contributions/ibm-config.md +++ b/site/content/docs/main/contributions/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/main/contributions/minio.md b/site/content/docs/main/contributions/minio.md similarity index 99% rename from site/docs/main/contributions/minio.md rename to site/content/docs/main/contributions/minio.md index 6c12a47a7..49927dcaa 100644 --- a/site/docs/main/contributions/minio.md +++ b/site/content/docs/main/contributions/minio.md @@ -1,4 +1,7 @@ -## Quick start evaluation install with Minio +--- +title: "Quick start evaluation install with Minio" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/main/contributions/oracle-config.md b/site/content/docs/main/contributions/oracle-config.md similarity index 99% rename from site/docs/main/contributions/oracle-config.md rename to site/content/docs/main/contributions/oracle-config.md index 1f2c1dc5b..3a99d56f9 100644 --- a/site/docs/main/contributions/oracle-config.md +++ b/site/content/docs/main/contributions/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/main/csi.md b/site/content/docs/main/csi.md similarity index 98% rename from site/docs/main/csi.md rename to site/content/docs/main/csi.md index ef328dd6d..a68653bea 100644 --- a/site/docs/main/csi.md +++ b/site/content/docs/main/csi.md @@ -1,4 +1,7 @@ -# Container Storage Interface Snapshot Support in Velero +--- +title: "Container Storage Interface Snapshot Support in Velero" +layout: docs +--- _This feature is under development. Documentation may not be up-to-date and features may not work as expected._ diff --git a/site/docs/main/custom-plugins.md b/site/content/docs/main/custom-plugins.md similarity index 99% rename from site/docs/main/custom-plugins.md rename to site/content/docs/main/custom-plugins.md index 4c562e385..3059006d3 100644 --- a/site/docs/main/custom-plugins.md +++ b/site/content/docs/main/custom-plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/main/customize-installation.md b/site/content/docs/main/customize-installation.md similarity index 99% rename from site/docs/main/customize-installation.md rename to site/content/docs/main/customize-installation.md index a09544797..41c57bb62 100644 --- a/site/docs/main/customize-installation.md +++ b/site/content/docs/main/customize-installation.md @@ -1,4 +1,7 @@ -# Customize Velero Install +--- +title: "Customize Velero Install" +layout: docs +--- - [Customize Velero Install](#customize-velero-install) - [Plugins](#plugins) diff --git a/site/docs/v1.2.0/debugging-install.md b/site/content/docs/main/debugging-install.md similarity index 98% rename from site/docs/v1.2.0/debugging-install.md rename to site/content/docs/main/debugging-install.md index 4abc5a3e1..9c2067b34 100644 --- a/site/docs/v1.2.0/debugging-install.md +++ b/site/content/docs/main/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v1.2.0/debugging-restores.md b/site/content/docs/main/debugging-restores.md similarity index 98% rename from site/docs/v1.2.0/debugging-restores.md rename to site/content/docs/main/debugging-restores.md index d50d4aacb..eb834b0bc 100644 --- a/site/docs/v1.2.0/debugging-restores.md +++ b/site/content/docs/main/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/main/development.md b/site/content/docs/main/development.md similarity index 96% rename from site/docs/main/development.md rename to site/content/docs/main/development.md index 22d2fead0..0a9596188 100644 --- a/site/docs/main/development.md +++ b/site/content/docs/main/development.md @@ -1,4 +1,7 @@ -# Development +--- +title: "Development " +layout: docs +--- ## Update generated files diff --git a/site/docs/v1.3.2/disaster-case.md b/site/content/docs/main/disaster-case.md similarity index 97% rename from site/docs/v1.3.2/disaster-case.md rename to site/content/docs/main/disaster-case.md index c9f126a8b..6b73e6716 100644 --- a/site/docs/v1.3.2/disaster-case.md +++ b/site/content/docs/main/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/docs/main/examples.md b/site/content/docs/main/examples.md similarity index 97% rename from site/docs/main/examples.md rename to site/content/docs/main/examples.md index 40b284ec3..c73ae2b23 100644 --- a/site/docs/main/examples.md +++ b/site/content/docs/main/examples.md @@ -1,4 +1,7 @@ -## Examples +--- +title: "Examples" +layout: docs +--- After you set up the Velero server, try these examples: diff --git a/site/docs/v1.4/faq.md b/site/content/docs/main/faq.md similarity index 72% rename from site/docs/v1.4/faq.md rename to site/content/docs/main/faq.md index 35eb793e6..9af2d5935 100644 --- a/site/docs/v1.4/faq.md +++ b/site/content/docs/main/faq.md @@ -1,3 +1,6 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- Our FAQ has been moved to here: https://github.com/vmware-tanzu/velero/wiki/Velero-FAQ. \ No newline at end of file diff --git a/site/docs/main/hooks.md b/site/content/docs/main/hooks.md similarity index 99% rename from site/docs/main/hooks.md rename to site/content/docs/main/hooks.md index a18766027..bee2b35b4 100644 --- a/site/docs/main/hooks.md +++ b/site/content/docs/main/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.3.2/how-velero-works.md b/site/content/docs/main/how-velero-works.md similarity index 99% rename from site/docs/v1.3.2/how-velero-works.md rename to site/content/docs/main/how-velero-works.md index 543ab2f94..45889caef 100644 --- a/site/docs/v1.3.2/how-velero-works.md +++ b/site/content/docs/main/how-velero-works.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v1.3.0/image-tagging.md b/site/content/docs/main/image-tagging.md similarity index 91% rename from site/docs/v1.3.0/image-tagging.md rename to site/content/docs/main/image-tagging.md index b0080ef1c..fbfb15617 100644 --- a/site/docs/v1.3.0/image-tagging.md +++ b/site/content/docs/main/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/main/img/README.md b/site/content/docs/main/img/README.md similarity index 100% rename from site/docs/main/img/README.md rename to site/content/docs/main/img/README.md diff --git a/site/docs/main/img/backup-process.png b/site/content/docs/main/img/backup-process.png similarity index 100% rename from site/docs/main/img/backup-process.png rename to site/content/docs/main/img/backup-process.png diff --git a/site/docs/main/img/velero.png b/site/content/docs/main/img/velero.png similarity index 100% rename from site/docs/main/img/velero.png rename to site/content/docs/main/img/velero.png diff --git a/site/docs/main/locations.md b/site/content/docs/main/locations.md similarity index 98% rename from site/docs/main/locations.md rename to site/content/docs/main/locations.md index ca28239a7..b5d8ca3fc 100644 --- a/site/docs/main/locations.md +++ b/site/content/docs/main/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- ## Overview diff --git a/site/docs/main/migration-case.md b/site/content/docs/main/migration-case.md similarity index 98% rename from site/docs/main/migration-case.md rename to site/content/docs/main/migration-case.md index c1fa1cd6f..e95323133 100644 --- a/site/docs/main/migration-case.md +++ b/site/content/docs/main/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/main/namespace.md b/site/content/docs/main/namespace.md similarity index 92% rename from site/docs/main/namespace.md rename to site/content/docs/main/namespace.md index 9a3d62808..14e2c6179 100644 --- a/site/docs/main/namespace.md +++ b/site/content/docs/main/namespace.md @@ -1,4 +1,7 @@ -# Run in a non-default namespace +--- +title: "Run in a non-default namespace" +layout: docs +--- The Velero installation and backups by default are run in the `velero` namespace. However, it is possible to use a different namespace. diff --git a/site/docs/v1.4/on-premises.md b/site/content/docs/main/on-premises.md similarity index 98% rename from site/docs/v1.4/on-premises.md rename to site/content/docs/main/on-premises.md index 03a9f73d0..5570ee56b 100644 --- a/site/docs/v1.4/on-premises.md +++ b/site/content/docs/main/on-premises.md @@ -1,4 +1,7 @@ -# On-Premises Environments +--- +title: "On-Premises Environments" +layout: docs +--- You can run Velero in an on-premises cluster in different ways depending on your requirements. diff --git a/site/docs/v1.4/output-file-format.md b/site/content/docs/main/output-file-format.md similarity index 99% rename from site/docs/v1.4/output-file-format.md rename to site/content/docs/main/output-file-format.md index 887743451..a7ab0ca0a 100644 --- a/site/docs/v1.4/output-file-format.md +++ b/site/content/docs/main/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/v1.3.0/overview-plugins.md b/site/content/docs/main/overview-plugins.md similarity index 96% rename from site/docs/v1.3.0/overview-plugins.md rename to site/content/docs/main/overview-plugins.md index 74eb3b0fb..037601d51 100644 --- a/site/docs/v1.3.0/overview-plugins.md +++ b/site/content/docs/main/overview-plugins.md @@ -1,5 +1,7 @@ - -# Velero plugin system +--- +title: "Velero plugin system" +layout: docs +--- Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. diff --git a/site/docs/main/rbac.md b/site/content/docs/main/rbac.md similarity index 95% rename from site/docs/main/rbac.md rename to site/content/docs/main/rbac.md index d8686bf6e..a9c22b9f1 100644 --- a/site/docs/main/rbac.md +++ b/site/content/docs/main/rbac.md @@ -1,4 +1,7 @@ -# Run Velero more securely with restrictive RBAC settings +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. diff --git a/site/docs/main/release-instructions.md b/site/content/docs/main/release-instructions.md similarity index 99% rename from site/docs/main/release-instructions.md rename to site/content/docs/main/release-instructions.md index 63bce5be5..9470ef398 100644 --- a/site/docs/main/release-instructions.md +++ b/site/content/docs/main/release-instructions.md @@ -1,4 +1,7 @@ -# Release Instructions +--- +title: "Release Instructions" +layout: docs +--- ## Ahead of Time diff --git a/site/docs/main/resource-filtering.md b/site/content/docs/main/resource-filtering.md similarity index 100% rename from site/docs/main/resource-filtering.md rename to site/content/docs/main/resource-filtering.md diff --git a/site/docs/main/restic.md b/site/content/docs/main/restic.md similarity index 99% rename from site/docs/main/restic.md rename to site/content/docs/main/restic.md index ece008a90..3551e74bc 100644 --- a/site/docs/main/restic.md +++ b/site/content/docs/main/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero supports backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.4/restore-reference.md b/site/content/docs/main/restore-reference.md similarity index 98% rename from site/docs/v1.4/restore-reference.md rename to site/content/docs/main/restore-reference.md index 46f4ffb40..6711679ac 100644 --- a/site/docs/v1.4/restore-reference.md +++ b/site/content/docs/main/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/docs/v1.3.1/run-locally.md b/site/content/docs/main/run-locally.md similarity index 97% rename from site/docs/v1.3.1/run-locally.md rename to site/content/docs/main/run-locally.md index 913cbc122..ffd735b4f 100644 --- a/site/docs/v1.3.1/run-locally.md +++ b/site/content/docs/main/run-locally.md @@ -1,4 +1,7 @@ -# Run Velero locally in development +--- +title: "Run Velero locally in development" +layout: docs +--- Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server image and redeploy it to the cluster with each change. diff --git a/site/docs/v1.4/self-signed-certificates.md b/site/content/docs/main/self-signed-certificates.md similarity index 92% rename from site/docs/v1.4/self-signed-certificates.md rename to site/content/docs/main/self-signed-certificates.md index aca33d9c1..a24bc32f4 100644 --- a/site/docs/v1.4/self-signed-certificates.md +++ b/site/content/docs/main/self-signed-certificates.md @@ -1,4 +1,7 @@ -# Use Velero with a storage provider secured by a self-signed certificate +--- +title: "Use Velero with a storage provider secured by a self-signed certificate" +layout: docs +--- If you are using an S3-Compatible storage provider that is secured with a self-signed certificate, connections to the object store may fail with a `certificate signed by unknown authority` message. In order to proceed, a certificate bundle may be provided when adding the storage provider. diff --git a/site/docs/main/start-contributing.md b/site/content/docs/main/start-contributing.md similarity index 97% rename from site/docs/main/start-contributing.md rename to site/content/docs/main/start-contributing.md index a4cb59d07..e87609320 100644 --- a/site/docs/main/start-contributing.md +++ b/site/content/docs/main/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/docs/main/style-guide.md b/site/content/docs/main/style-guide.md similarity index 99% rename from site/docs/main/style-guide.md rename to site/content/docs/main/style-guide.md index 2463be4a9..2c69907af 100644 --- a/site/docs/main/style-guide.md +++ b/site/content/docs/main/style-guide.md @@ -1,5 +1,7 @@ - -# Documentation Style Guide +--- +title: "Documentation Style Guide" +layout: docs +--- _This style guide is adapted from the [Kubernetes style guide](https://kubernetes.io/docs/contribute/style/style-guide/)._ diff --git a/site/docs/main/support-process.md b/site/content/docs/main/support-process.md similarity index 98% rename from site/docs/main/support-process.md rename to site/content/docs/main/support-process.md index c4bdf82a0..fc06e72e9 100644 --- a/site/docs/main/support-process.md +++ b/site/content/docs/main/support-process.md @@ -1,4 +1,7 @@ -# Support Process +--- +title: "Support Process" +layout: docs +--- ## Weekly Rotation diff --git a/site/docs/main/supported-providers.md b/site/content/docs/main/supported-providers.md similarity index 99% rename from site/docs/main/supported-providers.md rename to site/content/docs/main/supported-providers.md index 07e304ddc..ae1d25e55 100644 --- a/site/docs/main/supported-providers.md +++ b/site/content/docs/main/supported-providers.md @@ -1,4 +1,7 @@ -# Providers +--- +title: "Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. Velero has a plugin system which allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/docs/main/troubleshooting.md b/site/content/docs/main/troubleshooting.md similarity index 99% rename from site/docs/main/troubleshooting.md rename to site/content/docs/main/troubleshooting.md index 984d8f714..6d0fa998f 100644 --- a/site/docs/main/troubleshooting.md +++ b/site/content/docs/main/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v1.2.0/uninstalling.md b/site/content/docs/main/uninstalling.md similarity index 83% rename from site/docs/v1.2.0/uninstalling.md rename to site/content/docs/main/uninstalling.md index 727bc1aa0..f0b7b8d17 100644 --- a/site/docs/v1.2.0/uninstalling.md +++ b/site/content/docs/main/uninstalling.md @@ -1,4 +1,7 @@ -# Uninstalling Velero +--- +title: "Uninstalling Velero" +layout: docs +--- If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: diff --git a/site/docs/main/upgrade-to-1.4.md b/site/content/docs/main/upgrade-to-1.4.md similarity index 96% rename from site/docs/main/upgrade-to-1.4.md rename to site/content/docs/main/upgrade-to-1.4.md index 869185c6c..8c885eec6 100644 --- a/site/docs/main/upgrade-to-1.4.md +++ b/site/content/docs/main/upgrade-to-1.4.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.4 +--- +title: "Upgrading to Velero 1.4" +layout: docs +--- ## Prerequisites diff --git a/site/docs/main/velero-install.md b/site/content/docs/main/velero-install.md similarity index 98% rename from site/docs/main/velero-install.md rename to site/content/docs/main/velero-install.md index d0793bf0c..4c68d8095 100644 --- a/site/docs/main/velero-install.md +++ b/site/content/docs/main/velero-install.md @@ -1,4 +1,7 @@ -# Velero Install CLI +--- +title: "Velero Install CLI" +layout: docs +--- This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. diff --git a/site/docs/v0.10.0/vendoring-dependencies.md b/site/content/docs/main/vendoring-dependencies.md similarity index 89% rename from site/docs/v0.10.0/vendoring-dependencies.md rename to site/content/docs/main/vendoring-dependencies.md index 1729f21ec..9fc1bcac1 100644 --- a/site/docs/v0.10.0/vendoring-dependencies.md +++ b/site/content/docs/main/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/main/website-guidelines.md b/site/content/docs/main/website-guidelines.md similarity index 96% rename from site/docs/main/website-guidelines.md rename to site/content/docs/main/website-guidelines.md index 91bae775e..e68291eaa 100644 --- a/site/docs/main/website-guidelines.md +++ b/site/content/docs/main/website-guidelines.md @@ -1,4 +1,7 @@ -# Website Guidelines +--- +title: "Website Guidelines" +layout: docs +--- ## Running the website locally diff --git a/site/docs/main/zenhub.md b/site/content/docs/main/zenhub.md similarity index 97% rename from site/docs/main/zenhub.md rename to site/content/docs/main/zenhub.md index 45298b3a2..a723fb184 100644 --- a/site/docs/main/zenhub.md +++ b/site/content/docs/main/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v0.10.0/README.md b/site/content/docs/v0.10.0/_index.md similarity index 99% rename from site/docs/v0.10.0/README.md rename to site/content/docs/v0.10.0/_index.md index dcb67f08d..1a4fbd05a 100644 --- a/site/docs/v0.10.0/README.md +++ b/site/content/docs/v0.10.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.10.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.10.0/about.md b/site/content/docs/v0.10.0/about.md similarity index 99% rename from site/docs/v0.10.0/about.md rename to site/content/docs/v0.10.0/about.md index 6270ca8a5..570673af6 100644 --- a/site/docs/v0.10.0/about.md +++ b/site/content/docs/v0.10.0/about.md @@ -1,4 +1,7 @@ -# How Ark Works +--- +title: "How Ark Works" +layout: docs +--- Each Ark operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Ark also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v0.10.0/api-types/README.md b/site/content/docs/v0.10.0/api-types/README.md similarity index 85% rename from site/docs/v0.10.0/api-types/README.md rename to site/content/docs/v0.10.0/api-types/README.md index 554304820..444187df7 100644 --- a/site/docs/v0.10.0/api-types/README.md +++ b/site/content/docs/v0.10.0/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/v0.10.0/api-types/backup.md b/site/content/docs/v0.10.0/api-types/backup.md similarity index 99% rename from site/docs/v0.10.0/api-types/backup.md rename to site/content/docs/v0.10.0/api-types/backup.md index 40fe71c65..39b8cd197 100644 --- a/site/docs/v0.10.0/api-types/backup.md +++ b/site/content/docs/v0.10.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.10.0/api-types/backupstoragelocation.md b/site/content/docs/v0.10.0/api-types/backupstoragelocation.md similarity index 98% rename from site/docs/v0.10.0/api-types/backupstoragelocation.md rename to site/content/docs/v0.10.0/api-types/backupstoragelocation.md index 15218a4c6..1c50a5314 100644 --- a/site/docs/v0.10.0/api-types/backupstoragelocation.md +++ b/site/content/docs/v0.10.0/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Ark Backup Storage Locations +--- +title: "Ark Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v0.10.0/api-types/volumesnapshotlocation.md b/site/content/docs/v0.10.0/api-types/volumesnapshotlocation.md similarity index 97% rename from site/docs/v0.10.0/api-types/volumesnapshotlocation.md rename to site/content/docs/v0.10.0/api-types/volumesnapshotlocation.md index 95744c4c6..a65dc6ae5 100644 --- a/site/docs/v0.10.0/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v0.10.0/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Ark Volume Snapshot Location +--- +title: "Ark Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v0.10.0/aws-config.md b/site/content/docs/v0.10.0/aws-config.md similarity index 99% rename from site/docs/v0.10.0/aws-config.md rename to site/content/docs/v0.10.0/aws-config.md index 57e006588..547c42d70 100644 --- a/site/docs/v0.10.0/aws-config.md +++ b/site/content/docs/v0.10.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Ark on AWS +--- +title: "Run Ark on AWS" +layout: docs +--- To set up Ark on AWS, you: diff --git a/site/docs/v0.10.0/azure-config.md b/site/content/docs/v0.10.0/azure-config.md similarity index 99% rename from site/docs/v0.10.0/azure-config.md rename to site/content/docs/v0.10.0/azure-config.md index d72ae48f6..6f9b09cca 100644 --- a/site/docs/v0.10.0/azure-config.md +++ b/site/content/docs/v0.10.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Ark on Azure +--- +title: "Run Ark on Azure" +layout: docs +--- To configure Ark on Azure, you: diff --git a/site/docs/v0.10.0/build-from-scratch.md b/site/content/docs/v0.10.0/build-from-scratch.md similarity index 99% rename from site/docs/v0.10.0/build-from-scratch.md rename to site/content/docs/v0.10.0/build-from-scratch.md index 89021cc34..fb7e0b096 100644 --- a/site/docs/v0.10.0/build-from-scratch.md +++ b/site/content/docs/v0.10.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Download][2] diff --git a/site/docs/v0.10.0/debugging-install.md b/site/content/docs/v0.10.0/debugging-install.md similarity index 97% rename from site/docs/v0.10.0/debugging-install.md rename to site/content/docs/v0.10.0/debugging-install.md index 89cad18e1..b5b0c51f8 100644 --- a/site/docs/v0.10.0/debugging-install.md +++ b/site/content/docs/v0.10.0/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v0.10.0/debugging-restores.md b/site/content/docs/v0.10.0/debugging-restores.md similarity index 98% rename from site/docs/v0.10.0/debugging-restores.md rename to site/content/docs/v0.10.0/debugging-restores.md index bac4de501..137e3bb37 100644 --- a/site/docs/v0.10.0/debugging-restores.md +++ b/site/content/docs/v0.10.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.10.0/disaster-case.md b/site/content/docs/v0.10.0/disaster-case.md similarity index 95% rename from site/docs/v0.10.0/disaster-case.md rename to site/content/docs/v0.10.0/disaster-case.md index 73d569fba..d2eb5728c 100644 --- a/site/docs/v0.10.0/disaster-case.md +++ b/site/content/docs/v0.10.0/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Restore-Only Mode* diff --git a/site/docs/v0.7.1/extend.md b/site/content/docs/v0.10.0/extend.md similarity index 94% rename from site/docs/v0.7.1/extend.md rename to site/content/docs/v0.10.0/extend.md index 0a96b8e3e..ae282f58d 100644 --- a/site/docs/v0.7.1/extend.md +++ b/site/content/docs/v0.10.0/extend.md @@ -1,4 +1,7 @@ -# Extend Ark +--- +title: "Extend Ark" +layout: docs +--- Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/docs/v0.10.0/faq.md b/site/content/docs/v0.10.0/faq.md similarity index 98% rename from site/docs/v0.10.0/faq.md rename to site/content/docs/v0.10.0/faq.md index c8cc029a2..06e51360d 100644 --- a/site/docs/v0.10.0/faq.md +++ b/site/content/docs/v0.10.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.10.0/gcp-config.md b/site/content/docs/v0.10.0/gcp-config.md similarity index 99% rename from site/docs/v0.10.0/gcp-config.md rename to site/content/docs/v0.10.0/gcp-config.md index 7b0b13e92..34be52187 100644 --- a/site/docs/v0.10.0/gcp-config.md +++ b/site/content/docs/v0.10.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Ark on GCP +--- +title: "Run Ark on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either: diff --git a/site/docs/v0.10.0/get-started.md b/site/content/docs/v0.10.0/get-started.md similarity index 99% rename from site/docs/v0.10.0/get-started.md rename to site/content/docs/v0.10.0/get-started.md index 80da57e45..5e56064fc 100644 --- a/site/docs/v0.10.0/get-started.md +++ b/site/content/docs/v0.10.0/get-started.md @@ -1,4 +1,7 @@ -# Getting started +--- +title: "Getting started" +layout: docs +--- The following example sets up the Ark server and client, then backs up and restores a sample application. diff --git a/site/docs/v0.10.0/hooks.md b/site/content/docs/v0.10.0/hooks.md similarity index 99% rename from site/docs/v0.10.0/hooks.md rename to site/content/docs/v0.10.0/hooks.md index 5db78e643..ef6f736cf 100644 --- a/site/docs/v0.10.0/hooks.md +++ b/site/content/docs/v0.10.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.10.0/ibm-config.md b/site/content/docs/v0.10.0/ibm-config.md similarity index 97% rename from site/docs/v0.10.0/ibm-config.md rename to site/content/docs/v0.10.0/ibm-config.md index b25cc0f2c..6d76fe23f 100644 --- a/site/docs/v0.10.0/ibm-config.md +++ b/site/content/docs/v0.10.0/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Ark's storage destination. +--- +title: "Use IBM Cloud Object Storage as Ark's storage destination." +layout: docs +--- You can deploy Ark on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Ark's backups. To set up IBM Cloud Object Storage (COS) as Ark's destination, you: diff --git a/site/docs/v0.9.0/image-tagging.md b/site/content/docs/v0.10.0/image-tagging.md similarity index 91% rename from site/docs/v0.9.0/image-tagging.md rename to site/content/docs/v0.10.0/image-tagging.md index 2fd12e3cc..ec447e2b3 100644 --- a/site/docs/v0.9.0/image-tagging.md +++ b/site/content/docs/v0.10.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Ark's image tagging policy. diff --git a/site/docs/v0.10.0/img/README.md b/site/content/docs/v0.10.0/img/README.md similarity index 100% rename from site/docs/v0.10.0/img/README.md rename to site/content/docs/v0.10.0/img/README.md diff --git a/site/docs/v0.10.0/img/backup-process.png b/site/content/docs/v0.10.0/img/backup-process.png similarity index 100% rename from site/docs/v0.10.0/img/backup-process.png rename to site/content/docs/v0.10.0/img/backup-process.png diff --git a/site/docs/v0.10.0/install-overview.md b/site/content/docs/v0.10.0/install-overview.md similarity index 98% rename from site/docs/v0.10.0/install-overview.md rename to site/content/docs/v0.10.0/install-overview.md index e13d0bb57..2f71536a8 100644 --- a/site/docs/v0.10.0/install-overview.md +++ b/site/content/docs/v0.10.0/install-overview.md @@ -1,4 +1,7 @@ -# Set up Ark on your platform +--- +title: "Set up Ark on your platform" +layout: docs +--- You can run Ark with a cloud provider or on-premises. For detailed information about the platforms that Ark supports, see [Compatible Storage Providers][99]. diff --git a/site/docs/v0.10.0/locations.md b/site/content/docs/v0.10.0/locations.md similarity index 99% rename from site/docs/v0.10.0/locations.md rename to site/content/docs/v0.10.0/locations.md index 9479828b2..75b4ae8b8 100644 --- a/site/docs/v0.10.0/locations.md +++ b/site/content/docs/v0.10.0/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- Ark v0.10 introduces a new way of configuring where Ark backups and their associated persistent volume snapshots are stored. diff --git a/site/docs/v0.10.0/migration-case.md b/site/content/docs/v0.10.0/migration-case.md similarity index 97% rename from site/docs/v0.10.0/migration-case.md rename to site/content/docs/v0.10.0/migration-case.md index 41f28b889..8cc46ed09 100644 --- a/site/docs/v0.10.0/migration-case.md +++ b/site/content/docs/v0.10.0/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v0.10.0/namespace.md b/site/content/docs/v0.10.0/namespace.md similarity index 97% rename from site/docs/v0.10.0/namespace.md rename to site/content/docs/v0.10.0/namespace.md index ca8285774..d95a3656b 100644 --- a/site/docs/v0.10.0/namespace.md +++ b/site/content/docs/v0.10.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Ark version 0.7.0 and later, you can run Ark in any namespace. To do so, you specify the namespace in the YAML files that configure the Ark server. You then also specify the namespace when diff --git a/site/docs/v0.10.0/output-file-format.md b/site/content/docs/v0.10.0/output-file-format.md similarity index 98% rename from site/docs/v0.10.0/output-file-format.md rename to site/content/docs/v0.10.0/output-file-format.md index abdc0166b..6bef5b5ca 100644 --- a/site/docs/v0.10.0/output-file-format.md +++ b/site/content/docs/v0.10.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.10.0/plugins.md b/site/content/docs/v0.10.0/plugins.md similarity index 97% rename from site/docs/v0.10.0/plugins.md rename to site/content/docs/v0.10.0/plugins.md index d49da0a74..d848e93cb 100644 --- a/site/docs/v0.10.0/plugins.md +++ b/site/content/docs/v0.10.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary diff --git a/site/docs/v0.10.0/rbac.md b/site/content/docs/v0.10.0/rbac.md similarity index 96% rename from site/docs/v0.10.0/rbac.md rename to site/content/docs/v0.10.0/rbac.md index a7dea51d4..f898b578d 100644 --- a/site/docs/v0.10.0/rbac.md +++ b/site/content/docs/v0.10.0/rbac.md @@ -1,4 +1,7 @@ -# Run Ark more securely with restrictive RBAC settings +--- +title: "Run Ark more securely with restrictive RBAC settings" +layout: docs +--- By default Ark runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Ark can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Ark components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. diff --git a/site/docs/v0.10.0/restic.md b/site/content/docs/v0.10.0/restic.md similarity index 99% rename from site/docs/v0.10.0/restic.md rename to site/content/docs/v0.10.0/restic.md index ebb63cdb6..90ac55a45 100644 --- a/site/docs/v0.10.0/restic.md +++ b/site/content/docs/v0.10.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- As of version 0.9.0, Ark has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. diff --git a/site/docs/v0.10.0/storage-layout-reorg-v0.10.md b/site/content/docs/v0.10.0/storage-layout-reorg-v0.10.md similarity index 98% rename from site/docs/v0.10.0/storage-layout-reorg-v0.10.md rename to site/content/docs/v0.10.0/storage-layout-reorg-v0.10.md index dab57a936..2ad37e51e 100644 --- a/site/docs/v0.10.0/storage-layout-reorg-v0.10.md +++ b/site/content/docs/v0.10.0/storage-layout-reorg-v0.10.md @@ -1,4 +1,7 @@ -# Object Storage Layout Changes in v0.10 +--- +title: "Object Storage Layout Changes in v0.10" +layout: docs +--- ## Overview diff --git a/site/docs/v0.10.0/support-matrix.md b/site/content/docs/v0.10.0/support-matrix.md similarity index 97% rename from site/docs/v0.10.0/support-matrix.md rename to site/content/docs/v0.10.0/support-matrix.md index aa0d733c6..f0fd47dd4 100644 --- a/site/docs/v0.10.0/support-matrix.md +++ b/site/content/docs/v0.10.0/support-matrix.md @@ -1,4 +1,7 @@ -# Compatible Storage Providers +--- +title: "Compatible Storage Providers" +layout: docs +--- Ark supports a variety of storage providers for different backup and snapshot operations. As of version 0.6.0, a plugin system allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Ark codebase. diff --git a/site/docs/v0.10.0/troubleshooting.md b/site/content/docs/v0.10.0/troubleshooting.md similarity index 98% rename from site/docs/v0.10.0/troubleshooting.md rename to site/content/docs/v0.10.0/troubleshooting.md index 2b861a11b..936bce99c 100644 --- a/site/docs/v0.10.0/troubleshooting.md +++ b/site/content/docs/v0.10.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#ark-dr channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v0.10.0/upgrading-to-v0.10.md b/site/content/docs/v0.10.0/upgrading-to-v0.10.md similarity index 98% rename from site/docs/v0.10.0/upgrading-to-v0.10.md rename to site/content/docs/v0.10.0/upgrading-to-v0.10.md index d68b30939..0296da172 100644 --- a/site/docs/v0.10.0/upgrading-to-v0.10.md +++ b/site/content/docs/v0.10.0/upgrading-to-v0.10.md @@ -1,4 +1,7 @@ -# Upgrading to Ark v0.10 +--- +title: "Upgrading to Ark v0.10" +layout: docs +--- ## Overview diff --git a/site/docs/main/vendoring-dependencies.md b/site/content/docs/v0.10.0/vendoring-dependencies.md similarity index 89% rename from site/docs/main/vendoring-dependencies.md rename to site/content/docs/v0.10.0/vendoring-dependencies.md index 1729f21ec..9fc1bcac1 100644 --- a/site/docs/main/vendoring-dependencies.md +++ b/site/content/docs/v0.10.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.10.0/versions.md b/site/content/docs/v0.10.0/versions.md similarity index 96% rename from site/docs/v0.10.0/versions.md rename to site/content/docs/v0.10.0/versions.md index 10eef7b33..596facb23 100644 --- a/site/docs/v0.10.0/versions.md +++ b/site/content/docs/v0.10.0/versions.md @@ -1,4 +1,7 @@ -# Upgrading Ark versions +--- +title: "Upgrading Ark versions" +layout: docs +--- Ark supports multiple concurrent versions. Whether you're setting up Ark for the first time or upgrading to a new version, you need to pay careful attention to versioning. This doc page is new as of version 0.10.0, and will be updated with information about subsequent releases. diff --git a/site/docs/v0.10.0/zenhub.md b/site/content/docs/v0.10.0/zenhub.md similarity index 97% rename from site/docs/v0.10.0/zenhub.md rename to site/content/docs/v0.10.0/zenhub.md index e34b7678b..7b0d4ea62 100644 --- a/site/docs/v0.10.0/zenhub.md +++ b/site/content/docs/v0.10.0/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v0.11.0/README.md b/site/content/docs/v0.11.0/_index.md similarity index 99% rename from site/docs/v0.11.0/README.md rename to site/content/docs/v0.11.0/_index.md index 6ecea1c9c..ae814d91c 100644 --- a/site/docs/v0.11.0/README.md +++ b/site/content/docs/v0.11.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.11.0 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v0.11.0/about.md b/site/content/docs/v0.11.0/about.md similarity index 99% rename from site/docs/v0.11.0/about.md rename to site/content/docs/v0.11.0/about.md index e7a53b10a..cc2253248 100644 --- a/site/docs/v0.11.0/about.md +++ b/site/content/docs/v0.11.0/about.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v0.11.0/api-types/README.md b/site/content/docs/v0.11.0/api-types/README.md similarity index 85% rename from site/docs/v0.11.0/api-types/README.md rename to site/content/docs/v0.11.0/api-types/README.md index 424b02d00..290379288 100644 --- a/site/docs/v0.11.0/api-types/README.md +++ b/site/content/docs/v0.11.0/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/v0.11.0/api-types/backup.md b/site/content/docs/v0.11.0/api-types/backup.md similarity index 99% rename from site/docs/v0.11.0/api-types/backup.md rename to site/content/docs/v0.11.0/api-types/backup.md index f7dd9fdfc..9926d4268 100644 --- a/site/docs/v0.11.0/api-types/backup.md +++ b/site/content/docs/v0.11.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.11.0/api-types/backupstoragelocation.md b/site/content/docs/v0.11.0/api-types/backupstoragelocation.md similarity index 98% rename from site/docs/v0.11.0/api-types/backupstoragelocation.md rename to site/content/docs/v0.11.0/api-types/backupstoragelocation.md index c756c8f5b..5a870eb11 100644 --- a/site/docs/v0.11.0/api-types/backupstoragelocation.md +++ b/site/content/docs/v0.11.0/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v0.11.0/api-types/volumesnapshotlocation.md b/site/content/docs/v0.11.0/api-types/volumesnapshotlocation.md similarity index 97% rename from site/docs/v0.11.0/api-types/volumesnapshotlocation.md rename to site/content/docs/v0.11.0/api-types/volumesnapshotlocation.md index 734297f3d..20dd85a4e 100644 --- a/site/docs/v0.11.0/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v0.11.0/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v0.11.0/aws-config.md b/site/content/docs/v0.11.0/aws-config.md similarity index 99% rename from site/docs/v0.11.0/aws-config.md rename to site/content/docs/v0.11.0/aws-config.md index 07514037f..a9439d11a 100644 --- a/site/docs/v0.11.0/aws-config.md +++ b/site/content/docs/v0.11.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Velero on AWS +--- +title: "Run Velero on AWS" +layout: docs +--- To set up Velero on AWS, you: diff --git a/site/docs/v0.11.0/azure-config.md b/site/content/docs/v0.11.0/azure-config.md similarity index 99% rename from site/docs/v0.11.0/azure-config.md rename to site/content/docs/v0.11.0/azure-config.md index 4032926ab..76747079d 100644 --- a/site/docs/v0.11.0/azure-config.md +++ b/site/content/docs/v0.11.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Velero on Azure +--- +title: "Run Velero on Azure" +layout: docs +--- To configure Velero on Azure, you: diff --git a/site/docs/v0.11.0/build-from-scratch.md b/site/content/docs/v0.11.0/build-from-scratch.md similarity index 99% rename from site/docs/v0.11.0/build-from-scratch.md rename to site/content/docs/v0.11.0/build-from-scratch.md index debf1ea8b..d421e96a8 100644 --- a/site/docs/v0.11.0/build-from-scratch.md +++ b/site/content/docs/v0.11.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Getting the source][2] diff --git a/site/docs/v0.11.0/debugging-install.md b/site/content/docs/v0.11.0/debugging-install.md similarity index 98% rename from site/docs/v0.11.0/debugging-install.md rename to site/content/docs/v0.11.0/debugging-install.md index aaf25986d..34b6c7a1b 100644 --- a/site/docs/v0.11.0/debugging-install.md +++ b/site/content/docs/v0.11.0/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v0.11.0/debugging-restores.md b/site/content/docs/v0.11.0/debugging-restores.md similarity index 98% rename from site/docs/v0.11.0/debugging-restores.md rename to site/content/docs/v0.11.0/debugging-restores.md index 7ff6153be..57ae0df7c 100644 --- a/site/docs/v0.11.0/debugging-restores.md +++ b/site/content/docs/v0.11.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.11.0/disaster-case.md b/site/content/docs/v0.11.0/disaster-case.md similarity index 95% rename from site/docs/v0.11.0/disaster-case.md rename to site/content/docs/v0.11.0/disaster-case.md index 595811908..82968ecbf 100644 --- a/site/docs/v0.11.0/disaster-case.md +++ b/site/content/docs/v0.11.0/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Restore-Only Mode* diff --git a/site/docs/v0.11.0/expose-minio.md b/site/content/docs/v0.11.0/expose-minio.md similarity index 97% rename from site/docs/v0.11.0/expose-minio.md rename to site/content/docs/v0.11.0/expose-minio.md index 236d03809..1cc3446b9 100644 --- a/site/docs/v0.11.0/expose-minio.md +++ b/site/content/docs/v0.11.0/expose-minio.md @@ -1,4 +1,7 @@ -# Expose Minio outside your cluster +--- +title: "Expose Minio outside your cluster" +layout: docs +--- When you run commands to get logs or describe a backup, the Velero server generates a pre-signed URL to download the requested items. To access these URLs from outside the cluster -- that is, from your Velero client -- you need to make Minio available outside the cluster. You can: diff --git a/site/docs/v1.0.0/extend.md b/site/content/docs/v0.11.0/extend.md similarity index 93% rename from site/docs/v1.0.0/extend.md rename to site/content/docs/v0.11.0/extend.md index 5a1c68533..ec9d84332 100644 --- a/site/docs/v1.0.0/extend.md +++ b/site/content/docs/v0.11.0/extend.md @@ -1,4 +1,7 @@ -# Extend Velero +--- +title: "Extend Velero" +layout: docs +--- Velero includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/docs/v0.11.0/faq.md b/site/content/docs/v0.11.0/faq.md similarity index 98% rename from site/docs/v0.11.0/faq.md rename to site/content/docs/v0.11.0/faq.md index 202d844e7..abe49005a 100644 --- a/site/docs/v0.11.0/faq.md +++ b/site/content/docs/v0.11.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v0.11.0/gcp-config.md b/site/content/docs/v0.11.0/gcp-config.md similarity index 99% rename from site/docs/v0.11.0/gcp-config.md rename to site/content/docs/v0.11.0/gcp-config.md index 107cb03ad..4d5921ad1 100644 --- a/site/docs/v0.11.0/gcp-config.md +++ b/site/content/docs/v0.11.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Velero on GCP +--- +title: "Run Velero on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either: diff --git a/site/docs/v0.11.0/get-started.md b/site/content/docs/v0.11.0/get-started.md similarity index 99% rename from site/docs/v0.11.0/get-started.md rename to site/content/docs/v0.11.0/get-started.md index 151695e1c..e8b7224a8 100644 --- a/site/docs/v0.11.0/get-started.md +++ b/site/content/docs/v0.11.0/get-started.md @@ -1,4 +1,7 @@ -## Getting started +--- +title: "Getting started" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v0.11.0/hooks.md b/site/content/docs/v0.11.0/hooks.md similarity index 99% rename from site/docs/v0.11.0/hooks.md rename to site/content/docs/v0.11.0/hooks.md index dffac5385..7f785ca75 100644 --- a/site/docs/v0.11.0/hooks.md +++ b/site/content/docs/v0.11.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.11.0/ibm-config.md b/site/content/docs/v0.11.0/ibm-config.md similarity index 98% rename from site/docs/v0.11.0/ibm-config.md rename to site/content/docs/v0.11.0/ibm-config.md index 41e04bf1f..f9e9e5f3c 100644 --- a/site/docs/v0.11.0/ibm-config.md +++ b/site/content/docs/v0.11.0/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v0.11.0/image-tagging.md b/site/content/docs/v0.11.0/image-tagging.md similarity index 91% rename from site/docs/v0.11.0/image-tagging.md rename to site/content/docs/v0.11.0/image-tagging.md index afb37e971..43433c225 100644 --- a/site/docs/v0.11.0/image-tagging.md +++ b/site/content/docs/v0.11.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/v0.11.0/img/README.md b/site/content/docs/v0.11.0/img/README.md similarity index 100% rename from site/docs/v0.11.0/img/README.md rename to site/content/docs/v0.11.0/img/README.md diff --git a/site/docs/v0.11.0/img/backup-process.png b/site/content/docs/v0.11.0/img/backup-process.png similarity index 100% rename from site/docs/v0.11.0/img/backup-process.png rename to site/content/docs/v0.11.0/img/backup-process.png diff --git a/site/docs/v0.11.0/img/velero.png b/site/content/docs/v0.11.0/img/velero.png similarity index 100% rename from site/docs/v0.11.0/img/velero.png rename to site/content/docs/v0.11.0/img/velero.png diff --git a/site/docs/v0.11.0/install-overview.md b/site/content/docs/v0.11.0/install-overview.md similarity index 98% rename from site/docs/v0.11.0/install-overview.md rename to site/content/docs/v0.11.0/install-overview.md index a1f10c83a..5ffb70353 100644 --- a/site/docs/v0.11.0/install-overview.md +++ b/site/content/docs/v0.11.0/install-overview.md @@ -1,4 +1,7 @@ -# Set up Velero on your platform +--- +title: "Set up Velero on your platform" +layout: docs +--- You can run Velero with a cloud provider or on-premises. For detailed information about the platforms that Velero supports, see [Compatible Storage Providers][99]. diff --git a/site/docs/v0.11.0/locations.md b/site/content/docs/v0.11.0/locations.md similarity index 99% rename from site/docs/v0.11.0/locations.md rename to site/content/docs/v0.11.0/locations.md index f1af86ea5..e9500ecb8 100644 --- a/site/docs/v0.11.0/locations.md +++ b/site/content/docs/v0.11.0/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- Velero v0.10 introduces a new way of configuring where Velero backups and their associated persistent volume snapshots are stored. diff --git a/site/docs/v0.11.0/migrating-to-velero.md b/site/content/docs/v0.11.0/migrating-to-velero.md similarity index 98% rename from site/docs/v0.11.0/migrating-to-velero.md rename to site/content/docs/v0.11.0/migrating-to-velero.md index 5c648f6bd..383bfb0d4 100644 --- a/site/docs/v0.11.0/migrating-to-velero.md +++ b/site/content/docs/v0.11.0/migrating-to-velero.md @@ -1,4 +1,7 @@ -# Migrating from Heptio Ark to Velero +--- +title: "Migrating from Heptio Ark to Velero" +layout: docs +--- As of v0.11.0, Heptio Ark has become Velero. This means the following changes have been made: diff --git a/site/docs/v0.11.0/migration-case.md b/site/content/docs/v0.11.0/migration-case.md similarity index 97% rename from site/docs/v0.11.0/migration-case.md rename to site/content/docs/v0.11.0/migration-case.md index a4917fb99..f50225d6c 100644 --- a/site/docs/v0.11.0/migration-case.md +++ b/site/content/docs/v0.11.0/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v0.11.0/namespace.md b/site/content/docs/v0.11.0/namespace.md similarity index 97% rename from site/docs/v0.11.0/namespace.md rename to site/content/docs/v0.11.0/namespace.md index b77615b8c..bbad4d7f4 100644 --- a/site/docs/v0.11.0/namespace.md +++ b/site/content/docs/v0.11.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Velero version 0.7.0 and later, you can run Velero in any namespace. To do so, you specify the namespace in the YAML files that configure the Velero server. You then also specify the namespace when diff --git a/site/docs/v0.11.0/output-file-format.md b/site/content/docs/v0.11.0/output-file-format.md similarity index 98% rename from site/docs/v0.11.0/output-file-format.md rename to site/content/docs/v0.11.0/output-file-format.md index 04420be91..362e4735c 100644 --- a/site/docs/v0.11.0/output-file-format.md +++ b/site/content/docs/v0.11.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/v0.11.0/plugins.md b/site/content/docs/v0.11.0/plugins.md similarity index 97% rename from site/docs/v0.11.0/plugins.md rename to site/content/docs/v0.11.0/plugins.md index 12a6c876e..bf0f5637f 100644 --- a/site/docs/v0.11.0/plugins.md +++ b/site/content/docs/v0.11.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary diff --git a/site/docs/v1.0.0/rbac.md b/site/content/docs/v0.11.0/rbac.md similarity index 95% rename from site/docs/v1.0.0/rbac.md rename to site/content/docs/v0.11.0/rbac.md index d8686bf6e..a9c22b9f1 100644 --- a/site/docs/v1.0.0/rbac.md +++ b/site/content/docs/v0.11.0/rbac.md @@ -1,4 +1,7 @@ -# Run Velero more securely with restrictive RBAC settings +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. diff --git a/site/docs/v0.11.0/restic.md b/site/content/docs/v0.11.0/restic.md similarity index 99% rename from site/docs/v0.11.0/restic.md rename to site/content/docs/v0.11.0/restic.md index 690b4c373..fe6f7c198 100644 --- a/site/docs/v0.11.0/restic.md +++ b/site/content/docs/v0.11.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- As of version 0.9.0, Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. diff --git a/site/docs/v0.11.0/support-matrix.md b/site/content/docs/v0.11.0/support-matrix.md similarity index 97% rename from site/docs/v0.11.0/support-matrix.md rename to site/content/docs/v0.11.0/support-matrix.md index faf85dffc..71407cab5 100644 --- a/site/docs/v0.11.0/support-matrix.md +++ b/site/content/docs/v0.11.0/support-matrix.md @@ -1,4 +1,7 @@ -# Compatible Storage Providers +--- +title: "Compatible Storage Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. As of version 0.6.0, a plugin system allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/docs/v0.11.0/troubleshooting.md b/site/content/docs/v0.11.0/troubleshooting.md similarity index 98% rename from site/docs/v0.11.0/troubleshooting.md rename to site/content/docs/v0.11.0/troubleshooting.md index 0c70b876d..91f00f636 100644 --- a/site/docs/v0.11.0/troubleshooting.md +++ b/site/content/docs/v0.11.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v0.11.0/vendoring-dependencies.md b/site/content/docs/v0.11.0/vendoring-dependencies.md similarity index 89% rename from site/docs/v0.11.0/vendoring-dependencies.md rename to site/content/docs/v0.11.0/vendoring-dependencies.md index 1729f21ec..9fc1bcac1 100644 --- a/site/docs/v0.11.0/vendoring-dependencies.md +++ b/site/content/docs/v0.11.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.11.0/versions.md b/site/content/docs/v0.11.0/versions.md similarity index 96% rename from site/docs/v0.11.0/versions.md rename to site/content/docs/v0.11.0/versions.md index 1e3dc8ba4..46c6cd57c 100644 --- a/site/docs/v0.11.0/versions.md +++ b/site/content/docs/v0.11.0/versions.md @@ -1,4 +1,7 @@ -# Upgrading Velero versions +--- +title: "Upgrading Velero versions" +layout: docs +--- Velero supports multiple concurrent versions. Whether you're setting up Velero for the first time or upgrading to a new version, you need to pay careful attention to versioning. This doc page is new as of version 0.10.0, and will be updated with information about subsequent releases. diff --git a/site/docs/v0.11.0/zenhub.md b/site/content/docs/v0.11.0/zenhub.md similarity index 97% rename from site/docs/v0.11.0/zenhub.md rename to site/content/docs/v0.11.0/zenhub.md index 7bb32a387..c095c05d4 100644 --- a/site/docs/v0.11.0/zenhub.md +++ b/site/content/docs/v0.11.0/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v0.3.0/README.md b/site/content/docs/v0.3.0/_index.md similarity index 99% rename from site/docs/v0.3.0/README.md rename to site/content/docs/v0.3.0/_index.md index c1f105424..efd9ba7f7 100644 --- a/site/docs/v0.3.0/README.md +++ b/site/content/docs/v0.3.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.3.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.3.0/build-from-scratch.md b/site/content/docs/v0.3.0/build-from-scratch.md similarity index 97% rename from site/docs/v0.3.0/build-from-scratch.md rename to site/content/docs/v0.3.0/build-from-scratch.md index ce451ad6f..34d93912b 100644 --- a/site/docs/v0.3.0/build-from-scratch.md +++ b/site/content/docs/v0.3.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build From Scratch +--- +title: "Build From Scratch" +layout: docs +--- While the [README][0] pulls from the Heptio image registry, you can also build your own Heptio Ark container with the following steps: diff --git a/site/docs/v0.3.0/cli-reference/README.md b/site/content/docs/v0.3.0/cli-reference/README.md similarity index 95% rename from site/docs/v0.3.0/cli-reference/README.md rename to site/content/docs/v0.3.0/cli-reference/README.md index e3d87c872..bf6760d86 100644 --- a/site/docs/v0.3.0/cli-reference/README.md +++ b/site/content/docs/v0.3.0/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.3.0/cli-reference/ark.md b/site/content/docs/v0.3.0/cli-reference/ark.md similarity index 97% rename from site/docs/v0.3.0/cli-reference/ark.md rename to site/content/docs/v0.3.0/cli-reference/ark.md index d548d5af6..5fa107f74 100644 --- a/site/docs/v0.3.0/cli-reference/ark.md +++ b/site/content/docs/v0.3.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.3.0/cli-reference/ark_backup.md b/site/content/docs/v0.3.0/cli-reference/ark_backup.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_backup.md rename to site/content/docs/v0.3.0/cli-reference/ark_backup.md index 6191610bb..c3e362a2c 100644 --- a/site/docs/v0.3.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.3.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.3.0/cli-reference/ark_backup_create.md similarity index 97% rename from site/docs/v0.3.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.3.0/cli-reference/ark_backup_create.md index 1f03a8ce5..7bd9fd67f 100644 --- a/site/docs/v0.3.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.3.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.3.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.3.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.3.0/cli-reference/ark_backup_get.md index d1ef6e53a..58b3740ef 100644 --- a/site/docs/v0.3.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.3.0/cli-reference/ark_restore.md b/site/content/docs/v0.3.0/cli-reference/ark_restore.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_restore.md rename to site/content/docs/v0.3.0/cli-reference/ark_restore.md index 4c8c4bc7d..16730fff0 100644 --- a/site/docs/v0.3.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.3.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.3.0/cli-reference/ark_restore_create.md similarity index 97% rename from site/docs/v0.3.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.3.0/cli-reference/ark_restore_create.md index 223222f4e..90b89aca6 100644 --- a/site/docs/v0.3.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.3.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.3.0/cli-reference/ark_restore_delete.md similarity index 95% rename from site/docs/v0.3.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.3.0/cli-reference/ark_restore_delete.md index bd2276e74..40c69a2a5 100644 --- a/site/docs/v0.3.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.3.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.3.0/cli-reference/ark_restore_get.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.3.0/cli-reference/ark_restore_get.md index cd37983b0..313506edc 100644 --- a/site/docs/v0.3.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- get restores diff --git a/site/docs/v0.3.0/cli-reference/ark_schedule.md b/site/content/docs/v0.3.0/cli-reference/ark_schedule.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.3.0/cli-reference/ark_schedule.md index 7c146b11e..eb9408844 100644 --- a/site/docs/v0.3.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.3.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.3.0/cli-reference/ark_schedule_create.md similarity index 97% rename from site/docs/v0.3.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.3.0/cli-reference/ark_schedule_create.md index 8ec9c383a..b7700a638 100644 --- a/site/docs/v0.3.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.3.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.3.0/cli-reference/ark_schedule_delete.md similarity index 95% rename from site/docs/v0.3.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.3.0/cli-reference/ark_schedule_delete.md index e8057b3c5..341e8e389 100644 --- a/site/docs/v0.3.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.3.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.3.0/cli-reference/ark_schedule_get.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.3.0/cli-reference/ark_schedule_get.md index 9852eea53..570ae7316 100644 --- a/site/docs/v0.3.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.3.0/cli-reference/ark_server.md b/site/content/docs/v0.3.0/cli-reference/ark_server.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_server.md rename to site/content/docs/v0.3.0/cli-reference/ark_server.md index 15729ec22..400a692f5 100644 --- a/site/docs/v0.3.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.3.0/cli-reference/ark_version.md b/site/content/docs/v0.3.0/cli-reference/ark_version.md similarity index 96% rename from site/docs/v0.3.0/cli-reference/ark_version.md rename to site/content/docs/v0.3.0/cli-reference/ark_version.md index 5f08ff16c..0506ca96b 100644 --- a/site/docs/v0.3.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.3.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.3.0/cloud-provider-specifics.md b/site/content/docs/v0.3.0/cloud-provider-specifics.md similarity index 99% rename from site/docs/v0.3.0/cloud-provider-specifics.md rename to site/content/docs/v0.3.0/cloud-provider-specifics.md index 3b8f94b19..344808613 100644 --- a/site/docs/v0.3.0/cloud-provider-specifics.md +++ b/site/content/docs/v0.3.0/cloud-provider-specifics.md @@ -1,4 +1,7 @@ -# Cloud Provider Specifics +--- +title: "Cloud Provider Specifics" +layout: docs +--- While the [Quickstart][0] uses a local storage service to quickly set up Heptio Ark as a demonstration, this document details additional configurations that are required when integrating with the cloud providers below: diff --git a/site/docs/v0.4.0/concepts.md b/site/content/docs/v0.3.0/concepts.md similarity index 98% rename from site/docs/v0.4.0/concepts.md rename to site/content/docs/v0.3.0/concepts.md index 3e8ee4be8..8f8474e4c 100644 --- a/site/docs/v0.4.0/concepts.md +++ b/site/content/docs/v0.3.0/concepts.md @@ -1,4 +1,7 @@ -# Concepts +--- +title: "Concepts" +layout: docs +--- * [Overview][0] * [Operation types][1] diff --git a/site/docs/v0.3.0/config-definition.md b/site/content/docs/v0.3.0/config-definition.md similarity index 99% rename from site/docs/v0.3.0/config-definition.md rename to site/content/docs/v0.3.0/config-definition.md index d1c5a2b7b..afe6ec699 100644 --- a/site/docs/v0.3.0/config-definition.md +++ b/site/content/docs/v0.3.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][10] * [Example][11] diff --git a/site/docs/v0.4.0/debugging-restores.md b/site/content/docs/v0.3.0/debugging-restores.md similarity index 97% rename from site/docs/v0.4.0/debugging-restores.md rename to site/content/docs/v0.3.0/debugging-restores.md index 709b0e202..5f60e7884 100644 --- a/site/docs/v0.4.0/debugging-restores.md +++ b/site/content/docs/v0.3.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.3.0/img/README.md b/site/content/docs/v0.3.0/img/README.md similarity index 100% rename from site/docs/v0.3.0/img/README.md rename to site/content/docs/v0.3.0/img/README.md diff --git a/site/docs/v0.3.0/img/backup-process.png b/site/content/docs/v0.3.0/img/backup-process.png similarity index 100% rename from site/docs/v0.3.0/img/backup-process.png rename to site/content/docs/v0.3.0/img/backup-process.png diff --git a/site/docs/v0.3.0/output-file-format.md b/site/content/docs/v0.3.0/output-file-format.md similarity index 98% rename from site/docs/v0.3.0/output-file-format.md rename to site/content/docs/v0.3.0/output-file-format.md index 7f7b92a07..98fb952c7 100644 --- a/site/docs/v0.3.0/output-file-format.md +++ b/site/content/docs/v0.3.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.3.0/use-cases.md b/site/content/docs/v0.3.0/use-cases.md similarity index 98% rename from site/docs/v0.3.0/use-cases.md rename to site/content/docs/v0.3.0/use-cases.md index ca1d9f26e..a82ec5389 100644 --- a/site/docs/v0.3.0/use-cases.md +++ b/site/content/docs/v0.3.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/docs/v0.4.0/README.md b/site/content/docs/v0.4.0/_index.md similarity index 99% rename from site/docs/v0.4.0/README.md rename to site/content/docs/v0.4.0/_index.md index 77793f086..d351e860f 100644 --- a/site/docs/v0.4.0/README.md +++ b/site/content/docs/v0.4.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.4.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.4.0/build-from-scratch.md b/site/content/docs/v0.4.0/build-from-scratch.md similarity index 98% rename from site/docs/v0.4.0/build-from-scratch.md rename to site/content/docs/v0.4.0/build-from-scratch.md index df2ea33c6..472122ff4 100644 --- a/site/docs/v0.4.0/build-from-scratch.md +++ b/site/content/docs/v0.4.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build From Scratch +--- +title: "Build From Scratch" +layout: docs +--- While the [README][0] pulls from the Heptio image registry, you can also build your own Heptio Ark container with the following steps: diff --git a/site/docs/v0.4.0/cli-reference/README.md b/site/content/docs/v0.4.0/cli-reference/README.md similarity index 95% rename from site/docs/v0.4.0/cli-reference/README.md rename to site/content/docs/v0.4.0/cli-reference/README.md index be65aa485..598c40c81 100644 --- a/site/docs/v0.4.0/cli-reference/README.md +++ b/site/content/docs/v0.4.0/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.4.0/cli-reference/ark.md b/site/content/docs/v0.4.0/cli-reference/ark.md similarity index 97% rename from site/docs/v0.4.0/cli-reference/ark.md rename to site/content/docs/v0.4.0/cli-reference/ark.md index 5f5f12185..f2f847586 100644 --- a/site/docs/v0.4.0/cli-reference/ark.md +++ b/site/content/docs/v0.4.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.4.0/cli-reference/ark_backup.md b/site/content/docs/v0.4.0/cli-reference/ark_backup.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_backup.md rename to site/content/docs/v0.4.0/cli-reference/ark_backup.md index 35638f0d7..64bba01d4 100644 --- a/site/docs/v0.4.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.4.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.4.0/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.4.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.4.0/cli-reference/ark_backup_create.md index 0b317b229..6b2ce8d9b 100644 --- a/site/docs/v0.4.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.6.0/cli-reference/ark_backup_download.md b/site/content/docs/v0.4.0/cli-reference/ark_backup_download.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_backup_download.md rename to site/content/docs/v0.4.0/cli-reference/ark_backup_download.md index 75580c761..2cf53c2a8 100644 --- a/site/docs/v0.6.0/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.5.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.4.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.5.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.4.0/cli-reference/ark_backup_get.md index fd90b56a0..619975c28 100644 --- a/site/docs/v0.5.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.5.0/cli-reference/ark_backup_logs.md b/site/content/docs/v0.4.0/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.4.0/cli-reference/ark_backup_logs.md index e08515298..0e3092c78 100644 --- a/site/docs/v0.5.0/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.4.0/cli-reference/ark_restore.md b/site/content/docs/v0.4.0/cli-reference/ark_restore.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_restore.md rename to site/content/docs/v0.4.0/cli-reference/ark_restore.md index 5d68f202a..2ef64262d 100644 --- a/site/docs/v0.4.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.4.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.4.0/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.4.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.4.0/cli-reference/ark_restore_create.md index 395dcbe3f..dd4e8b4bb 100644 --- a/site/docs/v0.4.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.5.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.4.0/cli-reference/ark_restore_delete.md similarity index 95% rename from site/docs/v0.5.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.4.0/cli-reference/ark_restore_delete.md index 2b6563733..896140be2 100644 --- a/site/docs/v0.5.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.4.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.4.0/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.4.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.4.0/cli-reference/ark_restore_get.md index 987cc803c..a2a7926fd 100644 --- a/site/docs/v0.4.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- get restores diff --git a/site/docs/v0.5.0/cli-reference/ark_restore_logs.md b/site/content/docs/v0.4.0/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.4.0/cli-reference/ark_restore_logs.md index 677b45f0d..a04b5f299 100644 --- a/site/docs/v0.5.0/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.5.0/cli-reference/ark_schedule.md b/site/content/docs/v0.4.0/cli-reference/ark_schedule.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.4.0/cli-reference/ark_schedule.md index e080546e8..a28b80258 100644 --- a/site/docs/v0.5.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.4.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.4.0/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.4.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.4.0/cli-reference/ark_schedule_create.md index a3ea62726..9a07e618a 100644 --- a/site/docs/v0.4.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.4.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.4.0/cli-reference/ark_schedule_delete.md similarity index 95% rename from site/docs/v0.4.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.4.0/cli-reference/ark_schedule_delete.md index a86f1c5e3..60b66a7ac 100644 --- a/site/docs/v0.4.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.5.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.4.0/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.5.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.4.0/cli-reference/ark_schedule_get.md index a6b86ed5a..d9e91a7b0 100644 --- a/site/docs/v0.5.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.4.0/cli-reference/ark_server.md b/site/content/docs/v0.4.0/cli-reference/ark_server.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_server.md rename to site/content/docs/v0.4.0/cli-reference/ark_server.md index da18fe925..ae4650a2c 100644 --- a/site/docs/v0.4.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.4.0/cli-reference/ark_version.md b/site/content/docs/v0.4.0/cli-reference/ark_version.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_version.md rename to site/content/docs/v0.4.0/cli-reference/ark_version.md index 744cb5378..47008dfef 100644 --- a/site/docs/v0.4.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.4.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.4.0/cloud-provider-specifics.md b/site/content/docs/v0.4.0/cloud-provider-specifics.md similarity index 99% rename from site/docs/v0.4.0/cloud-provider-specifics.md rename to site/content/docs/v0.4.0/cloud-provider-specifics.md index 4b1954f0b..4b7eabb77 100644 --- a/site/docs/v0.4.0/cloud-provider-specifics.md +++ b/site/content/docs/v0.4.0/cloud-provider-specifics.md @@ -1,4 +1,7 @@ -# Cloud Provider Specifics +--- +title: "Cloud Provider Specifics" +layout: docs +--- > NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. > diff --git a/site/docs/v0.3.0/concepts.md b/site/content/docs/v0.4.0/concepts.md similarity index 98% rename from site/docs/v0.3.0/concepts.md rename to site/content/docs/v0.4.0/concepts.md index 3e8ee4be8..8f8474e4c 100644 --- a/site/docs/v0.3.0/concepts.md +++ b/site/content/docs/v0.4.0/concepts.md @@ -1,4 +1,7 @@ -# Concepts +--- +title: "Concepts" +layout: docs +--- * [Overview][0] * [Operation types][1] diff --git a/site/docs/v0.4.0/config-definition.md b/site/content/docs/v0.4.0/config-definition.md similarity index 99% rename from site/docs/v0.4.0/config-definition.md rename to site/content/docs/v0.4.0/config-definition.md index b98d32317..fc0b8a501 100644 --- a/site/docs/v0.4.0/config-definition.md +++ b/site/content/docs/v0.4.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][10] * [Example][11] diff --git a/site/docs/v0.5.0/debugging-restores.md b/site/content/docs/v0.4.0/debugging-restores.md similarity index 97% rename from site/docs/v0.5.0/debugging-restores.md rename to site/content/docs/v0.4.0/debugging-restores.md index 709b0e202..5f60e7884 100644 --- a/site/docs/v0.5.0/debugging-restores.md +++ b/site/content/docs/v0.4.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.4.0/img/README.md b/site/content/docs/v0.4.0/img/README.md similarity index 100% rename from site/docs/v0.4.0/img/README.md rename to site/content/docs/v0.4.0/img/README.md diff --git a/site/docs/v0.4.0/img/backup-process.png b/site/content/docs/v0.4.0/img/backup-process.png similarity index 100% rename from site/docs/v0.4.0/img/backup-process.png rename to site/content/docs/v0.4.0/img/backup-process.png diff --git a/site/docs/v0.4.0/output-file-format.md b/site/content/docs/v0.4.0/output-file-format.md similarity index 98% rename from site/docs/v0.4.0/output-file-format.md rename to site/content/docs/v0.4.0/output-file-format.md index 7f7b92a07..98fb952c7 100644 --- a/site/docs/v0.4.0/output-file-format.md +++ b/site/content/docs/v0.4.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.4.0/use-cases.md b/site/content/docs/v0.4.0/use-cases.md similarity index 98% rename from site/docs/v0.4.0/use-cases.md rename to site/content/docs/v0.4.0/use-cases.md index 7cb59ff90..e92ef61e3 100644 --- a/site/docs/v0.4.0/use-cases.md +++ b/site/content/docs/v0.4.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/docs/v0.5.0/vendoring-dependencies.md b/site/content/docs/v0.4.0/vendoring-dependencies.md similarity index 91% rename from site/docs/v0.5.0/vendoring-dependencies.md rename to site/content/docs/v0.4.0/vendoring-dependencies.md index ce5f9a9d4..67ad755bc 100644 --- a/site/docs/v0.5.0/vendoring-dependencies.md +++ b/site/content/docs/v0.4.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.5.0/README.md b/site/content/docs/v0.5.0/_index.md similarity index 99% rename from site/docs/v0.5.0/README.md rename to site/content/docs/v0.5.0/_index.md index 1aaa0f605..163113185 100644 --- a/site/docs/v0.5.0/README.md +++ b/site/content/docs/v0.5.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.5.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/content/docs/v0.5.0/api-types/README.md b/site/content/docs/v0.5.0/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.5.0/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/docs/v0.5.0/api-types/backup.md b/site/content/docs/v0.5.0/api-types/backup.md similarity index 99% rename from site/docs/v0.5.0/api-types/backup.md rename to site/content/docs/v0.5.0/api-types/backup.md index 75598ed9f..865353132 100644 --- a/site/docs/v0.5.0/api-types/backup.md +++ b/site/content/docs/v0.5.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.5.0/build-from-scratch.md b/site/content/docs/v0.5.0/build-from-scratch.md similarity index 98% rename from site/docs/v0.5.0/build-from-scratch.md rename to site/content/docs/v0.5.0/build-from-scratch.md index fa5e6aee8..1710f4623 100644 --- a/site/docs/v0.5.0/build-from-scratch.md +++ b/site/content/docs/v0.5.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build From Scratch +--- +title: "Build From Scratch" +layout: docs +--- While the [README][0] pulls from the Heptio image registry, you can also build your own Heptio Ark container with the following steps: diff --git a/site/docs/v0.5.0/cli-reference/README.md b/site/content/docs/v0.5.0/cli-reference/README.md similarity index 95% rename from site/docs/v0.5.0/cli-reference/README.md rename to site/content/docs/v0.5.0/cli-reference/README.md index be65aa485..598c40c81 100644 --- a/site/docs/v0.5.0/cli-reference/README.md +++ b/site/content/docs/v0.5.0/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.5.0/cli-reference/ark.md b/site/content/docs/v0.5.0/cli-reference/ark.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark.md rename to site/content/docs/v0.5.0/cli-reference/ark.md index fe1e05db4..5fbf4d2ad 100644 --- a/site/docs/v0.5.0/cli-reference/ark.md +++ b/site/content/docs/v0.5.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.5.0/cli-reference/ark_backup.md b/site/content/docs/v0.5.0/cli-reference/ark_backup.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_backup.md rename to site/content/docs/v0.5.0/cli-reference/ark_backup.md index 35638f0d7..64bba01d4 100644 --- a/site/docs/v0.5.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.5.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.5.0/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.5.0/cli-reference/ark_backup_create.md index d9568c80c..dbf00f01b 100644 --- a/site/docs/v0.5.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.5.0/cli-reference/ark_backup_download.md b/site/content/docs/v0.5.0/cli-reference/ark_backup_download.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_backup_download.md rename to site/content/docs/v0.5.0/cli-reference/ark_backup_download.md index 75580c761..2cf53c2a8 100644 --- a/site/docs/v0.5.0/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.6.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.5.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.5.0/cli-reference/ark_backup_get.md index fd90b56a0..619975c28 100644 --- a/site/docs/v0.6.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.6.0/cli-reference/ark_backup_logs.md b/site/content/docs/v0.5.0/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.5.0/cli-reference/ark_backup_logs.md index e08515298..0e3092c78 100644 --- a/site/docs/v0.6.0/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.5.0/cli-reference/ark_create.md b/site/content/docs/v0.5.0/cli-reference/ark_create.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_create.md rename to site/content/docs/v0.5.0/cli-reference/ark_create.md index 34d37dcde..98588a216 100644 --- a/site/docs/v0.5.0/cli-reference/ark_create.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.5.0/cli-reference/ark_create_backup.md b/site/content/docs/v0.5.0/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark_create_backup.md rename to site/content/docs/v0.5.0/cli-reference/ark_create_backup.md index 592be219a..c83d43b5a 100644 --- a/site/docs/v0.5.0/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.5.0/cli-reference/ark_create_restore.md b/site/content/docs/v0.5.0/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark_create_restore.md rename to site/content/docs/v0.5.0/cli-reference/ark_create_restore.md index 071757d20..9b3a78355 100644 --- a/site/docs/v0.5.0/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.5.0/cli-reference/ark_create_schedule.md b/site/content/docs/v0.5.0/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.5.0/cli-reference/ark_create_schedule.md index f9911e334..f2e30ab6c 100644 --- a/site/docs/v0.5.0/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.5.0/cli-reference/ark_get.md b/site/content/docs/v0.5.0/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.5.0/cli-reference/ark_get.md rename to site/content/docs/v0.5.0/cli-reference/ark_get.md index 949a84231..8c5be95b7 100644 --- a/site/docs/v0.5.0/cli-reference/ark_get.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.5.0/cli-reference/ark_get_backups.md b/site/content/docs/v0.5.0/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.5.0/cli-reference/ark_get_backups.md rename to site/content/docs/v0.5.0/cli-reference/ark_get_backups.md index 7ffa1b493..b496919b4 100644 --- a/site/docs/v0.5.0/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.6.0/cli-reference/ark_get_restores.md b/site/content/docs/v0.5.0/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_get_restores.md rename to site/content/docs/v0.5.0/cli-reference/ark_get_restores.md index ff615a2a1..0a3f4be50 100644 --- a/site/docs/v0.6.0/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.5.0/cli-reference/ark_get_schedules.md b/site/content/docs/v0.5.0/cli-reference/ark_get_schedules.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.5.0/cli-reference/ark_get_schedules.md index 7329b897d..7e1c29f93 100644 --- a/site/docs/v0.5.0/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.5.0/cli-reference/ark_restore.md b/site/content/docs/v0.5.0/cli-reference/ark_restore.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_restore.md rename to site/content/docs/v0.5.0/cli-reference/ark_restore.md index 4b8b6ea3c..158fa6341 100644 --- a/site/docs/v0.5.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.5.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.5.0/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.5.0/cli-reference/ark_restore_create.md index ec984dfab..7dc404be4 100644 --- a/site/docs/v0.5.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.4.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.5.0/cli-reference/ark_restore_delete.md similarity index 95% rename from site/docs/v0.4.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.5.0/cli-reference/ark_restore_delete.md index 2b6563733..896140be2 100644 --- a/site/docs/v0.4.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.5.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.5.0/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.5.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.5.0/cli-reference/ark_restore_get.md index c4e3738cc..f016b998b 100644 --- a/site/docs/v0.5.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.6.0/cli-reference/ark_restore_logs.md b/site/content/docs/v0.5.0/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.5.0/cli-reference/ark_restore_logs.md index 677b45f0d..a04b5f299 100644 --- a/site/docs/v0.6.0/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.4.0/cli-reference/ark_schedule.md b/site/content/docs/v0.5.0/cli-reference/ark_schedule.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.5.0/cli-reference/ark_schedule.md index e080546e8..a28b80258 100644 --- a/site/docs/v0.4.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.5.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.5.0/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.5.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.5.0/cli-reference/ark_schedule_create.md index 4548e71b0..f7b4f1ec2 100644 --- a/site/docs/v0.5.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.5.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.5.0/cli-reference/ark_schedule_delete.md similarity index 95% rename from site/docs/v0.5.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.5.0/cli-reference/ark_schedule_delete.md index a86f1c5e3..60b66a7ac 100644 --- a/site/docs/v0.5.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.6.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.5.0/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.5.0/cli-reference/ark_schedule_get.md index a6b86ed5a..d9e91a7b0 100644 --- a/site/docs/v0.6.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.5.0/cli-reference/ark_server.md b/site/content/docs/v0.5.0/cli-reference/ark_server.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_server.md rename to site/content/docs/v0.5.0/cli-reference/ark_server.md index ef770c248..e66631fdf 100644 --- a/site/docs/v0.5.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.5.0/cli-reference/ark_version.md b/site/content/docs/v0.5.0/cli-reference/ark_version.md similarity index 96% rename from site/docs/v0.5.0/cli-reference/ark_version.md rename to site/content/docs/v0.5.0/cli-reference/ark_version.md index 744cb5378..47008dfef 100644 --- a/site/docs/v0.5.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.5.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.5.0/cloud-provider-specifics.md b/site/content/docs/v0.5.0/cloud-provider-specifics.md similarity index 99% rename from site/docs/v0.5.0/cloud-provider-specifics.md rename to site/content/docs/v0.5.0/cloud-provider-specifics.md index d30a2867d..322aad4da 100644 --- a/site/docs/v0.5.0/cloud-provider-specifics.md +++ b/site/content/docs/v0.5.0/cloud-provider-specifics.md @@ -1,4 +1,7 @@ -# Cloud Provider Specifics +--- +title: "Cloud Provider Specifics" +layout: docs +--- > NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. > diff --git a/site/docs/v0.5.0/concepts.md b/site/content/docs/v0.5.0/concepts.md similarity index 99% rename from site/docs/v0.5.0/concepts.md rename to site/content/docs/v0.5.0/concepts.md index 8bf82bc37..eac529190 100644 --- a/site/docs/v0.5.0/concepts.md +++ b/site/content/docs/v0.5.0/concepts.md @@ -1,4 +1,7 @@ -# Concepts +--- +title: "Concepts" +layout: docs +--- * [Overview][0] * [Operation types][1] diff --git a/site/docs/v0.5.0/config-definition.md b/site/content/docs/v0.5.0/config-definition.md similarity index 99% rename from site/docs/v0.5.0/config-definition.md rename to site/content/docs/v0.5.0/config-definition.md index 50ff779e7..cef13282b 100644 --- a/site/docs/v0.5.0/config-definition.md +++ b/site/content/docs/v0.5.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.3.0/debugging-restores.md b/site/content/docs/v0.5.0/debugging-restores.md similarity index 97% rename from site/docs/v0.3.0/debugging-restores.md rename to site/content/docs/v0.5.0/debugging-restores.md index 709b0e202..5f60e7884 100644 --- a/site/docs/v0.3.0/debugging-restores.md +++ b/site/content/docs/v0.5.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.5.0/faq.md b/site/content/docs/v0.5.0/faq.md similarity index 97% rename from site/docs/v0.5.0/faq.md rename to site/content/docs/v0.5.0/faq.md index d51011f69..c96c6d549 100644 --- a/site/docs/v0.5.0/faq.md +++ b/site/content/docs/v0.5.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.5.0/hooks.md b/site/content/docs/v0.5.0/hooks.md similarity index 97% rename from site/docs/v0.5.0/hooks.md rename to site/content/docs/v0.5.0/hooks.md index 5e206cb8e..51eaeca78 100644 --- a/site/docs/v0.5.0/hooks.md +++ b/site/content/docs/v0.5.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.5.0/img/README.md b/site/content/docs/v0.5.0/img/README.md similarity index 100% rename from site/docs/v0.5.0/img/README.md rename to site/content/docs/v0.5.0/img/README.md diff --git a/site/docs/v0.5.0/img/backup-process.png b/site/content/docs/v0.5.0/img/backup-process.png similarity index 100% rename from site/docs/v0.5.0/img/backup-process.png rename to site/content/docs/v0.5.0/img/backup-process.png diff --git a/site/docs/v0.5.0/output-file-format.md b/site/content/docs/v0.5.0/output-file-format.md similarity index 98% rename from site/docs/v0.5.0/output-file-format.md rename to site/content/docs/v0.5.0/output-file-format.md index 11ab1310b..c8fb19a02 100644 --- a/site/docs/v0.5.0/output-file-format.md +++ b/site/content/docs/v0.5.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.5.0/use-cases.md b/site/content/docs/v0.5.0/use-cases.md similarity index 98% rename from site/docs/v0.5.0/use-cases.md rename to site/content/docs/v0.5.0/use-cases.md index 7cb59ff90..e92ef61e3 100644 --- a/site/docs/v0.5.0/use-cases.md +++ b/site/content/docs/v0.5.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/docs/v0.6.0/vendoring-dependencies.md b/site/content/docs/v0.5.0/vendoring-dependencies.md similarity index 91% rename from site/docs/v0.6.0/vendoring-dependencies.md rename to site/content/docs/v0.5.0/vendoring-dependencies.md index ce5f9a9d4..67ad755bc 100644 --- a/site/docs/v0.6.0/vendoring-dependencies.md +++ b/site/content/docs/v0.5.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.6.0/README.md b/site/content/docs/v0.6.0/_index.md similarity index 99% rename from site/docs/v0.6.0/README.md rename to site/content/docs/v0.6.0/_index.md index 599e953f8..3d833abba 100644 --- a/site/docs/v0.6.0/README.md +++ b/site/content/docs/v0.6.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.6.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/content/docs/v0.6.0/api-types/README.md b/site/content/docs/v0.6.0/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.6.0/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/docs/v0.6.0/api-types/backup.md b/site/content/docs/v0.6.0/api-types/backup.md similarity index 99% rename from site/docs/v0.6.0/api-types/backup.md rename to site/content/docs/v0.6.0/api-types/backup.md index 75598ed9f..865353132 100644 --- a/site/docs/v0.6.0/api-types/backup.md +++ b/site/content/docs/v0.6.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.6.0/build-from-scratch.md b/site/content/docs/v0.6.0/build-from-scratch.md similarity index 98% rename from site/docs/v0.6.0/build-from-scratch.md rename to site/content/docs/v0.6.0/build-from-scratch.md index feae2e62d..506bb0d1f 100644 --- a/site/docs/v0.6.0/build-from-scratch.md +++ b/site/content/docs/v0.6.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build From Scratch +--- +title: "Build From Scratch" +layout: docs +--- While the [README][0] pulls from the Heptio image registry, you can also build your own Heptio Ark container with the following steps: diff --git a/site/docs/v0.6.0/cli-reference/README.md b/site/content/docs/v0.6.0/cli-reference/README.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/README.md rename to site/content/docs/v0.6.0/cli-reference/README.md index be65aa485..598c40c81 100644 --- a/site/docs/v0.6.0/cli-reference/README.md +++ b/site/content/docs/v0.6.0/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.6.0/cli-reference/ark.md b/site/content/docs/v0.6.0/cli-reference/ark.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark.md rename to site/content/docs/v0.6.0/cli-reference/ark.md index 46f48ab8a..7d33e114f 100644 --- a/site/docs/v0.6.0/cli-reference/ark.md +++ b/site/content/docs/v0.6.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.6.0/cli-reference/ark_backup.md b/site/content/docs/v0.6.0/cli-reference/ark_backup.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_backup.md rename to site/content/docs/v0.6.0/cli-reference/ark_backup.md index fefdbad43..523834bd3 100644 --- a/site/docs/v0.6.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.6.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.6.0/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.6.0/cli-reference/ark_backup_create.md index 473be03fa..5369a0adb 100644 --- a/site/docs/v0.6.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.6.0/cli-reference/ark_backup_describe.md b/site/content/docs/v0.6.0/cli-reference/ark_backup_describe.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_backup_describe.md rename to site/content/docs/v0.6.0/cli-reference/ark_backup_describe.md index f718cf20b..08e0ef8c5 100644 --- a/site/docs/v0.6.0/cli-reference/ark_backup_describe.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_backup_describe.md @@ -1,4 +1,7 @@ -## ark backup describe +--- +title: "ark backup describe" +layout: docs +--- Describe backups diff --git a/site/docs/v0.4.0/cli-reference/ark_backup_download.md b/site/content/docs/v0.6.0/cli-reference/ark_backup_download.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_backup_download.md rename to site/content/docs/v0.6.0/cli-reference/ark_backup_download.md index 75580c761..2cf53c2a8 100644 --- a/site/docs/v0.4.0/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.4.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.6.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.4.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.6.0/cli-reference/ark_backup_get.md index fd90b56a0..619975c28 100644 --- a/site/docs/v0.4.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.4.0/cli-reference/ark_backup_logs.md b/site/content/docs/v0.6.0/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.6.0/cli-reference/ark_backup_logs.md index e08515298..0e3092c78 100644 --- a/site/docs/v0.4.0/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.6.0/cli-reference/ark_create.md b/site/content/docs/v0.6.0/cli-reference/ark_create.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_create.md rename to site/content/docs/v0.6.0/cli-reference/ark_create.md index 34d37dcde..98588a216 100644 --- a/site/docs/v0.6.0/cli-reference/ark_create.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.6.0/cli-reference/ark_create_backup.md b/site/content/docs/v0.6.0/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark_create_backup.md rename to site/content/docs/v0.6.0/cli-reference/ark_create_backup.md index d997e5eda..3e5006ffc 100644 --- a/site/docs/v0.6.0/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.6.0/cli-reference/ark_create_restore.md b/site/content/docs/v0.6.0/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark_create_restore.md rename to site/content/docs/v0.6.0/cli-reference/ark_create_restore.md index 071757d20..9b3a78355 100644 --- a/site/docs/v0.6.0/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.6.0/cli-reference/ark_create_schedule.md b/site/content/docs/v0.6.0/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.6.0/cli-reference/ark_create_schedule.md index eb4aa84be..c2a1f7c3e 100644 --- a/site/docs/v0.6.0/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.6.0/cli-reference/ark_describe.md b/site/content/docs/v0.6.0/cli-reference/ark_describe.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_describe.md rename to site/content/docs/v0.6.0/cli-reference/ark_describe.md index 6f47702eb..87cba6801 100644 --- a/site/docs/v0.6.0/cli-reference/ark_describe.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_describe.md @@ -1,4 +1,7 @@ -## ark describe +--- +title: "ark describe" +layout: docs +--- Describe ark resources diff --git a/site/docs/v0.6.0/cli-reference/ark_describe_backups.md b/site/content/docs/v0.6.0/cli-reference/ark_describe_backups.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_describe_backups.md rename to site/content/docs/v0.6.0/cli-reference/ark_describe_backups.md index 867975b20..d9b502ee4 100644 --- a/site/docs/v0.6.0/cli-reference/ark_describe_backups.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_describe_backups.md @@ -1,4 +1,7 @@ -## ark describe backups +--- +title: "ark describe backups" +layout: docs +--- Describe backups diff --git a/site/docs/v0.6.0/cli-reference/ark_describe_restores.md b/site/content/docs/v0.6.0/cli-reference/ark_describe_restores.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_describe_restores.md rename to site/content/docs/v0.6.0/cli-reference/ark_describe_restores.md index 337667302..7535c44f8 100644 --- a/site/docs/v0.6.0/cli-reference/ark_describe_restores.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_describe_restores.md @@ -1,4 +1,7 @@ -## ark describe restores +--- +title: "ark describe restores" +layout: docs +--- Describe restores diff --git a/site/docs/v0.6.0/cli-reference/ark_describe_schedules.md b/site/content/docs/v0.6.0/cli-reference/ark_describe_schedules.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_describe_schedules.md rename to site/content/docs/v0.6.0/cli-reference/ark_describe_schedules.md index 16b50b5f2..72b4e5856 100644 --- a/site/docs/v0.6.0/cli-reference/ark_describe_schedules.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_describe_schedules.md @@ -1,4 +1,7 @@ -## ark describe schedules +--- +title: "ark describe schedules" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.6.0/cli-reference/ark_get.md b/site/content/docs/v0.6.0/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_get.md rename to site/content/docs/v0.6.0/cli-reference/ark_get.md index 949a84231..8c5be95b7 100644 --- a/site/docs/v0.6.0/cli-reference/ark_get.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.6.0/cli-reference/ark_get_backups.md b/site/content/docs/v0.6.0/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_get_backups.md rename to site/content/docs/v0.6.0/cli-reference/ark_get_backups.md index 7ffa1b493..b496919b4 100644 --- a/site/docs/v0.6.0/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.5.0/cli-reference/ark_get_restores.md b/site/content/docs/v0.6.0/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.5.0/cli-reference/ark_get_restores.md rename to site/content/docs/v0.6.0/cli-reference/ark_get_restores.md index ff615a2a1..0a3f4be50 100644 --- a/site/docs/v0.5.0/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.6.0/cli-reference/ark_get_schedules.md b/site/content/docs/v0.6.0/cli-reference/ark_get_schedules.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.6.0/cli-reference/ark_get_schedules.md index 7329b897d..7e1c29f93 100644 --- a/site/docs/v0.6.0/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.6.0/cli-reference/ark_plugin.md b/site/content/docs/v0.6.0/cli-reference/ark_plugin.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_plugin.md rename to site/content/docs/v0.6.0/cli-reference/ark_plugin.md index 94d02261f..df3dbb141 100644 --- a/site/docs/v0.6.0/cli-reference/ark_plugin.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_plugin.md @@ -1,4 +1,7 @@ -## ark plugin +--- +title: "ark plugin" +layout: docs +--- Work with plugins diff --git a/site/docs/v0.6.0/cli-reference/ark_plugin_add.md b/site/content/docs/v0.6.0/cli-reference/ark_plugin_add.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_plugin_add.md rename to site/content/docs/v0.6.0/cli-reference/ark_plugin_add.md index aa3e6af3a..741b63802 100644 --- a/site/docs/v0.6.0/cli-reference/ark_plugin_add.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_plugin_add.md @@ -1,4 +1,7 @@ -## ark plugin add +--- +title: "ark plugin add" +layout: docs +--- Add a plugin diff --git a/site/docs/v0.6.0/cli-reference/ark_plugin_remove.md b/site/content/docs/v0.6.0/cli-reference/ark_plugin_remove.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_plugin_remove.md rename to site/content/docs/v0.6.0/cli-reference/ark_plugin_remove.md index 890f4e83b..bca030b7a 100644 --- a/site/docs/v0.6.0/cli-reference/ark_plugin_remove.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_plugin_remove.md @@ -1,4 +1,7 @@ -## ark plugin remove +--- +title: "ark plugin remove" +layout: docs +--- Remove a plugin diff --git a/site/docs/v0.6.0/cli-reference/ark_restore.md b/site/content/docs/v0.6.0/cli-reference/ark_restore.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_restore.md rename to site/content/docs/v0.6.0/cli-reference/ark_restore.md index 1c5a06adf..cc8cd6d68 100644 --- a/site/docs/v0.6.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.6.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.6.0/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.6.0/cli-reference/ark_restore_create.md index ec984dfab..7dc404be4 100644 --- a/site/docs/v0.6.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.6.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.6.0/cli-reference/ark_restore_delete.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.6.0/cli-reference/ark_restore_delete.md index 2b6563733..896140be2 100644 --- a/site/docs/v0.6.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.6.0/cli-reference/ark_restore_describe.md b/site/content/docs/v0.6.0/cli-reference/ark_restore_describe.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_restore_describe.md rename to site/content/docs/v0.6.0/cli-reference/ark_restore_describe.md index fcbd518f7..073626577 100644 --- a/site/docs/v0.6.0/cli-reference/ark_restore_describe.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_restore_describe.md @@ -1,4 +1,7 @@ -## ark restore describe +--- +title: "ark restore describe" +layout: docs +--- Describe restores diff --git a/site/docs/v0.6.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.6.0/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.6.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.6.0/cli-reference/ark_restore_get.md index c4e3738cc..f016b998b 100644 --- a/site/docs/v0.6.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.4.0/cli-reference/ark_restore_logs.md b/site/content/docs/v0.6.0/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.4.0/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.6.0/cli-reference/ark_restore_logs.md index 677b45f0d..a04b5f299 100644 --- a/site/docs/v0.4.0/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.6.0/cli-reference/ark_schedule.md b/site/content/docs/v0.6.0/cli-reference/ark_schedule.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.6.0/cli-reference/ark_schedule.md index a2141cd74..87390e63b 100644 --- a/site/docs/v0.6.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.6.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.6.0/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.6.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.6.0/cli-reference/ark_schedule_create.md index d5b896498..8cb996aad 100644 --- a/site/docs/v0.6.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.6.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.6.0/cli-reference/ark_schedule_delete.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.6.0/cli-reference/ark_schedule_delete.md index a86f1c5e3..60b66a7ac 100644 --- a/site/docs/v0.6.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.6.0/cli-reference/ark_schedule_describe.md b/site/content/docs/v0.6.0/cli-reference/ark_schedule_describe.md similarity index 95% rename from site/docs/v0.6.0/cli-reference/ark_schedule_describe.md rename to site/content/docs/v0.6.0/cli-reference/ark_schedule_describe.md index a008142f8..5b61d267f 100644 --- a/site/docs/v0.6.0/cli-reference/ark_schedule_describe.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_schedule_describe.md @@ -1,4 +1,7 @@ -## ark schedule describe +--- +title: "ark schedule describe" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.4.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.6.0/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.4.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.6.0/cli-reference/ark_schedule_get.md index a6b86ed5a..d9e91a7b0 100644 --- a/site/docs/v0.4.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.6.0/cli-reference/ark_server.md b/site/content/docs/v0.6.0/cli-reference/ark_server.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_server.md rename to site/content/docs/v0.6.0/cli-reference/ark_server.md index ef770c248..e66631fdf 100644 --- a/site/docs/v0.6.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.6.0/cli-reference/ark_version.md b/site/content/docs/v0.6.0/cli-reference/ark_version.md similarity index 96% rename from site/docs/v0.6.0/cli-reference/ark_version.md rename to site/content/docs/v0.6.0/cli-reference/ark_version.md index 744cb5378..47008dfef 100644 --- a/site/docs/v0.6.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.6.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.6.0/cloud-provider-specifics.md b/site/content/docs/v0.6.0/cloud-provider-specifics.md similarity index 99% rename from site/docs/v0.6.0/cloud-provider-specifics.md rename to site/content/docs/v0.6.0/cloud-provider-specifics.md index 7f5c66383..74cd06af7 100644 --- a/site/docs/v0.6.0/cloud-provider-specifics.md +++ b/site/content/docs/v0.6.0/cloud-provider-specifics.md @@ -1,4 +1,7 @@ -# Cloud Provider Specifics +--- +title: "Cloud Provider Specifics" +layout: docs +--- > NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. > diff --git a/site/docs/v0.6.0/concepts.md b/site/content/docs/v0.6.0/concepts.md similarity index 99% rename from site/docs/v0.6.0/concepts.md rename to site/content/docs/v0.6.0/concepts.md index 8bf82bc37..eac529190 100644 --- a/site/docs/v0.6.0/concepts.md +++ b/site/content/docs/v0.6.0/concepts.md @@ -1,4 +1,7 @@ -# Concepts +--- +title: "Concepts" +layout: docs +--- * [Overview][0] * [Operation types][1] diff --git a/site/docs/v0.6.0/config-definition.md b/site/content/docs/v0.6.0/config-definition.md similarity index 99% rename from site/docs/v0.6.0/config-definition.md rename to site/content/docs/v0.6.0/config-definition.md index ed22bc87b..e59a6b3da 100644 --- a/site/docs/v0.6.0/config-definition.md +++ b/site/content/docs/v0.6.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.7.1/debugging-restores.md b/site/content/docs/v0.6.0/debugging-restores.md similarity index 98% rename from site/docs/v0.7.1/debugging-restores.md rename to site/content/docs/v0.6.0/debugging-restores.md index 3b8fc1f93..338129ea3 100644 --- a/site/docs/v0.7.1/debugging-restores.md +++ b/site/content/docs/v0.6.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.7.1/faq.md b/site/content/docs/v0.6.0/faq.md similarity index 97% rename from site/docs/v0.7.1/faq.md rename to site/content/docs/v0.6.0/faq.md index f83829ec9..0fbfbbb35 100644 --- a/site/docs/v0.7.1/faq.md +++ b/site/content/docs/v0.6.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.6.0/hooks.md b/site/content/docs/v0.6.0/hooks.md similarity index 97% rename from site/docs/v0.6.0/hooks.md rename to site/content/docs/v0.6.0/hooks.md index 5e206cb8e..51eaeca78 100644 --- a/site/docs/v0.6.0/hooks.md +++ b/site/content/docs/v0.6.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.6.0/img/README.md b/site/content/docs/v0.6.0/img/README.md similarity index 100% rename from site/docs/v0.6.0/img/README.md rename to site/content/docs/v0.6.0/img/README.md diff --git a/site/docs/v0.6.0/img/backup-process.png b/site/content/docs/v0.6.0/img/backup-process.png similarity index 100% rename from site/docs/v0.6.0/img/backup-process.png rename to site/content/docs/v0.6.0/img/backup-process.png diff --git a/site/docs/v0.6.0/output-file-format.md b/site/content/docs/v0.6.0/output-file-format.md similarity index 98% rename from site/docs/v0.6.0/output-file-format.md rename to site/content/docs/v0.6.0/output-file-format.md index 11ab1310b..c8fb19a02 100644 --- a/site/docs/v0.6.0/output-file-format.md +++ b/site/content/docs/v0.6.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.6.0/plugins.md b/site/content/docs/v0.6.0/plugins.md similarity index 98% rename from site/docs/v0.6.0/plugins.md rename to site/content/docs/v0.6.0/plugins.md index 1cb2ae391..55dc172e4 100644 --- a/site/docs/v0.6.0/plugins.md +++ b/site/content/docs/v0.6.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary diff --git a/site/docs/v0.6.0/use-cases.md b/site/content/docs/v0.6.0/use-cases.md similarity index 98% rename from site/docs/v0.6.0/use-cases.md rename to site/content/docs/v0.6.0/use-cases.md index 92e709d67..1813dc041 100644 --- a/site/docs/v0.6.0/use-cases.md +++ b/site/content/docs/v0.6.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/docs/v0.7.0/vendoring-dependencies.md b/site/content/docs/v0.6.0/vendoring-dependencies.md similarity index 91% rename from site/docs/v0.7.0/vendoring-dependencies.md rename to site/content/docs/v0.6.0/vendoring-dependencies.md index ce5f9a9d4..67ad755bc 100644 --- a/site/docs/v0.7.0/vendoring-dependencies.md +++ b/site/content/docs/v0.6.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.7.0/README.md b/site/content/docs/v0.7.0/_index.md similarity index 99% rename from site/docs/v0.7.0/README.md rename to site/content/docs/v0.7.0/_index.md index cdcca123b..73f0ba6f4 100644 --- a/site/docs/v0.7.0/README.md +++ b/site/content/docs/v0.7.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.7.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.8.0/about.md b/site/content/docs/v0.7.0/about.md similarity index 99% rename from site/docs/v0.8.0/about.md rename to site/content/docs/v0.7.0/about.md index 2cb82db26..4d48dce47 100644 --- a/site/docs/v0.8.0/about.md +++ b/site/content/docs/v0.7.0/about.md @@ -1,4 +1,7 @@ -# About Heptio Ark +--- +title: "About Heptio Ark" +layout: docs +--- Heptio Ark provides customizable degrees of recovery for all Kubernetes objects (Pods, Deployments, Jobs, Custom Resource Definitions, etc.), as well as for persistent volumes. This recovery can be cluster-wide, or fine-tuned according to object type, namespace, or labels. diff --git a/site/content/docs/v0.7.0/api-types/README.md b/site/content/docs/v0.7.0/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.7.0/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/docs/v0.7.0/api-types/backup.md b/site/content/docs/v0.7.0/api-types/backup.md similarity index 99% rename from site/docs/v0.7.0/api-types/backup.md rename to site/content/docs/v0.7.0/api-types/backup.md index feef7c3dc..def928fc0 100644 --- a/site/docs/v0.7.0/api-types/backup.md +++ b/site/content/docs/v0.7.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.7.0/aws-config.md b/site/content/docs/v0.7.0/aws-config.md similarity index 98% rename from site/docs/v0.7.0/aws-config.md rename to site/content/docs/v0.7.0/aws-config.md index 0267f2aa2..8fff25289 100644 --- a/site/docs/v0.7.0/aws-config.md +++ b/site/content/docs/v0.7.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Ark on AWS +--- +title: "Run Ark on AWS" +layout: docs +--- To set up Ark on AWS, you: diff --git a/site/docs/v0.7.0/azure-config.md b/site/content/docs/v0.7.0/azure-config.md similarity index 99% rename from site/docs/v0.7.0/azure-config.md rename to site/content/docs/v0.7.0/azure-config.md index dd3cc733e..d6ba93007 100644 --- a/site/docs/v0.7.0/azure-config.md +++ b/site/content/docs/v0.7.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Ark on Azure +--- +title: "Run Ark on Azure" +layout: docs +--- To configure Ark on Azure, you: diff --git a/site/docs/v0.7.0/build-from-scratch.md b/site/content/docs/v0.7.0/build-from-scratch.md similarity index 98% rename from site/docs/v0.7.0/build-from-scratch.md rename to site/content/docs/v0.7.0/build-from-scratch.md index 6552682e3..001f17e26 100644 --- a/site/docs/v0.7.0/build-from-scratch.md +++ b/site/content/docs/v0.7.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Download][2] diff --git a/site/docs/v0.7.0/cli-reference/README.md b/site/content/docs/v0.7.0/cli-reference/README.md similarity index 93% rename from site/docs/v0.7.0/cli-reference/README.md rename to site/content/docs/v0.7.0/cli-reference/README.md index 29bebb516..1494296dd 100644 --- a/site/docs/v0.7.0/cli-reference/README.md +++ b/site/content/docs/v0.7.0/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.7.1/cli-reference/ark.md b/site/content/docs/v0.7.0/cli-reference/ark.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark.md rename to site/content/docs/v0.7.0/cli-reference/ark.md index daaf87f74..6c3652a3f 100644 --- a/site/docs/v0.7.1/cli-reference/ark.md +++ b/site/content/docs/v0.7.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.7.1/cli-reference/ark_backup.md b/site/content/docs/v0.7.0/cli-reference/ark_backup.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_backup.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup.md index 1e7fb67b2..7ca0694c1 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.7.1/cli-reference/ark_backup_create.md b/site/content/docs/v0.7.0/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark_backup_create.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup_create.md index 8f098c3c2..3fc8564ec 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.7.0/cli-reference/ark_backup_delete.md b/site/content/docs/v0.7.0/cli-reference/ark_backup_delete.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_backup_delete.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup_delete.md index 33d8b984e..ef10a6360 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup_delete.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup_delete.md @@ -1,4 +1,7 @@ -## ark backup delete +--- +title: "ark backup delete" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.7.1/cli-reference/ark_backup_describe.md b/site/content/docs/v0.7.0/cli-reference/ark_backup_describe.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_backup_describe.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup_describe.md index 53d17e5b1..cda0b04a7 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup_describe.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup_describe.md @@ -1,4 +1,7 @@ -## ark backup describe +--- +title: "ark backup describe" +layout: docs +--- Describe backups diff --git a/site/docs/v0.7.1/cli-reference/ark_backup_download.md b/site/content/docs/v0.7.0/cli-reference/ark_backup_download.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_backup_download.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup_download.md index 68f98ff6b..c8193deb7 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.7.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.7.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup_get.md index 3e289bd84..0a2463aaa 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.7.1/cli-reference/ark_backup_logs.md b/site/content/docs/v0.7.0/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.7.0/cli-reference/ark_backup_logs.md index 0ee6c9d47..ef90e24b2 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.7.1/cli-reference/ark_client.md b/site/content/docs/v0.7.0/cli-reference/ark_client.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_client.md rename to site/content/docs/v0.7.0/cli-reference/ark_client.md index 03c9d39c8..48cbfbb89 100644 --- a/site/docs/v0.7.1/cli-reference/ark_client.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_client.md @@ -1,4 +1,7 @@ -## ark client +--- +title: "ark client" +layout: docs +--- Ark client related commands diff --git a/site/docs/v0.7.0/cli-reference/ark_client_config.md b/site/content/docs/v0.7.0/cli-reference/ark_client_config.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_client_config.md rename to site/content/docs/v0.7.0/cli-reference/ark_client_config.md index b4ed2fa32..331537ab1 100644 --- a/site/docs/v0.7.0/cli-reference/ark_client_config.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_client_config.md @@ -1,4 +1,7 @@ -## ark client config +--- +title: "ark client config" +layout: docs +--- Get and set client configuration file values diff --git a/site/docs/v0.7.0/cli-reference/ark_client_config_get.md b/site/content/docs/v0.7.0/cli-reference/ark_client_config_get.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_client_config_get.md rename to site/content/docs/v0.7.0/cli-reference/ark_client_config_get.md index 403966449..05b777589 100644 --- a/site/docs/v0.7.0/cli-reference/ark_client_config_get.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_client_config_get.md @@ -1,4 +1,7 @@ -## ark client config get +--- +title: "ark client config get" +layout: docs +--- Get client configuration file values diff --git a/site/docs/v0.7.0/cli-reference/ark_client_config_set.md b/site/content/docs/v0.7.0/cli-reference/ark_client_config_set.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_client_config_set.md rename to site/content/docs/v0.7.0/cli-reference/ark_client_config_set.md index af2c49728..1f192300b 100644 --- a/site/docs/v0.7.0/cli-reference/ark_client_config_set.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_client_config_set.md @@ -1,4 +1,7 @@ -## ark client config set +--- +title: "ark client config set" +layout: docs +--- Set client configuration file values diff --git a/site/docs/v0.7.1/cli-reference/ark_create.md b/site/content/docs/v0.7.0/cli-reference/ark_create.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_create.md rename to site/content/docs/v0.7.0/cli-reference/ark_create.md index afecb59a5..b64dac444 100644 --- a/site/docs/v0.7.1/cli-reference/ark_create.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.7.1/cli-reference/ark_create_backup.md b/site/content/docs/v0.7.0/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark_create_backup.md rename to site/content/docs/v0.7.0/cli-reference/ark_create_backup.md index 7a75e7319..10dcf878b 100644 --- a/site/docs/v0.7.1/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.7.1/cli-reference/ark_create_restore.md b/site/content/docs/v0.7.0/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark_create_restore.md rename to site/content/docs/v0.7.0/cli-reference/ark_create_restore.md index 4b0242e51..f2f1665be 100644 --- a/site/docs/v0.7.1/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.7.0/cli-reference/ark_create_schedule.md b/site/content/docs/v0.7.0/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.7.0/cli-reference/ark_create_schedule.md index 446543d88..b2dd81544 100644 --- a/site/docs/v0.7.0/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.7.1/cli-reference/ark_delete.md b/site/content/docs/v0.7.0/cli-reference/ark_delete.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_delete.md rename to site/content/docs/v0.7.0/cli-reference/ark_delete.md index 3aece2995..e63d5cbef 100644 --- a/site/docs/v0.7.1/cli-reference/ark_delete.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_delete.md @@ -1,4 +1,7 @@ -## ark delete +--- +title: "ark delete" +layout: docs +--- Delete ark resources diff --git a/site/docs/v0.7.1/cli-reference/ark_delete_backup.md b/site/content/docs/v0.7.0/cli-reference/ark_delete_backup.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_delete_backup.md rename to site/content/docs/v0.7.0/cli-reference/ark_delete_backup.md index 2ceb94dfa..66672b816 100644 --- a/site/docs/v0.7.1/cli-reference/ark_delete_backup.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_delete_backup.md @@ -1,4 +1,7 @@ -## ark delete backup +--- +title: "ark delete backup" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.7.1/cli-reference/ark_delete_restore.md b/site/content/docs/v0.7.0/cli-reference/ark_delete_restore.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_delete_restore.md rename to site/content/docs/v0.7.0/cli-reference/ark_delete_restore.md index be7275bd2..6658297c6 100644 --- a/site/docs/v0.7.1/cli-reference/ark_delete_restore.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_delete_restore.md @@ -1,4 +1,7 @@ -## ark delete restore +--- +title: "ark delete restore" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.7.1/cli-reference/ark_delete_schedule.md b/site/content/docs/v0.7.0/cli-reference/ark_delete_schedule.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_delete_schedule.md rename to site/content/docs/v0.7.0/cli-reference/ark_delete_schedule.md index 28677b11d..e1cfdaf20 100644 --- a/site/docs/v0.7.1/cli-reference/ark_delete_schedule.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_delete_schedule.md @@ -1,4 +1,7 @@ -## ark delete schedule +--- +title: "ark delete schedule" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.7.0/cli-reference/ark_describe.md b/site/content/docs/v0.7.0/cli-reference/ark_describe.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_describe.md rename to site/content/docs/v0.7.0/cli-reference/ark_describe.md index 046beac3a..b2747cfc7 100644 --- a/site/docs/v0.7.0/cli-reference/ark_describe.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_describe.md @@ -1,4 +1,7 @@ -## ark describe +--- +title: "ark describe" +layout: docs +--- Describe ark resources diff --git a/site/docs/v0.7.1/cli-reference/ark_describe_backups.md b/site/content/docs/v0.7.0/cli-reference/ark_describe_backups.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_describe_backups.md rename to site/content/docs/v0.7.0/cli-reference/ark_describe_backups.md index 31f10eacb..551596afe 100644 --- a/site/docs/v0.7.1/cli-reference/ark_describe_backups.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_describe_backups.md @@ -1,4 +1,7 @@ -## ark describe backups +--- +title: "ark describe backups" +layout: docs +--- Describe backups diff --git a/site/docs/v0.7.1/cli-reference/ark_describe_restores.md b/site/content/docs/v0.7.0/cli-reference/ark_describe_restores.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_describe_restores.md rename to site/content/docs/v0.7.0/cli-reference/ark_describe_restores.md index 22d2debf9..4c13b80e1 100644 --- a/site/docs/v0.7.1/cli-reference/ark_describe_restores.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_describe_restores.md @@ -1,4 +1,7 @@ -## ark describe restores +--- +title: "ark describe restores" +layout: docs +--- Describe restores diff --git a/site/docs/v0.7.0/cli-reference/ark_describe_schedules.md b/site/content/docs/v0.7.0/cli-reference/ark_describe_schedules.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_describe_schedules.md rename to site/content/docs/v0.7.0/cli-reference/ark_describe_schedules.md index ee7e8de5b..4bc241ef3 100644 --- a/site/docs/v0.7.0/cli-reference/ark_describe_schedules.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_describe_schedules.md @@ -1,4 +1,7 @@ -## ark describe schedules +--- +title: "ark describe schedules" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.7.1/cli-reference/ark_get.md b/site/content/docs/v0.7.0/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_get.md rename to site/content/docs/v0.7.0/cli-reference/ark_get.md index 585af6a09..b39ec1857 100644 --- a/site/docs/v0.7.1/cli-reference/ark_get.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.7.0/cli-reference/ark_get_backups.md b/site/content/docs/v0.7.0/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_get_backups.md rename to site/content/docs/v0.7.0/cli-reference/ark_get_backups.md index 7fa64e48f..5e448127c 100644 --- a/site/docs/v0.7.0/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.7.1/cli-reference/ark_get_restores.md b/site/content/docs/v0.7.0/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_get_restores.md rename to site/content/docs/v0.7.0/cli-reference/ark_get_restores.md index 44eb931e2..6e9eb6f40 100644 --- a/site/docs/v0.7.1/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.7.0/cli-reference/ark_get_schedules.md b/site/content/docs/v0.7.0/cli-reference/ark_get_schedules.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.7.0/cli-reference/ark_get_schedules.md index a5d1e3649..24b00f718 100644 --- a/site/docs/v0.7.0/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.7.1/cli-reference/ark_plugin.md b/site/content/docs/v0.7.0/cli-reference/ark_plugin.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_plugin.md rename to site/content/docs/v0.7.0/cli-reference/ark_plugin.md index 8e0f4347c..84a576567 100644 --- a/site/docs/v0.7.1/cli-reference/ark_plugin.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_plugin.md @@ -1,4 +1,7 @@ -## ark plugin +--- +title: "ark plugin" +layout: docs +--- Work with plugins diff --git a/site/docs/v0.7.0/cli-reference/ark_plugin_add.md b/site/content/docs/v0.7.0/cli-reference/ark_plugin_add.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_plugin_add.md rename to site/content/docs/v0.7.0/cli-reference/ark_plugin_add.md index 1f5d20a13..70b4e63bb 100644 --- a/site/docs/v0.7.0/cli-reference/ark_plugin_add.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_plugin_add.md @@ -1,4 +1,7 @@ -## ark plugin add +--- +title: "ark plugin add" +layout: docs +--- Add a plugin diff --git a/site/docs/v0.7.0/cli-reference/ark_plugin_remove.md b/site/content/docs/v0.7.0/cli-reference/ark_plugin_remove.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_plugin_remove.md rename to site/content/docs/v0.7.0/cli-reference/ark_plugin_remove.md index fb46883ed..a7b2ea066 100644 --- a/site/docs/v0.7.0/cli-reference/ark_plugin_remove.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_plugin_remove.md @@ -1,4 +1,7 @@ -## ark plugin remove +--- +title: "ark plugin remove" +layout: docs +--- Remove a plugin diff --git a/site/docs/v0.7.0/cli-reference/ark_restore.md b/site/content/docs/v0.7.0/cli-reference/ark_restore.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_restore.md rename to site/content/docs/v0.7.0/cli-reference/ark_restore.md index 624b7cb59..0e5921285 100644 --- a/site/docs/v0.7.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.7.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.7.0/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.7.0/cli-reference/ark_restore_create.md index c906c5b6e..2b9301389 100644 --- a/site/docs/v0.7.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.7.1/cli-reference/ark_restore_delete.md b/site/content/docs/v0.7.0/cli-reference/ark_restore_delete.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.7.0/cli-reference/ark_restore_delete.md index bb5f614ec..ffdec0d2f 100644 --- a/site/docs/v0.7.1/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.7.0/cli-reference/ark_restore_describe.md b/site/content/docs/v0.7.0/cli-reference/ark_restore_describe.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_restore_describe.md rename to site/content/docs/v0.7.0/cli-reference/ark_restore_describe.md index 749173ee1..492bfe866 100644 --- a/site/docs/v0.7.0/cli-reference/ark_restore_describe.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_restore_describe.md @@ -1,4 +1,7 @@ -## ark restore describe +--- +title: "ark restore describe" +layout: docs +--- Describe restores diff --git a/site/docs/v0.7.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.7.0/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.7.0/cli-reference/ark_restore_get.md index 4f05fe34a..a586380d2 100644 --- a/site/docs/v0.7.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.7.1/cli-reference/ark_restore_logs.md b/site/content/docs/v0.7.0/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.7.0/cli-reference/ark_restore_logs.md index 7c0d8da17..645db8312 100644 --- a/site/docs/v0.7.1/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.7.1/cli-reference/ark_schedule.md b/site/content/docs/v0.7.0/cli-reference/ark_schedule.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_schedule.md rename to site/content/docs/v0.7.0/cli-reference/ark_schedule.md index 6c7b76ad7..464d06cb1 100644 --- a/site/docs/v0.7.1/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.7.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.7.0/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.7.0/cli-reference/ark_schedule_create.md index ccf1727e1..5ed81d7dc 100644 --- a/site/docs/v0.7.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.7.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.7.0/cli-reference/ark_schedule_delete.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.7.0/cli-reference/ark_schedule_delete.md index 230cf321a..44f1546d4 100644 --- a/site/docs/v0.7.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.7.0/cli-reference/ark_schedule_describe.md b/site/content/docs/v0.7.0/cli-reference/ark_schedule_describe.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_schedule_describe.md rename to site/content/docs/v0.7.0/cli-reference/ark_schedule_describe.md index 92fc105b0..29e8350a3 100644 --- a/site/docs/v0.7.0/cli-reference/ark_schedule_describe.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_schedule_describe.md @@ -1,4 +1,7 @@ -## ark schedule describe +--- +title: "ark schedule describe" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.7.1/cli-reference/ark_schedule_get.md b/site/content/docs/v0.7.0/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.7.0/cli-reference/ark_schedule_get.md index 07c9730e3..a5e4af117 100644 --- a/site/docs/v0.7.1/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.7.0/cli-reference/ark_server.md b/site/content/docs/v0.7.0/cli-reference/ark_server.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_server.md rename to site/content/docs/v0.7.0/cli-reference/ark_server.md index d09140491..2aed9d11a 100644 --- a/site/docs/v0.7.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.7.0/cli-reference/ark_version.md b/site/content/docs/v0.7.0/cli-reference/ark_version.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_version.md rename to site/content/docs/v0.7.0/cli-reference/ark_version.md index 2a5848f4c..90c9f4428 100644 --- a/site/docs/v0.7.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.7.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.7.0/cloud-common.md b/site/content/docs/v0.7.0/cloud-common.md similarity index 96% rename from site/docs/v0.7.0/cloud-common.md rename to site/content/docs/v0.7.0/cloud-common.md index 0adf4cb10..ce20334d8 100644 --- a/site/docs/v0.7.0/cloud-common.md +++ b/site/content/docs/v0.7.0/cloud-common.md @@ -1,4 +1,7 @@ -# Set up Ark with your cloud provider +--- +title: "Set up Ark with your cloud provider" +layout: docs +--- To run Ark with your cloud provider, you specify provider-specific settings for the Ark server. In version 0.7.0 and later, you can run Ark in any namespace, which requires additional customization. See [Run in custom namespace][3]. diff --git a/site/docs/v0.7.0/config-definition.md b/site/content/docs/v0.7.0/config-definition.md similarity index 99% rename from site/docs/v0.7.0/config-definition.md rename to site/content/docs/v0.7.0/config-definition.md index a05724ade..dbe1d853c 100644 --- a/site/docs/v0.7.0/config-definition.md +++ b/site/content/docs/v0.7.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.7.0/debugging-restores.md b/site/content/docs/v0.7.0/debugging-restores.md similarity index 98% rename from site/docs/v0.7.0/debugging-restores.md rename to site/content/docs/v0.7.0/debugging-restores.md index 3b8fc1f93..338129ea3 100644 --- a/site/docs/v0.7.0/debugging-restores.md +++ b/site/content/docs/v0.7.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.7.0/extend.md b/site/content/docs/v0.7.0/extend.md similarity index 94% rename from site/docs/v0.7.0/extend.md rename to site/content/docs/v0.7.0/extend.md index 9cfa8a4b7..10f9fd56a 100644 --- a/site/docs/v0.7.0/extend.md +++ b/site/content/docs/v0.7.0/extend.md @@ -1,4 +1,7 @@ -# Extend Ark +--- +title: "Extend Ark" +layout: docs +--- Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/docs/v0.6.0/faq.md b/site/content/docs/v0.7.0/faq.md similarity index 97% rename from site/docs/v0.6.0/faq.md rename to site/content/docs/v0.7.0/faq.md index f83829ec9..0fbfbbb35 100644 --- a/site/docs/v0.6.0/faq.md +++ b/site/content/docs/v0.7.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.7.0/gcp-config.md b/site/content/docs/v0.7.0/gcp-config.md similarity index 98% rename from site/docs/v0.7.0/gcp-config.md rename to site/content/docs/v0.7.0/gcp-config.md index 1556d85a7..4b21ef6d9 100644 --- a/site/docs/v0.7.0/gcp-config.md +++ b/site/content/docs/v0.7.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Ark on GCP +--- +title: "Run Ark on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either of: diff --git a/site/docs/v0.7.1/hooks.md b/site/content/docs/v0.7.0/hooks.md similarity index 98% rename from site/docs/v0.7.1/hooks.md rename to site/content/docs/v0.7.0/hooks.md index 5097f4090..6f83c98ff 100644 --- a/site/docs/v0.7.1/hooks.md +++ b/site/content/docs/v0.7.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.7.0/img/README.md b/site/content/docs/v0.7.0/img/README.md similarity index 100% rename from site/docs/v0.7.0/img/README.md rename to site/content/docs/v0.7.0/img/README.md diff --git a/site/docs/v0.7.0/img/backup-process.png b/site/content/docs/v0.7.0/img/backup-process.png similarity index 100% rename from site/docs/v0.7.0/img/backup-process.png rename to site/content/docs/v0.7.0/img/backup-process.png diff --git a/site/docs/v0.7.0/namespace.md b/site/content/docs/v0.7.0/namespace.md similarity index 96% rename from site/docs/v0.7.0/namespace.md rename to site/content/docs/v0.7.0/namespace.md index 1a82a5c38..5db4a02cc 100644 --- a/site/docs/v0.7.0/namespace.md +++ b/site/content/docs/v0.7.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Ark version 0.7.0 and later, you can run Ark in any namespace. To do so, you specify the namespace in the YAML files that configure the Ark server. You then also specify the namespace when you run Ark client commands. diff --git a/site/docs/v0.7.1/output-file-format.md b/site/content/docs/v0.7.0/output-file-format.md similarity index 98% rename from site/docs/v0.7.1/output-file-format.md rename to site/content/docs/v0.7.0/output-file-format.md index 8541e3a82..fd42f15ba 100644 --- a/site/docs/v0.7.1/output-file-format.md +++ b/site/content/docs/v0.7.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.8.0/plugins.md b/site/content/docs/v0.7.0/plugins.md similarity index 98% rename from site/docs/v0.8.0/plugins.md rename to site/content/docs/v0.7.0/plugins.md index 1cb2ae391..55dc172e4 100644 --- a/site/docs/v0.8.0/plugins.md +++ b/site/content/docs/v0.7.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary diff --git a/site/docs/v0.7.0/use-cases.md b/site/content/docs/v0.7.0/use-cases.md similarity index 98% rename from site/docs/v0.7.0/use-cases.md rename to site/content/docs/v0.7.0/use-cases.md index 289ea456d..bf2b66e6f 100644 --- a/site/docs/v0.7.0/use-cases.md +++ b/site/content/docs/v0.7.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/docs/v0.4.0/vendoring-dependencies.md b/site/content/docs/v0.7.0/vendoring-dependencies.md similarity index 91% rename from site/docs/v0.4.0/vendoring-dependencies.md rename to site/content/docs/v0.7.0/vendoring-dependencies.md index ce5f9a9d4..67ad755bc 100644 --- a/site/docs/v0.4.0/vendoring-dependencies.md +++ b/site/content/docs/v0.7.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.7.1/README.md b/site/content/docs/v0.7.1/_index.md similarity index 99% rename from site/docs/v0.7.1/README.md rename to site/content/docs/v0.7.1/_index.md index 883611498..ffb1921dd 100644 --- a/site/docs/v0.7.1/README.md +++ b/site/content/docs/v0.7.1/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.7.1 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.7.1/about.md b/site/content/docs/v0.7.1/about.md similarity index 99% rename from site/docs/v0.7.1/about.md rename to site/content/docs/v0.7.1/about.md index 2cb82db26..4d48dce47 100644 --- a/site/docs/v0.7.1/about.md +++ b/site/content/docs/v0.7.1/about.md @@ -1,4 +1,7 @@ -# About Heptio Ark +--- +title: "About Heptio Ark" +layout: docs +--- Heptio Ark provides customizable degrees of recovery for all Kubernetes objects (Pods, Deployments, Jobs, Custom Resource Definitions, etc.), as well as for persistent volumes. This recovery can be cluster-wide, or fine-tuned according to object type, namespace, or labels. diff --git a/site/content/docs/v0.7.1/api-types/README.md b/site/content/docs/v0.7.1/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.7.1/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/docs/v0.7.1/api-types/backup.md b/site/content/docs/v0.7.1/api-types/backup.md similarity index 99% rename from site/docs/v0.7.1/api-types/backup.md rename to site/content/docs/v0.7.1/api-types/backup.md index feef7c3dc..def928fc0 100644 --- a/site/docs/v0.7.1/api-types/backup.md +++ b/site/content/docs/v0.7.1/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.7.1/aws-config.md b/site/content/docs/v0.7.1/aws-config.md similarity index 98% rename from site/docs/v0.7.1/aws-config.md rename to site/content/docs/v0.7.1/aws-config.md index 789e4cb68..f7c84e325 100644 --- a/site/docs/v0.7.1/aws-config.md +++ b/site/content/docs/v0.7.1/aws-config.md @@ -1,4 +1,7 @@ -# Run Ark on AWS +--- +title: "Run Ark on AWS" +layout: docs +--- To set up Ark on AWS, you: diff --git a/site/docs/v0.7.1/azure-config.md b/site/content/docs/v0.7.1/azure-config.md similarity index 99% rename from site/docs/v0.7.1/azure-config.md rename to site/content/docs/v0.7.1/azure-config.md index 62bc62516..8b4e37739 100644 --- a/site/docs/v0.7.1/azure-config.md +++ b/site/content/docs/v0.7.1/azure-config.md @@ -1,4 +1,7 @@ -# Run Ark on Azure +--- +title: "Run Ark on Azure" +layout: docs +--- To configure Ark on Azure, you: diff --git a/site/docs/v0.7.1/build-from-scratch.md b/site/content/docs/v0.7.1/build-from-scratch.md similarity index 98% rename from site/docs/v0.7.1/build-from-scratch.md rename to site/content/docs/v0.7.1/build-from-scratch.md index 9ef0bc5ed..7cb0b411c 100644 --- a/site/docs/v0.7.1/build-from-scratch.md +++ b/site/content/docs/v0.7.1/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Download][2] diff --git a/site/docs/v0.8.1/cli-reference/README.md b/site/content/docs/v0.7.1/cli-reference/README.md similarity index 93% rename from site/docs/v0.8.1/cli-reference/README.md rename to site/content/docs/v0.7.1/cli-reference/README.md index 29bebb516..1494296dd 100644 --- a/site/docs/v0.8.1/cli-reference/README.md +++ b/site/content/docs/v0.7.1/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.7.0/cli-reference/ark.md b/site/content/docs/v0.7.1/cli-reference/ark.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark.md rename to site/content/docs/v0.7.1/cli-reference/ark.md index daaf87f74..6c3652a3f 100644 --- a/site/docs/v0.7.0/cli-reference/ark.md +++ b/site/content/docs/v0.7.1/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.7.0/cli-reference/ark_backup.md b/site/content/docs/v0.7.1/cli-reference/ark_backup.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_backup.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup.md index 1e7fb67b2..7ca0694c1 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.7.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.7.1/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup_create.md index 8f098c3c2..3fc8564ec 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.7.1/cli-reference/ark_backup_delete.md b/site/content/docs/v0.7.1/cli-reference/ark_backup_delete.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_backup_delete.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup_delete.md index 33d8b984e..ef10a6360 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup_delete.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup_delete.md @@ -1,4 +1,7 @@ -## ark backup delete +--- +title: "ark backup delete" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.7.0/cli-reference/ark_backup_describe.md b/site/content/docs/v0.7.1/cli-reference/ark_backup_describe.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_backup_describe.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup_describe.md index 53d17e5b1..cda0b04a7 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup_describe.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup_describe.md @@ -1,4 +1,7 @@ -## ark backup describe +--- +title: "ark backup describe" +layout: docs +--- Describe backups diff --git a/site/docs/v0.7.0/cli-reference/ark_backup_download.md b/site/content/docs/v0.7.1/cli-reference/ark_backup_download.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_backup_download.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup_download.md index 68f98ff6b..c8193deb7 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.7.1/cli-reference/ark_backup_get.md b/site/content/docs/v0.7.1/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_backup_get.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup_get.md index 3e289bd84..0a2463aaa 100644 --- a/site/docs/v0.7.1/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.7.0/cli-reference/ark_backup_logs.md b/site/content/docs/v0.7.1/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.7.1/cli-reference/ark_backup_logs.md index 0ee6c9d47..ef90e24b2 100644 --- a/site/docs/v0.7.0/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.7.0/cli-reference/ark_client.md b/site/content/docs/v0.7.1/cli-reference/ark_client.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_client.md rename to site/content/docs/v0.7.1/cli-reference/ark_client.md index 03c9d39c8..48cbfbb89 100644 --- a/site/docs/v0.7.0/cli-reference/ark_client.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_client.md @@ -1,4 +1,7 @@ -## ark client +--- +title: "ark client" +layout: docs +--- Ark client related commands diff --git a/site/docs/v0.7.1/cli-reference/ark_client_config.md b/site/content/docs/v0.7.1/cli-reference/ark_client_config.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_client_config.md rename to site/content/docs/v0.7.1/cli-reference/ark_client_config.md index b4ed2fa32..331537ab1 100644 --- a/site/docs/v0.7.1/cli-reference/ark_client_config.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_client_config.md @@ -1,4 +1,7 @@ -## ark client config +--- +title: "ark client config" +layout: docs +--- Get and set client configuration file values diff --git a/site/docs/v0.7.1/cli-reference/ark_client_config_get.md b/site/content/docs/v0.7.1/cli-reference/ark_client_config_get.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_client_config_get.md rename to site/content/docs/v0.7.1/cli-reference/ark_client_config_get.md index 403966449..05b777589 100644 --- a/site/docs/v0.7.1/cli-reference/ark_client_config_get.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_client_config_get.md @@ -1,4 +1,7 @@ -## ark client config get +--- +title: "ark client config get" +layout: docs +--- Get client configuration file values diff --git a/site/docs/v0.7.1/cli-reference/ark_client_config_set.md b/site/content/docs/v0.7.1/cli-reference/ark_client_config_set.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_client_config_set.md rename to site/content/docs/v0.7.1/cli-reference/ark_client_config_set.md index af2c49728..1f192300b 100644 --- a/site/docs/v0.7.1/cli-reference/ark_client_config_set.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_client_config_set.md @@ -1,4 +1,7 @@ -## ark client config set +--- +title: "ark client config set" +layout: docs +--- Set client configuration file values diff --git a/site/docs/v0.7.0/cli-reference/ark_create.md b/site/content/docs/v0.7.1/cli-reference/ark_create.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_create.md rename to site/content/docs/v0.7.1/cli-reference/ark_create.md index afecb59a5..b64dac444 100644 --- a/site/docs/v0.7.0/cli-reference/ark_create.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.7.0/cli-reference/ark_create_backup.md b/site/content/docs/v0.7.1/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark_create_backup.md rename to site/content/docs/v0.7.1/cli-reference/ark_create_backup.md index 7a75e7319..10dcf878b 100644 --- a/site/docs/v0.7.0/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.7.0/cli-reference/ark_create_restore.md b/site/content/docs/v0.7.1/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.7.0/cli-reference/ark_create_restore.md rename to site/content/docs/v0.7.1/cli-reference/ark_create_restore.md index 4b0242e51..f2f1665be 100644 --- a/site/docs/v0.7.0/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.7.1/cli-reference/ark_create_schedule.md b/site/content/docs/v0.7.1/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.7.1/cli-reference/ark_create_schedule.md index 446543d88..b2dd81544 100644 --- a/site/docs/v0.7.1/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.7.0/cli-reference/ark_delete.md b/site/content/docs/v0.7.1/cli-reference/ark_delete.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_delete.md rename to site/content/docs/v0.7.1/cli-reference/ark_delete.md index 3aece2995..e63d5cbef 100644 --- a/site/docs/v0.7.0/cli-reference/ark_delete.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_delete.md @@ -1,4 +1,7 @@ -## ark delete +--- +title: "ark delete" +layout: docs +--- Delete ark resources diff --git a/site/docs/v0.7.0/cli-reference/ark_delete_backup.md b/site/content/docs/v0.7.1/cli-reference/ark_delete_backup.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_delete_backup.md rename to site/content/docs/v0.7.1/cli-reference/ark_delete_backup.md index 2ceb94dfa..66672b816 100644 --- a/site/docs/v0.7.0/cli-reference/ark_delete_backup.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_delete_backup.md @@ -1,4 +1,7 @@ -## ark delete backup +--- +title: "ark delete backup" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.7.0/cli-reference/ark_delete_restore.md b/site/content/docs/v0.7.1/cli-reference/ark_delete_restore.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_delete_restore.md rename to site/content/docs/v0.7.1/cli-reference/ark_delete_restore.md index be7275bd2..6658297c6 100644 --- a/site/docs/v0.7.0/cli-reference/ark_delete_restore.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_delete_restore.md @@ -1,4 +1,7 @@ -## ark delete restore +--- +title: "ark delete restore" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.7.0/cli-reference/ark_delete_schedule.md b/site/content/docs/v0.7.1/cli-reference/ark_delete_schedule.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_delete_schedule.md rename to site/content/docs/v0.7.1/cli-reference/ark_delete_schedule.md index 28677b11d..e1cfdaf20 100644 --- a/site/docs/v0.7.0/cli-reference/ark_delete_schedule.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_delete_schedule.md @@ -1,4 +1,7 @@ -## ark delete schedule +--- +title: "ark delete schedule" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.7.1/cli-reference/ark_describe.md b/site/content/docs/v0.7.1/cli-reference/ark_describe.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_describe.md rename to site/content/docs/v0.7.1/cli-reference/ark_describe.md index 046beac3a..b2747cfc7 100644 --- a/site/docs/v0.7.1/cli-reference/ark_describe.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_describe.md @@ -1,4 +1,7 @@ -## ark describe +--- +title: "ark describe" +layout: docs +--- Describe ark resources diff --git a/site/docs/v0.7.0/cli-reference/ark_describe_backups.md b/site/content/docs/v0.7.1/cli-reference/ark_describe_backups.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_describe_backups.md rename to site/content/docs/v0.7.1/cli-reference/ark_describe_backups.md index 31f10eacb..551596afe 100644 --- a/site/docs/v0.7.0/cli-reference/ark_describe_backups.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_describe_backups.md @@ -1,4 +1,7 @@ -## ark describe backups +--- +title: "ark describe backups" +layout: docs +--- Describe backups diff --git a/site/docs/v0.7.0/cli-reference/ark_describe_restores.md b/site/content/docs/v0.7.1/cli-reference/ark_describe_restores.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_describe_restores.md rename to site/content/docs/v0.7.1/cli-reference/ark_describe_restores.md index 22d2debf9..4c13b80e1 100644 --- a/site/docs/v0.7.0/cli-reference/ark_describe_restores.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_describe_restores.md @@ -1,4 +1,7 @@ -## ark describe restores +--- +title: "ark describe restores" +layout: docs +--- Describe restores diff --git a/site/docs/v0.7.1/cli-reference/ark_describe_schedules.md b/site/content/docs/v0.7.1/cli-reference/ark_describe_schedules.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_describe_schedules.md rename to site/content/docs/v0.7.1/cli-reference/ark_describe_schedules.md index ee7e8de5b..4bc241ef3 100644 --- a/site/docs/v0.7.1/cli-reference/ark_describe_schedules.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_describe_schedules.md @@ -1,4 +1,7 @@ -## ark describe schedules +--- +title: "ark describe schedules" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.7.0/cli-reference/ark_get.md b/site/content/docs/v0.7.1/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_get.md rename to site/content/docs/v0.7.1/cli-reference/ark_get.md index 585af6a09..b39ec1857 100644 --- a/site/docs/v0.7.0/cli-reference/ark_get.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.7.1/cli-reference/ark_get_backups.md b/site/content/docs/v0.7.1/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_get_backups.md rename to site/content/docs/v0.7.1/cli-reference/ark_get_backups.md index 7fa64e48f..5e448127c 100644 --- a/site/docs/v0.7.1/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.7.0/cli-reference/ark_get_restores.md b/site/content/docs/v0.7.1/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_get_restores.md rename to site/content/docs/v0.7.1/cli-reference/ark_get_restores.md index 44eb931e2..6e9eb6f40 100644 --- a/site/docs/v0.7.0/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.7.1/cli-reference/ark_get_schedules.md b/site/content/docs/v0.7.1/cli-reference/ark_get_schedules.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.7.1/cli-reference/ark_get_schedules.md index a5d1e3649..24b00f718 100644 --- a/site/docs/v0.7.1/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.7.0/cli-reference/ark_plugin.md b/site/content/docs/v0.7.1/cli-reference/ark_plugin.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_plugin.md rename to site/content/docs/v0.7.1/cli-reference/ark_plugin.md index 8e0f4347c..84a576567 100644 --- a/site/docs/v0.7.0/cli-reference/ark_plugin.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_plugin.md @@ -1,4 +1,7 @@ -## ark plugin +--- +title: "ark plugin" +layout: docs +--- Work with plugins diff --git a/site/docs/v0.7.1/cli-reference/ark_plugin_add.md b/site/content/docs/v0.7.1/cli-reference/ark_plugin_add.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_plugin_add.md rename to site/content/docs/v0.7.1/cli-reference/ark_plugin_add.md index 1f5d20a13..70b4e63bb 100644 --- a/site/docs/v0.7.1/cli-reference/ark_plugin_add.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_plugin_add.md @@ -1,4 +1,7 @@ -## ark plugin add +--- +title: "ark plugin add" +layout: docs +--- Add a plugin diff --git a/site/docs/v0.7.1/cli-reference/ark_plugin_remove.md b/site/content/docs/v0.7.1/cli-reference/ark_plugin_remove.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_plugin_remove.md rename to site/content/docs/v0.7.1/cli-reference/ark_plugin_remove.md index fb46883ed..a7b2ea066 100644 --- a/site/docs/v0.7.1/cli-reference/ark_plugin_remove.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_plugin_remove.md @@ -1,4 +1,7 @@ -## ark plugin remove +--- +title: "ark plugin remove" +layout: docs +--- Remove a plugin diff --git a/site/docs/v0.7.1/cli-reference/ark_restore.md b/site/content/docs/v0.7.1/cli-reference/ark_restore.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_restore.md rename to site/content/docs/v0.7.1/cli-reference/ark_restore.md index 624b7cb59..0e5921285 100644 --- a/site/docs/v0.7.1/cli-reference/ark_restore.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.7.1/cli-reference/ark_restore_create.md b/site/content/docs/v0.7.1/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark_restore_create.md rename to site/content/docs/v0.7.1/cli-reference/ark_restore_create.md index c906c5b6e..2b9301389 100644 --- a/site/docs/v0.7.1/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.7.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.7.1/cli-reference/ark_restore_delete.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.7.1/cli-reference/ark_restore_delete.md index bb5f614ec..ffdec0d2f 100644 --- a/site/docs/v0.7.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.7.1/cli-reference/ark_restore_describe.md b/site/content/docs/v0.7.1/cli-reference/ark_restore_describe.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_restore_describe.md rename to site/content/docs/v0.7.1/cli-reference/ark_restore_describe.md index 749173ee1..492bfe866 100644 --- a/site/docs/v0.7.1/cli-reference/ark_restore_describe.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_restore_describe.md @@ -1,4 +1,7 @@ -## ark restore describe +--- +title: "ark restore describe" +layout: docs +--- Describe restores diff --git a/site/docs/v0.7.1/cli-reference/ark_restore_get.md b/site/content/docs/v0.7.1/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_restore_get.md rename to site/content/docs/v0.7.1/cli-reference/ark_restore_get.md index 4f05fe34a..a586380d2 100644 --- a/site/docs/v0.7.1/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.7.0/cli-reference/ark_restore_logs.md b/site/content/docs/v0.7.1/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.7.0/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.7.1/cli-reference/ark_restore_logs.md index 7c0d8da17..645db8312 100644 --- a/site/docs/v0.7.0/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.7.0/cli-reference/ark_schedule.md b/site/content/docs/v0.7.1/cli-reference/ark_schedule.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.7.1/cli-reference/ark_schedule.md index 6c7b76ad7..464d06cb1 100644 --- a/site/docs/v0.7.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.7.1/cli-reference/ark_schedule_create.md b/site/content/docs/v0.7.1/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.7.1/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.7.1/cli-reference/ark_schedule_create.md index ccf1727e1..5ed81d7dc 100644 --- a/site/docs/v0.7.1/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.7.1/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.7.1/cli-reference/ark_schedule_delete.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.7.1/cli-reference/ark_schedule_delete.md index 230cf321a..44f1546d4 100644 --- a/site/docs/v0.7.1/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.7.1/cli-reference/ark_schedule_describe.md b/site/content/docs/v0.7.1/cli-reference/ark_schedule_describe.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_schedule_describe.md rename to site/content/docs/v0.7.1/cli-reference/ark_schedule_describe.md index 92fc105b0..29e8350a3 100644 --- a/site/docs/v0.7.1/cli-reference/ark_schedule_describe.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_schedule_describe.md @@ -1,4 +1,7 @@ -## ark schedule describe +--- +title: "ark schedule describe" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.7.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.7.1/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.7.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.7.1/cli-reference/ark_schedule_get.md index 07c9730e3..a5e4af117 100644 --- a/site/docs/v0.7.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.7.1/cli-reference/ark_server.md b/site/content/docs/v0.7.1/cli-reference/ark_server.md similarity index 97% rename from site/docs/v0.7.1/cli-reference/ark_server.md rename to site/content/docs/v0.7.1/cli-reference/ark_server.md index d09140491..2aed9d11a 100644 --- a/site/docs/v0.7.1/cli-reference/ark_server.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.7.1/cli-reference/ark_version.md b/site/content/docs/v0.7.1/cli-reference/ark_version.md similarity index 96% rename from site/docs/v0.7.1/cli-reference/ark_version.md rename to site/content/docs/v0.7.1/cli-reference/ark_version.md index 2a5848f4c..90c9f4428 100644 --- a/site/docs/v0.7.1/cli-reference/ark_version.md +++ b/site/content/docs/v0.7.1/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.7.1/cloud-common.md b/site/content/docs/v0.7.1/cloud-common.md similarity index 96% rename from site/docs/v0.7.1/cloud-common.md rename to site/content/docs/v0.7.1/cloud-common.md index c228104ca..f671280c4 100644 --- a/site/docs/v0.7.1/cloud-common.md +++ b/site/content/docs/v0.7.1/cloud-common.md @@ -1,4 +1,7 @@ -# Set up Ark with your cloud provider +--- +title: "Set up Ark with your cloud provider" +layout: docs +--- To run Ark with your cloud provider, you specify provider-specific settings for the Ark server. In version 0.7.0 and later, you can run Ark in any namespace, which requires additional customization. See [Run in custom namespace][3]. diff --git a/site/docs/v0.7.1/config-definition.md b/site/content/docs/v0.7.1/config-definition.md similarity index 99% rename from site/docs/v0.7.1/config-definition.md rename to site/content/docs/v0.7.1/config-definition.md index a05724ade..dbe1d853c 100644 --- a/site/docs/v0.7.1/config-definition.md +++ b/site/content/docs/v0.7.1/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.8.1/debugging-deletes.md b/site/content/docs/v0.7.1/debugging-deletes.md similarity index 96% rename from site/docs/v0.8.1/debugging-deletes.md rename to site/content/docs/v0.7.1/debugging-deletes.md index b16693c22..1b788245c 100644 --- a/site/docs/v0.8.1/debugging-deletes.md +++ b/site/content/docs/v0.7.1/debugging-deletes.md @@ -1,4 +1,7 @@ -# Ark version 0.7.0 and later: issue with deleting namespaces and backups +--- +title: "Ark version 0.7.0 and later: issue with deleting namespaces and backups " +layout: docs +--- Version 0.7.0 introduced the ability to delete backups. However, you may encounter an issue if you try to delete the `heptio-ark` namespace. The namespace can get stuck in a terminating state, and you cannot delete your backups. diff --git a/site/docs/v0.6.0/debugging-restores.md b/site/content/docs/v0.7.1/debugging-restores.md similarity index 98% rename from site/docs/v0.6.0/debugging-restores.md rename to site/content/docs/v0.7.1/debugging-restores.md index 3b8fc1f93..338129ea3 100644 --- a/site/docs/v0.6.0/debugging-restores.md +++ b/site/content/docs/v0.7.1/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.8.0/extend.md b/site/content/docs/v0.7.1/extend.md similarity index 94% rename from site/docs/v0.8.0/extend.md rename to site/content/docs/v0.7.1/extend.md index 0a96b8e3e..ae282f58d 100644 --- a/site/docs/v0.8.0/extend.md +++ b/site/content/docs/v0.7.1/extend.md @@ -1,4 +1,7 @@ -# Extend Ark +--- +title: "Extend Ark" +layout: docs +--- Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/docs/v0.7.0/faq.md b/site/content/docs/v0.7.1/faq.md similarity index 97% rename from site/docs/v0.7.0/faq.md rename to site/content/docs/v0.7.1/faq.md index f83829ec9..0fbfbbb35 100644 --- a/site/docs/v0.7.0/faq.md +++ b/site/content/docs/v0.7.1/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.7.1/gcp-config.md b/site/content/docs/v0.7.1/gcp-config.md similarity index 98% rename from site/docs/v0.7.1/gcp-config.md rename to site/content/docs/v0.7.1/gcp-config.md index be450ac34..a987d96f3 100644 --- a/site/docs/v0.7.1/gcp-config.md +++ b/site/content/docs/v0.7.1/gcp-config.md @@ -1,4 +1,7 @@ -# Run Ark on GCP +--- +title: "Run Ark on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either of: diff --git a/site/docs/v0.8.1/hooks.md b/site/content/docs/v0.7.1/hooks.md similarity index 98% rename from site/docs/v0.8.1/hooks.md rename to site/content/docs/v0.7.1/hooks.md index 5097f4090..6f83c98ff 100644 --- a/site/docs/v0.8.1/hooks.md +++ b/site/content/docs/v0.7.1/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.7.1/img/README.md b/site/content/docs/v0.7.1/img/README.md similarity index 100% rename from site/docs/v0.7.1/img/README.md rename to site/content/docs/v0.7.1/img/README.md diff --git a/site/docs/v0.7.1/img/backup-process.png b/site/content/docs/v0.7.1/img/backup-process.png similarity index 100% rename from site/docs/v0.7.1/img/backup-process.png rename to site/content/docs/v0.7.1/img/backup-process.png diff --git a/site/docs/v0.7.1/namespace.md b/site/content/docs/v0.7.1/namespace.md similarity index 97% rename from site/docs/v0.7.1/namespace.md rename to site/content/docs/v0.7.1/namespace.md index 6f8e38d97..0b2fffe89 100644 --- a/site/docs/v0.7.1/namespace.md +++ b/site/content/docs/v0.7.1/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Ark version 0.7.0 and later, you can run Ark in any namespace. To do so, you specify the namespace in the YAML files that configure the Ark server. You then also specify the namespace when diff --git a/site/docs/v0.7.0/output-file-format.md b/site/content/docs/v0.7.1/output-file-format.md similarity index 98% rename from site/docs/v0.7.0/output-file-format.md rename to site/content/docs/v0.7.1/output-file-format.md index 8541e3a82..fd42f15ba 100644 --- a/site/docs/v0.7.0/output-file-format.md +++ b/site/content/docs/v0.7.1/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.7.1/plugins.md b/site/content/docs/v0.7.1/plugins.md similarity index 98% rename from site/docs/v0.7.1/plugins.md rename to site/content/docs/v0.7.1/plugins.md index 1cb2ae391..55dc172e4 100644 --- a/site/docs/v0.7.1/plugins.md +++ b/site/content/docs/v0.7.1/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary diff --git a/site/docs/v0.8.0/troubleshooting.md b/site/content/docs/v0.7.1/troubleshooting.md similarity index 88% rename from site/docs/v0.8.0/troubleshooting.md rename to site/content/docs/v0.7.1/troubleshooting.md index 39ea7c7cb..8233bef28 100644 --- a/site/docs/v0.8.0/troubleshooting.md +++ b/site/content/docs/v0.7.1/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [Kubernetes Slack team][25] channel `#ark-dr`. diff --git a/site/docs/v0.7.1/use-cases.md b/site/content/docs/v0.7.1/use-cases.md similarity index 98% rename from site/docs/v0.7.1/use-cases.md rename to site/content/docs/v0.7.1/use-cases.md index 5fb6c6b49..b2cbd3eac 100644 --- a/site/docs/v0.7.1/use-cases.md +++ b/site/content/docs/v0.7.1/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/content/docs/v0.7.1/vendoring-dependencies.md b/site/content/docs/v0.7.1/vendoring-dependencies.md new file mode 100644 index 000000000..67ad755bc --- /dev/null +++ b/site/content/docs/v0.7.1/vendoring-dependencies.md @@ -0,0 +1,26 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by running + +``` +go get -u github.com/golang/dep/cmd/dep +``` + +Dep currently pulls in a bit more than we'd like, so +we have created a script to remove these extra files: `hack/dep-save.sh`. + +## Adding a new dependency + +Run `hack/dep-save.sh`. If you want to see verbose output, you can append `-v` as in +`hack/dep-save.sh -v`. + +## Updating an existing dependency + +Run `hack/dep-save.sh -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep diff --git a/site/docs/v0.8.0/README.md b/site/content/docs/v0.8.0/_index.md similarity index 99% rename from site/docs/v0.8.0/README.md rename to site/content/docs/v0.8.0/_index.md index 0ce358e1d..afab04b7d 100644 --- a/site/docs/v0.8.0/README.md +++ b/site/content/docs/v0.8.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.8.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.8.1/about.md b/site/content/docs/v0.8.0/about.md similarity index 99% rename from site/docs/v0.8.1/about.md rename to site/content/docs/v0.8.0/about.md index 2cb82db26..4d48dce47 100644 --- a/site/docs/v0.8.1/about.md +++ b/site/content/docs/v0.8.0/about.md @@ -1,4 +1,7 @@ -# About Heptio Ark +--- +title: "About Heptio Ark" +layout: docs +--- Heptio Ark provides customizable degrees of recovery for all Kubernetes objects (Pods, Deployments, Jobs, Custom Resource Definitions, etc.), as well as for persistent volumes. This recovery can be cluster-wide, or fine-tuned according to object type, namespace, or labels. diff --git a/site/content/docs/v0.8.0/api-types/README.md b/site/content/docs/v0.8.0/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.8.0/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/docs/v0.8.0/api-types/backup.md b/site/content/docs/v0.8.0/api-types/backup.md similarity index 99% rename from site/docs/v0.8.0/api-types/backup.md rename to site/content/docs/v0.8.0/api-types/backup.md index feef7c3dc..def928fc0 100644 --- a/site/docs/v0.8.0/api-types/backup.md +++ b/site/content/docs/v0.8.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.8.0/aws-config.md b/site/content/docs/v0.8.0/aws-config.md similarity index 99% rename from site/docs/v0.8.0/aws-config.md rename to site/content/docs/v0.8.0/aws-config.md index db3eeb429..53278d16f 100644 --- a/site/docs/v0.8.0/aws-config.md +++ b/site/content/docs/v0.8.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Ark on AWS +--- +title: "Run Ark on AWS" +layout: docs +--- To set up Ark on AWS, you: diff --git a/site/docs/v0.8.0/azure-config.md b/site/content/docs/v0.8.0/azure-config.md similarity index 99% rename from site/docs/v0.8.0/azure-config.md rename to site/content/docs/v0.8.0/azure-config.md index 0d19957f2..48ccc2374 100644 --- a/site/docs/v0.8.0/azure-config.md +++ b/site/content/docs/v0.8.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Ark on Azure +--- +title: "Run Ark on Azure" +layout: docs +--- To configure Ark on Azure, you: diff --git a/site/docs/v0.9.0/build-from-scratch.md b/site/content/docs/v0.8.0/build-from-scratch.md similarity index 98% rename from site/docs/v0.9.0/build-from-scratch.md rename to site/content/docs/v0.8.0/build-from-scratch.md index 9ef0bc5ed..7cb0b411c 100644 --- a/site/docs/v0.9.0/build-from-scratch.md +++ b/site/content/docs/v0.8.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Download][2] diff --git a/site/docs/v0.7.1/cli-reference/README.md b/site/content/docs/v0.8.0/cli-reference/README.md similarity index 93% rename from site/docs/v0.7.1/cli-reference/README.md rename to site/content/docs/v0.8.0/cli-reference/README.md index 29bebb516..1494296dd 100644 --- a/site/docs/v0.7.1/cli-reference/README.md +++ b/site/content/docs/v0.8.0/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.8.0/cli-reference/ark.md b/site/content/docs/v0.8.0/cli-reference/ark.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark.md rename to site/content/docs/v0.8.0/cli-reference/ark.md index b67bccb94..e6f65d275 100644 --- a/site/docs/v0.8.0/cli-reference/ark.md +++ b/site/content/docs/v0.8.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.9.0/cli-reference/ark_backup.md b/site/content/docs/v0.8.0/cli-reference/ark_backup.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_backup.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup.md index 78c37bbf0..25bbfb4b8 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.8.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.8.0/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup_create.md index 153e46128..861cbc30a 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.9.0/cli-reference/ark_backup_delete.md b/site/content/docs/v0.8.0/cli-reference/ark_backup_delete.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_backup_delete.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup_delete.md index 7866f02f3..f1e246201 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup_delete.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup_delete.md @@ -1,4 +1,7 @@ -## ark backup delete +--- +title: "ark backup delete" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.8.0/cli-reference/ark_backup_describe.md b/site/content/docs/v0.8.0/cli-reference/ark_backup_describe.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_backup_describe.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup_describe.md index 41691b500..e50f635f6 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup_describe.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup_describe.md @@ -1,4 +1,7 @@ -## ark backup describe +--- +title: "ark backup describe" +layout: docs +--- Describe backups diff --git a/site/docs/v0.9.0/cli-reference/ark_backup_download.md b/site/content/docs/v0.8.0/cli-reference/ark_backup_download.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_backup_download.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup_download.md index e1b0c5800..703a607dd 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.8.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.8.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup_get.md index 130e86c0a..7cd1c9107 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.8.0/cli-reference/ark_backup_logs.md b/site/content/docs/v0.8.0/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.8.0/cli-reference/ark_backup_logs.md index 0850c7093..980b2ad32 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.9.0/cli-reference/ark_client.md b/site/content/docs/v0.8.0/cli-reference/ark_client.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_client.md rename to site/content/docs/v0.8.0/cli-reference/ark_client.md index b2ea636b0..b52fd4faa 100644 --- a/site/docs/v0.9.0/cli-reference/ark_client.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_client.md @@ -1,4 +1,7 @@ -## ark client +--- +title: "ark client" +layout: docs +--- Ark client related commands diff --git a/site/docs/v0.9.0/cli-reference/ark_client_config.md b/site/content/docs/v0.8.0/cli-reference/ark_client_config.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_client_config.md rename to site/content/docs/v0.8.0/cli-reference/ark_client_config.md index 6d68053a0..a5061fb76 100644 --- a/site/docs/v0.9.0/cli-reference/ark_client_config.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_client_config.md @@ -1,4 +1,7 @@ -## ark client config +--- +title: "ark client config" +layout: docs +--- Get and set client configuration file values diff --git a/site/docs/v0.9.0/cli-reference/ark_client_config_get.md b/site/content/docs/v0.8.0/cli-reference/ark_client_config_get.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_client_config_get.md rename to site/content/docs/v0.8.0/cli-reference/ark_client_config_get.md index 2e3d4d481..423bf890e 100644 --- a/site/docs/v0.9.0/cli-reference/ark_client_config_get.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_client_config_get.md @@ -1,4 +1,7 @@ -## ark client config get +--- +title: "ark client config get" +layout: docs +--- Get client configuration file values diff --git a/site/docs/v0.9.0/cli-reference/ark_client_config_set.md b/site/content/docs/v0.8.0/cli-reference/ark_client_config_set.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_client_config_set.md rename to site/content/docs/v0.8.0/cli-reference/ark_client_config_set.md index 7fddd86ca..1fc36fd96 100644 --- a/site/docs/v0.9.0/cli-reference/ark_client_config_set.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_client_config_set.md @@ -1,4 +1,7 @@ -## ark client config set +--- +title: "ark client config set" +layout: docs +--- Set client configuration file values diff --git a/site/docs/v0.9.0/cli-reference/ark_completion.md b/site/content/docs/v0.8.0/cli-reference/ark_completion.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_completion.md rename to site/content/docs/v0.8.0/cli-reference/ark_completion.md index 83a140529..8ce96bb8b 100644 --- a/site/docs/v0.9.0/cli-reference/ark_completion.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_completion.md @@ -1,4 +1,7 @@ -## ark completion +--- +title: "ark completion" +layout: docs +--- Output shell completion code for the specified shell (bash or zsh) diff --git a/site/docs/v0.9.0/cli-reference/ark_create.md b/site/content/docs/v0.8.0/cli-reference/ark_create.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_create.md rename to site/content/docs/v0.8.0/cli-reference/ark_create.md index fc7934f14..955e2b1a6 100644 --- a/site/docs/v0.9.0/cli-reference/ark_create.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.9.0/cli-reference/ark_create_backup.md b/site/content/docs/v0.8.0/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark_create_backup.md rename to site/content/docs/v0.8.0/cli-reference/ark_create_backup.md index 3e94680e7..aabb02547 100644 --- a/site/docs/v0.9.0/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.8.1/cli-reference/ark_create_restore.md b/site/content/docs/v0.8.0/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark_create_restore.md rename to site/content/docs/v0.8.0/cli-reference/ark_create_restore.md index 4035a16f8..d68a09ab1 100644 --- a/site/docs/v0.8.1/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.9.0/cli-reference/ark_create_schedule.md b/site/content/docs/v0.8.0/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.8.0/cli-reference/ark_create_schedule.md index 4ddb7b575..c21aa625a 100644 --- a/site/docs/v0.9.0/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.8.0/cli-reference/ark_delete.md b/site/content/docs/v0.8.0/cli-reference/ark_delete.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_delete.md rename to site/content/docs/v0.8.0/cli-reference/ark_delete.md index 7016169ce..6743909b9 100644 --- a/site/docs/v0.8.0/cli-reference/ark_delete.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_delete.md @@ -1,4 +1,7 @@ -## ark delete +--- +title: "ark delete" +layout: docs +--- Delete ark resources diff --git a/site/docs/v0.9.0/cli-reference/ark_delete_backup.md b/site/content/docs/v0.8.0/cli-reference/ark_delete_backup.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_delete_backup.md rename to site/content/docs/v0.8.0/cli-reference/ark_delete_backup.md index 3dceaf041..6ceaf8883 100644 --- a/site/docs/v0.9.0/cli-reference/ark_delete_backup.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_delete_backup.md @@ -1,4 +1,7 @@ -## ark delete backup +--- +title: "ark delete backup" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.8.0/cli-reference/ark_delete_restore.md b/site/content/docs/v0.8.0/cli-reference/ark_delete_restore.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_delete_restore.md rename to site/content/docs/v0.8.0/cli-reference/ark_delete_restore.md index 44d77ab9c..d290c574d 100644 --- a/site/docs/v0.8.0/cli-reference/ark_delete_restore.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_delete_restore.md @@ -1,4 +1,7 @@ -## ark delete restore +--- +title: "ark delete restore" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.9.0/cli-reference/ark_delete_schedule.md b/site/content/docs/v0.8.0/cli-reference/ark_delete_schedule.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_delete_schedule.md rename to site/content/docs/v0.8.0/cli-reference/ark_delete_schedule.md index 6131b0a37..541a02dfb 100644 --- a/site/docs/v0.9.0/cli-reference/ark_delete_schedule.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_delete_schedule.md @@ -1,4 +1,7 @@ -## ark delete schedule +--- +title: "ark delete schedule" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.8.1/cli-reference/ark_describe.md b/site/content/docs/v0.8.0/cli-reference/ark_describe.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_describe.md rename to site/content/docs/v0.8.0/cli-reference/ark_describe.md index a58c0eea7..8b934d9fd 100644 --- a/site/docs/v0.8.1/cli-reference/ark_describe.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_describe.md @@ -1,4 +1,7 @@ -## ark describe +--- +title: "ark describe" +layout: docs +--- Describe ark resources diff --git a/site/docs/v0.8.1/cli-reference/ark_describe_backups.md b/site/content/docs/v0.8.0/cli-reference/ark_describe_backups.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_describe_backups.md rename to site/content/docs/v0.8.0/cli-reference/ark_describe_backups.md index 731355a90..7e05c15f5 100644 --- a/site/docs/v0.8.1/cli-reference/ark_describe_backups.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_describe_backups.md @@ -1,4 +1,7 @@ -## ark describe backups +--- +title: "ark describe backups" +layout: docs +--- Describe backups diff --git a/site/docs/v0.8.1/cli-reference/ark_describe_restores.md b/site/content/docs/v0.8.0/cli-reference/ark_describe_restores.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_describe_restores.md rename to site/content/docs/v0.8.0/cli-reference/ark_describe_restores.md index e0d401ca3..9c1571c84 100644 --- a/site/docs/v0.8.1/cli-reference/ark_describe_restores.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_describe_restores.md @@ -1,4 +1,7 @@ -## ark describe restores +--- +title: "ark describe restores" +layout: docs +--- Describe restores diff --git a/site/docs/v0.8.0/cli-reference/ark_describe_schedules.md b/site/content/docs/v0.8.0/cli-reference/ark_describe_schedules.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_describe_schedules.md rename to site/content/docs/v0.8.0/cli-reference/ark_describe_schedules.md index 4b5dad30d..ba429cb96 100644 --- a/site/docs/v0.8.0/cli-reference/ark_describe_schedules.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_describe_schedules.md @@ -1,4 +1,7 @@ -## ark describe schedules +--- +title: "ark describe schedules" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.8.1/cli-reference/ark_get.md b/site/content/docs/v0.8.0/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_get.md rename to site/content/docs/v0.8.0/cli-reference/ark_get.md index 4a91e8a66..b35e0fbc9 100644 --- a/site/docs/v0.8.1/cli-reference/ark_get.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.8.1/cli-reference/ark_get_backups.md b/site/content/docs/v0.8.0/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_get_backups.md rename to site/content/docs/v0.8.0/cli-reference/ark_get_backups.md index f010ae5eb..70422ad24 100644 --- a/site/docs/v0.8.1/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.8.0/cli-reference/ark_get_restores.md b/site/content/docs/v0.8.0/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_get_restores.md rename to site/content/docs/v0.8.0/cli-reference/ark_get_restores.md index 382c27d4f..d36878151 100644 --- a/site/docs/v0.8.0/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.8.1/cli-reference/ark_get_schedules.md b/site/content/docs/v0.8.0/cli-reference/ark_get_schedules.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.8.0/cli-reference/ark_get_schedules.md index 2b8d1ce9a..b1de24b90 100644 --- a/site/docs/v0.8.1/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.8.1/cli-reference/ark_plugin.md b/site/content/docs/v0.8.0/cli-reference/ark_plugin.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_plugin.md rename to site/content/docs/v0.8.0/cli-reference/ark_plugin.md index 2dc71a5a9..c81272d87 100644 --- a/site/docs/v0.8.1/cli-reference/ark_plugin.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_plugin.md @@ -1,4 +1,7 @@ -## ark plugin +--- +title: "ark plugin" +layout: docs +--- Work with plugins diff --git a/site/docs/v0.8.1/cli-reference/ark_plugin_add.md b/site/content/docs/v0.8.0/cli-reference/ark_plugin_add.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_plugin_add.md rename to site/content/docs/v0.8.0/cli-reference/ark_plugin_add.md index 297cc6340..8cdd048a2 100644 --- a/site/docs/v0.8.1/cli-reference/ark_plugin_add.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_plugin_add.md @@ -1,4 +1,7 @@ -## ark plugin add +--- +title: "ark plugin add" +layout: docs +--- Add a plugin diff --git a/site/docs/v0.8.1/cli-reference/ark_plugin_remove.md b/site/content/docs/v0.8.0/cli-reference/ark_plugin_remove.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_plugin_remove.md rename to site/content/docs/v0.8.0/cli-reference/ark_plugin_remove.md index 98a8d5b87..1d77b30a5 100644 --- a/site/docs/v0.8.1/cli-reference/ark_plugin_remove.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_plugin_remove.md @@ -1,4 +1,7 @@ -## ark plugin remove +--- +title: "ark plugin remove" +layout: docs +--- Remove a plugin diff --git a/site/docs/v0.9.0/cli-reference/ark_restore.md b/site/content/docs/v0.8.0/cli-reference/ark_restore.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_restore.md rename to site/content/docs/v0.8.0/cli-reference/ark_restore.md index b55f523ea..d48298576 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.9.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.8.0/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.8.0/cli-reference/ark_restore_create.md index f83787cad..86c9118fc 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.8.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.8.0/cli-reference/ark_restore_delete.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.8.0/cli-reference/ark_restore_delete.md index 6835b07f7..a9d145112 100644 --- a/site/docs/v0.8.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.8.0/cli-reference/ark_restore_describe.md b/site/content/docs/v0.8.0/cli-reference/ark_restore_describe.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_restore_describe.md rename to site/content/docs/v0.8.0/cli-reference/ark_restore_describe.md index 2c5732380..a32bb5515 100644 --- a/site/docs/v0.8.0/cli-reference/ark_restore_describe.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_restore_describe.md @@ -1,4 +1,7 @@ -## ark restore describe +--- +title: "ark restore describe" +layout: docs +--- Describe restores diff --git a/site/docs/v0.8.1/cli-reference/ark_restore_get.md b/site/content/docs/v0.8.0/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_restore_get.md rename to site/content/docs/v0.8.0/cli-reference/ark_restore_get.md index 0ccd5631d..c2a3d658d 100644 --- a/site/docs/v0.8.1/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.9.0/cli-reference/ark_restore_logs.md b/site/content/docs/v0.8.0/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.8.0/cli-reference/ark_restore_logs.md index 86abd6ea9..e7597ef92 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.9.0/cli-reference/ark_schedule.md b/site/content/docs/v0.8.0/cli-reference/ark_schedule.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.8.0/cli-reference/ark_schedule.md index 586612b1d..75d57431a 100644 --- a/site/docs/v0.9.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.8.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.8.0/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.8.0/cli-reference/ark_schedule_create.md index c60c91a0d..c8a878170 100644 --- a/site/docs/v0.8.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.8.1/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.8.0/cli-reference/ark_schedule_delete.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.8.0/cli-reference/ark_schedule_delete.md index 40cd310e6..2a9aad0ca 100644 --- a/site/docs/v0.8.1/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.8.1/cli-reference/ark_schedule_describe.md b/site/content/docs/v0.8.0/cli-reference/ark_schedule_describe.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_schedule_describe.md rename to site/content/docs/v0.8.0/cli-reference/ark_schedule_describe.md index 986951758..9c7883b2b 100644 --- a/site/docs/v0.8.1/cli-reference/ark_schedule_describe.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_schedule_describe.md @@ -1,4 +1,7 @@ -## ark schedule describe +--- +title: "ark schedule describe" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.8.1/cli-reference/ark_schedule_get.md b/site/content/docs/v0.8.0/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.8.0/cli-reference/ark_schedule_get.md index 488d047a8..2c9506400 100644 --- a/site/docs/v0.8.1/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.8.0/cli-reference/ark_server.md b/site/content/docs/v0.8.0/cli-reference/ark_server.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_server.md rename to site/content/docs/v0.8.0/cli-reference/ark_server.md index 46bf223cd..2b08d2114 100644 --- a/site/docs/v0.8.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.8.0/cli-reference/ark_version.md b/site/content/docs/v0.8.0/cli-reference/ark_version.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_version.md rename to site/content/docs/v0.8.0/cli-reference/ark_version.md index 7aa4b75c8..5f29a5bfa 100644 --- a/site/docs/v0.8.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.8.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.8.1/cloud-common.md b/site/content/docs/v0.8.0/cloud-common.md similarity index 97% rename from site/docs/v0.8.1/cloud-common.md rename to site/content/docs/v0.8.0/cloud-common.md index 65a389886..5f46dab72 100644 --- a/site/docs/v0.8.1/cloud-common.md +++ b/site/content/docs/v0.8.0/cloud-common.md @@ -1,4 +1,7 @@ -# Set up Ark with your cloud provider +--- +title: "Set up Ark with your cloud provider" +layout: docs +--- To run Ark with your cloud provider, you specify provider-specific settings for the Ark server. In version 0.7.0 and later, you can run Ark in any namespace, which requires additional customization. See [Run in custom namespace][3]. diff --git a/site/docs/v0.8.0/config-definition.md b/site/content/docs/v0.8.0/config-definition.md similarity index 99% rename from site/docs/v0.8.0/config-definition.md rename to site/content/docs/v0.8.0/config-definition.md index 91fb981ee..182a4c167 100644 --- a/site/docs/v0.8.0/config-definition.md +++ b/site/content/docs/v0.8.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.8.0/debugging-deletes.md b/site/content/docs/v0.8.0/debugging-deletes.md similarity index 96% rename from site/docs/v0.8.0/debugging-deletes.md rename to site/content/docs/v0.8.0/debugging-deletes.md index b16693c22..1b788245c 100644 --- a/site/docs/v0.8.0/debugging-deletes.md +++ b/site/content/docs/v0.8.0/debugging-deletes.md @@ -1,4 +1,7 @@ -# Ark version 0.7.0 and later: issue with deleting namespaces and backups +--- +title: "Ark version 0.7.0 and later: issue with deleting namespaces and backups " +layout: docs +--- Version 0.7.0 introduced the ability to delete backups. However, you may encounter an issue if you try to delete the `heptio-ark` namespace. The namespace can get stuck in a terminating state, and you cannot delete your backups. diff --git a/site/docs/v0.8.0/debugging-restores.md b/site/content/docs/v0.8.0/debugging-restores.md similarity index 98% rename from site/docs/v0.8.0/debugging-restores.md rename to site/content/docs/v0.8.0/debugging-restores.md index bac4de501..137e3bb37 100644 --- a/site/docs/v0.8.0/debugging-restores.md +++ b/site/content/docs/v0.8.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.10.0/extend.md b/site/content/docs/v0.8.0/extend.md similarity index 94% rename from site/docs/v0.10.0/extend.md rename to site/content/docs/v0.8.0/extend.md index 0a96b8e3e..ae282f58d 100644 --- a/site/docs/v0.10.0/extend.md +++ b/site/content/docs/v0.8.0/extend.md @@ -1,4 +1,7 @@ -# Extend Ark +--- +title: "Extend Ark" +layout: docs +--- Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/docs/v0.8.0/faq.md b/site/content/docs/v0.8.0/faq.md similarity index 97% rename from site/docs/v0.8.0/faq.md rename to site/content/docs/v0.8.0/faq.md index f83829ec9..0fbfbbb35 100644 --- a/site/docs/v0.8.0/faq.md +++ b/site/content/docs/v0.8.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.8.1/gcp-config.md b/site/content/docs/v0.8.0/gcp-config.md similarity index 98% rename from site/docs/v0.8.1/gcp-config.md rename to site/content/docs/v0.8.0/gcp-config.md index aac2273ff..02a134a73 100644 --- a/site/docs/v0.8.1/gcp-config.md +++ b/site/content/docs/v0.8.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Ark on GCP +--- +title: "Run Ark on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either of: diff --git a/site/docs/v0.8.0/hooks.md b/site/content/docs/v0.8.0/hooks.md similarity index 98% rename from site/docs/v0.8.0/hooks.md rename to site/content/docs/v0.8.0/hooks.md index 5097f4090..6f83c98ff 100644 --- a/site/docs/v0.8.0/hooks.md +++ b/site/content/docs/v0.8.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.8.1/ibm-config.md b/site/content/docs/v0.8.0/ibm-config.md similarity index 97% rename from site/docs/v0.8.1/ibm-config.md rename to site/content/docs/v0.8.0/ibm-config.md index 97766d940..ef961a613 100644 --- a/site/docs/v0.8.1/ibm-config.md +++ b/site/content/docs/v0.8.0/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Ark's storage destination. +--- +title: "Use IBM Cloud Object Storage as Ark's storage destination." +layout: docs +--- You can deploy Ark on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Ark's backups. To set up IBM Cloud Object Storage (COS) as Ark's destination, you: diff --git a/site/docs/v0.8.0/img/README.md b/site/content/docs/v0.8.0/img/README.md similarity index 100% rename from site/docs/v0.8.0/img/README.md rename to site/content/docs/v0.8.0/img/README.md diff --git a/site/docs/v0.8.0/img/backup-process.png b/site/content/docs/v0.8.0/img/backup-process.png similarity index 100% rename from site/docs/v0.8.0/img/backup-process.png rename to site/content/docs/v0.8.0/img/backup-process.png diff --git a/site/docs/v0.9.0/namespace.md b/site/content/docs/v0.8.0/namespace.md similarity index 97% rename from site/docs/v0.9.0/namespace.md rename to site/content/docs/v0.8.0/namespace.md index c15ee41b4..5739f61e3 100644 --- a/site/docs/v0.9.0/namespace.md +++ b/site/content/docs/v0.8.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Ark version 0.7.0 and later, you can run Ark in any namespace. To do so, you specify the namespace in the YAML files that configure the Ark server. You then also specify the namespace when diff --git a/site/docs/v0.8.0/output-file-format.md b/site/content/docs/v0.8.0/output-file-format.md similarity index 98% rename from site/docs/v0.8.0/output-file-format.md rename to site/content/docs/v0.8.0/output-file-format.md index 8541e3a82..fd42f15ba 100644 --- a/site/docs/v0.8.0/output-file-format.md +++ b/site/content/docs/v0.8.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/docs/v0.7.0/plugins.md b/site/content/docs/v0.8.0/plugins.md similarity index 98% rename from site/docs/v0.7.0/plugins.md rename to site/content/docs/v0.8.0/plugins.md index 1cb2ae391..55dc172e4 100644 --- a/site/docs/v0.7.0/plugins.md +++ b/site/content/docs/v0.8.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary diff --git a/site/docs/v0.7.1/troubleshooting.md b/site/content/docs/v0.8.0/troubleshooting.md similarity index 88% rename from site/docs/v0.7.1/troubleshooting.md rename to site/content/docs/v0.8.0/troubleshooting.md index 39ea7c7cb..8233bef28 100644 --- a/site/docs/v0.7.1/troubleshooting.md +++ b/site/content/docs/v0.8.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [Kubernetes Slack team][25] channel `#ark-dr`. diff --git a/site/docs/v0.8.1/use-cases.md b/site/content/docs/v0.8.0/use-cases.md similarity index 98% rename from site/docs/v0.8.1/use-cases.md rename to site/content/docs/v0.8.0/use-cases.md index 7263079c9..0fa634014 100644 --- a/site/docs/v0.8.1/use-cases.md +++ b/site/content/docs/v0.8.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/docs/v0.8.0/vendoring-dependencies.md b/site/content/docs/v0.8.0/vendoring-dependencies.md similarity index 89% rename from site/docs/v0.8.0/vendoring-dependencies.md rename to site/content/docs/v0.8.0/vendoring-dependencies.md index 1729f21ec..9fc1bcac1 100644 --- a/site/docs/v0.8.0/vendoring-dependencies.md +++ b/site/content/docs/v0.8.0/vendoring-dependencies.md @@ -1,4 +1,7 @@ -# Vendoring dependencies +--- +title: "Vendoring dependencies" +layout: docs +--- ## Overview diff --git a/site/docs/v0.8.1/README.md b/site/content/docs/v0.8.1/_index.md similarity index 99% rename from site/docs/v0.8.1/README.md rename to site/content/docs/v0.8.1/_index.md index ff10c1bb4..3743725f4 100644 --- a/site/docs/v0.8.1/README.md +++ b/site/content/docs/v0.8.1/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.8.1 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.7.0/about.md b/site/content/docs/v0.8.1/about.md similarity index 99% rename from site/docs/v0.7.0/about.md rename to site/content/docs/v0.8.1/about.md index 2cb82db26..4d48dce47 100644 --- a/site/docs/v0.7.0/about.md +++ b/site/content/docs/v0.8.1/about.md @@ -1,4 +1,7 @@ -# About Heptio Ark +--- +title: "About Heptio Ark" +layout: docs +--- Heptio Ark provides customizable degrees of recovery for all Kubernetes objects (Pods, Deployments, Jobs, Custom Resource Definitions, etc.), as well as for persistent volumes. This recovery can be cluster-wide, or fine-tuned according to object type, namespace, or labels. diff --git a/site/content/docs/v0.8.1/api-types/README.md b/site/content/docs/v0.8.1/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.8.1/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/docs/v0.8.1/api-types/backup.md b/site/content/docs/v0.8.1/api-types/backup.md similarity index 99% rename from site/docs/v0.8.1/api-types/backup.md rename to site/content/docs/v0.8.1/api-types/backup.md index feef7c3dc..def928fc0 100644 --- a/site/docs/v0.8.1/api-types/backup.md +++ b/site/content/docs/v0.8.1/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v0.8.1/aws-config.md b/site/content/docs/v0.8.1/aws-config.md similarity index 99% rename from site/docs/v0.8.1/aws-config.md rename to site/content/docs/v0.8.1/aws-config.md index 8713dee37..f0020b4a1 100644 --- a/site/docs/v0.8.1/aws-config.md +++ b/site/content/docs/v0.8.1/aws-config.md @@ -1,4 +1,7 @@ -# Run Ark on AWS +--- +title: "Run Ark on AWS" +layout: docs +--- To set up Ark on AWS, you: diff --git a/site/docs/v0.8.1/azure-config.md b/site/content/docs/v0.8.1/azure-config.md similarity index 99% rename from site/docs/v0.8.1/azure-config.md rename to site/content/docs/v0.8.1/azure-config.md index 0d19957f2..48ccc2374 100644 --- a/site/docs/v0.8.1/azure-config.md +++ b/site/content/docs/v0.8.1/azure-config.md @@ -1,4 +1,7 @@ -# Run Ark on Azure +--- +title: "Run Ark on Azure" +layout: docs +--- To configure Ark on Azure, you: diff --git a/site/docs/v0.8.0/build-from-scratch.md b/site/content/docs/v0.8.1/build-from-scratch.md similarity index 98% rename from site/docs/v0.8.0/build-from-scratch.md rename to site/content/docs/v0.8.1/build-from-scratch.md index 9ef0bc5ed..7cb0b411c 100644 --- a/site/docs/v0.8.0/build-from-scratch.md +++ b/site/content/docs/v0.8.1/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Download][2] diff --git a/site/docs/v0.8.0/cli-reference/README.md b/site/content/docs/v0.8.1/cli-reference/README.md similarity index 93% rename from site/docs/v0.8.0/cli-reference/README.md rename to site/content/docs/v0.8.1/cli-reference/README.md index 29bebb516..1494296dd 100644 --- a/site/docs/v0.8.0/cli-reference/README.md +++ b/site/content/docs/v0.8.1/cli-reference/README.md @@ -1,4 +1,7 @@ -# Command line reference +--- +title: "Command line reference" +layout: docs +--- The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. diff --git a/site/docs/v0.8.1/cli-reference/ark.md b/site/content/docs/v0.8.1/cli-reference/ark.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark.md rename to site/content/docs/v0.8.1/cli-reference/ark.md index b67bccb94..e6f65d275 100644 --- a/site/docs/v0.8.1/cli-reference/ark.md +++ b/site/content/docs/v0.8.1/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.8.0/cli-reference/ark_backup.md b/site/content/docs/v0.8.1/cli-reference/ark_backup.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_backup.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup.md index 78c37bbf0..25bbfb4b8 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.9.0/cli-reference/ark_backup_create.md b/site/content/docs/v0.8.1/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark_backup_create.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup_create.md index 153e46128..861cbc30a 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.8.0/cli-reference/ark_backup_delete.md b/site/content/docs/v0.8.1/cli-reference/ark_backup_delete.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_backup_delete.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup_delete.md index 7866f02f3..f1e246201 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup_delete.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup_delete.md @@ -1,4 +1,7 @@ -## ark backup delete +--- +title: "ark backup delete" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.8.1/cli-reference/ark_backup_describe.md b/site/content/docs/v0.8.1/cli-reference/ark_backup_describe.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_backup_describe.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup_describe.md index 41691b500..e50f635f6 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup_describe.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup_describe.md @@ -1,4 +1,7 @@ -## ark backup describe +--- +title: "ark backup describe" +layout: docs +--- Describe backups diff --git a/site/docs/v0.8.0/cli-reference/ark_backup_download.md b/site/content/docs/v0.8.1/cli-reference/ark_backup_download.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_backup_download.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup_download.md index e1b0c5800..703a607dd 100644 --- a/site/docs/v0.8.0/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.8.1/cli-reference/ark_backup_get.md b/site/content/docs/v0.8.1/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_backup_get.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup_get.md index 130e86c0a..7cd1c9107 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.8.1/cli-reference/ark_backup_logs.md b/site/content/docs/v0.8.1/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.8.1/cli-reference/ark_backup_logs.md index 0850c7093..980b2ad32 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.8.1/cli-reference/ark_client.md b/site/content/docs/v0.8.1/cli-reference/ark_client.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_client.md rename to site/content/docs/v0.8.1/cli-reference/ark_client.md index b2ea636b0..b52fd4faa 100644 --- a/site/docs/v0.8.1/cli-reference/ark_client.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_client.md @@ -1,4 +1,7 @@ -## ark client +--- +title: "ark client" +layout: docs +--- Ark client related commands diff --git a/site/docs/v0.8.1/cli-reference/ark_client_config.md b/site/content/docs/v0.8.1/cli-reference/ark_client_config.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_client_config.md rename to site/content/docs/v0.8.1/cli-reference/ark_client_config.md index 6d68053a0..a5061fb76 100644 --- a/site/docs/v0.8.1/cli-reference/ark_client_config.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_client_config.md @@ -1,4 +1,7 @@ -## ark client config +--- +title: "ark client config" +layout: docs +--- Get and set client configuration file values diff --git a/site/docs/v0.8.1/cli-reference/ark_client_config_get.md b/site/content/docs/v0.8.1/cli-reference/ark_client_config_get.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_client_config_get.md rename to site/content/docs/v0.8.1/cli-reference/ark_client_config_get.md index 2e3d4d481..423bf890e 100644 --- a/site/docs/v0.8.1/cli-reference/ark_client_config_get.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_client_config_get.md @@ -1,4 +1,7 @@ -## ark client config get +--- +title: "ark client config get" +layout: docs +--- Get client configuration file values diff --git a/site/docs/v0.8.0/cli-reference/ark_client_config_set.md b/site/content/docs/v0.8.1/cli-reference/ark_client_config_set.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_client_config_set.md rename to site/content/docs/v0.8.1/cli-reference/ark_client_config_set.md index 7fddd86ca..1fc36fd96 100644 --- a/site/docs/v0.8.0/cli-reference/ark_client_config_set.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_client_config_set.md @@ -1,4 +1,7 @@ -## ark client config set +--- +title: "ark client config set" +layout: docs +--- Set client configuration file values diff --git a/site/docs/v0.8.0/cli-reference/ark_completion.md b/site/content/docs/v0.8.1/cli-reference/ark_completion.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_completion.md rename to site/content/docs/v0.8.1/cli-reference/ark_completion.md index 83a140529..8ce96bb8b 100644 --- a/site/docs/v0.8.0/cli-reference/ark_completion.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_completion.md @@ -1,4 +1,7 @@ -## ark completion +--- +title: "ark completion" +layout: docs +--- Output shell completion code for the specified shell (bash or zsh) diff --git a/site/docs/v0.8.1/cli-reference/ark_create.md b/site/content/docs/v0.8.1/cli-reference/ark_create.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_create.md rename to site/content/docs/v0.8.1/cli-reference/ark_create.md index fc7934f14..955e2b1a6 100644 --- a/site/docs/v0.8.1/cli-reference/ark_create.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.8.1/cli-reference/ark_create_backup.md b/site/content/docs/v0.8.1/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark_create_backup.md rename to site/content/docs/v0.8.1/cli-reference/ark_create_backup.md index 3e94680e7..aabb02547 100644 --- a/site/docs/v0.8.1/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.9.0/cli-reference/ark_create_restore.md b/site/content/docs/v0.8.1/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark_create_restore.md rename to site/content/docs/v0.8.1/cli-reference/ark_create_restore.md index 4035a16f8..d68a09ab1 100644 --- a/site/docs/v0.9.0/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.8.0/cli-reference/ark_create_schedule.md b/site/content/docs/v0.8.1/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.8.1/cli-reference/ark_create_schedule.md index 4ddb7b575..c21aa625a 100644 --- a/site/docs/v0.8.0/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.9.0/cli-reference/ark_delete.md b/site/content/docs/v0.8.1/cli-reference/ark_delete.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_delete.md rename to site/content/docs/v0.8.1/cli-reference/ark_delete.md index 7016169ce..6743909b9 100644 --- a/site/docs/v0.9.0/cli-reference/ark_delete.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_delete.md @@ -1,4 +1,7 @@ -## ark delete +--- +title: "ark delete" +layout: docs +--- Delete ark resources diff --git a/site/docs/v0.8.1/cli-reference/ark_delete_backup.md b/site/content/docs/v0.8.1/cli-reference/ark_delete_backup.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_delete_backup.md rename to site/content/docs/v0.8.1/cli-reference/ark_delete_backup.md index 3dceaf041..6ceaf8883 100644 --- a/site/docs/v0.8.1/cli-reference/ark_delete_backup.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_delete_backup.md @@ -1,4 +1,7 @@ -## ark delete backup +--- +title: "ark delete backup" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.9.0/cli-reference/ark_delete_restore.md b/site/content/docs/v0.8.1/cli-reference/ark_delete_restore.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_delete_restore.md rename to site/content/docs/v0.8.1/cli-reference/ark_delete_restore.md index 44d77ab9c..d290c574d 100644 --- a/site/docs/v0.9.0/cli-reference/ark_delete_restore.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_delete_restore.md @@ -1,4 +1,7 @@ -## ark delete restore +--- +title: "ark delete restore" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.8.0/cli-reference/ark_delete_schedule.md b/site/content/docs/v0.8.1/cli-reference/ark_delete_schedule.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_delete_schedule.md rename to site/content/docs/v0.8.1/cli-reference/ark_delete_schedule.md index 6131b0a37..541a02dfb 100644 --- a/site/docs/v0.8.0/cli-reference/ark_delete_schedule.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_delete_schedule.md @@ -1,4 +1,7 @@ -## ark delete schedule +--- +title: "ark delete schedule" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.9.0/cli-reference/ark_describe.md b/site/content/docs/v0.8.1/cli-reference/ark_describe.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_describe.md rename to site/content/docs/v0.8.1/cli-reference/ark_describe.md index a58c0eea7..8b934d9fd 100644 --- a/site/docs/v0.9.0/cli-reference/ark_describe.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_describe.md @@ -1,4 +1,7 @@ -## ark describe +--- +title: "ark describe" +layout: docs +--- Describe ark resources diff --git a/site/docs/v0.8.0/cli-reference/ark_describe_backups.md b/site/content/docs/v0.8.1/cli-reference/ark_describe_backups.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_describe_backups.md rename to site/content/docs/v0.8.1/cli-reference/ark_describe_backups.md index 731355a90..7e05c15f5 100644 --- a/site/docs/v0.8.0/cli-reference/ark_describe_backups.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_describe_backups.md @@ -1,4 +1,7 @@ -## ark describe backups +--- +title: "ark describe backups" +layout: docs +--- Describe backups diff --git a/site/docs/v0.8.0/cli-reference/ark_describe_restores.md b/site/content/docs/v0.8.1/cli-reference/ark_describe_restores.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_describe_restores.md rename to site/content/docs/v0.8.1/cli-reference/ark_describe_restores.md index e0d401ca3..9c1571c84 100644 --- a/site/docs/v0.8.0/cli-reference/ark_describe_restores.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_describe_restores.md @@ -1,4 +1,7 @@ -## ark describe restores +--- +title: "ark describe restores" +layout: docs +--- Describe restores diff --git a/site/docs/v0.8.1/cli-reference/ark_describe_schedules.md b/site/content/docs/v0.8.1/cli-reference/ark_describe_schedules.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_describe_schedules.md rename to site/content/docs/v0.8.1/cli-reference/ark_describe_schedules.md index 4b5dad30d..ba429cb96 100644 --- a/site/docs/v0.8.1/cli-reference/ark_describe_schedules.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_describe_schedules.md @@ -1,4 +1,7 @@ -## ark describe schedules +--- +title: "ark describe schedules" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.8.0/cli-reference/ark_get.md b/site/content/docs/v0.8.1/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_get.md rename to site/content/docs/v0.8.1/cli-reference/ark_get.md index 4a91e8a66..b35e0fbc9 100644 --- a/site/docs/v0.8.0/cli-reference/ark_get.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.8.0/cli-reference/ark_get_backups.md b/site/content/docs/v0.8.1/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_get_backups.md rename to site/content/docs/v0.8.1/cli-reference/ark_get_backups.md index f010ae5eb..70422ad24 100644 --- a/site/docs/v0.8.0/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.8.1/cli-reference/ark_get_restores.md b/site/content/docs/v0.8.1/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_get_restores.md rename to site/content/docs/v0.8.1/cli-reference/ark_get_restores.md index 382c27d4f..d36878151 100644 --- a/site/docs/v0.8.1/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.9.0/cli-reference/ark_get_schedules.md b/site/content/docs/v0.8.1/cli-reference/ark_get_schedules.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.8.1/cli-reference/ark_get_schedules.md index 2b8d1ce9a..b1de24b90 100644 --- a/site/docs/v0.9.0/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.9.0/cli-reference/ark_plugin.md b/site/content/docs/v0.8.1/cli-reference/ark_plugin.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_plugin.md rename to site/content/docs/v0.8.1/cli-reference/ark_plugin.md index 2dc71a5a9..c81272d87 100644 --- a/site/docs/v0.9.0/cli-reference/ark_plugin.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_plugin.md @@ -1,4 +1,7 @@ -## ark plugin +--- +title: "ark plugin" +layout: docs +--- Work with plugins diff --git a/site/docs/v0.9.0/cli-reference/ark_plugin_add.md b/site/content/docs/v0.8.1/cli-reference/ark_plugin_add.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_plugin_add.md rename to site/content/docs/v0.8.1/cli-reference/ark_plugin_add.md index 297cc6340..8cdd048a2 100644 --- a/site/docs/v0.9.0/cli-reference/ark_plugin_add.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_plugin_add.md @@ -1,4 +1,7 @@ -## ark plugin add +--- +title: "ark plugin add" +layout: docs +--- Add a plugin diff --git a/site/docs/v0.9.0/cli-reference/ark_plugin_remove.md b/site/content/docs/v0.8.1/cli-reference/ark_plugin_remove.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_plugin_remove.md rename to site/content/docs/v0.8.1/cli-reference/ark_plugin_remove.md index 98a8d5b87..1d77b30a5 100644 --- a/site/docs/v0.9.0/cli-reference/ark_plugin_remove.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_plugin_remove.md @@ -1,4 +1,7 @@ -## ark plugin remove +--- +title: "ark plugin remove" +layout: docs +--- Remove a plugin diff --git a/site/docs/v0.8.1/cli-reference/ark_restore.md b/site/content/docs/v0.8.1/cli-reference/ark_restore.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_restore.md rename to site/content/docs/v0.8.1/cli-reference/ark_restore.md index b55f523ea..d48298576 100644 --- a/site/docs/v0.8.1/cli-reference/ark_restore.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.8.0/cli-reference/ark_restore_create.md b/site/content/docs/v0.8.1/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark_restore_create.md rename to site/content/docs/v0.8.1/cli-reference/ark_restore_create.md index f83787cad..86c9118fc 100644 --- a/site/docs/v0.8.0/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.9.0/cli-reference/ark_restore_delete.md b/site/content/docs/v0.8.1/cli-reference/ark_restore_delete.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.8.1/cli-reference/ark_restore_delete.md index 6835b07f7..a9d145112 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.8.1/cli-reference/ark_restore_describe.md b/site/content/docs/v0.8.1/cli-reference/ark_restore_describe.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_restore_describe.md rename to site/content/docs/v0.8.1/cli-reference/ark_restore_describe.md index 2c5732380..a32bb5515 100644 --- a/site/docs/v0.8.1/cli-reference/ark_restore_describe.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_restore_describe.md @@ -1,4 +1,7 @@ -## ark restore describe +--- +title: "ark restore describe" +layout: docs +--- Describe restores diff --git a/site/docs/v0.8.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.8.1/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.8.1/cli-reference/ark_restore_get.md index 0ccd5631d..c2a3d658d 100644 --- a/site/docs/v0.8.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.8.0/cli-reference/ark_restore_logs.md b/site/content/docs/v0.8.1/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.8.1/cli-reference/ark_restore_logs.md index 86abd6ea9..e7597ef92 100644 --- a/site/docs/v0.8.0/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.8.1/cli-reference/ark_schedule.md b/site/content/docs/v0.8.1/cli-reference/ark_schedule.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_schedule.md rename to site/content/docs/v0.8.1/cli-reference/ark_schedule.md index 586612b1d..75d57431a 100644 --- a/site/docs/v0.8.1/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.9.0/cli-reference/ark_schedule_create.md b/site/content/docs/v0.8.1/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.8.1/cli-reference/ark_schedule_create.md index c60c91a0d..c8a878170 100644 --- a/site/docs/v0.9.0/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.8.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.8.1/cli-reference/ark_schedule_delete.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.8.1/cli-reference/ark_schedule_delete.md index 40cd310e6..2a9aad0ca 100644 --- a/site/docs/v0.8.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.9.0/cli-reference/ark_schedule_describe.md b/site/content/docs/v0.8.1/cli-reference/ark_schedule_describe.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_schedule_describe.md rename to site/content/docs/v0.8.1/cli-reference/ark_schedule_describe.md index 986951758..9c7883b2b 100644 --- a/site/docs/v0.9.0/cli-reference/ark_schedule_describe.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_schedule_describe.md @@ -1,4 +1,7 @@ -## ark schedule describe +--- +title: "ark schedule describe" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.9.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.8.1/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.8.1/cli-reference/ark_schedule_get.md index 488d047a8..2c9506400 100644 --- a/site/docs/v0.9.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.8.1/cli-reference/ark_server.md b/site/content/docs/v0.8.1/cli-reference/ark_server.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_server.md rename to site/content/docs/v0.8.1/cli-reference/ark_server.md index 46bf223cd..2b08d2114 100644 --- a/site/docs/v0.8.1/cli-reference/ark_server.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.9.0/cli-reference/ark_version.md b/site/content/docs/v0.8.1/cli-reference/ark_version.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_version.md rename to site/content/docs/v0.8.1/cli-reference/ark_version.md index 7aa4b75c8..5f29a5bfa 100644 --- a/site/docs/v0.9.0/cli-reference/ark_version.md +++ b/site/content/docs/v0.8.1/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.8.0/cloud-common.md b/site/content/docs/v0.8.1/cloud-common.md similarity index 97% rename from site/docs/v0.8.0/cloud-common.md rename to site/content/docs/v0.8.1/cloud-common.md index 65a389886..5f46dab72 100644 --- a/site/docs/v0.8.0/cloud-common.md +++ b/site/content/docs/v0.8.1/cloud-common.md @@ -1,4 +1,7 @@ -# Set up Ark with your cloud provider +--- +title: "Set up Ark with your cloud provider" +layout: docs +--- To run Ark with your cloud provider, you specify provider-specific settings for the Ark server. In version 0.7.0 and later, you can run Ark in any namespace, which requires additional customization. See [Run in custom namespace][3]. diff --git a/site/docs/v0.8.1/config-definition.md b/site/content/docs/v0.8.1/config-definition.md similarity index 99% rename from site/docs/v0.8.1/config-definition.md rename to site/content/docs/v0.8.1/config-definition.md index 91fb981ee..182a4c167 100644 --- a/site/docs/v0.8.1/config-definition.md +++ b/site/content/docs/v0.8.1/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.7.1/debugging-deletes.md b/site/content/docs/v0.8.1/debugging-deletes.md similarity index 96% rename from site/docs/v0.7.1/debugging-deletes.md rename to site/content/docs/v0.8.1/debugging-deletes.md index b16693c22..1b788245c 100644 --- a/site/docs/v0.7.1/debugging-deletes.md +++ b/site/content/docs/v0.8.1/debugging-deletes.md @@ -1,4 +1,7 @@ -# Ark version 0.7.0 and later: issue with deleting namespaces and backups +--- +title: "Ark version 0.7.0 and later: issue with deleting namespaces and backups " +layout: docs +--- Version 0.7.0 introduced the ability to delete backups. However, you may encounter an issue if you try to delete the `heptio-ark` namespace. The namespace can get stuck in a terminating state, and you cannot delete your backups. diff --git a/site/docs/v0.8.1/debugging-install.md b/site/content/docs/v0.8.1/debugging-install.md similarity index 97% rename from site/docs/v0.8.1/debugging-install.md rename to site/content/docs/v0.8.1/debugging-install.md index 2b0c72bc2..b0372ba89 100644 --- a/site/docs/v0.8.1/debugging-install.md +++ b/site/content/docs/v0.8.1/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v0.8.1/debugging-restores.md b/site/content/docs/v0.8.1/debugging-restores.md similarity index 98% rename from site/docs/v0.8.1/debugging-restores.md rename to site/content/docs/v0.8.1/debugging-restores.md index bac4de501..137e3bb37 100644 --- a/site/docs/v0.8.1/debugging-restores.md +++ b/site/content/docs/v0.8.1/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v0.8.1/extend.md b/site/content/docs/v0.8.1/extend.md similarity index 94% rename from site/docs/v0.8.1/extend.md rename to site/content/docs/v0.8.1/extend.md index 0a96b8e3e..ae282f58d 100644 --- a/site/docs/v0.8.1/extend.md +++ b/site/content/docs/v0.8.1/extend.md @@ -1,4 +1,7 @@ -# Extend Ark +--- +title: "Extend Ark" +layout: docs +--- Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/content/docs/v0.8.1/faq.md b/site/content/docs/v0.8.1/faq.md new file mode 100644 index 000000000..0fbfbbb35 --- /dev/null +++ b/site/content/docs/v0.8.1/faq.md @@ -0,0 +1,28 @@ +--- +title: "FAQ" +layout: docs +--- + +## When is it appropriate to use Ark instead of etcd's built in backup/restore? + +Etcd's backup/restore tooling is good for recovering from data loss in a single etcd cluster. For +example, it is a good idea to take a backup of etcd prior to upgrading etcd istelf. For more +sophisticated management of your Kubernetes cluster backups and restores, we feel that Ark is +generally a better approach. It gives you the ability to throw away an unstable cluster and restore +your Kubernetes resources and data into a new cluster, which you can't do easily just by backing up +and restoring etcd. + +Examples of cases where Ark is useful: + +* you don't have access to etcd (e.g. you're running on GKE) +* backing up both Kubernetes resources and persistent volume state +* cluster migrations +* backing up a subset of your Kubernetes resources +* backing up Kubernetes resources that are stored across multiple etcd clusters (for example if you + run a custom apiserver) + +## Will Ark restore my Kubernetes resources exactly the way they were before? + +Yes, with some exceptions. For example, when Ark restores pods it deletes the `nodeName` from the +pod so that it can be scheduled onto a new node. You can see some more examples of the differences +in [pod_action.go](https://github.com/heptio/ark/blob/main/pkg/restore/pod_action.go) diff --git a/site/docs/v0.8.0/gcp-config.md b/site/content/docs/v0.8.1/gcp-config.md similarity index 98% rename from site/docs/v0.8.0/gcp-config.md rename to site/content/docs/v0.8.1/gcp-config.md index aac2273ff..02a134a73 100644 --- a/site/docs/v0.8.0/gcp-config.md +++ b/site/content/docs/v0.8.1/gcp-config.md @@ -1,4 +1,7 @@ -# Run Ark on GCP +--- +title: "Run Ark on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either of: diff --git a/site/docs/v0.7.0/hooks.md b/site/content/docs/v0.8.1/hooks.md similarity index 98% rename from site/docs/v0.7.0/hooks.md rename to site/content/docs/v0.8.1/hooks.md index 5097f4090..6f83c98ff 100644 --- a/site/docs/v0.7.0/hooks.md +++ b/site/content/docs/v0.8.1/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Heptio Ark currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v0.8.0/ibm-config.md b/site/content/docs/v0.8.1/ibm-config.md similarity index 97% rename from site/docs/v0.8.0/ibm-config.md rename to site/content/docs/v0.8.1/ibm-config.md index 97766d940..ef961a613 100644 --- a/site/docs/v0.8.0/ibm-config.md +++ b/site/content/docs/v0.8.1/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Ark's storage destination. +--- +title: "Use IBM Cloud Object Storage as Ark's storage destination." +layout: docs +--- You can deploy Ark on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Ark's backups. To set up IBM Cloud Object Storage (COS) as Ark's destination, you: diff --git a/site/docs/v0.8.1/img/README.md b/site/content/docs/v0.8.1/img/README.md similarity index 100% rename from site/docs/v0.8.1/img/README.md rename to site/content/docs/v0.8.1/img/README.md diff --git a/site/docs/v0.8.1/img/backup-process.png b/site/content/docs/v0.8.1/img/backup-process.png similarity index 100% rename from site/docs/v0.8.1/img/backup-process.png rename to site/content/docs/v0.8.1/img/backup-process.png diff --git a/site/docs/v0.8.0/namespace.md b/site/content/docs/v0.8.1/namespace.md similarity index 97% rename from site/docs/v0.8.0/namespace.md rename to site/content/docs/v0.8.1/namespace.md index c15ee41b4..5739f61e3 100644 --- a/site/docs/v0.8.0/namespace.md +++ b/site/content/docs/v0.8.1/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Ark version 0.7.0 and later, you can run Ark in any namespace. To do so, you specify the namespace in the YAML files that configure the Ark server. You then also specify the namespace when diff --git a/site/docs/v0.8.1/output-file-format.md b/site/content/docs/v0.8.1/output-file-format.md similarity index 98% rename from site/docs/v0.8.1/output-file-format.md rename to site/content/docs/v0.8.1/output-file-format.md index 8541e3a82..fd42f15ba 100644 --- a/site/docs/v0.8.1/output-file-format.md +++ b/site/content/docs/v0.8.1/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). diff --git a/site/content/docs/v0.8.1/plugins.md b/site/content/docs/v0.8.1/plugins.md new file mode 100644 index 000000000..55dc172e4 --- /dev/null +++ b/site/content/docs/v0.8.1/plugins.md @@ -0,0 +1,38 @@ +--- +title: "Plugins" +layout: docs +--- + +Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores +without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary +containing an implementation of one of Ark's plugin kinds (described below), plus a small amount of boilerplate code to +expose the plugin implementation to Ark. This binary is added to a container image that serves as an init container for +the Ark server pod and copies the binary into a shared emptyDir volume for the Ark server to access. + +A fully-functional [sample plugin repository][1] is provided to serve as a convenient starting point for plugin authors. + +## Plugin Kinds + +Ark currently supports the following kinds of plugins: + +- **Object Store** - persists and retrieves backups, backup logs and restore logs +- **Block Store** - creates volume snapshots (during backup) and restores volumes from snapshots (during restore) +- **Backup Item Action** - executes arbitrary logic for individual items prior to storing them in a backup file +- **Restore Item Action** - executes arbitrary logic for individual items prior to restoring them into a cluster + +## Plugin Naming + +Ark relies on a naming convention to identify plugins. Each plugin binary should be named `ark--`, +where `plugin-kind` is one of `objectstore`, `blockstore`, `backupitemaction`, or `restoreitemaction`, and `name` is +unique within the plugin kind. + +## Plugin Logging + +Ark provides a [logger][2] that can be used by plugins to log structured information to the main Ark server log or +per-backup/restore logs. See the [sample repository][1] for an example of how to instantiate and use the logger +within your plugin. + + + +[1]: https://github.com/heptio/ark-plugin-example +[2]: https://github.com/heptio/ark/blob/main/pkg/plugin/logger.go diff --git a/site/docs/v0.8.1/troubleshooting.md b/site/content/docs/v0.8.1/troubleshooting.md similarity index 90% rename from site/docs/v0.8.1/troubleshooting.md rename to site/content/docs/v0.8.1/troubleshooting.md index b96d96f4d..b162aa973 100644 --- a/site/docs/v0.8.1/troubleshooting.md +++ b/site/content/docs/v0.8.1/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#ark-dr channel][25]. diff --git a/site/docs/v0.8.0/use-cases.md b/site/content/docs/v0.8.1/use-cases.md similarity index 98% rename from site/docs/v0.8.0/use-cases.md rename to site/content/docs/v0.8.1/use-cases.md index 7263079c9..0fa634014 100644 --- a/site/docs/v0.8.0/use-cases.md +++ b/site/content/docs/v0.8.1/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/content/docs/v0.8.1/vendoring-dependencies.md b/site/content/docs/v0.8.1/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v0.8.1/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v0.9.0/README.md b/site/content/docs/v0.9.0/_index.md similarity index 98% rename from site/docs/v0.9.0/README.md rename to site/content/docs/v0.9.0/_index.md index 8f417b716..4afe1ce1e 100644 --- a/site/docs/v0.9.0/README.md +++ b/site/content/docs/v0.9.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v0.9.0 +--- # Heptio Ark **Maintainers:** [Heptio][0] diff --git a/site/docs/v0.9.0/about.md b/site/content/docs/v0.9.0/about.md similarity index 99% rename from site/docs/v0.9.0/about.md rename to site/content/docs/v0.9.0/about.md index bea4177a6..6da454ddf 100644 --- a/site/docs/v0.9.0/about.md +++ b/site/content/docs/v0.9.0/about.md @@ -1,4 +1,7 @@ -# How Ark Works +--- +title: "How Ark Works" +layout: docs +--- Each Ark operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. The config custom resource specifies core information and options such as cloud provider settings. Ark also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/content/docs/v0.9.0/api-types/README.md b/site/content/docs/v0.9.0/api-types/README.md new file mode 100644 index 000000000..c4daaa12d --- /dev/null +++ b/site/content/docs/v0.9.0/api-types/README.md @@ -0,0 +1,10 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +* [Backup][1] + +[1]: backup.md diff --git a/site/content/docs/v0.9.0/api-types/backup.md b/site/content/docs/v0.9.0/api-types/backup.md new file mode 100644 index 000000000..def928fc0 --- /dev/null +++ b/site/content/docs/v0.9.0/api-types/backup.md @@ -0,0 +1,141 @@ +--- +title: "Backup API Type" +layout: docs +--- + +## Use + +The `Backup` API type is used as a request for the Ark Server to perform a backup. Once created, the +Ark Server immediately starts the backup process. + +## API GroupVersion + +Backup belongs to the API group version `ark.heptio.com/v1`. + +## Definition + +Here is a sample `Backup` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: ark.heptio.com/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Backup +# Standard Kubernetes metadata. Required. +metadata: + # Backup name. May be any valid Kubernetes object name. Required. + name: a + # Backup namespace. Required. In version 0.7.0 and later, can be any string. Must be the namespace of the Ark server. + namespace: heptio-ark +# Parameters about the backup. Required. +spec: + # Array of namespaces to include in the backup. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the backup. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the backup. For example, if a + # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the backup. Optional. + labelSelector: + matchLabels: + app: ark + component: server + # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and + # AWS. Valid values are true, false, and null/unset. If unset, Ark performs snapshots as long as + # a persistent volume provider is configured for Ark. + snapshotVolumes: null + # The amount of time before this backup is eligible for garbage collection. + ttl: 24h0m0s + # Actions to perform at different times during a backup. The only hook currently supported is + # executing a command in a container in a pod using the pod exec API. Optional. + hooks: + # Array of hooks that are applicable to specific resources. Optional. + resources: + - + # Name of the hook. Will be displayed in backup log. + name: my-hook + # Array of namespaces to which this hook applies. If unspecified, the hook applies to all + # namespaces. Optional. + includedNamespaces: + - '*' + # Array of namespaces to which this hook does not apply. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to which this hook applies. The only resource supported at this time is + # pods. + includedResources: + - pods + # Array of resources to which this hook does not apply. Optional. + excludedResources: [] + # This hook only applies to objects matching this label selector. Optional. + labelSelector: + matchLabels: + app: ark + component: server + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + # DEPRECATED. Use pre instead. + hooks: + # Same content as pre below. + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + pre: + - + # The type of hook. This must be "exec". + exec: + # The name of the container where the command will be executed. If unspecified, the + # first container in the pod will be used. Optional. + container: my-container + # The command to execute, specified as an array. Required. + command: + - /bin/uname + - -a + # How to handle an error executing the command. Valid values are Fail and Continue. + # Defaults to Fail. Optional. + onError: Fail + # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. + timeout: 10s + # An array of hooks to run after all custom actions and additional items have been + # processed. Currently only "exec" hooks are supported. + post: + # Same content as pre above. +# Status about the Backup. Users should not set any data here. +status: + # The date and time when the Backup is eligible for garbage collection. + expiration: null + # The current phase. Valid values are New, FailedValidation, InProgress, Completed, Failed. + phase: "" + # An array of any validation errors encountered. + validationErrors: null + # The version of this Backup. The only version currently supported is 1. + version: 1 + # Information about PersistentVolumes needed during restores. + volumeBackups: + # Each key is the name of a PersistentVolume. + some-pv-name: + # The ID used by the cloud provider for the snapshot created for this Backup. + snapshotID: snap-1234 + # The type of the volume in the cloud provider API. + type: io1 + # The availability zone where the volume resides in the cloud provider. + availabilityZone: my-zone + # The amount of provisioned IOPS for the volume. Optional. + iops: 10000 +``` diff --git a/site/docs/v0.9.0/aws-config.md b/site/content/docs/v0.9.0/aws-config.md similarity index 99% rename from site/docs/v0.9.0/aws-config.md rename to site/content/docs/v0.9.0/aws-config.md index 80b6d91a4..24f962db8 100644 --- a/site/docs/v0.9.0/aws-config.md +++ b/site/content/docs/v0.9.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Ark on AWS +--- +title: "Run Ark on AWS" +layout: docs +--- To set up Ark on AWS, you: diff --git a/site/docs/v0.9.0/azure-config.md b/site/content/docs/v0.9.0/azure-config.md similarity index 99% rename from site/docs/v0.9.0/azure-config.md rename to site/content/docs/v0.9.0/azure-config.md index e7302f638..ae2a49d7e 100644 --- a/site/docs/v0.9.0/azure-config.md +++ b/site/content/docs/v0.9.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Ark on Azure +--- +title: "Run Ark on Azure" +layout: docs +--- To configure Ark on Azure, you: diff --git a/site/docs/v0.8.1/build-from-scratch.md b/site/content/docs/v0.9.0/build-from-scratch.md similarity index 98% rename from site/docs/v0.8.1/build-from-scratch.md rename to site/content/docs/v0.9.0/build-from-scratch.md index 9ef0bc5ed..7cb0b411c 100644 --- a/site/docs/v0.8.1/build-from-scratch.md +++ b/site/content/docs/v0.9.0/build-from-scratch.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Download][2] diff --git a/site/content/docs/v0.9.0/cli-reference/README.md b/site/content/docs/v0.9.0/cli-reference/README.md new file mode 100644 index 000000000..1494296dd --- /dev/null +++ b/site/content/docs/v0.9.0/cli-reference/README.md @@ -0,0 +1,23 @@ +--- +title: "Command line reference" +layout: docs +--- + +The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. + +[The files in the CLI reference directory][1] in the repository enumerate each of the possible `ark` commands and their flags. +This information is available in the CLI, using the `--help` flag. + +## Running the client + +We recommend that you [download a pre-built release][26], but you can also build and run the `ark` executable. + +## Kubernetes cluster credentials + +In general, Ark will search for your cluster credentials in the following order: +* `--kubeconfig` command line flag +* `$KUBECONFIG` environment variable +* In-cluster credentials--this only works when you are running Ark in a pod + +[1]: https://github.com/heptio/ark/tree/main/docs/cli-reference +[26]: https://github.com/heptio/ark/releases diff --git a/site/docs/v0.9.0/cli-reference/ark.md b/site/content/docs/v0.9.0/cli-reference/ark.md similarity index 98% rename from site/docs/v0.9.0/cli-reference/ark.md rename to site/content/docs/v0.9.0/cli-reference/ark.md index b66760527..a2d325a9e 100644 --- a/site/docs/v0.9.0/cli-reference/ark.md +++ b/site/content/docs/v0.9.0/cli-reference/ark.md @@ -1,4 +1,7 @@ -## ark +--- +title: "ark" +layout: docs +--- Back up and restore Kubernetes cluster resources. diff --git a/site/docs/v0.8.1/cli-reference/ark_backup.md b/site/content/docs/v0.9.0/cli-reference/ark_backup.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_backup.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup.md index 78c37bbf0..25bbfb4b8 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup.md @@ -1,4 +1,7 @@ -## ark backup +--- +title: "ark backup" +layout: docs +--- Work with backups diff --git a/site/docs/v0.8.1/cli-reference/ark_backup_create.md b/site/content/docs/v0.9.0/cli-reference/ark_backup_create.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark_backup_create.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup_create.md index 153e46128..861cbc30a 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup_create.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup_create.md @@ -1,4 +1,7 @@ -## ark backup create +--- +title: "ark backup create" +layout: docs +--- Create a backup diff --git a/site/docs/v0.8.1/cli-reference/ark_backup_delete.md b/site/content/docs/v0.9.0/cli-reference/ark_backup_delete.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_backup_delete.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup_delete.md index 7866f02f3..f1e246201 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup_delete.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup_delete.md @@ -1,4 +1,7 @@ -## ark backup delete +--- +title: "ark backup delete" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.9.0/cli-reference/ark_backup_describe.md b/site/content/docs/v0.9.0/cli-reference/ark_backup_describe.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_backup_describe.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup_describe.md index 7cd20c23e..f63f6b7df 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup_describe.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup_describe.md @@ -1,4 +1,7 @@ -## ark backup describe +--- +title: "ark backup describe" +layout: docs +--- Describe backups diff --git a/site/docs/v0.8.1/cli-reference/ark_backup_download.md b/site/content/docs/v0.9.0/cli-reference/ark_backup_download.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_backup_download.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup_download.md index e1b0c5800..703a607dd 100644 --- a/site/docs/v0.8.1/cli-reference/ark_backup_download.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup_download.md @@ -1,4 +1,7 @@ -## ark backup download +--- +title: "ark backup download" +layout: docs +--- Download a backup diff --git a/site/docs/v0.9.0/cli-reference/ark_backup_get.md b/site/content/docs/v0.9.0/cli-reference/ark_backup_get.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_backup_get.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup_get.md index 130e86c0a..7cd1c9107 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup_get.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup_get.md @@ -1,4 +1,7 @@ -## ark backup get +--- +title: "ark backup get" +layout: docs +--- Get backups diff --git a/site/docs/v0.9.0/cli-reference/ark_backup_logs.md b/site/content/docs/v0.9.0/cli-reference/ark_backup_logs.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_backup_logs.md rename to site/content/docs/v0.9.0/cli-reference/ark_backup_logs.md index 0850c7093..980b2ad32 100644 --- a/site/docs/v0.9.0/cli-reference/ark_backup_logs.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_backup_logs.md @@ -1,4 +1,7 @@ -## ark backup logs +--- +title: "ark backup logs" +layout: docs +--- Get backup logs diff --git a/site/docs/v0.8.0/cli-reference/ark_client.md b/site/content/docs/v0.9.0/cli-reference/ark_client.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_client.md rename to site/content/docs/v0.9.0/cli-reference/ark_client.md index b2ea636b0..b52fd4faa 100644 --- a/site/docs/v0.8.0/cli-reference/ark_client.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_client.md @@ -1,4 +1,7 @@ -## ark client +--- +title: "ark client" +layout: docs +--- Ark client related commands diff --git a/site/docs/v0.8.0/cli-reference/ark_client_config.md b/site/content/docs/v0.9.0/cli-reference/ark_client_config.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_client_config.md rename to site/content/docs/v0.9.0/cli-reference/ark_client_config.md index 6d68053a0..a5061fb76 100644 --- a/site/docs/v0.8.0/cli-reference/ark_client_config.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_client_config.md @@ -1,4 +1,7 @@ -## ark client config +--- +title: "ark client config" +layout: docs +--- Get and set client configuration file values diff --git a/site/docs/v0.8.0/cli-reference/ark_client_config_get.md b/site/content/docs/v0.9.0/cli-reference/ark_client_config_get.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_client_config_get.md rename to site/content/docs/v0.9.0/cli-reference/ark_client_config_get.md index 2e3d4d481..423bf890e 100644 --- a/site/docs/v0.8.0/cli-reference/ark_client_config_get.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_client_config_get.md @@ -1,4 +1,7 @@ -## ark client config get +--- +title: "ark client config get" +layout: docs +--- Get client configuration file values diff --git a/site/docs/v0.8.1/cli-reference/ark_client_config_set.md b/site/content/docs/v0.9.0/cli-reference/ark_client_config_set.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_client_config_set.md rename to site/content/docs/v0.9.0/cli-reference/ark_client_config_set.md index 7fddd86ca..1fc36fd96 100644 --- a/site/docs/v0.8.1/cli-reference/ark_client_config_set.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_client_config_set.md @@ -1,4 +1,7 @@ -## ark client config set +--- +title: "ark client config set" +layout: docs +--- Set client configuration file values diff --git a/site/docs/v0.8.1/cli-reference/ark_completion.md b/site/content/docs/v0.9.0/cli-reference/ark_completion.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_completion.md rename to site/content/docs/v0.9.0/cli-reference/ark_completion.md index 83a140529..8ce96bb8b 100644 --- a/site/docs/v0.8.1/cli-reference/ark_completion.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_completion.md @@ -1,4 +1,7 @@ -## ark completion +--- +title: "ark completion" +layout: docs +--- Output shell completion code for the specified shell (bash or zsh) diff --git a/site/docs/v0.8.0/cli-reference/ark_create.md b/site/content/docs/v0.9.0/cli-reference/ark_create.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_create.md rename to site/content/docs/v0.9.0/cli-reference/ark_create.md index fc7934f14..955e2b1a6 100644 --- a/site/docs/v0.8.0/cli-reference/ark_create.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_create.md @@ -1,4 +1,7 @@ -## ark create +--- +title: "ark create" +layout: docs +--- Create ark resources diff --git a/site/docs/v0.8.0/cli-reference/ark_create_backup.md b/site/content/docs/v0.9.0/cli-reference/ark_create_backup.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark_create_backup.md rename to site/content/docs/v0.9.0/cli-reference/ark_create_backup.md index 3e94680e7..aabb02547 100644 --- a/site/docs/v0.8.0/cli-reference/ark_create_backup.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_create_backup.md @@ -1,4 +1,7 @@ -## ark create backup +--- +title: "ark create backup" +layout: docs +--- Create a backup diff --git a/site/docs/v0.8.0/cli-reference/ark_create_restore.md b/site/content/docs/v0.9.0/cli-reference/ark_create_restore.md similarity index 98% rename from site/docs/v0.8.0/cli-reference/ark_create_restore.md rename to site/content/docs/v0.9.0/cli-reference/ark_create_restore.md index 4035a16f8..d68a09ab1 100644 --- a/site/docs/v0.8.0/cli-reference/ark_create_restore.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_create_restore.md @@ -1,4 +1,7 @@ -## ark create restore +--- +title: "ark create restore" +layout: docs +--- Create a restore diff --git a/site/docs/v0.8.1/cli-reference/ark_create_schedule.md b/site/content/docs/v0.9.0/cli-reference/ark_create_schedule.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark_create_schedule.md rename to site/content/docs/v0.9.0/cli-reference/ark_create_schedule.md index 4ddb7b575..c21aa625a 100644 --- a/site/docs/v0.8.1/cli-reference/ark_create_schedule.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_create_schedule.md @@ -1,4 +1,7 @@ -## ark create schedule +--- +title: "ark create schedule" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.8.1/cli-reference/ark_delete.md b/site/content/docs/v0.9.0/cli-reference/ark_delete.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_delete.md rename to site/content/docs/v0.9.0/cli-reference/ark_delete.md index 7016169ce..6743909b9 100644 --- a/site/docs/v0.8.1/cli-reference/ark_delete.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_delete.md @@ -1,4 +1,7 @@ -## ark delete +--- +title: "ark delete" +layout: docs +--- Delete ark resources diff --git a/site/docs/v0.8.0/cli-reference/ark_delete_backup.md b/site/content/docs/v0.9.0/cli-reference/ark_delete_backup.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_delete_backup.md rename to site/content/docs/v0.9.0/cli-reference/ark_delete_backup.md index 3dceaf041..6ceaf8883 100644 --- a/site/docs/v0.8.0/cli-reference/ark_delete_backup.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_delete_backup.md @@ -1,4 +1,7 @@ -## ark delete backup +--- +title: "ark delete backup" +layout: docs +--- Delete a backup diff --git a/site/docs/v0.8.1/cli-reference/ark_delete_restore.md b/site/content/docs/v0.9.0/cli-reference/ark_delete_restore.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_delete_restore.md rename to site/content/docs/v0.9.0/cli-reference/ark_delete_restore.md index 44d77ab9c..d290c574d 100644 --- a/site/docs/v0.8.1/cli-reference/ark_delete_restore.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_delete_restore.md @@ -1,4 +1,7 @@ -## ark delete restore +--- +title: "ark delete restore" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.8.1/cli-reference/ark_delete_schedule.md b/site/content/docs/v0.9.0/cli-reference/ark_delete_schedule.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_delete_schedule.md rename to site/content/docs/v0.9.0/cli-reference/ark_delete_schedule.md index 6131b0a37..541a02dfb 100644 --- a/site/docs/v0.8.1/cli-reference/ark_delete_schedule.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_delete_schedule.md @@ -1,4 +1,7 @@ -## ark delete schedule +--- +title: "ark delete schedule" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.8.0/cli-reference/ark_describe.md b/site/content/docs/v0.9.0/cli-reference/ark_describe.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_describe.md rename to site/content/docs/v0.9.0/cli-reference/ark_describe.md index a58c0eea7..8b934d9fd 100644 --- a/site/docs/v0.8.0/cli-reference/ark_describe.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_describe.md @@ -1,4 +1,7 @@ -## ark describe +--- +title: "ark describe" +layout: docs +--- Describe ark resources diff --git a/site/docs/v0.9.0/cli-reference/ark_describe_backups.md b/site/content/docs/v0.9.0/cli-reference/ark_describe_backups.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_describe_backups.md rename to site/content/docs/v0.9.0/cli-reference/ark_describe_backups.md index e03ccfcbd..9a33b3580 100644 --- a/site/docs/v0.9.0/cli-reference/ark_describe_backups.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_describe_backups.md @@ -1,4 +1,7 @@ -## ark describe backups +--- +title: "ark describe backups" +layout: docs +--- Describe backups diff --git a/site/docs/v0.9.0/cli-reference/ark_describe_restores.md b/site/content/docs/v0.9.0/cli-reference/ark_describe_restores.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_describe_restores.md rename to site/content/docs/v0.9.0/cli-reference/ark_describe_restores.md index 0b5cddd22..c1940e24a 100644 --- a/site/docs/v0.9.0/cli-reference/ark_describe_restores.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_describe_restores.md @@ -1,4 +1,7 @@ -## ark describe restores +--- +title: "ark describe restores" +layout: docs +--- Describe restores diff --git a/site/docs/v0.9.0/cli-reference/ark_describe_schedules.md b/site/content/docs/v0.9.0/cli-reference/ark_describe_schedules.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_describe_schedules.md rename to site/content/docs/v0.9.0/cli-reference/ark_describe_schedules.md index 4b5dad30d..ba429cb96 100644 --- a/site/docs/v0.9.0/cli-reference/ark_describe_schedules.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_describe_schedules.md @@ -1,4 +1,7 @@ -## ark describe schedules +--- +title: "ark describe schedules" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.9.0/cli-reference/ark_get.md b/site/content/docs/v0.9.0/cli-reference/ark_get.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_get.md rename to site/content/docs/v0.9.0/cli-reference/ark_get.md index 4a91e8a66..b35e0fbc9 100644 --- a/site/docs/v0.9.0/cli-reference/ark_get.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_get.md @@ -1,4 +1,7 @@ -## ark get +--- +title: "ark get" +layout: docs +--- Get ark resources diff --git a/site/docs/v0.9.0/cli-reference/ark_get_backups.md b/site/content/docs/v0.9.0/cli-reference/ark_get_backups.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_get_backups.md rename to site/content/docs/v0.9.0/cli-reference/ark_get_backups.md index f010ae5eb..70422ad24 100644 --- a/site/docs/v0.9.0/cli-reference/ark_get_backups.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_get_backups.md @@ -1,4 +1,7 @@ -## ark get backups +--- +title: "ark get backups" +layout: docs +--- Get backups diff --git a/site/docs/v0.9.0/cli-reference/ark_get_restores.md b/site/content/docs/v0.9.0/cli-reference/ark_get_restores.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_get_restores.md rename to site/content/docs/v0.9.0/cli-reference/ark_get_restores.md index 382c27d4f..d36878151 100644 --- a/site/docs/v0.9.0/cli-reference/ark_get_restores.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_get_restores.md @@ -1,4 +1,7 @@ -## ark get restores +--- +title: "ark get restores" +layout: docs +--- Get restores diff --git a/site/docs/v0.8.0/cli-reference/ark_get_schedules.md b/site/content/docs/v0.9.0/cli-reference/ark_get_schedules.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_get_schedules.md rename to site/content/docs/v0.9.0/cli-reference/ark_get_schedules.md index 2b8d1ce9a..b1de24b90 100644 --- a/site/docs/v0.8.0/cli-reference/ark_get_schedules.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_get_schedules.md @@ -1,4 +1,7 @@ -## ark get schedules +--- +title: "ark get schedules" +layout: docs +--- Get schedules diff --git a/site/docs/v0.8.0/cli-reference/ark_plugin.md b/site/content/docs/v0.9.0/cli-reference/ark_plugin.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_plugin.md rename to site/content/docs/v0.9.0/cli-reference/ark_plugin.md index 2dc71a5a9..c81272d87 100644 --- a/site/docs/v0.8.0/cli-reference/ark_plugin.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_plugin.md @@ -1,4 +1,7 @@ -## ark plugin +--- +title: "ark plugin" +layout: docs +--- Work with plugins diff --git a/site/docs/v0.8.0/cli-reference/ark_plugin_add.md b/site/content/docs/v0.9.0/cli-reference/ark_plugin_add.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_plugin_add.md rename to site/content/docs/v0.9.0/cli-reference/ark_plugin_add.md index 297cc6340..8cdd048a2 100644 --- a/site/docs/v0.8.0/cli-reference/ark_plugin_add.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_plugin_add.md @@ -1,4 +1,7 @@ -## ark plugin add +--- +title: "ark plugin add" +layout: docs +--- Add a plugin diff --git a/site/docs/v0.8.0/cli-reference/ark_plugin_remove.md b/site/content/docs/v0.9.0/cli-reference/ark_plugin_remove.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_plugin_remove.md rename to site/content/docs/v0.9.0/cli-reference/ark_plugin_remove.md index 98a8d5b87..1d77b30a5 100644 --- a/site/docs/v0.8.0/cli-reference/ark_plugin_remove.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_plugin_remove.md @@ -1,4 +1,7 @@ -## ark plugin remove +--- +title: "ark plugin remove" +layout: docs +--- Remove a plugin diff --git a/site/docs/v0.9.0/cli-reference/ark_restic.md b/site/content/docs/v0.9.0/cli-reference/ark_restic.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_restic.md rename to site/content/docs/v0.9.0/cli-reference/ark_restic.md index 27ba211f1..769453b2f 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restic.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restic.md @@ -1,4 +1,7 @@ -## ark restic +--- +title: "ark restic" +layout: docs +--- Work with restic diff --git a/site/docs/v0.9.0/cli-reference/ark_restic_repo.md b/site/content/docs/v0.9.0/cli-reference/ark_restic_repo.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_restic_repo.md rename to site/content/docs/v0.9.0/cli-reference/ark_restic_repo.md index ae41d6ddb..e0373feed 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restic_repo.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restic_repo.md @@ -1,4 +1,7 @@ -## ark restic repo +--- +title: "ark restic repo" +layout: docs +--- Work with restic repositories diff --git a/site/docs/v0.9.0/cli-reference/ark_restic_repo_get.md b/site/content/docs/v0.9.0/cli-reference/ark_restic_repo_get.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_restic_repo_get.md rename to site/content/docs/v0.9.0/cli-reference/ark_restic_repo_get.md index de9fa38ea..62375f84e 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restic_repo_get.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restic_repo_get.md @@ -1,4 +1,7 @@ -## ark restic repo get +--- +title: "ark restic repo get" +layout: docs +--- Get restic repositories diff --git a/site/docs/v0.9.0/cli-reference/ark_restic_server.md b/site/content/docs/v0.9.0/cli-reference/ark_restic_server.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_restic_server.md rename to site/content/docs/v0.9.0/cli-reference/ark_restic_server.md index 02e9df772..154981f14 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restic_server.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restic_server.md @@ -1,4 +1,7 @@ -## ark restic server +--- +title: "ark restic server" +layout: docs +--- Run the ark restic server diff --git a/site/docs/v0.8.0/cli-reference/ark_restore.md b/site/content/docs/v0.9.0/cli-reference/ark_restore.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_restore.md rename to site/content/docs/v0.9.0/cli-reference/ark_restore.md index b55f523ea..d48298576 100644 --- a/site/docs/v0.8.0/cli-reference/ark_restore.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restore.md @@ -1,4 +1,7 @@ -## ark restore +--- +title: "ark restore" +layout: docs +--- Work with restores diff --git a/site/docs/v0.8.1/cli-reference/ark_restore_create.md b/site/content/docs/v0.9.0/cli-reference/ark_restore_create.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark_restore_create.md rename to site/content/docs/v0.9.0/cli-reference/ark_restore_create.md index f83787cad..86c9118fc 100644 --- a/site/docs/v0.8.1/cli-reference/ark_restore_create.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restore_create.md @@ -1,4 +1,7 @@ -## ark restore create +--- +title: "ark restore create" +layout: docs +--- Create a restore diff --git a/site/docs/v0.8.1/cli-reference/ark_restore_delete.md b/site/content/docs/v0.9.0/cli-reference/ark_restore_delete.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_restore_delete.md rename to site/content/docs/v0.9.0/cli-reference/ark_restore_delete.md index 6835b07f7..a9d145112 100644 --- a/site/docs/v0.8.1/cli-reference/ark_restore_delete.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restore_delete.md @@ -1,4 +1,7 @@ -## ark restore delete +--- +title: "ark restore delete" +layout: docs +--- Delete a restore diff --git a/site/docs/v0.9.0/cli-reference/ark_restore_describe.md b/site/content/docs/v0.9.0/cli-reference/ark_restore_describe.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_restore_describe.md rename to site/content/docs/v0.9.0/cli-reference/ark_restore_describe.md index cb06f1314..e70986351 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restore_describe.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restore_describe.md @@ -1,4 +1,7 @@ -## ark restore describe +--- +title: "ark restore describe" +layout: docs +--- Describe restores diff --git a/site/docs/v0.9.0/cli-reference/ark_restore_get.md b/site/content/docs/v0.9.0/cli-reference/ark_restore_get.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_restore_get.md rename to site/content/docs/v0.9.0/cli-reference/ark_restore_get.md index 0ccd5631d..c2a3d658d 100644 --- a/site/docs/v0.9.0/cli-reference/ark_restore_get.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restore_get.md @@ -1,4 +1,7 @@ -## ark restore get +--- +title: "ark restore get" +layout: docs +--- Get restores diff --git a/site/docs/v0.8.1/cli-reference/ark_restore_logs.md b/site/content/docs/v0.9.0/cli-reference/ark_restore_logs.md similarity index 96% rename from site/docs/v0.8.1/cli-reference/ark_restore_logs.md rename to site/content/docs/v0.9.0/cli-reference/ark_restore_logs.md index 86abd6ea9..e7597ef92 100644 --- a/site/docs/v0.8.1/cli-reference/ark_restore_logs.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_restore_logs.md @@ -1,4 +1,7 @@ -## ark restore logs +--- +title: "ark restore logs" +layout: docs +--- Get restore logs diff --git a/site/docs/v0.8.0/cli-reference/ark_schedule.md b/site/content/docs/v0.9.0/cli-reference/ark_schedule.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_schedule.md rename to site/content/docs/v0.9.0/cli-reference/ark_schedule.md index 586612b1d..75d57431a 100644 --- a/site/docs/v0.8.0/cli-reference/ark_schedule.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_schedule.md @@ -1,4 +1,7 @@ -## ark schedule +--- +title: "ark schedule" +layout: docs +--- Work with schedules diff --git a/site/docs/v0.8.1/cli-reference/ark_schedule_create.md b/site/content/docs/v0.9.0/cli-reference/ark_schedule_create.md similarity index 98% rename from site/docs/v0.8.1/cli-reference/ark_schedule_create.md rename to site/content/docs/v0.9.0/cli-reference/ark_schedule_create.md index c60c91a0d..c8a878170 100644 --- a/site/docs/v0.8.1/cli-reference/ark_schedule_create.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_schedule_create.md @@ -1,4 +1,7 @@ -## ark schedule create +--- +title: "ark schedule create" +layout: docs +--- Create a schedule diff --git a/site/docs/v0.9.0/cli-reference/ark_schedule_delete.md b/site/content/docs/v0.9.0/cli-reference/ark_schedule_delete.md similarity index 96% rename from site/docs/v0.9.0/cli-reference/ark_schedule_delete.md rename to site/content/docs/v0.9.0/cli-reference/ark_schedule_delete.md index 40cd310e6..2a9aad0ca 100644 --- a/site/docs/v0.9.0/cli-reference/ark_schedule_delete.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_schedule_delete.md @@ -1,4 +1,7 @@ -## ark schedule delete +--- +title: "ark schedule delete" +layout: docs +--- Delete a schedule diff --git a/site/docs/v0.8.0/cli-reference/ark_schedule_describe.md b/site/content/docs/v0.9.0/cli-reference/ark_schedule_describe.md similarity index 96% rename from site/docs/v0.8.0/cli-reference/ark_schedule_describe.md rename to site/content/docs/v0.9.0/cli-reference/ark_schedule_describe.md index 986951758..9c7883b2b 100644 --- a/site/docs/v0.8.0/cli-reference/ark_schedule_describe.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_schedule_describe.md @@ -1,4 +1,7 @@ -## ark schedule describe +--- +title: "ark schedule describe" +layout: docs +--- Describe schedules diff --git a/site/docs/v0.8.0/cli-reference/ark_schedule_get.md b/site/content/docs/v0.9.0/cli-reference/ark_schedule_get.md similarity index 97% rename from site/docs/v0.8.0/cli-reference/ark_schedule_get.md rename to site/content/docs/v0.9.0/cli-reference/ark_schedule_get.md index 488d047a8..2c9506400 100644 --- a/site/docs/v0.8.0/cli-reference/ark_schedule_get.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_schedule_get.md @@ -1,4 +1,7 @@ -## ark schedule get +--- +title: "ark schedule get" +layout: docs +--- Get schedules diff --git a/site/docs/v0.9.0/cli-reference/ark_server.md b/site/content/docs/v0.9.0/cli-reference/ark_server.md similarity index 97% rename from site/docs/v0.9.0/cli-reference/ark_server.md rename to site/content/docs/v0.9.0/cli-reference/ark_server.md index e6727f29a..7d365a5a2 100644 --- a/site/docs/v0.9.0/cli-reference/ark_server.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_server.md @@ -1,4 +1,7 @@ -## ark server +--- +title: "ark server" +layout: docs +--- Run the ark server diff --git a/site/docs/v0.8.1/cli-reference/ark_version.md b/site/content/docs/v0.9.0/cli-reference/ark_version.md similarity index 97% rename from site/docs/v0.8.1/cli-reference/ark_version.md rename to site/content/docs/v0.9.0/cli-reference/ark_version.md index 7aa4b75c8..5f29a5bfa 100644 --- a/site/docs/v0.8.1/cli-reference/ark_version.md +++ b/site/content/docs/v0.9.0/cli-reference/ark_version.md @@ -1,4 +1,7 @@ -## ark version +--- +title: "ark version" +layout: docs +--- Print the ark version and associated image diff --git a/site/docs/v0.9.0/config-definition.md b/site/content/docs/v0.9.0/config-definition.md similarity index 99% rename from site/docs/v0.9.0/config-definition.md rename to site/content/docs/v0.9.0/config-definition.md index e49c6e95c..4ce609298 100644 --- a/site/docs/v0.9.0/config-definition.md +++ b/site/content/docs/v0.9.0/config-definition.md @@ -1,4 +1,7 @@ -# Ark Config definition +--- +title: "Ark Config definition" +layout: docs +--- * [Overview][8] * [Example][9] diff --git a/site/docs/v0.9.0/debugging-install.md b/site/content/docs/v0.9.0/debugging-install.md similarity index 97% rename from site/docs/v0.9.0/debugging-install.md rename to site/content/docs/v0.9.0/debugging-install.md index e4796ca04..1d93371f9 100644 --- a/site/docs/v0.9.0/debugging-install.md +++ b/site/content/docs/v0.9.0/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v0.9.0/debugging-restores.md b/site/content/docs/v0.9.0/debugging-restores.md similarity index 98% rename from site/docs/v0.9.0/debugging-restores.md rename to site/content/docs/v0.9.0/debugging-restores.md index bac4de501..137e3bb37 100644 --- a/site/docs/v0.9.0/debugging-restores.md +++ b/site/content/docs/v0.9.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/content/docs/v0.9.0/extend.md b/site/content/docs/v0.9.0/extend.md new file mode 100644 index 000000000..ae282f58d --- /dev/null +++ b/site/content/docs/v0.9.0/extend.md @@ -0,0 +1,12 @@ +--- +title: "Extend Ark" +layout: docs +--- + +Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: + +* [Hooks][27] allow you to specify commands to be executed within running pods during a backup. This is useful if you need to run a workload-specific command prior to taking a backup (for example, to flush disk buffers or to freeze a database). +* [Plugins][28] allow you to develop custom object/block storage back-ends or per-item backup/restore actions that can execute arbitrary logic, including modifying the items being backed up/restored. Plugins can be used by Ark without needing to be compiled into the core Ark binary. + +[27]: hooks.md +[28]: plugins.md diff --git a/site/docs/v0.9.0/faq.md b/site/content/docs/v0.9.0/faq.md similarity index 98% rename from site/docs/v0.9.0/faq.md rename to site/content/docs/v0.9.0/faq.md index 912bd68a0..354523315 100644 --- a/site/docs/v0.9.0/faq.md +++ b/site/content/docs/v0.9.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Ark instead of etcd's built in backup/restore? diff --git a/site/docs/v0.9.0/gcp-config.md b/site/content/docs/v0.9.0/gcp-config.md similarity index 98% rename from site/docs/v0.9.0/gcp-config.md rename to site/content/docs/v0.9.0/gcp-config.md index aac2273ff..02a134a73 100644 --- a/site/docs/v0.9.0/gcp-config.md +++ b/site/content/docs/v0.9.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Ark on GCP +--- +title: "Run Ark on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either of: diff --git a/site/content/docs/v0.9.0/hooks.md b/site/content/docs/v0.9.0/hooks.md new file mode 100644 index 000000000..6f83c98ff --- /dev/null +++ b/site/content/docs/v0.9.0/hooks.md @@ -0,0 +1,57 @@ +--- +title: "Hooks" +layout: docs +--- + +Heptio Ark currently supports executing commands in containers in pods during a backup. + +## Backup Hooks + +When performing a backup, you can specify one or more commands to execute in a container in a pod +when that pod is being backed up. + +Ark versions prior to v0.7.0 only support hooks that execute prior to any custom action processing +("pre" hooks). + +As of version v0.7.0, Ark also supports "post" hooks - these execute after all custom actions have +completed, as well as after all the additional items specified by custom actions have been backed +up. + +An example of when you might use both pre and post hooks is freezing a file system. If you want to +ensure that all pending disk I/O operations have completed prior to taking a snapshot, you could use +a pre hook to run `fsfreeze --freeze`. Next, Ark would take a snapshot of the disk. Finally, you +could use a post hook to run `fsfreeze --unfreeze`. + +There are two ways to specify hooks: annotations on the pod itself, and in the Backup spec. + +### Specifying Hooks As Pod Annotations + +You can use the following annotations on a pod to make Ark execute a hook when backing up the pod: + +#### Pre hooks + +| Annotation Name | Description | +| --- | --- | +| `pre.hook.backup.ark.heptio.com/container` | The container where the command should be executed. Defaults to the first container in the pod. Optional. | +| `pre.hook.backup.ark.heptio.com/command` | The command to execute. If you need multiple arguments, specify the command as a JSON array, such as `["/usr/bin/uname", "-a"]` | +| `pre.hook.backup.ark.heptio.com/on-error` | What to do if the command returns a non-zero exit code. Defaults to Fail. Valid values are Fail and Continue. Optional. | +| `pre.hook.backup.ark.heptio.com/timeout` | How long to wait for the command to execute. The hook is considered in error if the command exceeds the timeout. Defaults to 30s. Optional. | + +Ark v0.7.0+ continues to support the original (deprecated) way to specify pre hooks - without the +`pre.` prefix in the annotation names (e.g. `hook.backup.ark.heptio.com/container`). + +#### Post hooks (v0.7.0+) + +| Annotation Name | Description | +| --- | --- | +| `post.hook.backup.ark.heptio.com/container` | The container where the command should be executed. Defaults to the first container in the pod. Optional. | +| `post.hook.backup.ark.heptio.com/command` | The command to execute. If you need multiple arguments, specify the command as a JSON array, such as `["/usr/bin/uname", "-a"]` | +| `post.hook.backup.ark.heptio.com/on-error` | What to do if the command returns a non-zero exit code. Defaults to Fail. Valid values are Fail and Continue. Optional. | +| `post.hook.backup.ark.heptio.com/timeout` | How long to wait for the command to execute. The hook is considered in error if the command exceeds the timeout. Defaults to 30s. Optional. | + +### Specifying Hooks in the Backup Spec + +Please see the documentation on the [Backup API Type][1] for how to specify hooks in the Backup +spec. + +[1]: api-types/backup.md diff --git a/site/docs/v0.9.0/ibm-config.md b/site/content/docs/v0.9.0/ibm-config.md similarity index 97% rename from site/docs/v0.9.0/ibm-config.md rename to site/content/docs/v0.9.0/ibm-config.md index 218727a3a..ac803c175 100644 --- a/site/docs/v0.9.0/ibm-config.md +++ b/site/content/docs/v0.9.0/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Ark's storage destination. +--- +title: "Use IBM Cloud Object Storage as Ark's storage destination." +layout: docs +--- You can deploy Ark on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Ark's backups. To set up IBM Cloud Object Storage (COS) as Ark's destination, you: diff --git a/site/docs/v0.10.0/image-tagging.md b/site/content/docs/v0.9.0/image-tagging.md similarity index 91% rename from site/docs/v0.10.0/image-tagging.md rename to site/content/docs/v0.9.0/image-tagging.md index 2fd12e3cc..ec447e2b3 100644 --- a/site/docs/v0.10.0/image-tagging.md +++ b/site/content/docs/v0.9.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Ark's image tagging policy. diff --git a/site/docs/v0.9.0/img/README.md b/site/content/docs/v0.9.0/img/README.md similarity index 100% rename from site/docs/v0.9.0/img/README.md rename to site/content/docs/v0.9.0/img/README.md diff --git a/site/docs/v0.9.0/img/backup-process.png b/site/content/docs/v0.9.0/img/backup-process.png similarity index 100% rename from site/docs/v0.9.0/img/backup-process.png rename to site/content/docs/v0.9.0/img/backup-process.png diff --git a/site/docs/v0.9.0/install-overview.md b/site/content/docs/v0.9.0/install-overview.md similarity index 98% rename from site/docs/v0.9.0/install-overview.md rename to site/content/docs/v0.9.0/install-overview.md index 1cdd5a7fc..889457e07 100644 --- a/site/docs/v0.9.0/install-overview.md +++ b/site/content/docs/v0.9.0/install-overview.md @@ -1,4 +1,7 @@ -# Set up Ark on your platform +--- +title: "Set up Ark on your platform" +layout: docs +--- You can run Ark with a cloud provider or on-premises. For detailed information about the platforms that Ark supports, see [Compatible Storage Providers][99]. diff --git a/site/docs/v0.8.1/namespace.md b/site/content/docs/v0.9.0/namespace.md similarity index 97% rename from site/docs/v0.8.1/namespace.md rename to site/content/docs/v0.9.0/namespace.md index c15ee41b4..5739f61e3 100644 --- a/site/docs/v0.8.1/namespace.md +++ b/site/content/docs/v0.9.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- In Ark version 0.7.0 and later, you can run Ark in any namespace. To do so, you specify the namespace in the YAML files that configure the Ark server. You then also specify the namespace when diff --git a/site/content/docs/v0.9.0/output-file-format.md b/site/content/docs/v0.9.0/output-file-format.md new file mode 100644 index 000000000..fd42f15ba --- /dev/null +++ b/site/content/docs/v0.9.0/output-file-format.md @@ -0,0 +1,102 @@ +--- +title: "Output file format" +layout: docs +--- + +A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). + +In cloud object storage, each backup file is stored in its own subdirectory in the bucket specified in the Ark server configuration. This subdirectory includes an additional file called `ark-backup.json`. The JSON file lists all information about your associated Backup resource, including any default values. This gives you a complete historical record of the backup configuration. The JSON file also specifies `status.version`, which corresponds to the output file format. + +The directory structure in your cloud storage looks something like: + +``` +rootBucket/ + backup1234/ + ark-backup.json + backup1234.tar.gz +``` + +## Example backup JSON file + +``` +{ + "kind": "Backup", + "apiVersion": "ark.heptio.com/v1", + "metadata": { + "name": "test-backup", + "namespace": "heptio-ark", + "selfLink": "/apis/ark.heptio.com/v1/namespaces/heptio-ark/backups/testtest", + "uid": "a12345cb-75f5-11e7-b4c2-abcdef123456", + "resourceVersion": "337075", + "creationTimestamp": "2017-07-31T13:39:15Z" + }, + "spec": { + "includedNamespaces": [ + "*" + ], + "excludedNamespaces": null, + "includedResources": [ + "*" + ], + "excludedResources": null, + "labelSelector": null, + "snapshotVolumes": true, + "ttl": "24h0m0s" + }, + "status": { + "version": 1, + "expiration": "2017-08-01T13:39:15Z", + "phase": "Completed", + "volumeBackups": { + "pvc-e1e2d345-7583-11e7-b4c2-abcdef123456": { + "snapshotID": "snap-04b1a8e11dfb33ab0", + "type": "gp2", + "iops": 100 + } + }, + "validationErrors": null + } +} +``` +Note that this file includes detailed info about your volume snapshots in the `status.volumeBackups` field, which can be helpful if you want to manually check them in your cloud provider GUI. + +## file format version: 1 + +When unzipped, a typical backup directory (e.g. `backup1234.tar.gz`) looks like the following: + +``` +resources/ + persistentvolumes/ + cluster/ + pv01.json + ... + configmaps/ + namespaces/ + namespace1/ + myconfigmap.json + ... + namespace2/ + ... + pods/ + namespaces/ + namespace1/ + mypod.json + ... + namespace2/ + ... + jobs/ + namespaces/ + namespace1/ + awesome-job.json + ... + namespace2/ + ... + deployments/ + namespaces/ + namespace1/ + cool-deployment.json + ... + namespace2/ + ... + ... +``` diff --git a/site/content/docs/v0.9.0/plugins.md b/site/content/docs/v0.9.0/plugins.md new file mode 100644 index 000000000..55dc172e4 --- /dev/null +++ b/site/content/docs/v0.9.0/plugins.md @@ -0,0 +1,38 @@ +--- +title: "Plugins" +layout: docs +--- + +Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores +without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary +containing an implementation of one of Ark's plugin kinds (described below), plus a small amount of boilerplate code to +expose the plugin implementation to Ark. This binary is added to a container image that serves as an init container for +the Ark server pod and copies the binary into a shared emptyDir volume for the Ark server to access. + +A fully-functional [sample plugin repository][1] is provided to serve as a convenient starting point for plugin authors. + +## Plugin Kinds + +Ark currently supports the following kinds of plugins: + +- **Object Store** - persists and retrieves backups, backup logs and restore logs +- **Block Store** - creates volume snapshots (during backup) and restores volumes from snapshots (during restore) +- **Backup Item Action** - executes arbitrary logic for individual items prior to storing them in a backup file +- **Restore Item Action** - executes arbitrary logic for individual items prior to restoring them into a cluster + +## Plugin Naming + +Ark relies on a naming convention to identify plugins. Each plugin binary should be named `ark--`, +where `plugin-kind` is one of `objectstore`, `blockstore`, `backupitemaction`, or `restoreitemaction`, and `name` is +unique within the plugin kind. + +## Plugin Logging + +Ark provides a [logger][2] that can be used by plugins to log structured information to the main Ark server log or +per-backup/restore logs. See the [sample repository][1] for an example of how to instantiate and use the logger +within your plugin. + + + +[1]: https://github.com/heptio/ark-plugin-example +[2]: https://github.com/heptio/ark/blob/main/pkg/plugin/logger.go diff --git a/site/docs/v0.9.0/quickstart.md b/site/content/docs/v0.9.0/quickstart.md similarity index 98% rename from site/docs/v0.9.0/quickstart.md rename to site/content/docs/v0.9.0/quickstart.md index 78c8b42dd..02a75a2c2 100644 --- a/site/docs/v0.9.0/quickstart.md +++ b/site/content/docs/v0.9.0/quickstart.md @@ -1,4 +1,7 @@ -## Getting started +--- +title: "Getting started" +layout: docs +--- The following example sets up the Ark server and client, then backs up and restores a sample application. diff --git a/site/docs/v0.9.0/restic.md b/site/content/docs/v0.9.0/restic.md similarity index 99% rename from site/docs/v0.9.0/restic.md rename to site/content/docs/v0.9.0/restic.md index 53afb6540..4f74cec6e 100644 --- a/site/docs/v0.9.0/restic.md +++ b/site/content/docs/v0.9.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- As of version 0.9.0, Ark has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. diff --git a/site/docs/v0.9.0/support-matrix.md b/site/content/docs/v0.9.0/support-matrix.md similarity index 97% rename from site/docs/v0.9.0/support-matrix.md rename to site/content/docs/v0.9.0/support-matrix.md index 6a39a2759..8945b69e6 100644 --- a/site/docs/v0.9.0/support-matrix.md +++ b/site/content/docs/v0.9.0/support-matrix.md @@ -1,4 +1,7 @@ -# Compatible Storage Providers +--- +title: "Compatible Storage Providers" +layout: docs +--- Ark supports a variety of storage providers for different backup and snapshot operations. As of version 0.6.0, a plugin system allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Ark codebase. diff --git a/site/docs/v0.9.0/troubleshooting.md b/site/content/docs/v0.9.0/troubleshooting.md similarity index 98% rename from site/docs/v0.9.0/troubleshooting.md rename to site/content/docs/v0.9.0/troubleshooting.md index 55f26a7fd..dae5d2a83 100644 --- a/site/docs/v0.9.0/troubleshooting.md +++ b/site/content/docs/v0.9.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#ark-dr channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v0.9.0/use-cases.md b/site/content/docs/v0.9.0/use-cases.md similarity index 98% rename from site/docs/v0.9.0/use-cases.md rename to site/content/docs/v0.9.0/use-cases.md index 7263079c9..0fa634014 100644 --- a/site/docs/v0.9.0/use-cases.md +++ b/site/content/docs/v0.9.0/use-cases.md @@ -1,4 +1,7 @@ -# Use Cases +--- +title: "Use Cases" +layout: docs +--- This doc provides sample Ark commands for the following common scenarios: * [Disaster recovery][0] diff --git a/site/content/docs/v0.9.0/vendoring-dependencies.md b/site/content/docs/v0.9.0/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v0.9.0/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.0.0/README.md b/site/content/docs/v1.0.0/_index.md similarity index 99% rename from site/docs/v1.0.0/README.md rename to site/content/docs/v1.0.0/_index.md index f2532abd9..a07247a06 100644 --- a/site/docs/v1.0.0/README.md +++ b/site/content/docs/v1.0.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.0.0 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v1.0.0/about.md b/site/content/docs/v1.0.0/about.md similarity index 99% rename from site/docs/v1.0.0/about.md rename to site/content/docs/v1.0.0/about.md index 1d9c5c174..28f85707d 100644 --- a/site/docs/v1.0.0/about.md +++ b/site/content/docs/v1.0.0/about.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v1.1.0/api-types/README.md b/site/content/docs/v1.0.0/api-types/README.md similarity index 85% rename from site/docs/v1.1.0/api-types/README.md rename to site/content/docs/v1.0.0/api-types/README.md index 424b02d00..290379288 100644 --- a/site/docs/v1.1.0/api-types/README.md +++ b/site/content/docs/v1.0.0/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/v1.3.0/api-types/backup.md b/site/content/docs/v1.0.0/api-types/backup.md similarity index 99% rename from site/docs/v1.3.0/api-types/backup.md rename to site/content/docs/v1.0.0/api-types/backup.md index 70120a921..2223081ae 100644 --- a/site/docs/v1.3.0/api-types/backup.md +++ b/site/content/docs/v1.0.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.0.0/api-types/backupstoragelocation.md b/site/content/docs/v1.0.0/api-types/backupstoragelocation.md similarity index 98% rename from site/docs/v1.0.0/api-types/backupstoragelocation.md rename to site/content/docs/v1.0.0/api-types/backupstoragelocation.md index 4d6b9baa5..f436602f0 100644 --- a/site/docs/v1.0.0/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.0.0/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v1.0.0/api-types/volumesnapshotlocation.md b/site/content/docs/v1.0.0/api-types/volumesnapshotlocation.md similarity index 97% rename from site/docs/v1.0.0/api-types/volumesnapshotlocation.md rename to site/content/docs/v1.0.0/api-types/volumesnapshotlocation.md index 97ac6735e..16578b8c5 100644 --- a/site/docs/v1.0.0/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v1.0.0/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v1.0.0/aws-config.md b/site/content/docs/v1.0.0/aws-config.md similarity index 99% rename from site/docs/v1.0.0/aws-config.md rename to site/content/docs/v1.0.0/aws-config.md index 9592b53e9..d15f985f5 100644 --- a/site/docs/v1.0.0/aws-config.md +++ b/site/content/docs/v1.0.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Velero on AWS +--- +title: "Run Velero on AWS" +layout: docs +--- To set up Velero on AWS, you: diff --git a/site/docs/v1.0.0/azure-config.md b/site/content/docs/v1.0.0/azure-config.md similarity index 99% rename from site/docs/v1.0.0/azure-config.md rename to site/content/docs/v1.0.0/azure-config.md index 313973187..dd7e0c941 100644 --- a/site/docs/v1.0.0/azure-config.md +++ b/site/content/docs/v1.0.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Velero on Azure +--- +title: "Run Velero on Azure" +layout: docs +--- To configure Velero on Azure, you: diff --git a/site/docs/v1.0.0/build-from-source.md b/site/content/docs/v1.0.0/build-from-source.md similarity index 99% rename from site/docs/v1.0.0/build-from-source.md rename to site/content/docs/v1.0.0/build-from-source.md index 1d67c31e7..6c62191d8 100644 --- a/site/docs/v1.0.0/build-from-source.md +++ b/site/content/docs/v1.0.0/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- * [Prerequisites][1] * [Getting the source][2] diff --git a/site/docs/v1.1.0/debugging-install.md b/site/content/docs/v1.0.0/debugging-install.md similarity index 98% rename from site/docs/v1.1.0/debugging-install.md rename to site/content/docs/v1.0.0/debugging-install.md index 4abc5a3e1..9c2067b34 100644 --- a/site/docs/v1.1.0/debugging-install.md +++ b/site/content/docs/v1.0.0/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/main/debugging-restores.md b/site/content/docs/v1.0.0/debugging-restores.md similarity index 98% rename from site/docs/main/debugging-restores.md rename to site/content/docs/v1.0.0/debugging-restores.md index d50d4aacb..eb834b0bc 100644 --- a/site/docs/main/debugging-restores.md +++ b/site/content/docs/v1.0.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v1.0.0/disaster-case.md b/site/content/docs/v1.0.0/disaster-case.md similarity index 95% rename from site/docs/v1.0.0/disaster-case.md rename to site/content/docs/v1.0.0/disaster-case.md index 3c66f6286..5d2ca5475 100644 --- a/site/docs/v1.0.0/disaster-case.md +++ b/site/content/docs/v1.0.0/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Restore-Only Mode* diff --git a/site/docs/v0.11.0/extend.md b/site/content/docs/v1.0.0/extend.md similarity index 93% rename from site/docs/v0.11.0/extend.md rename to site/content/docs/v1.0.0/extend.md index 5a1c68533..ec9d84332 100644 --- a/site/docs/v0.11.0/extend.md +++ b/site/content/docs/v1.0.0/extend.md @@ -1,4 +1,7 @@ -# Extend Velero +--- +title: "Extend Velero" +layout: docs +--- Velero includes mechanisms for extending the core functionality to meet your individual backup/restore needs: diff --git a/site/docs/v1.0.0/faq.md b/site/content/docs/v1.0.0/faq.md similarity index 98% rename from site/docs/v1.0.0/faq.md rename to site/content/docs/v1.0.0/faq.md index 607e4ea25..bd201ba8a 100644 --- a/site/docs/v1.0.0/faq.md +++ b/site/content/docs/v1.0.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v1.0.0/gcp-config.md b/site/content/docs/v1.0.0/gcp-config.md similarity index 99% rename from site/docs/v1.0.0/gcp-config.md rename to site/content/docs/v1.0.0/gcp-config.md index a5658c627..8ad68409d 100644 --- a/site/docs/v1.0.0/gcp-config.md +++ b/site/content/docs/v1.0.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Velero on GCP +--- +title: "Run Velero on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either: diff --git a/site/docs/v1.1.0/get-started.md b/site/content/docs/v1.0.0/get-started.md similarity index 99% rename from site/docs/v1.1.0/get-started.md rename to site/content/docs/v1.0.0/get-started.md index 7ed8ee9fc..81eaabf7d 100644 --- a/site/docs/v1.1.0/get-started.md +++ b/site/content/docs/v1.0.0/get-started.md @@ -1,4 +1,7 @@ -## Getting started +--- +title: "Getting started" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.0.0/hooks.md b/site/content/docs/v1.0.0/hooks.md similarity index 99% rename from site/docs/v1.0.0/hooks.md rename to site/content/docs/v1.0.0/hooks.md index f58d66e11..02b33313e 100644 --- a/site/docs/v1.0.0/hooks.md +++ b/site/content/docs/v1.0.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.0.0/ibm-config.md b/site/content/docs/v1.0.0/ibm-config.md similarity index 98% rename from site/docs/v1.0.0/ibm-config.md rename to site/content/docs/v1.0.0/ibm-config.md index 8e5024843..389f1defe 100644 --- a/site/docs/v1.0.0/ibm-config.md +++ b/site/content/docs/v1.0.0/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v1.0.0/image-tagging.md b/site/content/docs/v1.0.0/image-tagging.md similarity index 91% rename from site/docs/v1.0.0/image-tagging.md rename to site/content/docs/v1.0.0/image-tagging.md index 921e49f0c..6e2468031 100644 --- a/site/docs/v1.0.0/image-tagging.md +++ b/site/content/docs/v1.0.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/v1.0.0/img/README.md b/site/content/docs/v1.0.0/img/README.md similarity index 100% rename from site/docs/v1.0.0/img/README.md rename to site/content/docs/v1.0.0/img/README.md diff --git a/site/docs/v1.0.0/img/backup-process.png b/site/content/docs/v1.0.0/img/backup-process.png similarity index 100% rename from site/docs/v1.0.0/img/backup-process.png rename to site/content/docs/v1.0.0/img/backup-process.png diff --git a/site/docs/v1.0.0/img/velero.png b/site/content/docs/v1.0.0/img/velero.png similarity index 100% rename from site/docs/v1.0.0/img/velero.png rename to site/content/docs/v1.0.0/img/velero.png diff --git a/site/docs/v1.0.0/install-overview.md b/site/content/docs/v1.0.0/install-overview.md similarity index 98% rename from site/docs/v1.0.0/install-overview.md rename to site/content/docs/v1.0.0/install-overview.md index 1aece0c5e..0795d97f6 100644 --- a/site/docs/v1.0.0/install-overview.md +++ b/site/content/docs/v1.0.0/install-overview.md @@ -1,4 +1,7 @@ -# Set up Velero on your platform +--- +title: "Set up Velero on your platform" +layout: docs +--- You can run Velero with a cloud provider or on-premises. For detailed information about the platforms that Velero supports, see [Compatible Storage Providers][99]. diff --git a/site/docs/v1.1.0/locations.md b/site/content/docs/v1.0.0/locations.md similarity index 98% rename from site/docs/v1.1.0/locations.md rename to site/content/docs/v1.0.0/locations.md index 7c7a0b9c9..90e2e516a 100644 --- a/site/docs/v1.1.0/locations.md +++ b/site/content/docs/v1.0.0/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- ## Overview diff --git a/site/docs/v1.1.0/migrating-to-velero.md b/site/content/docs/v1.0.0/migrating-to-velero.md similarity index 98% rename from site/docs/v1.1.0/migrating-to-velero.md rename to site/content/docs/v1.0.0/migrating-to-velero.md index cd984e28d..1fbff6c72 100644 --- a/site/docs/v1.1.0/migrating-to-velero.md +++ b/site/content/docs/v1.0.0/migrating-to-velero.md @@ -1,4 +1,7 @@ -# Migrating from Heptio Ark to Velero +--- +title: "Migrating from Heptio Ark to Velero" +layout: docs +--- As of v0.11.0, Heptio Ark has become Velero. This means the following changes have been made: diff --git a/site/docs/v1.0.0/migration-case.md b/site/content/docs/v1.0.0/migration-case.md similarity index 97% rename from site/docs/v1.0.0/migration-case.md rename to site/content/docs/v1.0.0/migration-case.md index 1296cc6b6..76fc90998 100644 --- a/site/docs/v1.0.0/migration-case.md +++ b/site/content/docs/v1.0.0/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v1.0.0/namespace.md b/site/content/docs/v1.0.0/namespace.md similarity index 89% rename from site/docs/v1.0.0/namespace.md rename to site/content/docs/v1.0.0/namespace.md index 1c4802c57..231027841 100644 --- a/site/docs/v1.0.0/namespace.md +++ b/site/content/docs/v1.0.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- You can run Velero in any namespace. diff --git a/site/docs/v1.0.0/oracle-config.md b/site/content/docs/v1.0.0/oracle-config.md similarity index 99% rename from site/docs/v1.0.0/oracle-config.md rename to site/content/docs/v1.0.0/oracle-config.md index 1f2c1dc5b..3a99d56f9 100644 --- a/site/docs/v1.0.0/oracle-config.md +++ b/site/content/docs/v1.0.0/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.2.0/output-file-format.md b/site/content/docs/v1.0.0/output-file-format.md similarity index 98% rename from site/docs/v1.2.0/output-file-format.md rename to site/content/docs/v1.0.0/output-file-format.md index 04420be91..362e4735c 100644 --- a/site/docs/v1.2.0/output-file-format.md +++ b/site/content/docs/v1.0.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/v1.0.0/plugins.md b/site/content/docs/v1.0.0/plugins.md similarity index 99% rename from site/docs/v1.0.0/plugins.md rename to site/content/docs/v1.0.0/plugins.md index 99f595f9c..e9024fcce 100644 --- a/site/docs/v1.0.0/plugins.md +++ b/site/content/docs/v1.0.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v0.11.0/rbac.md b/site/content/docs/v1.0.0/rbac.md similarity index 95% rename from site/docs/v0.11.0/rbac.md rename to site/content/docs/v1.0.0/rbac.md index d8686bf6e..a9c22b9f1 100644 --- a/site/docs/v0.11.0/rbac.md +++ b/site/content/docs/v1.0.0/rbac.md @@ -1,4 +1,7 @@ -# Run Velero more securely with restrictive RBAC settings +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. diff --git a/site/docs/v1.0.0/restic.md b/site/content/docs/v1.0.0/restic.md similarity index 99% rename from site/docs/v1.0.0/restic.md rename to site/content/docs/v1.0.0/restic.md index 903433317..00b012624 100644 --- a/site/docs/v1.0.0/restic.md +++ b/site/content/docs/v1.0.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.0.0/support-matrix.md b/site/content/docs/v1.0.0/support-matrix.md similarity index 98% rename from site/docs/v1.0.0/support-matrix.md rename to site/content/docs/v1.0.0/support-matrix.md index cfdd2cf58..efd7dd7a5 100644 --- a/site/docs/v1.0.0/support-matrix.md +++ b/site/content/docs/v1.0.0/support-matrix.md @@ -1,4 +1,7 @@ -# Supported Kubernetes Versions +--- +title: "Supported Kubernetes Versions" +layout: docs +--- - In general, Velero works on Kubernetes version 1.7 or later (when Custom Resource Definitions were introduced). - Restic support requires Kubernetes version 1.10 or later, or an earlier version with the mount propagation feature enabled. See [Restic Integration][17]. diff --git a/site/docs/v1.0.0/troubleshooting.md b/site/content/docs/v1.0.0/troubleshooting.md similarity index 98% rename from site/docs/v1.0.0/troubleshooting.md rename to site/content/docs/v1.0.0/troubleshooting.md index a3922dfc7..132506863 100644 --- a/site/docs/v1.0.0/troubleshooting.md +++ b/site/content/docs/v1.0.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v1.0.0/upgrade-to-1.0.md b/site/content/docs/v1.0.0/upgrade-to-1.0.md similarity index 99% rename from site/docs/v1.0.0/upgrade-to-1.0.md rename to site/content/docs/v1.0.0/upgrade-to-1.0.md index 8af593c8c..b796904c1 100644 --- a/site/docs/v1.0.0/upgrade-to-1.0.md +++ b/site/content/docs/v1.0.0/upgrade-to-1.0.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.0 +--- +title: "Upgrading to Velero 1.0" +layout: docs +--- ## Prerequisites - Velero v0.11 installed. If you're not already on v0.11, see the [instructions for upgrading to v0.11][0]. **Upgrading directly from v0.10.x or earlier to v1.0 is not supported!** diff --git a/site/content/docs/v1.0.0/vendoring-dependencies.md b/site/content/docs/v1.0.0/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.0.0/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.0.0/zenhub.md b/site/content/docs/v1.0.0/zenhub.md similarity index 97% rename from site/docs/v1.0.0/zenhub.md rename to site/content/docs/v1.0.0/zenhub.md index 3d3e09b74..4d4b2391a 100644 --- a/site/docs/v1.0.0/zenhub.md +++ b/site/content/docs/v1.0.0/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v1.1.0/README.md b/site/content/docs/v1.1.0/_index.md similarity index 99% rename from site/docs/v1.1.0/README.md rename to site/content/docs/v1.1.0/_index.md index ab96bcf23..4b96e5a00 100644 --- a/site/docs/v1.1.0/README.md +++ b/site/content/docs/v1.1.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.1.0 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v1.1.0/about.md b/site/content/docs/v1.1.0/about.md similarity index 99% rename from site/docs/v1.1.0/about.md rename to site/content/docs/v1.1.0/about.md index 85febb1df..44013c5b0 100644 --- a/site/docs/v1.1.0/about.md +++ b/site/content/docs/v1.1.0/about.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v1.0.0/api-types/README.md b/site/content/docs/v1.1.0/api-types/README.md similarity index 85% rename from site/docs/v1.0.0/api-types/README.md rename to site/content/docs/v1.1.0/api-types/README.md index 424b02d00..290379288 100644 --- a/site/docs/v1.0.0/api-types/README.md +++ b/site/content/docs/v1.1.0/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/v1.0.0/api-types/backup.md b/site/content/docs/v1.1.0/api-types/backup.md similarity index 99% rename from site/docs/v1.0.0/api-types/backup.md rename to site/content/docs/v1.1.0/api-types/backup.md index 70120a921..2223081ae 100644 --- a/site/docs/v1.0.0/api-types/backup.md +++ b/site/content/docs/v1.1.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.1.0/api-types/backupstoragelocation.md b/site/content/docs/v1.1.0/api-types/backupstoragelocation.md similarity index 98% rename from site/docs/v1.1.0/api-types/backupstoragelocation.md rename to site/content/docs/v1.1.0/api-types/backupstoragelocation.md index f3c84e054..46b2d410b 100644 --- a/site/docs/v1.1.0/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.1.0/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v1.1.0/api-types/volumesnapshotlocation.md b/site/content/docs/v1.1.0/api-types/volumesnapshotlocation.md similarity index 97% rename from site/docs/v1.1.0/api-types/volumesnapshotlocation.md rename to site/content/docs/v1.1.0/api-types/volumesnapshotlocation.md index 8e6ad15c2..1299945b1 100644 --- a/site/docs/v1.1.0/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v1.1.0/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v1.1.0/aws-config.md b/site/content/docs/v1.1.0/aws-config.md similarity index 99% rename from site/docs/v1.1.0/aws-config.md rename to site/content/docs/v1.1.0/aws-config.md index 349930cb0..92971f4ea 100644 --- a/site/docs/v1.1.0/aws-config.md +++ b/site/content/docs/v1.1.0/aws-config.md @@ -1,4 +1,7 @@ -# Run Velero on AWS +--- +title: "Run Velero on AWS" +layout: docs +--- To set up Velero on AWS, you: diff --git a/site/docs/v1.1.0/azure-config.md b/site/content/docs/v1.1.0/azure-config.md similarity index 99% rename from site/docs/v1.1.0/azure-config.md rename to site/content/docs/v1.1.0/azure-config.md index 42645bf14..831244975 100644 --- a/site/docs/v1.1.0/azure-config.md +++ b/site/content/docs/v1.1.0/azure-config.md @@ -1,4 +1,7 @@ -# Run Velero on Azure +--- +title: "Run Velero on Azure" +layout: docs +--- To configure Velero on Azure, you: diff --git a/site/docs/v1.1.0/backup-reference.md b/site/content/docs/v1.1.0/backup-reference.md similarity index 91% rename from site/docs/v1.1.0/backup-reference.md rename to site/content/docs/v1.1.0/backup-reference.md index d262d4184..fcda95a71 100644 --- a/site/docs/v1.1.0/backup-reference.md +++ b/site/content/docs/v1.1.0/backup-reference.md @@ -1,4 +1,7 @@ -# Backup Reference +--- +title: "Backup Reference" +layout: docs +--- ## Exclude Specific Items from Backup diff --git a/site/docs/v1.1.0/build-from-source.md b/site/content/docs/v1.1.0/build-from-source.md similarity index 98% rename from site/docs/v1.1.0/build-from-source.md rename to site/content/docs/v1.1.0/build-from-source.md index 6a61562e1..a259eca4b 100644 --- a/site/docs/v1.1.0/build-from-source.md +++ b/site/content/docs/v1.1.0/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.0.0/debugging-install.md b/site/content/docs/v1.1.0/debugging-install.md similarity index 98% rename from site/docs/v1.0.0/debugging-install.md rename to site/content/docs/v1.1.0/debugging-install.md index 4abc5a3e1..9c2067b34 100644 --- a/site/docs/v1.0.0/debugging-install.md +++ b/site/content/docs/v1.1.0/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v1.0.0/debugging-restores.md b/site/content/docs/v1.1.0/debugging-restores.md similarity index 98% rename from site/docs/v1.0.0/debugging-restores.md rename to site/content/docs/v1.1.0/debugging-restores.md index d50d4aacb..eb834b0bc 100644 --- a/site/docs/v1.0.0/debugging-restores.md +++ b/site/content/docs/v1.1.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v1.1.0/development.md b/site/content/docs/v1.1.0/development.md similarity index 96% rename from site/docs/v1.1.0/development.md rename to site/content/docs/v1.1.0/development.md index 1e3f97bcc..86fec9ba8 100644 --- a/site/docs/v1.1.0/development.md +++ b/site/content/docs/v1.1.0/development.md @@ -1,4 +1,7 @@ -# Development +--- +title: "Development " +layout: docs +--- ## Update generated files diff --git a/site/docs/v1.3.0/disaster-case.md b/site/content/docs/v1.1.0/disaster-case.md similarity index 96% rename from site/docs/v1.3.0/disaster-case.md rename to site/content/docs/v1.1.0/disaster-case.md index 88f61e7c7..8fa82f73c 100644 --- a/site/docs/v1.3.0/disaster-case.md +++ b/site/content/docs/v1.1.0/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/docs/v1.1.0/faq.md b/site/content/docs/v1.1.0/faq.md similarity index 98% rename from site/docs/v1.1.0/faq.md rename to site/content/docs/v1.1.0/faq.md index 6b0aa80c1..104872c05 100644 --- a/site/docs/v1.1.0/faq.md +++ b/site/content/docs/v1.1.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v1.1.0/gcp-config.md b/site/content/docs/v1.1.0/gcp-config.md similarity index 99% rename from site/docs/v1.1.0/gcp-config.md rename to site/content/docs/v1.1.0/gcp-config.md index bd068b0a6..7c373b2a4 100644 --- a/site/docs/v1.1.0/gcp-config.md +++ b/site/content/docs/v1.1.0/gcp-config.md @@ -1,4 +1,7 @@ -# Run Velero on GCP +--- +title: "Run Velero on GCP" +layout: docs +--- You can run Kubernetes on Google Cloud Platform in either: diff --git a/site/docs/v1.0.0/get-started.md b/site/content/docs/v1.1.0/get-started.md similarity index 99% rename from site/docs/v1.0.0/get-started.md rename to site/content/docs/v1.1.0/get-started.md index 7ed8ee9fc..81eaabf7d 100644 --- a/site/docs/v1.0.0/get-started.md +++ b/site/content/docs/v1.1.0/get-started.md @@ -1,4 +1,7 @@ -## Getting started +--- +title: "Getting started" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.1.0/hooks.md b/site/content/docs/v1.1.0/hooks.md similarity index 99% rename from site/docs/v1.1.0/hooks.md rename to site/content/docs/v1.1.0/hooks.md index 597914149..2d0e83ade 100644 --- a/site/docs/v1.1.0/hooks.md +++ b/site/content/docs/v1.1.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.1.0/ibm-config.md b/site/content/docs/v1.1.0/ibm-config.md similarity index 98% rename from site/docs/v1.1.0/ibm-config.md rename to site/content/docs/v1.1.0/ibm-config.md index 11da3e31c..0fdd3a3b4 100644 --- a/site/docs/v1.1.0/ibm-config.md +++ b/site/content/docs/v1.1.0/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v1.1.0/image-tagging.md b/site/content/docs/v1.1.0/image-tagging.md similarity index 91% rename from site/docs/v1.1.0/image-tagging.md rename to site/content/docs/v1.1.0/image-tagging.md index 921e49f0c..6e2468031 100644 --- a/site/docs/v1.1.0/image-tagging.md +++ b/site/content/docs/v1.1.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/v1.1.0/img/README.md b/site/content/docs/v1.1.0/img/README.md similarity index 100% rename from site/docs/v1.1.0/img/README.md rename to site/content/docs/v1.1.0/img/README.md diff --git a/site/docs/v1.1.0/img/backup-process.png b/site/content/docs/v1.1.0/img/backup-process.png similarity index 100% rename from site/docs/v1.1.0/img/backup-process.png rename to site/content/docs/v1.1.0/img/backup-process.png diff --git a/site/docs/v1.1.0/img/velero.png b/site/content/docs/v1.1.0/img/velero.png similarity index 100% rename from site/docs/v1.1.0/img/velero.png rename to site/content/docs/v1.1.0/img/velero.png diff --git a/site/docs/v1.1.0/install-overview.md b/site/content/docs/v1.1.0/install-overview.md similarity index 99% rename from site/docs/v1.1.0/install-overview.md rename to site/content/docs/v1.1.0/install-overview.md index b1fdf2456..6a077fb5d 100644 --- a/site/docs/v1.1.0/install-overview.md +++ b/site/content/docs/v1.1.0/install-overview.md @@ -1,4 +1,7 @@ -# Set up Velero on your platform +--- +title: "Set up Velero on your platform" +layout: docs +--- You can run Velero with a cloud provider or on-premises. For detailed information about the platforms that Velero supports, see [Compatible Storage Providers][99]. diff --git a/site/docs/v1.0.0/locations.md b/site/content/docs/v1.1.0/locations.md similarity index 98% rename from site/docs/v1.0.0/locations.md rename to site/content/docs/v1.1.0/locations.md index 7c7a0b9c9..90e2e516a 100644 --- a/site/docs/v1.0.0/locations.md +++ b/site/content/docs/v1.1.0/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- ## Overview diff --git a/site/docs/v1.0.0/migrating-to-velero.md b/site/content/docs/v1.1.0/migrating-to-velero.md similarity index 98% rename from site/docs/v1.0.0/migrating-to-velero.md rename to site/content/docs/v1.1.0/migrating-to-velero.md index cd984e28d..1fbff6c72 100644 --- a/site/docs/v1.0.0/migrating-to-velero.md +++ b/site/content/docs/v1.1.0/migrating-to-velero.md @@ -1,4 +1,7 @@ -# Migrating from Heptio Ark to Velero +--- +title: "Migrating from Heptio Ark to Velero" +layout: docs +--- As of v0.11.0, Heptio Ark has become Velero. This means the following changes have been made: diff --git a/site/docs/v1.1.0/migration-case.md b/site/content/docs/v1.1.0/migration-case.md similarity index 97% rename from site/docs/v1.1.0/migration-case.md rename to site/content/docs/v1.1.0/migration-case.md index 41afcf9ef..f9abf7a40 100644 --- a/site/docs/v1.1.0/migration-case.md +++ b/site/content/docs/v1.1.0/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v1.1.0/namespace.md b/site/content/docs/v1.1.0/namespace.md similarity index 89% rename from site/docs/v1.1.0/namespace.md rename to site/content/docs/v1.1.0/namespace.md index 1c4802c57..231027841 100644 --- a/site/docs/v1.1.0/namespace.md +++ b/site/content/docs/v1.1.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- You can run Velero in any namespace. diff --git a/site/docs/v1.1.0/oracle-config.md b/site/content/docs/v1.1.0/oracle-config.md similarity index 99% rename from site/docs/v1.1.0/oracle-config.md rename to site/content/docs/v1.1.0/oracle-config.md index 6cdcac92c..a0de6020a 100644 --- a/site/docs/v1.1.0/oracle-config.md +++ b/site/content/docs/v1.1.0/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.0.0/output-file-format.md b/site/content/docs/v1.1.0/output-file-format.md similarity index 98% rename from site/docs/v1.0.0/output-file-format.md rename to site/content/docs/v1.1.0/output-file-format.md index 04420be91..362e4735c 100644 --- a/site/docs/v1.0.0/output-file-format.md +++ b/site/content/docs/v1.1.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/v1.1.0/plugins.md b/site/content/docs/v1.1.0/plugins.md similarity index 99% rename from site/docs/v1.1.0/plugins.md rename to site/content/docs/v1.1.0/plugins.md index 6cdf3bb3e..617b711e5 100644 --- a/site/docs/v1.1.0/plugins.md +++ b/site/content/docs/v1.1.0/plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v1.1.0/rbac.md b/site/content/docs/v1.1.0/rbac.md similarity index 95% rename from site/docs/v1.1.0/rbac.md rename to site/content/docs/v1.1.0/rbac.md index d8686bf6e..a9c22b9f1 100644 --- a/site/docs/v1.1.0/rbac.md +++ b/site/content/docs/v1.1.0/rbac.md @@ -1,4 +1,7 @@ -# Run Velero more securely with restrictive RBAC settings +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. diff --git a/site/docs/v1.1.0/restic.md b/site/content/docs/v1.1.0/restic.md similarity index 99% rename from site/docs/v1.1.0/restic.md rename to site/content/docs/v1.1.0/restic.md index f7d55f8ed..d73e8db57 100644 --- a/site/docs/v1.1.0/restic.md +++ b/site/content/docs/v1.1.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.1.0/restore-reference.md b/site/content/docs/v1.1.0/restore-reference.md similarity index 96% rename from site/docs/v1.1.0/restore-reference.md rename to site/content/docs/v1.1.0/restore-reference.md index 8cbc43eea..83aebc7d8 100644 --- a/site/docs/v1.1.0/restore-reference.md +++ b/site/content/docs/v1.1.0/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/docs/v1.1.0/run-locally.md b/site/content/docs/v1.1.0/run-locally.md similarity index 97% rename from site/docs/v1.1.0/run-locally.md rename to site/content/docs/v1.1.0/run-locally.md index bba98d85c..60dd4c1ba 100644 --- a/site/docs/v1.1.0/run-locally.md +++ b/site/content/docs/v1.1.0/run-locally.md @@ -1,4 +1,7 @@ -# Run Velero locally in development +--- +title: "Run Velero locally in development" +layout: docs +--- Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server image and redeploy it to the cluster with each change. diff --git a/site/docs/v1.1.0/start-contributing.md b/site/content/docs/v1.1.0/start-contributing.md similarity index 96% rename from site/docs/v1.1.0/start-contributing.md rename to site/content/docs/v1.1.0/start-contributing.md index e5932fb3b..b70bdfbca 100644 --- a/site/docs/v1.1.0/start-contributing.md +++ b/site/content/docs/v1.1.0/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/docs/v1.1.0/support-matrix.md b/site/content/docs/v1.1.0/support-matrix.md similarity index 98% rename from site/docs/v1.1.0/support-matrix.md rename to site/content/docs/v1.1.0/support-matrix.md index 1888493e8..19bd2f7d2 100644 --- a/site/docs/v1.1.0/support-matrix.md +++ b/site/content/docs/v1.1.0/support-matrix.md @@ -1,4 +1,7 @@ -# Supported Kubernetes Versions +--- +title: "Supported Kubernetes Versions" +layout: docs +--- - In general, Velero works on Kubernetes version 1.7 or later (when Custom Resource Definitions were introduced). - Restic support requires Kubernetes version 1.10 or later, or an earlier version with the mount propagation feature enabled. See [Restic Integration][17]. diff --git a/site/docs/v1.1.0/troubleshooting.md b/site/content/docs/v1.1.0/troubleshooting.md similarity index 98% rename from site/docs/v1.1.0/troubleshooting.md rename to site/content/docs/v1.1.0/troubleshooting.md index a3922dfc7..132506863 100644 --- a/site/docs/v1.1.0/troubleshooting.md +++ b/site/content/docs/v1.1.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v1.1.0/upgrade-to-1.1.md b/site/content/docs/v1.1.0/upgrade-to-1.1.md similarity index 95% rename from site/docs/v1.1.0/upgrade-to-1.1.md rename to site/content/docs/v1.1.0/upgrade-to-1.1.md index 939c43ae5..2a5221841 100644 --- a/site/docs/v1.1.0/upgrade-to-1.1.md +++ b/site/content/docs/v1.1.0/upgrade-to-1.1.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.1 +--- +title: "Upgrading to Velero 1.1" +layout: docs +--- ## Prerequisites - [Velero v1.0][1] installed. diff --git a/site/content/docs/v1.1.0/vendoring-dependencies.md b/site/content/docs/v1.1.0/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.1.0/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.1.0/zenhub.md b/site/content/docs/v1.1.0/zenhub.md similarity index 97% rename from site/docs/v1.1.0/zenhub.md rename to site/content/docs/v1.1.0/zenhub.md index 3d3e09b74..4d4b2391a 100644 --- a/site/docs/v1.1.0/zenhub.md +++ b/site/content/docs/v1.1.0/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v1.2.0/README.md b/site/content/docs/v1.2.0/_index.md similarity index 98% rename from site/docs/v1.2.0/README.md rename to site/content/docs/v1.2.0/_index.md index 94dd37fff..13e3a082e 100644 --- a/site/docs/v1.2.0/README.md +++ b/site/content/docs/v1.2.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.2.0 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v1.2.0/api-types/README.md b/site/content/docs/v1.2.0/api-types/README.md similarity index 87% rename from site/docs/v1.2.0/api-types/README.md rename to site/content/docs/v1.2.0/api-types/README.md index 31c4ce403..6c17ba969 100644 --- a/site/docs/v1.2.0/api-types/README.md +++ b/site/content/docs/v1.2.0/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/v1.2.0/api-types/backup.md b/site/content/docs/v1.2.0/api-types/backup.md similarity index 99% rename from site/docs/v1.2.0/api-types/backup.md rename to site/content/docs/v1.2.0/api-types/backup.md index 70120a921..2223081ae 100644 --- a/site/docs/v1.2.0/api-types/backup.md +++ b/site/content/docs/v1.2.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.3.0/api-types/backupstoragelocation.md b/site/content/docs/v1.2.0/api-types/backupstoragelocation.md similarity index 97% rename from site/docs/v1.3.0/api-types/backupstoragelocation.md rename to site/content/docs/v1.2.0/api-types/backupstoragelocation.md index cd11c49fe..c3a28c4f8 100644 --- a/site/docs/v1.3.0/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.2.0/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v1.3.0/api-types/schedule.md b/site/content/docs/v1.2.0/api-types/schedule.md similarity index 99% rename from site/docs/v1.3.0/api-types/schedule.md rename to site/content/docs/v1.2.0/api-types/schedule.md index ec7e471a6..7b3139bf9 100644 --- a/site/docs/v1.3.0/api-types/schedule.md +++ b/site/content/docs/v1.2.0/api-types/schedule.md @@ -1,4 +1,7 @@ -# Schedule API Type +--- +title: "Schedule API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.3.1/api-types/volumesnapshotlocation.md b/site/content/docs/v1.2.0/api-types/volumesnapshotlocation.md similarity index 96% rename from site/docs/v1.3.1/api-types/volumesnapshotlocation.md rename to site/content/docs/v1.2.0/api-types/volumesnapshotlocation.md index 8f3588dcb..aef5f4053 100644 --- a/site/docs/v1.3.1/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v1.2.0/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v1.3.2/backup-reference.md b/site/content/docs/v1.2.0/backup-reference.md similarity index 87% rename from site/docs/v1.3.2/backup-reference.md rename to site/content/docs/v1.2.0/backup-reference.md index 797230d67..6ea8df91c 100644 --- a/site/docs/v1.3.2/backup-reference.md +++ b/site/content/docs/v1.2.0/backup-reference.md @@ -1,4 +1,7 @@ -# Backup Reference +--- +title: "Backup Reference" +layout: docs +--- ## Exclude Specific Items from Backup diff --git a/site/docs/v1.2.0/basic-install.md b/site/content/docs/v1.2.0/basic-install.md similarity index 98% rename from site/docs/v1.2.0/basic-install.md rename to site/content/docs/v1.2.0/basic-install.md index ab0ce6355..36bb149f8 100644 --- a/site/docs/v1.2.0/basic-install.md +++ b/site/content/docs/v1.2.0/basic-install.md @@ -1,4 +1,7 @@ -# Basic Install +--- +title: "Basic Install" +layout: docs +--- - [Basic Install](#basic-install) - [Prerequisites](#prerequisites) diff --git a/site/docs/v1.3.2/build-from-source.md b/site/content/docs/v1.2.0/build-from-source.md similarity index 99% rename from site/docs/v1.3.2/build-from-source.md rename to site/content/docs/v1.2.0/build-from-source.md index 0536d8efd..6fbadc119 100644 --- a/site/docs/v1.3.2/build-from-source.md +++ b/site/content/docs/v1.2.0/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.2.0/code-standards.md b/site/content/docs/v1.2.0/code-standards.md similarity index 98% rename from site/docs/v1.2.0/code-standards.md rename to site/content/docs/v1.2.0/code-standards.md index f353b9166..7b57ae0ad 100644 --- a/site/docs/v1.2.0/code-standards.md +++ b/site/content/docs/v1.2.0/code-standards.md @@ -1,4 +1,7 @@ -# Code Standards +--- +title: "Code Standards" +layout: docs +--- ## Adding a changelog diff --git a/site/docs/v1.3.2/contributions/ibm-config.md b/site/content/docs/v1.2.0/contributions/ibm-config.md similarity index 98% rename from site/docs/v1.3.2/contributions/ibm-config.md rename to site/content/docs/v1.2.0/contributions/ibm-config.md index ea90167a3..299492bc0 100644 --- a/site/docs/v1.3.2/contributions/ibm-config.md +++ b/site/content/docs/v1.2.0/contributions/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v1.3.1/contributions/minio.md b/site/content/docs/v1.2.0/contributions/minio.md similarity index 99% rename from site/docs/v1.3.1/contributions/minio.md rename to site/content/docs/v1.2.0/contributions/minio.md index 2f4507633..b9c8c5110 100644 --- a/site/docs/v1.3.1/contributions/minio.md +++ b/site/content/docs/v1.2.0/contributions/minio.md @@ -1,4 +1,7 @@ -## Quick start evaluation install with Minio +--- +title: "Quick start evaluation install with Minio" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.2.0/contributions/oracle-config.md b/site/content/docs/v1.2.0/contributions/oracle-config.md similarity index 99% rename from site/docs/v1.2.0/contributions/oracle-config.md rename to site/content/docs/v1.2.0/contributions/oracle-config.md index 7be2796e1..f12eb8e49 100644 --- a/site/docs/v1.2.0/contributions/oracle-config.md +++ b/site/content/docs/v1.2.0/contributions/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.2.0/custom-plugins.md b/site/content/docs/v1.2.0/custom-plugins.md similarity index 99% rename from site/docs/v1.2.0/custom-plugins.md rename to site/content/docs/v1.2.0/custom-plugins.md index fe599c9db..b7d42019f 100644 --- a/site/docs/v1.2.0/custom-plugins.md +++ b/site/content/docs/v1.2.0/custom-plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v1.2.0/customize-installation.md b/site/content/docs/v1.2.0/customize-installation.md similarity index 99% rename from site/docs/v1.2.0/customize-installation.md rename to site/content/docs/v1.2.0/customize-installation.md index 2b177f92f..04950f8ab 100644 --- a/site/docs/v1.2.0/customize-installation.md +++ b/site/content/docs/v1.2.0/customize-installation.md @@ -1,4 +1,7 @@ -# Customize Velero Install +--- +title: "Customize Velero Install" +layout: docs +--- - [Customize Velero Install](#customize-velero-install) - [Plugins](#plugins) diff --git a/site/docs/main/debugging-install.md b/site/content/docs/v1.2.0/debugging-install.md similarity index 98% rename from site/docs/main/debugging-install.md rename to site/content/docs/v1.2.0/debugging-install.md index 4abc5a3e1..9c2067b34 100644 --- a/site/docs/main/debugging-install.md +++ b/site/content/docs/v1.2.0/debugging-install.md @@ -1,4 +1,7 @@ -# Debugging Installation Issues +--- +title: "Debugging Installation Issues" +layout: docs +--- ## General diff --git a/site/docs/v1.1.0/debugging-restores.md b/site/content/docs/v1.2.0/debugging-restores.md similarity index 98% rename from site/docs/v1.1.0/debugging-restores.md rename to site/content/docs/v1.2.0/debugging-restores.md index d50d4aacb..eb834b0bc 100644 --- a/site/docs/v1.1.0/debugging-restores.md +++ b/site/content/docs/v1.2.0/debugging-restores.md @@ -1,4 +1,7 @@ -# Debugging Restores +--- +title: "Debugging Restores" +layout: docs +--- * [Example][0] * [Structure][1] diff --git a/site/docs/v1.2.0/development.md b/site/content/docs/v1.2.0/development.md similarity index 94% rename from site/docs/v1.2.0/development.md rename to site/content/docs/v1.2.0/development.md index cf3b3c4fc..c805a27da 100644 --- a/site/docs/v1.2.0/development.md +++ b/site/content/docs/v1.2.0/development.md @@ -1,4 +1,7 @@ -# Development +--- +title: "Development " +layout: docs +--- ## Update generated files diff --git a/site/docs/v1.3.1/disaster-case.md b/site/content/docs/v1.2.0/disaster-case.md similarity index 96% rename from site/docs/v1.3.1/disaster-case.md rename to site/content/docs/v1.2.0/disaster-case.md index 88f61e7c7..8fa82f73c 100644 --- a/site/docs/v1.3.1/disaster-case.md +++ b/site/content/docs/v1.2.0/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/docs/v1.3.1/examples.md b/site/content/docs/v1.2.0/examples.md similarity index 97% rename from site/docs/v1.3.1/examples.md rename to site/content/docs/v1.2.0/examples.md index 40b284ec3..c73ae2b23 100644 --- a/site/docs/v1.3.1/examples.md +++ b/site/content/docs/v1.2.0/examples.md @@ -1,4 +1,7 @@ -## Examples +--- +title: "Examples" +layout: docs +--- After you set up the Velero server, try these examples: diff --git a/site/docs/v1.2.0/faq.md b/site/content/docs/v1.2.0/faq.md similarity index 98% rename from site/docs/v1.2.0/faq.md rename to site/content/docs/v1.2.0/faq.md index e61bc984c..22437aa2f 100644 --- a/site/docs/v1.2.0/faq.md +++ b/site/content/docs/v1.2.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v1.2.0/hooks.md b/site/content/docs/v1.2.0/hooks.md similarity index 99% rename from site/docs/v1.2.0/hooks.md rename to site/content/docs/v1.2.0/hooks.md index 5c1da7ab9..7c7ec82eb 100644 --- a/site/docs/v1.2.0/hooks.md +++ b/site/content/docs/v1.2.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.2.0/how-velero-works.md b/site/content/docs/v1.2.0/how-velero-works.md similarity index 99% rename from site/docs/v1.2.0/how-velero-works.md rename to site/content/docs/v1.2.0/how-velero-works.md index 85febb1df..44013c5b0 100644 --- a/site/docs/v1.2.0/how-velero-works.md +++ b/site/content/docs/v1.2.0/how-velero-works.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/main/image-tagging.md b/site/content/docs/v1.2.0/image-tagging.md similarity index 91% rename from site/docs/main/image-tagging.md rename to site/content/docs/v1.2.0/image-tagging.md index b0080ef1c..fbfb15617 100644 --- a/site/docs/main/image-tagging.md +++ b/site/content/docs/v1.2.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/v1.2.0/img/README.md b/site/content/docs/v1.2.0/img/README.md similarity index 100% rename from site/docs/v1.2.0/img/README.md rename to site/content/docs/v1.2.0/img/README.md diff --git a/site/docs/v1.2.0/img/backup-process.png b/site/content/docs/v1.2.0/img/backup-process.png similarity index 100% rename from site/docs/v1.2.0/img/backup-process.png rename to site/content/docs/v1.2.0/img/backup-process.png diff --git a/site/docs/v1.2.0/img/velero.png b/site/content/docs/v1.2.0/img/velero.png similarity index 100% rename from site/docs/v1.2.0/img/velero.png rename to site/content/docs/v1.2.0/img/velero.png diff --git a/site/docs/v1.3.0/locations.md b/site/content/docs/v1.2.0/locations.md similarity index 98% rename from site/docs/v1.3.0/locations.md rename to site/content/docs/v1.2.0/locations.md index ca28239a7..b5d8ca3fc 100644 --- a/site/docs/v1.3.0/locations.md +++ b/site/content/docs/v1.2.0/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- ## Overview diff --git a/site/docs/v1.2.0/migration-case.md b/site/content/docs/v1.2.0/migration-case.md similarity index 97% rename from site/docs/v1.2.0/migration-case.md rename to site/content/docs/v1.2.0/migration-case.md index 41afcf9ef..f9abf7a40 100644 --- a/site/docs/v1.2.0/migration-case.md +++ b/site/content/docs/v1.2.0/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v1.2.0/namespace.md b/site/content/docs/v1.2.0/namespace.md similarity index 89% rename from site/docs/v1.2.0/namespace.md rename to site/content/docs/v1.2.0/namespace.md index fb50cf67d..92ae22b1a 100644 --- a/site/docs/v1.2.0/namespace.md +++ b/site/content/docs/v1.2.0/namespace.md @@ -1,4 +1,7 @@ -# Run in custom namespace +--- +title: "Run in custom namespace" +layout: docs +--- You can run Velero in any namespace. diff --git a/site/docs/v1.3.2/on-premises.md b/site/content/docs/v1.2.0/on-premises.md similarity index 96% rename from site/docs/v1.3.2/on-premises.md rename to site/content/docs/v1.2.0/on-premises.md index ec199287c..774252107 100644 --- a/site/docs/v1.3.2/on-premises.md +++ b/site/content/docs/v1.2.0/on-premises.md @@ -1,4 +1,7 @@ -# On-Premises Environments +--- +title: "On-Premises Environments" +layout: docs +--- You can run Velero in an on-premises cluster in different ways depending on your requirements. diff --git a/site/docs/v1.1.0/output-file-format.md b/site/content/docs/v1.2.0/output-file-format.md similarity index 98% rename from site/docs/v1.1.0/output-file-format.md rename to site/content/docs/v1.2.0/output-file-format.md index 04420be91..362e4735c 100644 --- a/site/docs/v1.1.0/output-file-format.md +++ b/site/content/docs/v1.2.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/main/overview-plugins.md b/site/content/docs/v1.2.0/overview-plugins.md similarity index 96% rename from site/docs/main/overview-plugins.md rename to site/content/docs/v1.2.0/overview-plugins.md index 74eb3b0fb..037601d51 100644 --- a/site/docs/main/overview-plugins.md +++ b/site/content/docs/v1.2.0/overview-plugins.md @@ -1,5 +1,7 @@ - -# Velero plugin system +--- +title: "Velero plugin system" +layout: docs +--- Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. diff --git a/site/content/docs/v1.2.0/rbac.md b/site/content/docs/v1.2.0/rbac.md new file mode 100644 index 000000000..a9c22b9f1 --- /dev/null +++ b/site/content/docs/v1.2.0/rbac.md @@ -0,0 +1,50 @@ +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- + +By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. + +**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. + +For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. + +## Set up Roles and RoleBindings + +Here's a sample Role and RoleBinding pair. + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + namespace: YOUR_NAMESPACE_HERE + name: ROLE_NAME_HERE + labels: + component: velero +rules: + - apiGroups: + - velero.io + verbs: + - "*" + resources: + - "*" +``` + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: ROLEBINDING_NAME_HERE +subjects: + - kind: ServiceAccount + name: YOUR_SERVICEACCOUNT_HERE +roleRef: + kind: Role + name: ROLE_NAME_HERE + apiGroup: rbac.authorization.k8s.io +``` + +[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ +[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ +[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +[4]: namespace.md diff --git a/site/docs/v1.3.0/restic.md b/site/content/docs/v1.2.0/restic.md similarity index 99% rename from site/docs/v1.3.0/restic.md rename to site/content/docs/v1.2.0/restic.md index b3c071b4d..9242ed2b4 100644 --- a/site/docs/v1.3.0/restic.md +++ b/site/content/docs/v1.2.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.3.1/restore-reference.md b/site/content/docs/v1.2.0/restore-reference.md similarity index 98% rename from site/docs/v1.3.1/restore-reference.md rename to site/content/docs/v1.2.0/restore-reference.md index 43c40a287..9a53b93ee 100644 --- a/site/docs/v1.3.1/restore-reference.md +++ b/site/content/docs/v1.2.0/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/docs/main/run-locally.md b/site/content/docs/v1.2.0/run-locally.md similarity index 97% rename from site/docs/main/run-locally.md rename to site/content/docs/v1.2.0/run-locally.md index 913cbc122..ffd735b4f 100644 --- a/site/docs/main/run-locally.md +++ b/site/content/docs/v1.2.0/run-locally.md @@ -1,4 +1,7 @@ -# Run Velero locally in development +--- +title: "Run Velero locally in development" +layout: docs +--- Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server image and redeploy it to the cluster with each change. diff --git a/site/docs/v1.2.0/start-contributing.md b/site/content/docs/v1.2.0/start-contributing.md similarity index 96% rename from site/docs/v1.2.0/start-contributing.md rename to site/content/docs/v1.2.0/start-contributing.md index e3b4ae117..29690ed51 100644 --- a/site/docs/v1.2.0/start-contributing.md +++ b/site/content/docs/v1.2.0/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/docs/v1.3.0/support-process.md b/site/content/docs/v1.2.0/support-process.md similarity index 98% rename from site/docs/v1.3.0/support-process.md rename to site/content/docs/v1.2.0/support-process.md index c4bdf82a0..fc06e72e9 100644 --- a/site/docs/v1.3.0/support-process.md +++ b/site/content/docs/v1.2.0/support-process.md @@ -1,4 +1,7 @@ -# Support Process +--- +title: "Support Process" +layout: docs +--- ## Weekly Rotation diff --git a/site/docs/v1.3.0/supported-providers.md b/site/content/docs/v1.2.0/supported-providers.md similarity index 99% rename from site/docs/v1.3.0/supported-providers.md rename to site/content/docs/v1.2.0/supported-providers.md index bcc0306aa..e832bb560 100644 --- a/site/docs/v1.3.0/supported-providers.md +++ b/site/content/docs/v1.2.0/supported-providers.md @@ -1,4 +1,7 @@ -# Providers +--- +title: "Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. Velero has a plugin system which allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/docs/v1.3.0/troubleshooting.md b/site/content/docs/v1.2.0/troubleshooting.md similarity index 99% rename from site/docs/v1.3.0/troubleshooting.md rename to site/content/docs/v1.2.0/troubleshooting.md index 984d8f714..6d0fa998f 100644 --- a/site/docs/v1.3.0/troubleshooting.md +++ b/site/content/docs/v1.2.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/main/uninstalling.md b/site/content/docs/v1.2.0/uninstalling.md similarity index 83% rename from site/docs/main/uninstalling.md rename to site/content/docs/v1.2.0/uninstalling.md index 727bc1aa0..f0b7b8d17 100644 --- a/site/docs/main/uninstalling.md +++ b/site/content/docs/v1.2.0/uninstalling.md @@ -1,4 +1,7 @@ -# Uninstalling Velero +--- +title: "Uninstalling Velero" +layout: docs +--- If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: diff --git a/site/docs/v1.2.0/upgrade-to-1.2.md b/site/content/docs/v1.2.0/upgrade-to-1.2.md similarity index 97% rename from site/docs/v1.2.0/upgrade-to-1.2.md rename to site/content/docs/v1.2.0/upgrade-to-1.2.md index 583ce85e6..3a5383a50 100644 --- a/site/docs/v1.2.0/upgrade-to-1.2.md +++ b/site/content/docs/v1.2.0/upgrade-to-1.2.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.2 +--- +title: "Upgrading to Velero 1.2" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.3.1/velero-install.md b/site/content/docs/v1.2.0/velero-install.md similarity index 98% rename from site/docs/v1.3.1/velero-install.md rename to site/content/docs/v1.2.0/velero-install.md index 58718d16c..951cc9f11 100644 --- a/site/docs/v1.3.1/velero-install.md +++ b/site/content/docs/v1.2.0/velero-install.md @@ -1,4 +1,7 @@ -# Velero Install CLI +--- +title: "Velero Install CLI" +layout: docs +--- This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. diff --git a/site/content/docs/v1.2.0/vendoring-dependencies.md b/site/content/docs/v1.2.0/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.2.0/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.2.0/website-guidelines.md b/site/content/docs/v1.2.0/website-guidelines.md similarity index 96% rename from site/docs/v1.2.0/website-guidelines.md rename to site/content/docs/v1.2.0/website-guidelines.md index 9521db9a1..999c8bcb0 100644 --- a/site/docs/v1.2.0/website-guidelines.md +++ b/site/content/docs/v1.2.0/website-guidelines.md @@ -1,4 +1,7 @@ -# Website Guidelines +--- +title: "Website Guidelines" +layout: docs +--- ## Running the website locally diff --git a/site/docs/v1.3.0/zenhub.md b/site/content/docs/v1.2.0/zenhub.md similarity index 97% rename from site/docs/v1.3.0/zenhub.md rename to site/content/docs/v1.2.0/zenhub.md index 45298b3a2..a723fb184 100644 --- a/site/docs/v1.3.0/zenhub.md +++ b/site/content/docs/v1.2.0/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v1.3.0/README.md b/site/content/docs/v1.3.0/_index.md similarity index 98% rename from site/docs/v1.3.0/README.md rename to site/content/docs/v1.3.0/_index.md index 46faaf2bc..8c1339de9 100644 --- a/site/docs/v1.3.0/README.md +++ b/site/content/docs/v1.3.0/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.3.0 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v1.3.1/api-types/README.md b/site/content/docs/v1.3.0/api-types/README.md similarity index 88% rename from site/docs/v1.3.1/api-types/README.md rename to site/content/docs/v1.3.0/api-types/README.md index 2ba83cc5e..54c23544d 100644 --- a/site/docs/v1.3.1/api-types/README.md +++ b/site/content/docs/v1.3.0/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/docs/v1.1.0/api-types/backup.md b/site/content/docs/v1.3.0/api-types/backup.md similarity index 99% rename from site/docs/v1.1.0/api-types/backup.md rename to site/content/docs/v1.3.0/api-types/backup.md index 70120a921..2223081ae 100644 --- a/site/docs/v1.1.0/api-types/backup.md +++ b/site/content/docs/v1.3.0/api-types/backup.md @@ -1,4 +1,7 @@ -# Backup API Type +--- +title: "Backup API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.3.2/api-types/backupstoragelocation.md b/site/content/docs/v1.3.0/api-types/backupstoragelocation.md similarity index 97% rename from site/docs/v1.3.2/api-types/backupstoragelocation.md rename to site/content/docs/v1.3.0/api-types/backupstoragelocation.md index cd11c49fe..c3a28c4f8 100644 --- a/site/docs/v1.3.2/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.3.0/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v1.3.1/api-types/restore.md b/site/content/docs/v1.3.0/api-types/restore.md similarity index 98% rename from site/docs/v1.3.1/api-types/restore.md rename to site/content/docs/v1.3.0/api-types/restore.md index 2044d4725..cc76e7f3a 100644 --- a/site/docs/v1.3.1/api-types/restore.md +++ b/site/content/docs/v1.3.0/api-types/restore.md @@ -1,4 +1,7 @@ -# Restore API Type +--- +title: "Restore API Type" +layout: docs +--- ## Use diff --git a/site/docs/main/api-types/schedule.md b/site/content/docs/v1.3.0/api-types/schedule.md similarity index 99% rename from site/docs/main/api-types/schedule.md rename to site/content/docs/v1.3.0/api-types/schedule.md index ec7e471a6..7b3139bf9 100644 --- a/site/docs/main/api-types/schedule.md +++ b/site/content/docs/v1.3.0/api-types/schedule.md @@ -1,4 +1,7 @@ -# Schedule API Type +--- +title: "Schedule API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.2.0/api-types/volumesnapshotlocation.md b/site/content/docs/v1.3.0/api-types/volumesnapshotlocation.md similarity index 96% rename from site/docs/v1.2.0/api-types/volumesnapshotlocation.md rename to site/content/docs/v1.3.0/api-types/volumesnapshotlocation.md index 8f3588dcb..aef5f4053 100644 --- a/site/docs/v1.2.0/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v1.3.0/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v1.3.0/backup-reference.md b/site/content/docs/v1.3.0/backup-reference.md similarity index 87% rename from site/docs/v1.3.0/backup-reference.md rename to site/content/docs/v1.3.0/backup-reference.md index 797230d67..6ea8df91c 100644 --- a/site/docs/v1.3.0/backup-reference.md +++ b/site/content/docs/v1.3.0/backup-reference.md @@ -1,4 +1,7 @@ -# Backup Reference +--- +title: "Backup Reference" +layout: docs +--- ## Exclude Specific Items from Backup diff --git a/site/docs/v1.3.2/basic-install.md b/site/content/docs/v1.3.0/basic-install.md similarity index 98% rename from site/docs/v1.3.2/basic-install.md rename to site/content/docs/v1.3.0/basic-install.md index fde47086f..7fdb5af3d 100644 --- a/site/docs/v1.3.2/basic-install.md +++ b/site/content/docs/v1.3.0/basic-install.md @@ -1,4 +1,7 @@ -# Basic Install +--- +title: "Basic Install" +layout: docs +--- - [Basic Install](#basic-install) - [Prerequisites](#prerequisites) diff --git a/site/docs/v1.3.0/build-from-source.md b/site/content/docs/v1.3.0/build-from-source.md similarity index 99% rename from site/docs/v1.3.0/build-from-source.md rename to site/content/docs/v1.3.0/build-from-source.md index 0536d8efd..6fbadc119 100644 --- a/site/docs/v1.3.0/build-from-source.md +++ b/site/content/docs/v1.3.0/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.3.0/code-standards.md b/site/content/docs/v1.3.0/code-standards.md similarity index 98% rename from site/docs/v1.3.0/code-standards.md rename to site/content/docs/v1.3.0/code-standards.md index b4e21194d..ed9c12fee 100644 --- a/site/docs/v1.3.0/code-standards.md +++ b/site/content/docs/v1.3.0/code-standards.md @@ -1,4 +1,7 @@ -# Code Standards +--- +title: "Code Standards" +layout: docs +--- ## Adding a changelog diff --git a/site/docs/v1.3.0/contributions/ibm-config.md b/site/content/docs/v1.3.0/contributions/ibm-config.md similarity index 98% rename from site/docs/v1.3.0/contributions/ibm-config.md rename to site/content/docs/v1.3.0/contributions/ibm-config.md index ea90167a3..299492bc0 100644 --- a/site/docs/v1.3.0/contributions/ibm-config.md +++ b/site/content/docs/v1.3.0/contributions/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v1.3.0/contributions/minio.md b/site/content/docs/v1.3.0/contributions/minio.md similarity index 99% rename from site/docs/v1.3.0/contributions/minio.md rename to site/content/docs/v1.3.0/contributions/minio.md index 2f4507633..b9c8c5110 100644 --- a/site/docs/v1.3.0/contributions/minio.md +++ b/site/content/docs/v1.3.0/contributions/minio.md @@ -1,4 +1,7 @@ -## Quick start evaluation install with Minio +--- +title: "Quick start evaluation install with Minio" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.3.0/contributions/oracle-config.md b/site/content/docs/v1.3.0/contributions/oracle-config.md similarity index 99% rename from site/docs/v1.3.0/contributions/oracle-config.md rename to site/content/docs/v1.3.0/contributions/oracle-config.md index 694d1869b..7dbefa16f 100644 --- a/site/docs/v1.3.0/contributions/oracle-config.md +++ b/site/content/docs/v1.3.0/contributions/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.3.0/csi.md b/site/content/docs/v1.3.0/csi.md similarity index 93% rename from site/docs/v1.3.0/csi.md rename to site/content/docs/v1.3.0/csi.md index c9e37f699..a8f272a32 100644 --- a/site/docs/v1.3.0/csi.md +++ b/site/content/docs/v1.3.0/csi.md @@ -1,4 +1,7 @@ -# Container Storage Interface Snapshot Support in Velero +--- +title: "Container Storage Interface Snapshot Support in Velero" +layout: docs +--- _This feature is under development. Documentation may not be up-to-date and features may not work as expected._ diff --git a/site/docs/v1.3.0/custom-plugins.md b/site/content/docs/v1.3.0/custom-plugins.md similarity index 99% rename from site/docs/v1.3.0/custom-plugins.md rename to site/content/docs/v1.3.0/custom-plugins.md index 564dfd5b7..0451bbd63 100644 --- a/site/docs/v1.3.0/custom-plugins.md +++ b/site/content/docs/v1.3.0/custom-plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v1.3.2/customize-installation.md b/site/content/docs/v1.3.0/customize-installation.md similarity index 99% rename from site/docs/v1.3.2/customize-installation.md rename to site/content/docs/v1.3.0/customize-installation.md index 32842a82b..9928c0944 100644 --- a/site/docs/v1.3.2/customize-installation.md +++ b/site/content/docs/v1.3.0/customize-installation.md @@ -1,4 +1,7 @@ -# Customize Velero Install +--- +title: "Customize Velero Install" +layout: docs +--- - [Customize Velero Install](#customize-velero-install) - [Plugins](#plugins) diff --git a/site/content/docs/v1.3.0/debugging-install.md b/site/content/docs/v1.3.0/debugging-install.md new file mode 100644 index 000000000..9c2067b34 --- /dev/null +++ b/site/content/docs/v1.3.0/debugging-install.md @@ -0,0 +1,74 @@ +--- +title: "Debugging Installation Issues" +layout: docs +--- + +## General + +### `invalid configuration: no configuration has been provided` +This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the +following locations: +* the path specified by the `--kubeconfig` flag, if any +* the path specified by the `$KUBECONFIG` environment variable, if any +* `~/.kube/config` + +### Backups or restores stuck in `New` phase +This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: +``` +kubectl -n velero describe pods +kubectl -n velero logs deployment/velero +``` + + +## AWS + +### `NoCredentialProviders: no valid providers in chain` + +#### Using credentials +This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `credentials-velero` file is formatted properly and has the correct values: + + ``` + [default] + aws_access_key_id= + aws_secret_access_key= + ``` + +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +#### Using kube2iam +This means that Velero can't read the content of the S3 bucket. Ensure the following: + +* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. +* The new Velero role has all the permissions listed in the documentation regarding S3. + + +## Azure + +### `Failed to refresh the Token` or `adal: Refresh request failed` +This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted +properly into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + + +## GCE/GKE + +### `open credentials/cloud: no such file or directory` +This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +[0]: azure-config.md#create-service-principal diff --git a/site/content/docs/v1.3.0/debugging-restores.md b/site/content/docs/v1.3.0/debugging-restores.md new file mode 100644 index 000000000..eb834b0bc --- /dev/null +++ b/site/content/docs/v1.3.0/debugging-restores.md @@ -0,0 +1,109 @@ +--- +title: "Debugging Restores" +layout: docs +--- + +* [Example][0] +* [Structure][1] + +## Example + +When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: + +``` +NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR +backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT +backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT +backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT +backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT +``` + +To delve into the warnings and errors into more detail, you can use `velero restore describe`: + +```bash +velero restore describe backup-test-20170726180512 +``` + +The output looks like this: + +``` +Name: backup-test-20170726180512 +Namespace: velero +Labels: +Annotations: + +Backup: backup-test + +Namespaces: + Included: * + Excluded: + +Resources: + Included: serviceaccounts + Excluded: nodes, events, events.events.k8s.io + Cluster-scoped: auto + +Namespace mappings: + +Label selector: + +Restore PVs: auto + +Phase: Completed + +Validation errors: + +Warnings: + Velero: + Cluster: + Namespaces: + velero: serviceaccounts "velero" already exists + serviceaccounts "default" already exists + kube-public: serviceaccounts "default" already exists + kube-system: serviceaccounts "attachdetach-controller" already exists + serviceaccounts "certificate-controller" already exists + serviceaccounts "cronjob-controller" already exists + serviceaccounts "daemon-set-controller" already exists + serviceaccounts "default" already exists + serviceaccounts "deployment-controller" already exists + serviceaccounts "disruption-controller" already exists + serviceaccounts "endpoint-controller" already exists + serviceaccounts "generic-garbage-collector" already exists + serviceaccounts "horizontal-pod-autoscaler" already exists + serviceaccounts "job-controller" already exists + serviceaccounts "kube-dns" already exists + serviceaccounts "namespace-controller" already exists + serviceaccounts "node-controller" already exists + serviceaccounts "persistent-volume-binder" already exists + serviceaccounts "pod-garbage-collector" already exists + serviceaccounts "replicaset-controller" already exists + serviceaccounts "replication-controller" already exists + serviceaccounts "resourcequota-controller" already exists + serviceaccounts "service-account-controller" already exists + serviceaccounts "service-controller" already exists + serviceaccounts "statefulset-controller" already exists + serviceaccounts "ttl-controller" already exists + default: serviceaccounts "default" already exists + +Errors: + Velero: + Cluster: + Namespaces: +``` + +## Structure + +Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the +restore looks "normal" and all resources referenced in the backup exist in some form, although some +of them may have been pre-existing). + +Both errors and warnings are structured in the same way: + +* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). + +* `Cluster`: A list of issues related to the restore of cluster-scoped resources. + +* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. + +[0]: #example +[1]: #structure diff --git a/site/docs/v1.3.1/development.md b/site/content/docs/v1.3.0/development.md similarity index 94% rename from site/docs/v1.3.1/development.md rename to site/content/docs/v1.3.0/development.md index cf3b3c4fc..c805a27da 100644 --- a/site/docs/v1.3.1/development.md +++ b/site/content/docs/v1.3.0/development.md @@ -1,4 +1,7 @@ -# Development +--- +title: "Development " +layout: docs +--- ## Update generated files diff --git a/site/docs/v1.2.0/disaster-case.md b/site/content/docs/v1.3.0/disaster-case.md similarity index 96% rename from site/docs/v1.2.0/disaster-case.md rename to site/content/docs/v1.3.0/disaster-case.md index 88f61e7c7..8fa82f73c 100644 --- a/site/docs/v1.2.0/disaster-case.md +++ b/site/content/docs/v1.3.0/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/docs/v1.2.0/examples.md b/site/content/docs/v1.3.0/examples.md similarity index 97% rename from site/docs/v1.2.0/examples.md rename to site/content/docs/v1.3.0/examples.md index 40b284ec3..c73ae2b23 100644 --- a/site/docs/v1.2.0/examples.md +++ b/site/content/docs/v1.3.0/examples.md @@ -1,4 +1,7 @@ -## Examples +--- +title: "Examples" +layout: docs +--- After you set up the Velero server, try these examples: diff --git a/site/docs/v1.3.0/faq.md b/site/content/docs/v1.3.0/faq.md similarity index 98% rename from site/docs/v1.3.0/faq.md rename to site/content/docs/v1.3.0/faq.md index 7402489fa..c42d1e9f1 100644 --- a/site/docs/v1.3.0/faq.md +++ b/site/content/docs/v1.3.0/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v1.3.0/hooks.md b/site/content/docs/v1.3.0/hooks.md similarity index 99% rename from site/docs/v1.3.0/hooks.md rename to site/content/docs/v1.3.0/hooks.md index 46c568fb5..2477a6f5a 100644 --- a/site/docs/v1.3.0/hooks.md +++ b/site/content/docs/v1.3.0/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.3.1/how-velero-works.md b/site/content/docs/v1.3.0/how-velero-works.md similarity index 99% rename from site/docs/v1.3.1/how-velero-works.md rename to site/content/docs/v1.3.0/how-velero-works.md index 85febb1df..44013c5b0 100644 --- a/site/docs/v1.3.1/how-velero-works.md +++ b/site/content/docs/v1.3.0/how-velero-works.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v1.2.0/image-tagging.md b/site/content/docs/v1.3.0/image-tagging.md similarity index 91% rename from site/docs/v1.2.0/image-tagging.md rename to site/content/docs/v1.3.0/image-tagging.md index b0080ef1c..fbfb15617 100644 --- a/site/docs/v1.2.0/image-tagging.md +++ b/site/content/docs/v1.3.0/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/v1.3.0/img/README.md b/site/content/docs/v1.3.0/img/README.md similarity index 100% rename from site/docs/v1.3.0/img/README.md rename to site/content/docs/v1.3.0/img/README.md diff --git a/site/docs/v1.3.0/img/backup-process.png b/site/content/docs/v1.3.0/img/backup-process.png similarity index 100% rename from site/docs/v1.3.0/img/backup-process.png rename to site/content/docs/v1.3.0/img/backup-process.png diff --git a/site/docs/v1.3.0/img/velero.png b/site/content/docs/v1.3.0/img/velero.png similarity index 100% rename from site/docs/v1.3.0/img/velero.png rename to site/content/docs/v1.3.0/img/velero.png diff --git a/site/docs/v1.2.0/locations.md b/site/content/docs/v1.3.0/locations.md similarity index 98% rename from site/docs/v1.2.0/locations.md rename to site/content/docs/v1.3.0/locations.md index ca28239a7..b5d8ca3fc 100644 --- a/site/docs/v1.2.0/locations.md +++ b/site/content/docs/v1.3.0/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- ## Overview diff --git a/site/docs/v1.3.0/migration-case.md b/site/content/docs/v1.3.0/migration-case.md similarity index 97% rename from site/docs/v1.3.0/migration-case.md rename to site/content/docs/v1.3.0/migration-case.md index 41afcf9ef..f9abf7a40 100644 --- a/site/docs/v1.3.0/migration-case.md +++ b/site/content/docs/v1.3.0/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v1.3.2/namespace.md b/site/content/docs/v1.3.0/namespace.md similarity index 92% rename from site/docs/v1.3.2/namespace.md rename to site/content/docs/v1.3.0/namespace.md index 9a3d62808..14e2c6179 100644 --- a/site/docs/v1.3.2/namespace.md +++ b/site/content/docs/v1.3.0/namespace.md @@ -1,4 +1,7 @@ -# Run in a non-default namespace +--- +title: "Run in a non-default namespace" +layout: docs +--- The Velero installation and backups by default are run in the `velero` namespace. However, it is possible to use a different namespace. diff --git a/site/docs/v1.2.0/on-premises.md b/site/content/docs/v1.3.0/on-premises.md similarity index 96% rename from site/docs/v1.2.0/on-premises.md rename to site/content/docs/v1.3.0/on-premises.md index ec199287c..774252107 100644 --- a/site/docs/v1.2.0/on-premises.md +++ b/site/content/docs/v1.3.0/on-premises.md @@ -1,4 +1,7 @@ -# On-Premises Environments +--- +title: "On-Premises Environments" +layout: docs +--- You can run Velero in an on-premises cluster in different ways depending on your requirements. diff --git a/site/docs/v1.3.0/output-file-format.md b/site/content/docs/v1.3.0/output-file-format.md similarity index 98% rename from site/docs/v1.3.0/output-file-format.md rename to site/content/docs/v1.3.0/output-file-format.md index a4b462614..f96120530 100644 --- a/site/docs/v1.3.0/output-file-format.md +++ b/site/content/docs/v1.3.0/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/v1.3.1/overview-plugins.md b/site/content/docs/v1.3.0/overview-plugins.md similarity index 96% rename from site/docs/v1.3.1/overview-plugins.md rename to site/content/docs/v1.3.0/overview-plugins.md index 74eb3b0fb..037601d51 100644 --- a/site/docs/v1.3.1/overview-plugins.md +++ b/site/content/docs/v1.3.0/overview-plugins.md @@ -1,5 +1,7 @@ - -# Velero plugin system +--- +title: "Velero plugin system" +layout: docs +--- Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. diff --git a/site/content/docs/v1.3.0/rbac.md b/site/content/docs/v1.3.0/rbac.md new file mode 100644 index 000000000..a9c22b9f1 --- /dev/null +++ b/site/content/docs/v1.3.0/rbac.md @@ -0,0 +1,50 @@ +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- + +By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. + +**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. + +For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. + +## Set up Roles and RoleBindings + +Here's a sample Role and RoleBinding pair. + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + namespace: YOUR_NAMESPACE_HERE + name: ROLE_NAME_HERE + labels: + component: velero +rules: + - apiGroups: + - velero.io + verbs: + - "*" + resources: + - "*" +``` + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: ROLEBINDING_NAME_HERE +subjects: + - kind: ServiceAccount + name: YOUR_SERVICEACCOUNT_HERE +roleRef: + kind: Role + name: ROLE_NAME_HERE + apiGroup: rbac.authorization.k8s.io +``` + +[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ +[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ +[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +[4]: namespace.md diff --git a/site/docs/v1.3.0/release-instructions.md b/site/content/docs/v1.3.0/release-instructions.md similarity index 99% rename from site/docs/v1.3.0/release-instructions.md rename to site/content/docs/v1.3.0/release-instructions.md index 73481bb82..1a433ea19 100644 --- a/site/docs/v1.3.0/release-instructions.md +++ b/site/content/docs/v1.3.0/release-instructions.md @@ -1,4 +1,7 @@ -# Release Instructions +--- +title: "Release Instructions" +layout: docs +--- ## Ahead of Time diff --git a/site/docs/v1.2.0/restic.md b/site/content/docs/v1.3.0/restic.md similarity index 99% rename from site/docs/v1.2.0/restic.md rename to site/content/docs/v1.3.0/restic.md index b3c071b4d..9242ed2b4 100644 --- a/site/docs/v1.2.0/restic.md +++ b/site/content/docs/v1.3.0/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.3.0/restore-reference.md b/site/content/docs/v1.3.0/restore-reference.md similarity index 98% rename from site/docs/v1.3.0/restore-reference.md rename to site/content/docs/v1.3.0/restore-reference.md index 43c40a287..9a53b93ee 100644 --- a/site/docs/v1.3.0/restore-reference.md +++ b/site/content/docs/v1.3.0/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/docs/v1.2.0/run-locally.md b/site/content/docs/v1.3.0/run-locally.md similarity index 97% rename from site/docs/v1.2.0/run-locally.md rename to site/content/docs/v1.3.0/run-locally.md index 913cbc122..ffd735b4f 100644 --- a/site/docs/v1.2.0/run-locally.md +++ b/site/content/docs/v1.3.0/run-locally.md @@ -1,4 +1,7 @@ -# Run Velero locally in development +--- +title: "Run Velero locally in development" +layout: docs +--- Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server image and redeploy it to the cluster with each change. diff --git a/site/docs/v1.3.0/start-contributing.md b/site/content/docs/v1.3.0/start-contributing.md similarity index 96% rename from site/docs/v1.3.0/start-contributing.md rename to site/content/docs/v1.3.0/start-contributing.md index f221ac3b8..43088628b 100644 --- a/site/docs/v1.3.0/start-contributing.md +++ b/site/content/docs/v1.3.0/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/docs/v1.2.0/support-process.md b/site/content/docs/v1.3.0/support-process.md similarity index 98% rename from site/docs/v1.2.0/support-process.md rename to site/content/docs/v1.3.0/support-process.md index c4bdf82a0..fc06e72e9 100644 --- a/site/docs/v1.2.0/support-process.md +++ b/site/content/docs/v1.3.0/support-process.md @@ -1,4 +1,7 @@ -# Support Process +--- +title: "Support Process" +layout: docs +--- ## Weekly Rotation diff --git a/site/docs/v1.3.1/supported-providers.md b/site/content/docs/v1.3.0/supported-providers.md similarity index 99% rename from site/docs/v1.3.1/supported-providers.md rename to site/content/docs/v1.3.0/supported-providers.md index bcc0306aa..e832bb560 100644 --- a/site/docs/v1.3.1/supported-providers.md +++ b/site/content/docs/v1.3.0/supported-providers.md @@ -1,4 +1,7 @@ -# Providers +--- +title: "Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. Velero has a plugin system which allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/docs/v1.2.0/troubleshooting.md b/site/content/docs/v1.3.0/troubleshooting.md similarity index 99% rename from site/docs/v1.2.0/troubleshooting.md rename to site/content/docs/v1.3.0/troubleshooting.md index 984d8f714..6d0fa998f 100644 --- a/site/docs/v1.2.0/troubleshooting.md +++ b/site/content/docs/v1.3.0/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v1.3.0/uninstalling.md b/site/content/docs/v1.3.0/uninstalling.md similarity index 83% rename from site/docs/v1.3.0/uninstalling.md rename to site/content/docs/v1.3.0/uninstalling.md index 727bc1aa0..f0b7b8d17 100644 --- a/site/docs/v1.3.0/uninstalling.md +++ b/site/content/docs/v1.3.0/uninstalling.md @@ -1,4 +1,7 @@ -# Uninstalling Velero +--- +title: "Uninstalling Velero" +layout: docs +--- If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: diff --git a/site/docs/v1.3.0/upgrade-to-1.3.md b/site/content/docs/v1.3.0/upgrade-to-1.3.md similarity index 96% rename from site/docs/v1.3.0/upgrade-to-1.3.md rename to site/content/docs/v1.3.0/upgrade-to-1.3.md index 528852e25..e06c04173 100644 --- a/site/docs/v1.3.0/upgrade-to-1.3.md +++ b/site/content/docs/v1.3.0/upgrade-to-1.3.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.3 +--- +title: "Upgrading to Velero 1.3" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.2.0/velero-install.md b/site/content/docs/v1.3.0/velero-install.md similarity index 98% rename from site/docs/v1.2.0/velero-install.md rename to site/content/docs/v1.3.0/velero-install.md index 58718d16c..951cc9f11 100644 --- a/site/docs/v1.2.0/velero-install.md +++ b/site/content/docs/v1.3.0/velero-install.md @@ -1,4 +1,7 @@ -# Velero Install CLI +--- +title: "Velero Install CLI" +layout: docs +--- This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. diff --git a/site/content/docs/v1.3.0/vendoring-dependencies.md b/site/content/docs/v1.3.0/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.3.0/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.0/website-guidelines.md b/site/content/docs/v1.3.0/website-guidelines.md similarity index 96% rename from site/docs/v1.3.0/website-guidelines.md rename to site/content/docs/v1.3.0/website-guidelines.md index 0d6c115c5..58a3b7580 100644 --- a/site/docs/v1.3.0/website-guidelines.md +++ b/site/content/docs/v1.3.0/website-guidelines.md @@ -1,4 +1,7 @@ -# Website Guidelines +--- +title: "Website Guidelines" +layout: docs +--- ## Running the website locally diff --git a/site/docs/v1.3.1/zenhub.md b/site/content/docs/v1.3.0/zenhub.md similarity index 97% rename from site/docs/v1.3.1/zenhub.md rename to site/content/docs/v1.3.0/zenhub.md index 45298b3a2..a723fb184 100644 --- a/site/docs/v1.3.1/zenhub.md +++ b/site/content/docs/v1.3.0/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v1.3.1/README.md b/site/content/docs/v1.3.1/_index.md similarity index 98% rename from site/docs/v1.3.1/README.md rename to site/content/docs/v1.3.1/_index.md index 33fa84d96..9aa12aa72 100644 --- a/site/docs/v1.3.1/README.md +++ b/site/content/docs/v1.3.1/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.3.1 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/main/api-types/README.md b/site/content/docs/v1.3.1/api-types/README.md similarity index 88% rename from site/docs/main/api-types/README.md rename to site/content/docs/v1.3.1/api-types/README.md index 2ba83cc5e..54c23544d 100644 --- a/site/docs/main/api-types/README.md +++ b/site/content/docs/v1.3.1/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/content/docs/v1.3.1/api-types/backup.md b/site/content/docs/v1.3.1/api-types/backup.md new file mode 100644 index 000000000..2223081ae --- /dev/null +++ b/site/content/docs/v1.3.1/api-types/backup.md @@ -0,0 +1,146 @@ +--- +title: "Backup API Type" +layout: docs +--- + +## Use + +The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the +Velero Server immediately starts the backup process. + +## API GroupVersion + +Backup belongs to the API group version `velero.io/v1`. + +## Definition + +Here is a sample `Backup` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: velero.io/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Backup +# Standard Kubernetes metadata. Required. +metadata: + # Backup name. May be any valid Kubernetes object name. Required. + name: a + # Backup namespace. Must be the namespace of the Velero server. Required. + namespace: velero +# Parameters about the backup. Required. +spec: + # Array of namespaces to include in the backup. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the backup. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the backup. For example, if a + # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the backup. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and + # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as + # a persistent volume provider is configured for Velero. + snapshotVolumes: null + # Where to store the tarball and logs. + storageLocation: aws-primary + # The list of locations in which to store volume snapshots created for this backup. + volumeSnapshotLocations: + - aws-primary + - gcp-primary + # The amount of time before this backup is eligible for garbage collection. If not specified, + # a default value of 30 days will be used. The default can be configured on the velero server + # by passing the flag --default-backup-ttl. + ttl: 24h0m0s + # Actions to perform at different times during a backup. The only hook currently supported is + # executing a command in a container in a pod using the pod exec API. Optional. + hooks: + # Array of hooks that are applicable to specific resources. Optional. + resources: + - + # Name of the hook. Will be displayed in backup log. + name: my-hook + # Array of namespaces to which this hook applies. If unspecified, the hook applies to all + # namespaces. Optional. + includedNamespaces: + - '*' + # Array of namespaces to which this hook does not apply. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to which this hook applies. The only resource supported at this time is + # pods. + includedResources: + - pods + # Array of resources to which this hook does not apply. Optional. + excludedResources: [] + # This hook only applies to objects matching this label selector. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + pre: + - + # The type of hook. This must be "exec". + exec: + # The name of the container where the command will be executed. If unspecified, the + # first container in the pod will be used. Optional. + container: my-container + # The command to execute, specified as an array. Required. + command: + - /bin/uname + - -a + # How to handle an error executing the command. Valid values are Fail and Continue. + # Defaults to Fail. Optional. + onError: Fail + # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. + timeout: 10s + # An array of hooks to run after all custom actions and additional items have been + # processed. Currently only "exec" hooks are supported. + post: + # Same content as pre above. +# Status about the Backup. Users should not set any data here. +status: + # The version of this Backup. The only version currently supported is 1. + version: 1 + # The date and time when the Backup is eligible for garbage collection. + expiration: null + # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. + phase: "" + # An array of any validation errors encountered. + validationErrors: null + # Date/time when the backup started being processed. + startTimestamp: 2019-04-29T15:58:43Z + # Date/time when the backup finished being processed. + completionTimestamp: 2019-04-29T15:58:56Z + # Number of volume snapshots that Velero tried to create for this backup. + volumeSnapshotsAttempted: 2 + # Number of volume snapshots that Velero successfully created for this backup. + volumeSnapshotsCompleted: 1 + # Number of warnings that were logged by the backup. + warnings: 2 + # Number of errors that were logged by the backup. + errors: 0 + +``` diff --git a/site/docs/v1.2.0/api-types/backupstoragelocation.md b/site/content/docs/v1.3.1/api-types/backupstoragelocation.md similarity index 97% rename from site/docs/v1.2.0/api-types/backupstoragelocation.md rename to site/content/docs/v1.3.1/api-types/backupstoragelocation.md index cd11c49fe..c3a28c4f8 100644 --- a/site/docs/v1.2.0/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.3.1/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v1.3.0/api-types/restore.md b/site/content/docs/v1.3.1/api-types/restore.md similarity index 98% rename from site/docs/v1.3.0/api-types/restore.md rename to site/content/docs/v1.3.1/api-types/restore.md index 2044d4725..cc76e7f3a 100644 --- a/site/docs/v1.3.0/api-types/restore.md +++ b/site/content/docs/v1.3.1/api-types/restore.md @@ -1,4 +1,7 @@ -# Restore API Type +--- +title: "Restore API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.3.1/api-types/schedule.md b/site/content/docs/v1.3.1/api-types/schedule.md similarity index 99% rename from site/docs/v1.3.1/api-types/schedule.md rename to site/content/docs/v1.3.1/api-types/schedule.md index ec7e471a6..7b3139bf9 100644 --- a/site/docs/v1.3.1/api-types/schedule.md +++ b/site/content/docs/v1.3.1/api-types/schedule.md @@ -1,4 +1,7 @@ -# Schedule API Type +--- +title: "Schedule API Type" +layout: docs +--- ## Use diff --git a/site/docs/v1.3.0/api-types/volumesnapshotlocation.md b/site/content/docs/v1.3.1/api-types/volumesnapshotlocation.md similarity index 96% rename from site/docs/v1.3.0/api-types/volumesnapshotlocation.md rename to site/content/docs/v1.3.1/api-types/volumesnapshotlocation.md index 8f3588dcb..aef5f4053 100644 --- a/site/docs/v1.3.0/api-types/volumesnapshotlocation.md +++ b/site/content/docs/v1.3.1/api-types/volumesnapshotlocation.md @@ -1,4 +1,7 @@ -# Velero Volume Snapshot Location +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- ## Volume Snapshot Location diff --git a/site/docs/v1.2.0/backup-reference.md b/site/content/docs/v1.3.1/backup-reference.md similarity index 87% rename from site/docs/v1.2.0/backup-reference.md rename to site/content/docs/v1.3.1/backup-reference.md index 797230d67..6ea8df91c 100644 --- a/site/docs/v1.2.0/backup-reference.md +++ b/site/content/docs/v1.3.1/backup-reference.md @@ -1,4 +1,7 @@ -# Backup Reference +--- +title: "Backup Reference" +layout: docs +--- ## Exclude Specific Items from Backup diff --git a/site/docs/v1.3.0/basic-install.md b/site/content/docs/v1.3.1/basic-install.md similarity index 98% rename from site/docs/v1.3.0/basic-install.md rename to site/content/docs/v1.3.1/basic-install.md index fde47086f..7fdb5af3d 100644 --- a/site/docs/v1.3.0/basic-install.md +++ b/site/content/docs/v1.3.1/basic-install.md @@ -1,4 +1,7 @@ -# Basic Install +--- +title: "Basic Install" +layout: docs +--- - [Basic Install](#basic-install) - [Prerequisites](#prerequisites) diff --git a/site/docs/v1.2.0/build-from-source.md b/site/content/docs/v1.3.1/build-from-source.md similarity index 99% rename from site/docs/v1.2.0/build-from-source.md rename to site/content/docs/v1.3.1/build-from-source.md index 0536d8efd..6fbadc119 100644 --- a/site/docs/v1.2.0/build-from-source.md +++ b/site/content/docs/v1.3.1/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.3.1/code-standards.md b/site/content/docs/v1.3.1/code-standards.md similarity index 98% rename from site/docs/v1.3.1/code-standards.md rename to site/content/docs/v1.3.1/code-standards.md index 586a865fa..f76152a15 100644 --- a/site/docs/v1.3.1/code-standards.md +++ b/site/content/docs/v1.3.1/code-standards.md @@ -1,4 +1,7 @@ -# Code Standards +--- +title: "Code Standards" +layout: docs +--- ## Adding a changelog diff --git a/site/docs/v1.3.1/contributions/ibm-config.md b/site/content/docs/v1.3.1/contributions/ibm-config.md similarity index 98% rename from site/docs/v1.3.1/contributions/ibm-config.md rename to site/content/docs/v1.3.1/contributions/ibm-config.md index ea90167a3..299492bc0 100644 --- a/site/docs/v1.3.1/contributions/ibm-config.md +++ b/site/content/docs/v1.3.1/contributions/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v1.2.0/contributions/minio.md b/site/content/docs/v1.3.1/contributions/minio.md similarity index 99% rename from site/docs/v1.2.0/contributions/minio.md rename to site/content/docs/v1.3.1/contributions/minio.md index 2f4507633..b9c8c5110 100644 --- a/site/docs/v1.2.0/contributions/minio.md +++ b/site/content/docs/v1.3.1/contributions/minio.md @@ -1,4 +1,7 @@ -## Quick start evaluation install with Minio +--- +title: "Quick start evaluation install with Minio" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.3.1/contributions/oracle-config.md b/site/content/docs/v1.3.1/contributions/oracle-config.md similarity index 99% rename from site/docs/v1.3.1/contributions/oracle-config.md rename to site/content/docs/v1.3.1/contributions/oracle-config.md index 8cb97cd94..ad1bb32d8 100644 --- a/site/docs/v1.3.1/contributions/oracle-config.md +++ b/site/content/docs/v1.3.1/contributions/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.3.1/csi.md b/site/content/docs/v1.3.1/csi.md similarity index 93% rename from site/docs/v1.3.1/csi.md rename to site/content/docs/v1.3.1/csi.md index c9e37f699..a8f272a32 100644 --- a/site/docs/v1.3.1/csi.md +++ b/site/content/docs/v1.3.1/csi.md @@ -1,4 +1,7 @@ -# Container Storage Interface Snapshot Support in Velero +--- +title: "Container Storage Interface Snapshot Support in Velero" +layout: docs +--- _This feature is under development. Documentation may not be up-to-date and features may not work as expected._ diff --git a/site/docs/v1.3.1/custom-plugins.md b/site/content/docs/v1.3.1/custom-plugins.md similarity index 99% rename from site/docs/v1.3.1/custom-plugins.md rename to site/content/docs/v1.3.1/custom-plugins.md index 7688ca558..b9c21f31f 100644 --- a/site/docs/v1.3.1/custom-plugins.md +++ b/site/content/docs/v1.3.1/custom-plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v1.3.1/customize-installation.md b/site/content/docs/v1.3.1/customize-installation.md similarity index 99% rename from site/docs/v1.3.1/customize-installation.md rename to site/content/docs/v1.3.1/customize-installation.md index 32842a82b..9928c0944 100644 --- a/site/docs/v1.3.1/customize-installation.md +++ b/site/content/docs/v1.3.1/customize-installation.md @@ -1,4 +1,7 @@ -# Customize Velero Install +--- +title: "Customize Velero Install" +layout: docs +--- - [Customize Velero Install](#customize-velero-install) - [Plugins](#plugins) diff --git a/site/content/docs/v1.3.1/debugging-install.md b/site/content/docs/v1.3.1/debugging-install.md new file mode 100644 index 000000000..9c2067b34 --- /dev/null +++ b/site/content/docs/v1.3.1/debugging-install.md @@ -0,0 +1,74 @@ +--- +title: "Debugging Installation Issues" +layout: docs +--- + +## General + +### `invalid configuration: no configuration has been provided` +This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the +following locations: +* the path specified by the `--kubeconfig` flag, if any +* the path specified by the `$KUBECONFIG` environment variable, if any +* `~/.kube/config` + +### Backups or restores stuck in `New` phase +This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: +``` +kubectl -n velero describe pods +kubectl -n velero logs deployment/velero +``` + + +## AWS + +### `NoCredentialProviders: no valid providers in chain` + +#### Using credentials +This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `credentials-velero` file is formatted properly and has the correct values: + + ``` + [default] + aws_access_key_id= + aws_secret_access_key= + ``` + +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +#### Using kube2iam +This means that Velero can't read the content of the S3 bucket. Ensure the following: + +* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. +* The new Velero role has all the permissions listed in the documentation regarding S3. + + +## Azure + +### `Failed to refresh the Token` or `adal: Refresh request failed` +This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted +properly into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + + +## GCE/GKE + +### `open credentials/cloud: no such file or directory` +This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +[0]: azure-config.md#create-service-principal diff --git a/site/content/docs/v1.3.1/debugging-restores.md b/site/content/docs/v1.3.1/debugging-restores.md new file mode 100644 index 000000000..eb834b0bc --- /dev/null +++ b/site/content/docs/v1.3.1/debugging-restores.md @@ -0,0 +1,109 @@ +--- +title: "Debugging Restores" +layout: docs +--- + +* [Example][0] +* [Structure][1] + +## Example + +When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: + +``` +NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR +backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT +backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT +backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT +backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT +``` + +To delve into the warnings and errors into more detail, you can use `velero restore describe`: + +```bash +velero restore describe backup-test-20170726180512 +``` + +The output looks like this: + +``` +Name: backup-test-20170726180512 +Namespace: velero +Labels: +Annotations: + +Backup: backup-test + +Namespaces: + Included: * + Excluded: + +Resources: + Included: serviceaccounts + Excluded: nodes, events, events.events.k8s.io + Cluster-scoped: auto + +Namespace mappings: + +Label selector: + +Restore PVs: auto + +Phase: Completed + +Validation errors: + +Warnings: + Velero: + Cluster: + Namespaces: + velero: serviceaccounts "velero" already exists + serviceaccounts "default" already exists + kube-public: serviceaccounts "default" already exists + kube-system: serviceaccounts "attachdetach-controller" already exists + serviceaccounts "certificate-controller" already exists + serviceaccounts "cronjob-controller" already exists + serviceaccounts "daemon-set-controller" already exists + serviceaccounts "default" already exists + serviceaccounts "deployment-controller" already exists + serviceaccounts "disruption-controller" already exists + serviceaccounts "endpoint-controller" already exists + serviceaccounts "generic-garbage-collector" already exists + serviceaccounts "horizontal-pod-autoscaler" already exists + serviceaccounts "job-controller" already exists + serviceaccounts "kube-dns" already exists + serviceaccounts "namespace-controller" already exists + serviceaccounts "node-controller" already exists + serviceaccounts "persistent-volume-binder" already exists + serviceaccounts "pod-garbage-collector" already exists + serviceaccounts "replicaset-controller" already exists + serviceaccounts "replication-controller" already exists + serviceaccounts "resourcequota-controller" already exists + serviceaccounts "service-account-controller" already exists + serviceaccounts "service-controller" already exists + serviceaccounts "statefulset-controller" already exists + serviceaccounts "ttl-controller" already exists + default: serviceaccounts "default" already exists + +Errors: + Velero: + Cluster: + Namespaces: +``` + +## Structure + +Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the +restore looks "normal" and all resources referenced in the backup exist in some form, although some +of them may have been pre-existing). + +Both errors and warnings are structured in the same way: + +* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). + +* `Cluster`: A list of issues related to the restore of cluster-scoped resources. + +* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. + +[0]: #example +[1]: #structure diff --git a/site/docs/v1.3.2/development.md b/site/content/docs/v1.3.1/development.md similarity index 94% rename from site/docs/v1.3.2/development.md rename to site/content/docs/v1.3.1/development.md index cf3b3c4fc..c805a27da 100644 --- a/site/docs/v1.3.2/development.md +++ b/site/content/docs/v1.3.1/development.md @@ -1,4 +1,7 @@ -# Development +--- +title: "Development " +layout: docs +--- ## Update generated files diff --git a/site/docs/v1.1.0/disaster-case.md b/site/content/docs/v1.3.1/disaster-case.md similarity index 96% rename from site/docs/v1.1.0/disaster-case.md rename to site/content/docs/v1.3.1/disaster-case.md index 88f61e7c7..8fa82f73c 100644 --- a/site/docs/v1.1.0/disaster-case.md +++ b/site/content/docs/v1.3.1/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/docs/v1.3.0/examples.md b/site/content/docs/v1.3.1/examples.md similarity index 97% rename from site/docs/v1.3.0/examples.md rename to site/content/docs/v1.3.1/examples.md index 40b284ec3..c73ae2b23 100644 --- a/site/docs/v1.3.0/examples.md +++ b/site/content/docs/v1.3.1/examples.md @@ -1,4 +1,7 @@ -## Examples +--- +title: "Examples" +layout: docs +--- After you set up the Velero server, try these examples: diff --git a/site/docs/v1.3.1/faq.md b/site/content/docs/v1.3.1/faq.md similarity index 98% rename from site/docs/v1.3.1/faq.md rename to site/content/docs/v1.3.1/faq.md index d9e1b2ad7..e65fa2eec 100644 --- a/site/docs/v1.3.1/faq.md +++ b/site/content/docs/v1.3.1/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v1.3.1/hooks.md b/site/content/docs/v1.3.1/hooks.md similarity index 99% rename from site/docs/v1.3.1/hooks.md rename to site/content/docs/v1.3.1/hooks.md index 98e00f071..18c16c1e9 100644 --- a/site/docs/v1.3.1/hooks.md +++ b/site/content/docs/v1.3.1/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.3.0/how-velero-works.md b/site/content/docs/v1.3.1/how-velero-works.md similarity index 99% rename from site/docs/v1.3.0/how-velero-works.md rename to site/content/docs/v1.3.1/how-velero-works.md index 85febb1df..44013c5b0 100644 --- a/site/docs/v1.3.0/how-velero-works.md +++ b/site/content/docs/v1.3.1/how-velero-works.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/docs/v1.3.1/image-tagging.md b/site/content/docs/v1.3.1/image-tagging.md similarity index 91% rename from site/docs/v1.3.1/image-tagging.md rename to site/content/docs/v1.3.1/image-tagging.md index b0080ef1c..fbfb15617 100644 --- a/site/docs/v1.3.1/image-tagging.md +++ b/site/content/docs/v1.3.1/image-tagging.md @@ -1,4 +1,7 @@ -# Image tagging policy +--- +title: "Image tagging policy" +layout: docs +--- This document describes Velero's image tagging policy. diff --git a/site/docs/v1.3.1/img/README.md b/site/content/docs/v1.3.1/img/README.md similarity index 100% rename from site/docs/v1.3.1/img/README.md rename to site/content/docs/v1.3.1/img/README.md diff --git a/site/docs/v1.3.1/img/backup-process.png b/site/content/docs/v1.3.1/img/backup-process.png similarity index 100% rename from site/docs/v1.3.1/img/backup-process.png rename to site/content/docs/v1.3.1/img/backup-process.png diff --git a/site/docs/v1.3.1/img/velero.png b/site/content/docs/v1.3.1/img/velero.png similarity index 100% rename from site/docs/v1.3.1/img/velero.png rename to site/content/docs/v1.3.1/img/velero.png diff --git a/site/docs/v1.3.1/locations.md b/site/content/docs/v1.3.1/locations.md similarity index 98% rename from site/docs/v1.3.1/locations.md rename to site/content/docs/v1.3.1/locations.md index ca28239a7..b5d8ca3fc 100644 --- a/site/docs/v1.3.1/locations.md +++ b/site/content/docs/v1.3.1/locations.md @@ -1,4 +1,7 @@ -# Backup Storage Locations and Volume Snapshot Locations +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- ## Overview diff --git a/site/docs/v1.3.1/migration-case.md b/site/content/docs/v1.3.1/migration-case.md similarity index 97% rename from site/docs/v1.3.1/migration-case.md rename to site/content/docs/v1.3.1/migration-case.md index 41afcf9ef..f9abf7a40 100644 --- a/site/docs/v1.3.1/migration-case.md +++ b/site/content/docs/v1.3.1/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v1.3.0/namespace.md b/site/content/docs/v1.3.1/namespace.md similarity index 92% rename from site/docs/v1.3.0/namespace.md rename to site/content/docs/v1.3.1/namespace.md index 9a3d62808..14e2c6179 100644 --- a/site/docs/v1.3.0/namespace.md +++ b/site/content/docs/v1.3.1/namespace.md @@ -1,4 +1,7 @@ -# Run in a non-default namespace +--- +title: "Run in a non-default namespace" +layout: docs +--- The Velero installation and backups by default are run in the `velero` namespace. However, it is possible to use a different namespace. diff --git a/site/docs/v1.3.0/on-premises.md b/site/content/docs/v1.3.1/on-premises.md similarity index 96% rename from site/docs/v1.3.0/on-premises.md rename to site/content/docs/v1.3.1/on-premises.md index ec199287c..774252107 100644 --- a/site/docs/v1.3.0/on-premises.md +++ b/site/content/docs/v1.3.1/on-premises.md @@ -1,4 +1,7 @@ -# On-Premises Environments +--- +title: "On-Premises Environments" +layout: docs +--- You can run Velero in an on-premises cluster in different ways depending on your requirements. diff --git a/site/docs/v1.3.1/output-file-format.md b/site/content/docs/v1.3.1/output-file-format.md similarity index 98% rename from site/docs/v1.3.1/output-file-format.md rename to site/content/docs/v1.3.1/output-file-format.md index a4b462614..f96120530 100644 --- a/site/docs/v1.3.1/output-file-format.md +++ b/site/content/docs/v1.3.1/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/docs/v1.2.0/overview-plugins.md b/site/content/docs/v1.3.1/overview-plugins.md similarity index 96% rename from site/docs/v1.2.0/overview-plugins.md rename to site/content/docs/v1.3.1/overview-plugins.md index 74eb3b0fb..037601d51 100644 --- a/site/docs/v1.2.0/overview-plugins.md +++ b/site/content/docs/v1.3.1/overview-plugins.md @@ -1,5 +1,7 @@ - -# Velero plugin system +--- +title: "Velero plugin system" +layout: docs +--- Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. diff --git a/site/content/docs/v1.3.1/rbac.md b/site/content/docs/v1.3.1/rbac.md new file mode 100644 index 000000000..a9c22b9f1 --- /dev/null +++ b/site/content/docs/v1.3.1/rbac.md @@ -0,0 +1,50 @@ +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- + +By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. + +**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. + +For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. + +## Set up Roles and RoleBindings + +Here's a sample Role and RoleBinding pair. + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + namespace: YOUR_NAMESPACE_HERE + name: ROLE_NAME_HERE + labels: + component: velero +rules: + - apiGroups: + - velero.io + verbs: + - "*" + resources: + - "*" +``` + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: ROLEBINDING_NAME_HERE +subjects: + - kind: ServiceAccount + name: YOUR_SERVICEACCOUNT_HERE +roleRef: + kind: Role + name: ROLE_NAME_HERE + apiGroup: rbac.authorization.k8s.io +``` + +[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ +[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ +[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +[4]: namespace.md diff --git a/site/docs/v1.3.2/release-instructions.md b/site/content/docs/v1.3.1/release-instructions.md similarity index 99% rename from site/docs/v1.3.2/release-instructions.md rename to site/content/docs/v1.3.1/release-instructions.md index 73481bb82..1a433ea19 100644 --- a/site/docs/v1.3.2/release-instructions.md +++ b/site/content/docs/v1.3.1/release-instructions.md @@ -1,4 +1,7 @@ -# Release Instructions +--- +title: "Release Instructions" +layout: docs +--- ## Ahead of Time diff --git a/site/docs/v1.3.2/restic.md b/site/content/docs/v1.3.1/restic.md similarity index 99% rename from site/docs/v1.3.2/restic.md rename to site/content/docs/v1.3.1/restic.md index 03056030a..3aaf9e026 100644 --- a/site/docs/v1.3.2/restic.md +++ b/site/content/docs/v1.3.1/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.3.2/restore-reference.md b/site/content/docs/v1.3.1/restore-reference.md similarity index 98% rename from site/docs/v1.3.2/restore-reference.md rename to site/content/docs/v1.3.1/restore-reference.md index 43c40a287..9a53b93ee 100644 --- a/site/docs/v1.3.2/restore-reference.md +++ b/site/content/docs/v1.3.1/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/docs/v1.3.0/run-locally.md b/site/content/docs/v1.3.1/run-locally.md similarity index 97% rename from site/docs/v1.3.0/run-locally.md rename to site/content/docs/v1.3.1/run-locally.md index 913cbc122..ffd735b4f 100644 --- a/site/docs/v1.3.0/run-locally.md +++ b/site/content/docs/v1.3.1/run-locally.md @@ -1,4 +1,7 @@ -# Run Velero locally in development +--- +title: "Run Velero locally in development" +layout: docs +--- Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server image and redeploy it to the cluster with each change. diff --git a/site/docs/v1.3.1/start-contributing.md b/site/content/docs/v1.3.1/start-contributing.md similarity index 96% rename from site/docs/v1.3.1/start-contributing.md rename to site/content/docs/v1.3.1/start-contributing.md index 5b7e25b0d..8691cf418 100644 --- a/site/docs/v1.3.1/start-contributing.md +++ b/site/content/docs/v1.3.1/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/docs/v1.3.1/support-process.md b/site/content/docs/v1.3.1/support-process.md similarity index 98% rename from site/docs/v1.3.1/support-process.md rename to site/content/docs/v1.3.1/support-process.md index c4bdf82a0..fc06e72e9 100644 --- a/site/docs/v1.3.1/support-process.md +++ b/site/content/docs/v1.3.1/support-process.md @@ -1,4 +1,7 @@ -# Support Process +--- +title: "Support Process" +layout: docs +--- ## Weekly Rotation diff --git a/site/docs/v1.2.0/supported-providers.md b/site/content/docs/v1.3.1/supported-providers.md similarity index 99% rename from site/docs/v1.2.0/supported-providers.md rename to site/content/docs/v1.3.1/supported-providers.md index bcc0306aa..e832bb560 100644 --- a/site/docs/v1.2.0/supported-providers.md +++ b/site/content/docs/v1.3.1/supported-providers.md @@ -1,4 +1,7 @@ -# Providers +--- +title: "Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. Velero has a plugin system which allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/docs/v1.3.1/troubleshooting.md b/site/content/docs/v1.3.1/troubleshooting.md similarity index 99% rename from site/docs/v1.3.1/troubleshooting.md rename to site/content/docs/v1.3.1/troubleshooting.md index 984d8f714..6d0fa998f 100644 --- a/site/docs/v1.3.1/troubleshooting.md +++ b/site/content/docs/v1.3.1/troubleshooting.md @@ -1,4 +1,7 @@ -# Troubleshooting +--- +title: "Troubleshooting" +layout: docs +--- These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. diff --git a/site/docs/v1.3.1/uninstalling.md b/site/content/docs/v1.3.1/uninstalling.md similarity index 83% rename from site/docs/v1.3.1/uninstalling.md rename to site/content/docs/v1.3.1/uninstalling.md index 727bc1aa0..f0b7b8d17 100644 --- a/site/docs/v1.3.1/uninstalling.md +++ b/site/content/docs/v1.3.1/uninstalling.md @@ -1,4 +1,7 @@ -# Uninstalling Velero +--- +title: "Uninstalling Velero" +layout: docs +--- If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: diff --git a/site/docs/v1.3.1/upgrade-to-1.3.md b/site/content/docs/v1.3.1/upgrade-to-1.3.md similarity index 96% rename from site/docs/v1.3.1/upgrade-to-1.3.md rename to site/content/docs/v1.3.1/upgrade-to-1.3.md index 01992fe45..bc7b5adf7 100644 --- a/site/docs/v1.3.1/upgrade-to-1.3.md +++ b/site/content/docs/v1.3.1/upgrade-to-1.3.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.3 +--- +title: "Upgrading to Velero 1.3" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.3.2/velero-install.md b/site/content/docs/v1.3.1/velero-install.md similarity index 98% rename from site/docs/v1.3.2/velero-install.md rename to site/content/docs/v1.3.1/velero-install.md index 58718d16c..951cc9f11 100644 --- a/site/docs/v1.3.2/velero-install.md +++ b/site/content/docs/v1.3.1/velero-install.md @@ -1,4 +1,7 @@ -# Velero Install CLI +--- +title: "Velero Install CLI" +layout: docs +--- This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. diff --git a/site/content/docs/v1.3.1/vendoring-dependencies.md b/site/content/docs/v1.3.1/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.3.1/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.1/website-guidelines.md b/site/content/docs/v1.3.1/website-guidelines.md similarity index 96% rename from site/docs/v1.3.1/website-guidelines.md rename to site/content/docs/v1.3.1/website-guidelines.md index bfd7eb79f..0edc930ea 100644 --- a/site/docs/v1.3.1/website-guidelines.md +++ b/site/content/docs/v1.3.1/website-guidelines.md @@ -1,4 +1,7 @@ -# Website Guidelines +--- +title: "Website Guidelines" +layout: docs +--- ## Running the website locally diff --git a/site/docs/v1.2.0/zenhub.md b/site/content/docs/v1.3.1/zenhub.md similarity index 97% rename from site/docs/v1.2.0/zenhub.md rename to site/content/docs/v1.3.1/zenhub.md index 45298b3a2..a723fb184 100644 --- a/site/docs/v1.2.0/zenhub.md +++ b/site/content/docs/v1.3.1/zenhub.md @@ -1,4 +1,7 @@ -# ZenHub +--- +title: "ZenHub" +layout: docs +--- As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. diff --git a/site/docs/v1.3.2/README.md b/site/content/docs/v1.3.2/_index.md similarity index 98% rename from site/docs/v1.3.2/README.md rename to site/content/docs/v1.3.2/_index.md index 824fad314..083cc3906 100644 --- a/site/docs/v1.3.2/README.md +++ b/site/content/docs/v1.3.2/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.3.2 +--- ![100] [![Build Status][1]][2] diff --git a/site/docs/v1.3.2/api-types/README.md b/site/content/docs/v1.3.2/api-types/README.md similarity index 88% rename from site/docs/v1.3.2/api-types/README.md rename to site/content/docs/v1.3.2/api-types/README.md index 2ba83cc5e..54c23544d 100644 --- a/site/docs/v1.3.2/api-types/README.md +++ b/site/content/docs/v1.3.2/api-types/README.md @@ -1,4 +1,7 @@ -# Table of Contents +--- +title: "Table of Contents" +layout: docs +--- ## API types diff --git a/site/content/docs/v1.3.2/api-types/backup.md b/site/content/docs/v1.3.2/api-types/backup.md new file mode 100644 index 000000000..2223081ae --- /dev/null +++ b/site/content/docs/v1.3.2/api-types/backup.md @@ -0,0 +1,146 @@ +--- +title: "Backup API Type" +layout: docs +--- + +## Use + +The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the +Velero Server immediately starts the backup process. + +## API GroupVersion + +Backup belongs to the API group version `velero.io/v1`. + +## Definition + +Here is a sample `Backup` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: velero.io/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Backup +# Standard Kubernetes metadata. Required. +metadata: + # Backup name. May be any valid Kubernetes object name. Required. + name: a + # Backup namespace. Must be the namespace of the Velero server. Required. + namespace: velero +# Parameters about the backup. Required. +spec: + # Array of namespaces to include in the backup. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the backup. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the backup. For example, if a + # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the backup. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and + # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as + # a persistent volume provider is configured for Velero. + snapshotVolumes: null + # Where to store the tarball and logs. + storageLocation: aws-primary + # The list of locations in which to store volume snapshots created for this backup. + volumeSnapshotLocations: + - aws-primary + - gcp-primary + # The amount of time before this backup is eligible for garbage collection. If not specified, + # a default value of 30 days will be used. The default can be configured on the velero server + # by passing the flag --default-backup-ttl. + ttl: 24h0m0s + # Actions to perform at different times during a backup. The only hook currently supported is + # executing a command in a container in a pod using the pod exec API. Optional. + hooks: + # Array of hooks that are applicable to specific resources. Optional. + resources: + - + # Name of the hook. Will be displayed in backup log. + name: my-hook + # Array of namespaces to which this hook applies. If unspecified, the hook applies to all + # namespaces. Optional. + includedNamespaces: + - '*' + # Array of namespaces to which this hook does not apply. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to which this hook applies. The only resource supported at this time is + # pods. + includedResources: + - pods + # Array of resources to which this hook does not apply. Optional. + excludedResources: [] + # This hook only applies to objects matching this label selector. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + pre: + - + # The type of hook. This must be "exec". + exec: + # The name of the container where the command will be executed. If unspecified, the + # first container in the pod will be used. Optional. + container: my-container + # The command to execute, specified as an array. Required. + command: + - /bin/uname + - -a + # How to handle an error executing the command. Valid values are Fail and Continue. + # Defaults to Fail. Optional. + onError: Fail + # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. + timeout: 10s + # An array of hooks to run after all custom actions and additional items have been + # processed. Currently only "exec" hooks are supported. + post: + # Same content as pre above. +# Status about the Backup. Users should not set any data here. +status: + # The version of this Backup. The only version currently supported is 1. + version: 1 + # The date and time when the Backup is eligible for garbage collection. + expiration: null + # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. + phase: "" + # An array of any validation errors encountered. + validationErrors: null + # Date/time when the backup started being processed. + startTimestamp: 2019-04-29T15:58:43Z + # Date/time when the backup finished being processed. + completionTimestamp: 2019-04-29T15:58:56Z + # Number of volume snapshots that Velero tried to create for this backup. + volumeSnapshotsAttempted: 2 + # Number of volume snapshots that Velero successfully created for this backup. + volumeSnapshotsCompleted: 1 + # Number of warnings that were logged by the backup. + warnings: 2 + # Number of errors that were logged by the backup. + errors: 0 + +``` diff --git a/site/docs/v1.3.1/api-types/backupstoragelocation.md b/site/content/docs/v1.3.2/api-types/backupstoragelocation.md similarity index 97% rename from site/docs/v1.3.1/api-types/backupstoragelocation.md rename to site/content/docs/v1.3.2/api-types/backupstoragelocation.md index cd11c49fe..c3a28c4f8 100644 --- a/site/docs/v1.3.1/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.3.2/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/docs/v1.3.2/api-types/restore.md b/site/content/docs/v1.3.2/api-types/restore.md similarity index 98% rename from site/docs/v1.3.2/api-types/restore.md rename to site/content/docs/v1.3.2/api-types/restore.md index 2044d4725..cc76e7f3a 100644 --- a/site/docs/v1.3.2/api-types/restore.md +++ b/site/content/docs/v1.3.2/api-types/restore.md @@ -1,4 +1,7 @@ -# Restore API Type +--- +title: "Restore API Type" +layout: docs +--- ## Use diff --git a/site/content/docs/v1.3.2/api-types/schedule.md b/site/content/docs/v1.3.2/api-types/schedule.md new file mode 100644 index 000000000..7b3139bf9 --- /dev/null +++ b/site/content/docs/v1.3.2/api-types/schedule.md @@ -0,0 +1,135 @@ +--- +title: "Schedule API Type" +layout: docs +--- + +## Use + +The `Schedule` API type is used as a repeatable request for the Velero server to perform a backup for a given cron notation. Once created, the +Velero Server will start the backup process. It will then wait for the next valid point of the given cron expression and execute the backup +process on a repeating basis. + +## API GroupVersion + +Schedule belongs to the API group version `velero.io/v1`. + +## Definition + +Here is a sample `Schedule` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: velero.io/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Schedule +# Standard Kubernetes metadata. Required. +metadata: + # Schedule name. May be any valid Kubernetes object name. Required. + name: a + # Schedule namespace. Must be the namespace of the Velero server. Required. + namespace: velero +# Parameters about the scheduled backup. Required. +spec: + # Schedule is a Cron expression defining when to run the Backup + schedule: 0 7 * * * + # Template is the spec that should be used for each backup triggered by this schedule. + template: + # Array of namespaces to include in the scheduled backup. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the scheduled backup. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the scheduled backup. For example, if a + # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the scheduled backup. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and + # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as + # a persistent volume provider is configured for Velero. + snapshotVolumes: null + # Where to store the tarball and logs. + storageLocation: aws-primary + # The list of locations in which to store volume snapshots created for backups under this schedule. + volumeSnapshotLocations: + - aws-primary + - gcp-primary + # The amount of time before backups created on this schedule are eligible for garbage collection. If not specified, + # a default value of 30 days will be used. The default can be configured on the velero server + # by passing the flag --default-backup-ttl. + ttl: 24h0m0s + # Actions to perform at different times during a backup. The only hook currently supported is + # executing a command in a container in a pod using the pod exec API. Optional. + hooks: + # Array of hooks that are applicable to specific resources. Optional. + resources: + - + # Name of the hook. Will be displayed in backup log. + name: my-hook + # Array of namespaces to which this hook applies. If unspecified, the hook applies to all + # namespaces. Optional. + includedNamespaces: + - '*' + # Array of namespaces to which this hook does not apply. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to which this hook applies. The only resource supported at this time is + # pods. + includedResources: + - pods + # Array of resources to which this hook does not apply. Optional. + excludedResources: [] + # This hook only applies to objects matching this label selector. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + pre: + - + # The type of hook. This must be "exec". + exec: + # The name of the container where the command will be executed. If unspecified, the + # first container in the pod will be used. Optional. + container: my-container + # The command to execute, specified as an array. Required. + command: + - /bin/uname + - -a + # How to handle an error executing the command. Valid values are Fail and Continue. + # Defaults to Fail. Optional. + onError: Fail + # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. + timeout: 10s + # An array of hooks to run after all custom actions and additional items have been + # processed. Currently only "exec" hooks are supported. + post: + # Same content as pre above. +status: + # The current phase of the latest scheduled backup. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. + phase: "" + # Date/time of the last backup for a given schedule + lastBackup: + # An array of any validation errors encountered. + validationErrors: +``` diff --git a/site/content/docs/v1.3.2/api-types/volumesnapshotlocation.md b/site/content/docs/v1.3.2/api-types/volumesnapshotlocation.md new file mode 100644 index 000000000..aef5f4053 --- /dev/null +++ b/site/content/docs/v1.3.2/api-types/volumesnapshotlocation.md @@ -0,0 +1,41 @@ +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- + +## Volume Snapshot Location + +A volume snapshot location is the location in which to store the volume snapshots created for a backup. + +Velero can be configured to take snapshots of volumes from multiple providers. Velero also allows you to configure multiple possible `VolumeSnapshotLocation` per provider, although you can only select one location per provider at backup time. + +Each VolumeSnapshotLocation describes a provider + location. These are represented in the cluster via the `VolumeSnapshotLocation` CRD. Velero must have at least one `VolumeSnapshotLocation` per cloud provider. + +A sample YAML `VolumeSnapshotLocation` looks like the following: + +```yaml +apiVersion: velero.io/v1 +kind: VolumeSnapshotLocation +metadata: + name: aws-default + namespace: velero +spec: + provider: aws + config: + region: us-west-2 + profile: "default" +``` + +### Parameter Reference + +The configurable parameters are as follows: + +#### Main config parameters + +| Key | Type | Default | Meaning | +| --- | --- | --- | --- | +| `provider` | String | Required Field | The name for whichever storage provider will be used to create/store the volume snapshots. See [your volume snapshot provider's plugin documentation][0] for the appropriate value to use. | +| `config` | map[string]string | None (Optional) | Provider-specific configuration keys/values to be passed to the volume snapshotter plugin. See [your volume snapshot provider's plugin documentation][0] for details. | + + +[0]: ../supported-providers.md diff --git a/site/docs/v1.3.1/backup-reference.md b/site/content/docs/v1.3.2/backup-reference.md similarity index 87% rename from site/docs/v1.3.1/backup-reference.md rename to site/content/docs/v1.3.2/backup-reference.md index 797230d67..6ea8df91c 100644 --- a/site/docs/v1.3.1/backup-reference.md +++ b/site/content/docs/v1.3.2/backup-reference.md @@ -1,4 +1,7 @@ -# Backup Reference +--- +title: "Backup Reference" +layout: docs +--- ## Exclude Specific Items from Backup diff --git a/site/docs/v1.3.1/basic-install.md b/site/content/docs/v1.3.2/basic-install.md similarity index 98% rename from site/docs/v1.3.1/basic-install.md rename to site/content/docs/v1.3.2/basic-install.md index fde47086f..7fdb5af3d 100644 --- a/site/docs/v1.3.1/basic-install.md +++ b/site/content/docs/v1.3.2/basic-install.md @@ -1,4 +1,7 @@ -# Basic Install +--- +title: "Basic Install" +layout: docs +--- - [Basic Install](#basic-install) - [Prerequisites](#prerequisites) diff --git a/site/docs/v1.3.1/build-from-source.md b/site/content/docs/v1.3.2/build-from-source.md similarity index 99% rename from site/docs/v1.3.1/build-from-source.md rename to site/content/docs/v1.3.2/build-from-source.md index 0536d8efd..6fbadc119 100644 --- a/site/docs/v1.3.1/build-from-source.md +++ b/site/content/docs/v1.3.2/build-from-source.md @@ -1,4 +1,7 @@ -# Build from source +--- +title: "Build from source" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.3.2/code-standards.md b/site/content/docs/v1.3.2/code-standards.md similarity index 98% rename from site/docs/v1.3.2/code-standards.md rename to site/content/docs/v1.3.2/code-standards.md index 4323756bf..0987630f3 100644 --- a/site/docs/v1.3.2/code-standards.md +++ b/site/content/docs/v1.3.2/code-standards.md @@ -1,4 +1,7 @@ -# Code Standards +--- +title: "Code Standards" +layout: docs +--- ## Adding a changelog diff --git a/site/docs/v1.2.0/contributions/ibm-config.md b/site/content/docs/v1.3.2/contributions/ibm-config.md similarity index 98% rename from site/docs/v1.2.0/contributions/ibm-config.md rename to site/content/docs/v1.3.2/contributions/ibm-config.md index ea90167a3..299492bc0 100644 --- a/site/docs/v1.2.0/contributions/ibm-config.md +++ b/site/content/docs/v1.3.2/contributions/ibm-config.md @@ -1,4 +1,7 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. To set up IBM Cloud Object Storage (COS) as Velero's destination, you: diff --git a/site/docs/v1.3.2/contributions/minio.md b/site/content/docs/v1.3.2/contributions/minio.md similarity index 99% rename from site/docs/v1.3.2/contributions/minio.md rename to site/content/docs/v1.3.2/contributions/minio.md index db550f23e..4245c8e07 100644 --- a/site/docs/v1.3.2/contributions/minio.md +++ b/site/content/docs/v1.3.2/contributions/minio.md @@ -1,4 +1,7 @@ -## Quick start evaluation install with Minio +--- +title: "Quick start evaluation install with Minio" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.3.2/contributions/oracle-config.md b/site/content/docs/v1.3.2/contributions/oracle-config.md similarity index 99% rename from site/docs/v1.3.2/contributions/oracle-config.md rename to site/content/docs/v1.3.2/contributions/oracle-config.md index 8c88c80e8..bb7033ee1 100644 --- a/site/docs/v1.3.2/contributions/oracle-config.md +++ b/site/content/docs/v1.3.2/contributions/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.3.2/csi.md b/site/content/docs/v1.3.2/csi.md similarity index 96% rename from site/docs/v1.3.2/csi.md rename to site/content/docs/v1.3.2/csi.md index 2d87a8de4..388fbc368 100644 --- a/site/docs/v1.3.2/csi.md +++ b/site/content/docs/v1.3.2/csi.md @@ -1,4 +1,7 @@ -# Container Storage Interface Snapshot Support in Velero +--- +title: "Container Storage Interface Snapshot Support in Velero" +layout: docs +--- _This feature is under development. Documentation may not be up-to-date and features may not work as expected._ diff --git a/site/docs/v1.3.2/custom-plugins.md b/site/content/docs/v1.3.2/custom-plugins.md similarity index 99% rename from site/docs/v1.3.2/custom-plugins.md rename to site/content/docs/v1.3.2/custom-plugins.md index 9e86467de..baa5b26d0 100644 --- a/site/docs/v1.3.2/custom-plugins.md +++ b/site/content/docs/v1.3.2/custom-plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v1.3.0/customize-installation.md b/site/content/docs/v1.3.2/customize-installation.md similarity index 99% rename from site/docs/v1.3.0/customize-installation.md rename to site/content/docs/v1.3.2/customize-installation.md index 32842a82b..9928c0944 100644 --- a/site/docs/v1.3.0/customize-installation.md +++ b/site/content/docs/v1.3.2/customize-installation.md @@ -1,4 +1,7 @@ -# Customize Velero Install +--- +title: "Customize Velero Install" +layout: docs +--- - [Customize Velero Install](#customize-velero-install) - [Plugins](#plugins) diff --git a/site/content/docs/v1.3.2/debugging-install.md b/site/content/docs/v1.3.2/debugging-install.md new file mode 100644 index 000000000..9c2067b34 --- /dev/null +++ b/site/content/docs/v1.3.2/debugging-install.md @@ -0,0 +1,74 @@ +--- +title: "Debugging Installation Issues" +layout: docs +--- + +## General + +### `invalid configuration: no configuration has been provided` +This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the +following locations: +* the path specified by the `--kubeconfig` flag, if any +* the path specified by the `$KUBECONFIG` environment variable, if any +* `~/.kube/config` + +### Backups or restores stuck in `New` phase +This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: +``` +kubectl -n velero describe pods +kubectl -n velero logs deployment/velero +``` + + +## AWS + +### `NoCredentialProviders: no valid providers in chain` + +#### Using credentials +This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `credentials-velero` file is formatted properly and has the correct values: + + ``` + [default] + aws_access_key_id= + aws_secret_access_key= + ``` + +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +#### Using kube2iam +This means that Velero can't read the content of the S3 bucket. Ensure the following: + +* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. +* The new Velero role has all the permissions listed in the documentation regarding S3. + + +## Azure + +### `Failed to refresh the Token` or `adal: Refresh request failed` +This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted +properly into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + + +## GCE/GKE + +### `open credentials/cloud: no such file or directory` +This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +[0]: azure-config.md#create-service-principal diff --git a/site/content/docs/v1.3.2/debugging-restores.md b/site/content/docs/v1.3.2/debugging-restores.md new file mode 100644 index 000000000..eb834b0bc --- /dev/null +++ b/site/content/docs/v1.3.2/debugging-restores.md @@ -0,0 +1,109 @@ +--- +title: "Debugging Restores" +layout: docs +--- + +* [Example][0] +* [Structure][1] + +## Example + +When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: + +``` +NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR +backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT +backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT +backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT +backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT +``` + +To delve into the warnings and errors into more detail, you can use `velero restore describe`: + +```bash +velero restore describe backup-test-20170726180512 +``` + +The output looks like this: + +``` +Name: backup-test-20170726180512 +Namespace: velero +Labels: +Annotations: + +Backup: backup-test + +Namespaces: + Included: * + Excluded: + +Resources: + Included: serviceaccounts + Excluded: nodes, events, events.events.k8s.io + Cluster-scoped: auto + +Namespace mappings: + +Label selector: + +Restore PVs: auto + +Phase: Completed + +Validation errors: + +Warnings: + Velero: + Cluster: + Namespaces: + velero: serviceaccounts "velero" already exists + serviceaccounts "default" already exists + kube-public: serviceaccounts "default" already exists + kube-system: serviceaccounts "attachdetach-controller" already exists + serviceaccounts "certificate-controller" already exists + serviceaccounts "cronjob-controller" already exists + serviceaccounts "daemon-set-controller" already exists + serviceaccounts "default" already exists + serviceaccounts "deployment-controller" already exists + serviceaccounts "disruption-controller" already exists + serviceaccounts "endpoint-controller" already exists + serviceaccounts "generic-garbage-collector" already exists + serviceaccounts "horizontal-pod-autoscaler" already exists + serviceaccounts "job-controller" already exists + serviceaccounts "kube-dns" already exists + serviceaccounts "namespace-controller" already exists + serviceaccounts "node-controller" already exists + serviceaccounts "persistent-volume-binder" already exists + serviceaccounts "pod-garbage-collector" already exists + serviceaccounts "replicaset-controller" already exists + serviceaccounts "replication-controller" already exists + serviceaccounts "resourcequota-controller" already exists + serviceaccounts "service-account-controller" already exists + serviceaccounts "service-controller" already exists + serviceaccounts "statefulset-controller" already exists + serviceaccounts "ttl-controller" already exists + default: serviceaccounts "default" already exists + +Errors: + Velero: + Cluster: + Namespaces: +``` + +## Structure + +Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the +restore looks "normal" and all resources referenced in the backup exist in some form, although some +of them may have been pre-existing). + +Both errors and warnings are structured in the same way: + +* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). + +* `Cluster`: A list of issues related to the restore of cluster-scoped resources. + +* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. + +[0]: #example +[1]: #structure diff --git a/site/docs/v1.3.0/development.md b/site/content/docs/v1.3.2/development.md similarity index 94% rename from site/docs/v1.3.0/development.md rename to site/content/docs/v1.3.2/development.md index cf3b3c4fc..c805a27da 100644 --- a/site/docs/v1.3.0/development.md +++ b/site/content/docs/v1.3.2/development.md @@ -1,4 +1,7 @@ -# Development +--- +title: "Development " +layout: docs +--- ## Update generated files diff --git a/site/docs/v1.4/disaster-case.md b/site/content/docs/v1.3.2/disaster-case.md similarity index 97% rename from site/docs/v1.4/disaster-case.md rename to site/content/docs/v1.3.2/disaster-case.md index c9f126a8b..6b73e6716 100644 --- a/site/docs/v1.4/disaster-case.md +++ b/site/content/docs/v1.3.2/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/content/docs/v1.3.2/examples.md b/site/content/docs/v1.3.2/examples.md new file mode 100644 index 000000000..c73ae2b23 --- /dev/null +++ b/site/content/docs/v1.3.2/examples.md @@ -0,0 +1,66 @@ +--- +title: "Examples" +layout: docs +--- + +After you set up the Velero server, try these examples: + +### Basic example (without PersistentVolumes) + +1. Start the sample nginx app: + + ```bash + kubectl apply -f examples/nginx-app/base.yaml + ``` + +1. Create a backup: + + ```bash + velero backup create nginx-backup --include-namespaces nginx-example + ``` + +1. Simulate a disaster: + + ```bash + kubectl delete namespaces nginx-example + ``` + + Wait for the namespace to be deleted. + +1. Restore your lost resources: + + ```bash + velero restore create --from-backup nginx-backup + ``` + +### Snapshot example (with PersistentVolumes) + +> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks. + +1. Start the sample nginx app: + + ```bash + kubectl apply -f examples/nginx-app/with-pv.yaml + ``` + +1. Create a backup with PV snapshotting: + + ```bash + velero backup create nginx-backup --include-namespaces nginx-example + ``` + +1. Simulate a disaster: + + ```bash + kubectl delete namespaces nginx-example + ``` + + Because the default [reclaim policy][1] for dynamically-provisioned PVs is "Delete", these commands should trigger your cloud provider to delete the disk that backs the PV. Deletion is asynchronous, so this may take some time. **Before continuing to the next step, check your cloud provider to confirm that the disk no longer exists.** + +1. Restore your lost resources: + + ```bash + velero restore create --from-backup nginx-backup + ``` + +[1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming diff --git a/site/docs/v1.3.2/faq.md b/site/content/docs/v1.3.2/faq.md similarity index 98% rename from site/docs/v1.3.2/faq.md rename to site/content/docs/v1.3.2/faq.md index a7df0898b..f49b04a90 100644 --- a/site/docs/v1.3.2/faq.md +++ b/site/content/docs/v1.3.2/faq.md @@ -1,4 +1,7 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- ## When is it appropriate to use Velero instead of etcd's built in backup/restore? diff --git a/site/docs/v1.3.2/hooks.md b/site/content/docs/v1.3.2/hooks.md similarity index 99% rename from site/docs/v1.3.2/hooks.md rename to site/content/docs/v1.3.2/hooks.md index e0ae32220..2e688dee0 100644 --- a/site/docs/v1.3.2/hooks.md +++ b/site/content/docs/v1.3.2/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/v1.4/how-velero-works.md b/site/content/docs/v1.3.2/how-velero-works.md similarity index 99% rename from site/docs/v1.4/how-velero-works.md rename to site/content/docs/v1.3.2/how-velero-works.md index 543ab2f94..45889caef 100644 --- a/site/docs/v1.4/how-velero-works.md +++ b/site/content/docs/v1.3.2/how-velero-works.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/content/docs/v1.3.2/image-tagging.md b/site/content/docs/v1.3.2/image-tagging.md new file mode 100644 index 000000000..fbfb15617 --- /dev/null +++ b/site/content/docs/v1.3.2/image-tagging.md @@ -0,0 +1,24 @@ +--- +title: "Image tagging policy" +layout: docs +--- + +This document describes Velero's image tagging policy. + +## Released versions + +`velero/velero:` + +Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/vmware-tanzu/velero` repository has a matching image, e.g. `velero/velero:v1.0.0`. + +### Latest + +`velero/velero:latest` + +The `latest` tag follows the most recently released version of Velero. + +## Development + +`velero/velero:main` + +The `main` tag follows the latest commit to land on the `main` branch. diff --git a/site/docs/v1.3.2/img/README.md b/site/content/docs/v1.3.2/img/README.md similarity index 100% rename from site/docs/v1.3.2/img/README.md rename to site/content/docs/v1.3.2/img/README.md diff --git a/site/docs/v1.3.2/img/backup-process.png b/site/content/docs/v1.3.2/img/backup-process.png similarity index 100% rename from site/docs/v1.3.2/img/backup-process.png rename to site/content/docs/v1.3.2/img/backup-process.png diff --git a/site/docs/v1.3.2/img/velero.png b/site/content/docs/v1.3.2/img/velero.png similarity index 100% rename from site/docs/v1.3.2/img/velero.png rename to site/content/docs/v1.3.2/img/velero.png diff --git a/site/content/docs/v1.3.2/locations.md b/site/content/docs/v1.3.2/locations.md new file mode 100644 index 000000000..b5d8ca3fc --- /dev/null +++ b/site/content/docs/v1.3.2/locations.md @@ -0,0 +1,167 @@ +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- + +## Overview + +Velero has two custom resources, `BackupStorageLocation` and `VolumeSnapshotLocation`, that are used to configure where Velero backups and their associated persistent volume snapshots are stored. + +A `BackupStorageLocation` is defined as a bucket, a prefix within that bucket under which all Velero data should be stored, and a set of additional provider-specific fields (e.g. AWS region, Azure storage account, etc.) The [API documentation][1] captures the configurable parameters for each in-tree provider. + +A `VolumeSnapshotLocation` is defined entirely by provider-specific fields (e.g. AWS region, Azure resource group, Portworx snapshot type, etc.) The [API documentation][2] captures the configurable parameters for each in-tree provider. + +The user can pre-configure one or more possible `BackupStorageLocations` and one or more `VolumeSnapshotLocations`, and can select *at backup creation time* the location in which the backup and associated snapshots should be stored. + +This configuration design enables a number of different use cases, including: + +- Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) +- Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region +- For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud + +## Limitations / Caveats + +- Velero only supports a single set of credentials *per provider*. It's not yet possible to use different credentials for different locations, if they're for the same provider. + +- Volume snapshots are still limited by where your provider allows you to create snapshots. For example, AWS and Azure do not allow you to create a volume snapshot in a different region than where the volume is. If you try to take a Velero backup using a volume snapshot location with a different region than where your cluster's volumes are, the backup will fail. + +- Each Velero backup has one `BackupStorageLocation`, and one `VolumeSnapshotLocation` per volume provider. It is not possible (yet) to send a single Velero backup to multiple backup storage locations simultaneously, or a single volume snapshot to multiple locations simultaneously. However, you can always set up multiple scheduled backups that differ only in the storage locations used if redundancy of backups across locations is important. + +- Cross-provider snapshots are not supported. If you have a cluster with more than one type of volume (e.g. EBS and Portworx), but you only have a `VolumeSnapshotLocation` configured for EBS, then Velero will **only** snapshot the EBS volumes. + +- Restic data is stored under a prefix/subdirectory of the main Velero bucket, and will go into the bucket corresponding to the `BackupStorageLocation` selected by the user at backup creation time. + +## Examples + +Let's look at some examples of how we can use this configuration mechanism to address some common use cases: + +#### Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) + +During server configuration: + +```shell +velero snapshot-location create ebs-us-east-1 \ + --provider aws \ + --config region=us-east-1 + +velero snapshot-location create portworx-cloud \ + --provider portworx \ + --config type=cloud +``` + +During backup creation: + +```shell +velero backup create full-cluster-backup \ + --volume-snapshot-locations ebs-us-east-1,portworx-cloud +``` + +Alternately, since in this example there's only one possible volume snapshot location configured for each of our two providers (`ebs-us-east-1` for `aws`, and `portworx-cloud` for `portworx`), Velero doesn't require them to be explicitly specified when creating the backup: + +```shell +velero backup create full-cluster-backup +``` + +#### Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region + +During server configuration: + +```shell +velero backup-location create default \ + --provider aws \ + --bucket velero-backups \ + --config region=us-east-1 + +velero backup-location create s3-alt-region \ + --provider aws \ + --bucket velero-backups-alt \ + --config region=us-west-1 +``` + +During backup creation: + +```shell +# The Velero server will automatically store backups in the backup storage location named "default" if +# one is not specified when creating the backup. You can alter which backup storage location is used +# by default by setting the --default-backup-storage-location flag on the `velero server` command (run +# by the Velero deployment) to the name of a different backup storage location. +velero backup create full-cluster-backup +``` + +Or: + +```shell +velero backup create full-cluster-alternate-location-backup \ + --storage-location s3-alt-region +``` + +#### For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud + +During server configuration: + +```shell +velero snapshot-location create portworx-local \ + --provider portworx \ + --config type=local + +velero snapshot-location create portworx-cloud \ + --provider portworx \ + --config type=cloud +``` + +During backup creation: + +```shell +# Note that since in this example we have two possible volume snapshot locations for the Portworx +# provider, we need to explicitly specify which one to use when creating a backup. Alternately, +# you can set the --default-volume-snapshot-locations flag on the `velero server` command (run by +# the Velero deployment) to specify which location should be used for each provider by default, in +# which case you don't need to specify it when creating a backup. +velero backup create local-snapshot-backup \ + --volume-snapshot-locations portworx-local +``` + +Or: + +```shell +velero backup create cloud-snapshot-backup \ + --volume-snapshot-locations portworx-cloud +``` + +#### Use a single location + +If you don't have a use case for more than one location, it's still easy to use Velero. Let's assume you're running on AWS, in the `us-west-1` region: + +During server configuration: + +```shell +velero backup-location create default \ + --provider aws \ + --bucket velero-backups \ + --config region=us-west-1 + +velero snapshot-location create ebs-us-west-1 \ + --provider aws \ + --config region=us-west-1 +``` + +During backup creation: + +```shell +# Velero will automatically use your configured backup storage location and volume snapshot location. +# Nothing needs to be specified when creating a backup. +velero backup create full-cluster-backup +``` + +## Additional Use Cases + +1. If you're using Azure's AKS, you may want to store your volume snapshots outside of the "infrastructure" resource group that is automatically created when you create your AKS cluster. This is possible using a `VolumeSnapshotLocation`, by specifying a `resourceGroup` under the `config` section of the snapshot location. See the [Azure volume snapshot location documentation][3] for details. + +1. If you're using Azure, you may want to store your Velero backups across multiple storage accounts and/or resource groups/subscriptions. This is possible using a `BackupStorageLocation`, by specifying a `storageAccount`, `resourceGroup` and/or `subscriptionId`, respectively, under the `config` section of the backup location. See the [Azure backup storage location documentation][4] for details. + + + +[1]: api-types/backupstoragelocation.md +[2]: api-types/volumesnapshotlocation.md +[3]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md +[4]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md diff --git a/site/docs/v1.3.2/migration-case.md b/site/content/docs/v1.3.2/migration-case.md similarity index 97% rename from site/docs/v1.3.2/migration-case.md rename to site/content/docs/v1.3.2/migration-case.md index 85ec5edef..e4400b00d 100644 --- a/site/docs/v1.3.2/migration-case.md +++ b/site/content/docs/v1.3.2/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/docs/v1.3.1/namespace.md b/site/content/docs/v1.3.2/namespace.md similarity index 92% rename from site/docs/v1.3.1/namespace.md rename to site/content/docs/v1.3.2/namespace.md index 9a3d62808..14e2c6179 100644 --- a/site/docs/v1.3.1/namespace.md +++ b/site/content/docs/v1.3.2/namespace.md @@ -1,4 +1,7 @@ -# Run in a non-default namespace +--- +title: "Run in a non-default namespace" +layout: docs +--- The Velero installation and backups by default are run in the `velero` namespace. However, it is possible to use a different namespace. diff --git a/site/docs/v1.3.1/on-premises.md b/site/content/docs/v1.3.2/on-premises.md similarity index 96% rename from site/docs/v1.3.1/on-premises.md rename to site/content/docs/v1.3.2/on-premises.md index ec199287c..774252107 100644 --- a/site/docs/v1.3.1/on-premises.md +++ b/site/content/docs/v1.3.2/on-premises.md @@ -1,4 +1,7 @@ -# On-Premises Environments +--- +title: "On-Premises Environments" +layout: docs +--- You can run Velero in an on-premises cluster in different ways depending on your requirements. diff --git a/site/docs/v1.3.2/output-file-format.md b/site/content/docs/v1.3.2/output-file-format.md similarity index 98% rename from site/docs/v1.3.2/output-file-format.md rename to site/content/docs/v1.3.2/output-file-format.md index a4b462614..f96120530 100644 --- a/site/docs/v1.3.2/output-file-format.md +++ b/site/content/docs/v1.3.2/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/content/docs/v1.3.2/overview-plugins.md b/site/content/docs/v1.3.2/overview-plugins.md new file mode 100644 index 000000000..037601d51 --- /dev/null +++ b/site/content/docs/v1.3.2/overview-plugins.md @@ -0,0 +1,29 @@ +--- +title: "Velero plugin system" +layout: docs +--- + +Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. + +For server installation, Velero requires that at least one plugin is added (with the `--plugins` flag). The plugin will be either of the type object store or volume snapshotter, or a plugin that contains both. An exception to this is that when the user is not configuring a backup storage location or a snapshot storage location at the time of install, this flag is optional. + +Any plugin can be added after Velero has been installed by using the command `velero plugin add `. + +Example with a dockerhub image: `velero plugin add velero/velero-plugin-for-aws:v1.0.0`. + +In the same way, any plugin can be removed by using the command `velero plugin remove `. + +## Creating a new plugin + +Anyone can add integrations for any platform to provide additional backup and volume storage without modifying the Velero codebase. To write a plugin for a new backup or volume storage platform, take a look at our [example repo][1] and at our documentation for [Custom plugins][2]. + +## Adding a new plugin + +After you publish your plugin on your own repository, open a PR that adds a link to it under the appropriate list of [supported providers][3] page in our documentation. + +You can also add the [`velero-plugin` GitHub Topic][4] to your repo, and it will be shown under the aggregated list of repositories automatically. + +[1]: https://github.com/vmware-tanzu/velero-plugin-example/ +[2]: custom-plugins.md +[3]: supported-providers.md +[4]: https://github.com/topics/velero-plugin diff --git a/site/content/docs/v1.3.2/rbac.md b/site/content/docs/v1.3.2/rbac.md new file mode 100644 index 000000000..a9c22b9f1 --- /dev/null +++ b/site/content/docs/v1.3.2/rbac.md @@ -0,0 +1,50 @@ +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- + +By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. + +**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. + +For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. + +## Set up Roles and RoleBindings + +Here's a sample Role and RoleBinding pair. + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + namespace: YOUR_NAMESPACE_HERE + name: ROLE_NAME_HERE + labels: + component: velero +rules: + - apiGroups: + - velero.io + verbs: + - "*" + resources: + - "*" +``` + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: ROLEBINDING_NAME_HERE +subjects: + - kind: ServiceAccount + name: YOUR_SERVICEACCOUNT_HERE +roleRef: + kind: Role + name: ROLE_NAME_HERE + apiGroup: rbac.authorization.k8s.io +``` + +[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ +[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ +[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +[4]: namespace.md diff --git a/site/docs/v1.3.1/release-instructions.md b/site/content/docs/v1.3.2/release-instructions.md similarity index 99% rename from site/docs/v1.3.1/release-instructions.md rename to site/content/docs/v1.3.2/release-instructions.md index 73481bb82..1a433ea19 100644 --- a/site/docs/v1.3.1/release-instructions.md +++ b/site/content/docs/v1.3.2/release-instructions.md @@ -1,4 +1,7 @@ -# Release Instructions +--- +title: "Release Instructions" +layout: docs +--- ## Ahead of Time diff --git a/site/docs/v1.3.1/restic.md b/site/content/docs/v1.3.2/restic.md similarity index 99% rename from site/docs/v1.3.1/restic.md rename to site/content/docs/v1.3.2/restic.md index 03056030a..3aaf9e026 100644 --- a/site/docs/v1.3.1/restic.md +++ b/site/content/docs/v1.3.2/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/v1.2.0/restore-reference.md b/site/content/docs/v1.3.2/restore-reference.md similarity index 98% rename from site/docs/v1.2.0/restore-reference.md rename to site/content/docs/v1.3.2/restore-reference.md index 43c40a287..9a53b93ee 100644 --- a/site/docs/v1.2.0/restore-reference.md +++ b/site/content/docs/v1.3.2/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/content/docs/v1.3.2/run-locally.md b/site/content/docs/v1.3.2/run-locally.md new file mode 100644 index 000000000..ffd735b4f --- /dev/null +++ b/site/content/docs/v1.3.2/run-locally.md @@ -0,0 +1,52 @@ +--- +title: "Run Velero locally in development" +layout: docs +--- + +Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server +image and redeploy it to the cluster with each change. + +## Run Velero locally with a remote cluster + +Velero runs against the Kubernetes API server as the endpoint (as per the `kubeconfig` configuration), so both the Velero server and client use the same `client-go` to communicate with Kubernetes. This means the Velero server can be run locally just as functionally as if it was running in the remote cluster. + +### Prerequisites + +When running Velero, you will need to ensure that you set up all of the following: + +* Appropriate RBAC permissions in the cluster + * Read access for all data from the source cluster and namespaces + * Write access to the target cluster and namespaces +* Cloud provider credentials + * Read/write access to volumes + * Read/write access to object storage for backup data +* A [BackupStorageLocation][20] object definition for the Velero server +* (Optional) A [VolumeSnapshotLocation][21] object definition for the Velero server, to take PV snapshots + +### 1. Install Velero + +See documentation on how to install Velero in some specific providers: [Install overview][22] + +### 2. Scale deployment down to zero + +After you use the `velero install` command to install Velero into your cluster, you scale the Velero deployment down to 0 so it is not simultaneously being run on the remote cluster and potentially causing things to get out of sync: + +`kubectl scale --replicas=0 deployment velero -n velero` + +#### 3. Start the Velero server locally + +* To run the server locally, use the full path according to the binary you need. Example, if you are on a Mac, and using `AWS` as a provider, this is how to run the binary you built from source using the full path: `AWS_SHARED_CREDENTIALS_FILE= ./_output/bin/darwin/amd64/velero`. Alternatively, you may add the `velero` binary to your `PATH`. + +* Start the server: `velero server [CLI flags]`. The following CLI flags may be useful to customize, but see `velero server --help` for full details: + * `--log-level`: set the Velero server's log level (default `info`, use `debug` for the most logging) + * `--kubeconfig`: set the path to the kubeconfig file the Velero server uses to talk to the Kubernetes apiserver (default `$KUBECONFIG`) + * `--namespace`: the set namespace where the Velero server should look for backups, schedules, restores (default `velero`) + * `--plugin-dir`: set the directory where the Velero server looks for plugins (default `/plugins`) + * `--metrics-address`: set the bind address and port where Prometheus metrics are exposed (default `:8085`) + +[15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file +[16]: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable +[18]: https://eksctl.io/ +[20]: api-types/backupstoragelocation.md +[21]: api-types/volumesnapshotlocation.md +[22]: basic-install.md diff --git a/site/docs/v1.3.2/start-contributing.md b/site/content/docs/v1.3.2/start-contributing.md similarity index 96% rename from site/docs/v1.3.2/start-contributing.md rename to site/content/docs/v1.3.2/start-contributing.md index b28dfb9f1..d7050efbf 100644 --- a/site/docs/v1.3.2/start-contributing.md +++ b/site/content/docs/v1.3.2/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/content/docs/v1.3.2/support-process.md b/site/content/docs/v1.3.2/support-process.md new file mode 100644 index 000000000..fc06e72e9 --- /dev/null +++ b/site/content/docs/v1.3.2/support-process.md @@ -0,0 +1,44 @@ +--- +title: "Support Process" +layout: docs +--- + +## Weekly Rotation + +The Velero maintainers use a weekly rotation to manage community support. Each week, a different maintainer is the point person for responding to incoming support issues via Slack, GitHub, and the Google group. The point person is *not* expected to be on-call 24x7. Instead, they choose one or more hour(s) per day to be available/responding to incoming issues. They will communicate to the community what that time slot will be each week. + +## Start of Week + +We will update the public Slack channel's topic to indicate that you are the point person for the week, and what hours you'll be available. + +## During the Week + +### Where we will monitor +- `#velero` public Slack channel in Kubernetes org +- [all Velero-related repos][0] in GitHub (`velero`, `velero-plugin-for-[aws|gcp|microsoft-azure|csi]`, `helm-charts`) +- [Project Velero Google Group][1] + +### GitHub issue flow + +Generally speaking, new GitHub issues will fall into one of several categories. We use the following process for each: + +1. **Feature request** + - Label the issue with `Enhancement/User` or `Enhancement/Dev` + - Leave the issue in the `New Issues` swimlane for triage by product mgmt +1. **Bug** + - Label the issue with `Bug` + - Leave the issue in the `New Issues` swimlane for triage by product mgmt +1. **User question/problem** that does not clearly fall into one of the previous categories + - When you start investigating/responding, label the issue with `Investigating` + - Add comments as you go, so both the user and future support people have as much context as possible + - Use the `Needs Info` label to indicate an issue is waiting for information from the user. Remove/re-add the label as needed. + - If you resolve the issue with the user, close it out + - If the issue ends up being a feature request or a bug, update the title and follow the appropriate process for it + - If the reporter becomes unresponsive after multiple pings, close out the issue due to inactivity and comment that the user can always reach out again as needed + +## End of Week + +We ensure all GitHub issues worked on during the week on are labeled with `Investigating` and `Needs Info` (if appropriate), and have updated comments so the next person can pick them up. + +[0]: https://app.zenhub.com/workspaces/velero-5c59c15e39d47b774b5864e3/board?repos=99143276,112385197,213946861,190224441,214524700,214524630 +[1]: https://groups.google.com/forum/#!forum/projectvelero diff --git a/site/docs/v1.3.2/supported-providers.md b/site/content/docs/v1.3.2/supported-providers.md similarity index 99% rename from site/docs/v1.3.2/supported-providers.md rename to site/content/docs/v1.3.2/supported-providers.md index 8377f9cbe..1a93a3b75 100644 --- a/site/docs/v1.3.2/supported-providers.md +++ b/site/content/docs/v1.3.2/supported-providers.md @@ -1,4 +1,7 @@ -# Providers +--- +title: "Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. Velero has a plugin system which allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/content/docs/v1.3.2/troubleshooting.md b/site/content/docs/v1.3.2/troubleshooting.md new file mode 100644 index 000000000..6d0fa998f --- /dev/null +++ b/site/content/docs/v1.3.2/troubleshooting.md @@ -0,0 +1,126 @@ +--- +title: "Troubleshooting" +layout: docs +--- + +These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. + +- [Troubleshooting](#troubleshooting) + - [Debug installation/ setup issues](#debug-installation-setup-issues) + - [Debug restores](#debug-restores) + - [General troubleshooting information](#general-troubleshooting-information) + - [Getting velero debug logs](#getting-velero-debug-logs) + - [Known issue with restoring LoadBalancer Service](#known-issue-with-restoring-loadbalancer-service) + - [Miscellaneous issues](#miscellaneous-issues) + - [Velero reports `custom resource not found` errors when starting up.](#velero-reports-custom-resource-not-found-errors-when-starting-up) + - [`velero backup logs` returns a `SignatureDoesNotMatch` error](#velero-backup-logs-returns-a-signaturedoesnotmatch-error) + - [Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress](#velero-or-a-pod-it-was-backing-up-restarted-during-a-backup-and-the-backup-is-stuck-inprogress) + - [Velero is not publishing prometheus metrics](#velero-is-not-publishing-prometheus-metrics) + +## Debug installation/ setup issues + +- [Debug installation/setup issues][2] + +## Debug restores + +- [Debug restores][1] + +## General troubleshooting information + +You can use the `velero bug` command to open a [Github issue][4] by launching a browser window with some prepopulated values. Values included are OS, CPU architecture, `kubectl` client and server versions (if available) and the `velero` client version. This information isn't submitted to Github until you click the `Submit new issue` button in the Github UI, so feel free to add, remove or update whatever information you like. + +Some general commands for troubleshooting that may be helpful: + +* `velero backup describe ` - describe the details of a backup +* `velero backup logs ` - fetch the logs for this specific backup. Useful for viewing failures and warnings, including resources that could not be backed up. +* `velero restore describe ` - describe the details of a restore +* `velero restore logs ` - fetch the logs for this specific restore. Useful for viewing failures and warnings, including resources that could not be restored. +* `kubectl logs deployment/velero -n velero` - fetch the logs of the Velero server pod. This provides the output of the Velero server processes. + +### Getting velero debug logs + +You can increase the verbosity of the Velero server by editing your Velero deployment to look like this: + + +``` +kubectl edit deployment/velero -n velero +... + containers: + - name: velero + image: velero/velero:latest + command: + - /velero + args: + - server + - --log-level # Add this line + - debug # Add this line +... +``` + +## Known issue with restoring LoadBalancer Service + +Because of how Kubernetes handles Service objects of `type=LoadBalancer`, when you restore these objects you might encounter an issue with changed values for Service UIDs. Kubernetes automatically generates the name of the cloud resource based on the Service UID, which is different when restored, resulting in a different name for the cloud load balancer. If the DNS CNAME for your application points to the DNS name of your cloud load balancer, you'll need to update the CNAME pointer when you perform a Velero restore. + +Alternatively, you might be able to use the Service's `spec.loadBalancerIP` field to keep connections valid, if your cloud provider supports this value. See [the Kubernetes documentation about Services of Type LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). + +## Miscellaneous issues + +### Velero reports `custom resource not found` errors when starting up. + +Velero's server will not start if the required Custom Resource Definitions are not found in Kubernetes. Run `velero install` again to install any missing custom resource definitions. + +### `velero backup logs` returns a `SignatureDoesNotMatch` error + +Downloading artifacts from object storage utilizes temporary, signed URLs. In the case of S3-compatible +providers, such as Ceph, there may be differences between their implementation and the official S3 +API that cause errors. + +Here are some things to verify if you receive `SignatureDoesNotMatch` errors: + + * Make sure your S3-compatible layer is using [signature version 4][5] (such as Ceph RADOS v12.2.7) + * For Ceph, try using a native Ceph account for credentials instead of external providers such as OpenStack Keystone + +## Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress + +Velero cannot currently resume backups that were interrupted. Backups stuck in the `InProgress` phase can be deleted with `kubectl delete backup -n `. +Backups in the `InProgress` phase have not uploaded any files to object storage. + +## Velero is not publishing prometheus metrics + +Steps to troubleshoot: + +- Confirm that your velero deployment has metrics publishing enabled. The [latest Velero helm charts][6] have been setup with [metrics enabled by default][7]. +- Confirm that the Velero server pod exposes the port on which the metrics server listens on. By default, this value is 8085. + +```yaml + ports: + - containerPort: 8085 + name: metrics + protocol: TCP +``` + +- Confirm that the metric server is listening for and responding to connections on this port. This can be done using [port-forwarding][9] as shown below + +```bash +$ kubectl -n port-forward 8085:8085 +Forwarding from 127.0.0.1:8085 -> 8085 +Forwarding from [::1]:8085 -> 8085 +. +. +. +``` + +Now, visiting http://localhost:8085/metrics on a browser should show the metrics that are being scraped from Velero. + +- Confirm that the Velero server pod has the nessary [annotations][8] for prometheus to scrape metrics. +- Confirm, from the Prometheus UI, that the Velero pod is one of the targets being scraped from Prometheus. + +[1]: debugging-restores.md +[2]: debugging-install.md +[4]: https://github.com/vmware-tanzu/velero/issues +[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html +[6]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero +[7]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L44 +[8]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L49-L52 +[9]: https://kubectl.docs.kubernetes.io/pages/container_debugging/port_forward_to_pods.html +[25]: https://kubernetes.slack.com/messages/velero diff --git a/site/content/docs/v1.3.2/uninstalling.md b/site/content/docs/v1.3.2/uninstalling.md new file mode 100644 index 000000000..f0b7b8d17 --- /dev/null +++ b/site/content/docs/v1.3.2/uninstalling.md @@ -0,0 +1,11 @@ +--- +title: "Uninstalling Velero" +layout: docs +--- + +If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: + +```bash +kubectl delete namespace/velero clusterrolebinding/velero +kubectl delete crds -l component=velero +``` diff --git a/site/docs/v1.3.2/upgrade-to-1.3.md b/site/content/docs/v1.3.2/upgrade-to-1.3.md similarity index 96% rename from site/docs/v1.3.2/upgrade-to-1.3.md rename to site/content/docs/v1.3.2/upgrade-to-1.3.md index d321f8894..8745a1b3d 100644 --- a/site/docs/v1.3.2/upgrade-to-1.3.md +++ b/site/content/docs/v1.3.2/upgrade-to-1.3.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.3 +--- +title: "Upgrading to Velero 1.3" +layout: docs +--- ## Prerequisites diff --git a/site/docs/v1.3.0/velero-install.md b/site/content/docs/v1.3.2/velero-install.md similarity index 98% rename from site/docs/v1.3.0/velero-install.md rename to site/content/docs/v1.3.2/velero-install.md index 58718d16c..951cc9f11 100644 --- a/site/docs/v1.3.0/velero-install.md +++ b/site/content/docs/v1.3.2/velero-install.md @@ -1,4 +1,7 @@ -# Velero Install CLI +--- +title: "Velero Install CLI" +layout: docs +--- This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. diff --git a/site/content/docs/v1.3.2/vendoring-dependencies.md b/site/content/docs/v1.3.2/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.3.2/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.2/website-guidelines.md b/site/content/docs/v1.3.2/website-guidelines.md similarity index 96% rename from site/docs/v1.3.2/website-guidelines.md rename to site/content/docs/v1.3.2/website-guidelines.md index 575a34839..84ebd4e47 100644 --- a/site/docs/v1.3.2/website-guidelines.md +++ b/site/content/docs/v1.3.2/website-guidelines.md @@ -1,4 +1,7 @@ -# Website Guidelines +--- +title: "Website Guidelines" +layout: docs +--- ## Running the website locally diff --git a/site/content/docs/v1.3.2/zenhub.md b/site/content/docs/v1.3.2/zenhub.md new file mode 100644 index 000000000..a723fb184 --- /dev/null +++ b/site/content/docs/v1.3.2/zenhub.md @@ -0,0 +1,18 @@ +--- +title: "ZenHub" +layout: docs +--- + +As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. +GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. + +While GitHub issues, milestones, and labels generally work pretty well, the Velero team has found that product planning requires some additional tooling that GitHub projects do not offer. + +In our effort to minimize tooling while enabling product management insights, we have decided to use [ZenHub Open-Source](https://www.zenhub.com/blog/open-source/) to overlay product and project tracking on top of GitHub. +ZenHub is a GitHub application that provides Kanban visualization, Epic tracking, fine-grained prioritization, and more. It's primary backing storage system is existing GitHub issues along with additional metadata stored in ZenHub's database. + +If you are a Velero user or Velero Developer, you do not _need_ to use ZenHub for your regular workflow (e.g to see open bug reports or feature requests, work on pull requests). However, if you'd like to be able to visualize the high-level project goals and roadmap, you will need to use the free version of ZenHub. + +## Using ZenHub + +ZenHub can be integrated within the GitHub interface using their [Chrome or FireFox extensions](https://www.zenhub.com/extension). In addition, you can use their dedicated [web application](https://app.zenhub.com/workspace/o/vmware-tanzu/velero/boards?filterLogic=all&repos=99143276). diff --git a/site/docs/v1.4/README.md b/site/content/docs/v1.4/_index.md similarity index 98% rename from site/docs/v1.4/README.md rename to site/content/docs/v1.4/_index.md index a3ff7cbd9..c11d5b270 100644 --- a/site/docs/v1.4/README.md +++ b/site/content/docs/v1.4/_index.md @@ -1,3 +1,6 @@ +--- +version: v1.4 +--- ![100] [![Build Status][1]][2] diff --git a/site/content/docs/v1.4/api-types/README.md b/site/content/docs/v1.4/api-types/README.md new file mode 100644 index 000000000..54c23544d --- /dev/null +++ b/site/content/docs/v1.4/api-types/README.md @@ -0,0 +1,21 @@ +--- +title: "Table of Contents" +layout: docs +--- + +## API types + +Here we list the API types that have some functionality that you can only configure via json/yaml vs the `velero` cli +(hooks) + +* [Backup][1] +* [Restore][2] +* [Schedule][3] +* [BackupStorageLocation][4] +* [VolumeSnapshotLocation][5] + +[1]: backup.md +[2]: restore.md +[3]: schedule.md +[4]: backupstoragelocation.md +[5]: volumesnapshotlocation.md diff --git a/site/content/docs/v1.4/api-types/backup.md b/site/content/docs/v1.4/api-types/backup.md new file mode 100644 index 000000000..2223081ae --- /dev/null +++ b/site/content/docs/v1.4/api-types/backup.md @@ -0,0 +1,146 @@ +--- +title: "Backup API Type" +layout: docs +--- + +## Use + +The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the +Velero Server immediately starts the backup process. + +## API GroupVersion + +Backup belongs to the API group version `velero.io/v1`. + +## Definition + +Here is a sample `Backup` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: velero.io/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Backup +# Standard Kubernetes metadata. Required. +metadata: + # Backup name. May be any valid Kubernetes object name. Required. + name: a + # Backup namespace. Must be the namespace of the Velero server. Required. + namespace: velero +# Parameters about the backup. Required. +spec: + # Array of namespaces to include in the backup. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the backup. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the backup. For example, if a + # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the backup. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and + # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as + # a persistent volume provider is configured for Velero. + snapshotVolumes: null + # Where to store the tarball and logs. + storageLocation: aws-primary + # The list of locations in which to store volume snapshots created for this backup. + volumeSnapshotLocations: + - aws-primary + - gcp-primary + # The amount of time before this backup is eligible for garbage collection. If not specified, + # a default value of 30 days will be used. The default can be configured on the velero server + # by passing the flag --default-backup-ttl. + ttl: 24h0m0s + # Actions to perform at different times during a backup. The only hook currently supported is + # executing a command in a container in a pod using the pod exec API. Optional. + hooks: + # Array of hooks that are applicable to specific resources. Optional. + resources: + - + # Name of the hook. Will be displayed in backup log. + name: my-hook + # Array of namespaces to which this hook applies. If unspecified, the hook applies to all + # namespaces. Optional. + includedNamespaces: + - '*' + # Array of namespaces to which this hook does not apply. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to which this hook applies. The only resource supported at this time is + # pods. + includedResources: + - pods + # Array of resources to which this hook does not apply. Optional. + excludedResources: [] + # This hook only applies to objects matching this label selector. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + pre: + - + # The type of hook. This must be "exec". + exec: + # The name of the container where the command will be executed. If unspecified, the + # first container in the pod will be used. Optional. + container: my-container + # The command to execute, specified as an array. Required. + command: + - /bin/uname + - -a + # How to handle an error executing the command. Valid values are Fail and Continue. + # Defaults to Fail. Optional. + onError: Fail + # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. + timeout: 10s + # An array of hooks to run after all custom actions and additional items have been + # processed. Currently only "exec" hooks are supported. + post: + # Same content as pre above. +# Status about the Backup. Users should not set any data here. +status: + # The version of this Backup. The only version currently supported is 1. + version: 1 + # The date and time when the Backup is eligible for garbage collection. + expiration: null + # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. + phase: "" + # An array of any validation errors encountered. + validationErrors: null + # Date/time when the backup started being processed. + startTimestamp: 2019-04-29T15:58:43Z + # Date/time when the backup finished being processed. + completionTimestamp: 2019-04-29T15:58:56Z + # Number of volume snapshots that Velero tried to create for this backup. + volumeSnapshotsAttempted: 2 + # Number of volume snapshots that Velero successfully created for this backup. + volumeSnapshotsCompleted: 1 + # Number of warnings that were logged by the backup. + warnings: 2 + # Number of errors that were logged by the backup. + errors: 0 + +``` diff --git a/site/docs/v1.4/api-types/backupstoragelocation.md b/site/content/docs/v1.4/api-types/backupstoragelocation.md similarity index 97% rename from site/docs/v1.4/api-types/backupstoragelocation.md rename to site/content/docs/v1.4/api-types/backupstoragelocation.md index 8fb3a0974..948be0894 100644 --- a/site/docs/v1.4/api-types/backupstoragelocation.md +++ b/site/content/docs/v1.4/api-types/backupstoragelocation.md @@ -1,4 +1,7 @@ -# Velero Backup Storage Locations +--- +title: "Velero Backup Storage Locations" +layout: docs +--- ## Backup Storage Location diff --git a/site/content/docs/v1.4/api-types/restore.md b/site/content/docs/v1.4/api-types/restore.md new file mode 100644 index 000000000..cc76e7f3a --- /dev/null +++ b/site/content/docs/v1.4/api-types/restore.md @@ -0,0 +1,92 @@ +--- +title: "Restore API Type" +layout: docs +--- + +## Use + +The `Restore` API type is used as a request for the Velero server to perform a Restore. Once created, the +Velero Server immediately starts the Restore process. + +## API GroupVersion + +Restore belongs to the API group version `velero.io/v1`. + +## Definition + +Here is a sample `Restore` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: velero.io/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Restore +# Standard Kubernetes metadata. Required. +metadata: + # Restore name. May be any valid Kubernetes object name. Required. + name: a-very-special-backup-0000111122223333 + # Restore namespace. Must be the namespace of the Velero server. Required. + namespace: velero +# Parameters about the restore. Required. +spec: + # BackupName is the unique name of the Velero backup to restore from. + backupName: a-very-special-backup + # Array of namespaces to include in the restore. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the restore. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the restore. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the restore. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the restore. For example, if a + # PersistentVolumeClaim is included in the restore, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the restore. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # 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: + namespace-backup-from: namespace-to-restore-to + # RestorePVs specifies whether to restore all included PVs + # from snapshot (via the cloudprovider). + restorePVs: true + # ScheduleName is the unique name of the Velero schedule + # to restore from. If specified, and BackupName is empty, Velero will + # restore from the most recent successful backup created from this schedule. + scheduleName: my-scheduled-backup-name +# RestoreStatus captures the current status of a Velero restore. Users should not set any data here. +status: + # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. + phase: "" + # An array of any validation errors encountered. + validationErrors: null + # Number of warnings that were logged by the restore. + warnings: 2 + # Errors is a count of all error messages that were generated + # during execution of the restore. The actual errors are stored in object + # storage. + errors: 0 + # FailureReason is an error that caused the entire restore + # to fail. + failureReason: + +``` diff --git a/site/content/docs/v1.4/api-types/schedule.md b/site/content/docs/v1.4/api-types/schedule.md new file mode 100644 index 000000000..7b3139bf9 --- /dev/null +++ b/site/content/docs/v1.4/api-types/schedule.md @@ -0,0 +1,135 @@ +--- +title: "Schedule API Type" +layout: docs +--- + +## Use + +The `Schedule` API type is used as a repeatable request for the Velero server to perform a backup for a given cron notation. Once created, the +Velero Server will start the backup process. It will then wait for the next valid point of the given cron expression and execute the backup +process on a repeating basis. + +## API GroupVersion + +Schedule belongs to the API group version `velero.io/v1`. + +## Definition + +Here is a sample `Schedule` object with each of the fields documented: + +```yaml +# Standard Kubernetes API Version declaration. Required. +apiVersion: velero.io/v1 +# Standard Kubernetes Kind declaration. Required. +kind: Schedule +# Standard Kubernetes metadata. Required. +metadata: + # Schedule name. May be any valid Kubernetes object name. Required. + name: a + # Schedule namespace. Must be the namespace of the Velero server. Required. + namespace: velero +# Parameters about the scheduled backup. Required. +spec: + # Schedule is a Cron expression defining when to run the Backup + schedule: 0 7 * * * + # Template is the spec that should be used for each backup triggered by this schedule. + template: + # Array of namespaces to include in the scheduled backup. If unspecified, all namespaces are included. + # Optional. + includedNamespaces: + - '*' + # Array of namespaces to exclude from the scheduled backup. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to include in the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. If unspecified, all resources are included. Optional. + includedResources: + - '*' + # Array of resources to exclude from the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') + # or fully-qualified. Optional. + excludedResources: + - storageclasses.storage.k8s.io + # Whether or not to include cluster-scoped resources. Valid values are true, false, and + # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded + # resources and the label selector). If false, no cluster-scoped resources are included. If unset, + # all cluster-scoped resources are included if and only if all namespaces are included and there are + # no excluded namespaces. Otherwise, if there is at least one namespace specified in either + # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed + # up are those associated with namespace-scoped resources included in the scheduled backup. For example, if a + # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is + # cluster-scoped) would also be backed up. + includeClusterResources: null + # Individual objects must match this label selector to be included in the scheduled backup. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and + # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as + # a persistent volume provider is configured for Velero. + snapshotVolumes: null + # Where to store the tarball and logs. + storageLocation: aws-primary + # The list of locations in which to store volume snapshots created for backups under this schedule. + volumeSnapshotLocations: + - aws-primary + - gcp-primary + # The amount of time before backups created on this schedule are eligible for garbage collection. If not specified, + # a default value of 30 days will be used. The default can be configured on the velero server + # by passing the flag --default-backup-ttl. + ttl: 24h0m0s + # Actions to perform at different times during a backup. The only hook currently supported is + # executing a command in a container in a pod using the pod exec API. Optional. + hooks: + # Array of hooks that are applicable to specific resources. Optional. + resources: + - + # Name of the hook. Will be displayed in backup log. + name: my-hook + # Array of namespaces to which this hook applies. If unspecified, the hook applies to all + # namespaces. Optional. + includedNamespaces: + - '*' + # Array of namespaces to which this hook does not apply. Optional. + excludedNamespaces: + - some-namespace + # Array of resources to which this hook applies. The only resource supported at this time is + # pods. + includedResources: + - pods + # Array of resources to which this hook does not apply. Optional. + excludedResources: [] + # This hook only applies to objects matching this label selector. Optional. + labelSelector: + matchLabels: + app: velero + component: server + # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. + pre: + - + # The type of hook. This must be "exec". + exec: + # The name of the container where the command will be executed. If unspecified, the + # first container in the pod will be used. Optional. + container: my-container + # The command to execute, specified as an array. Required. + command: + - /bin/uname + - -a + # How to handle an error executing the command. Valid values are Fail and Continue. + # Defaults to Fail. Optional. + onError: Fail + # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. + timeout: 10s + # An array of hooks to run after all custom actions and additional items have been + # processed. Currently only "exec" hooks are supported. + post: + # Same content as pre above. +status: + # The current phase of the latest scheduled backup. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. + phase: "" + # Date/time of the last backup for a given schedule + lastBackup: + # An array of any validation errors encountered. + validationErrors: +``` diff --git a/site/content/docs/v1.4/api-types/volumesnapshotlocation.md b/site/content/docs/v1.4/api-types/volumesnapshotlocation.md new file mode 100644 index 000000000..aef5f4053 --- /dev/null +++ b/site/content/docs/v1.4/api-types/volumesnapshotlocation.md @@ -0,0 +1,41 @@ +--- +title: "Velero Volume Snapshot Location" +layout: docs +--- + +## Volume Snapshot Location + +A volume snapshot location is the location in which to store the volume snapshots created for a backup. + +Velero can be configured to take snapshots of volumes from multiple providers. Velero also allows you to configure multiple possible `VolumeSnapshotLocation` per provider, although you can only select one location per provider at backup time. + +Each VolumeSnapshotLocation describes a provider + location. These are represented in the cluster via the `VolumeSnapshotLocation` CRD. Velero must have at least one `VolumeSnapshotLocation` per cloud provider. + +A sample YAML `VolumeSnapshotLocation` looks like the following: + +```yaml +apiVersion: velero.io/v1 +kind: VolumeSnapshotLocation +metadata: + name: aws-default + namespace: velero +spec: + provider: aws + config: + region: us-west-2 + profile: "default" +``` + +### Parameter Reference + +The configurable parameters are as follows: + +#### Main config parameters + +| Key | Type | Default | Meaning | +| --- | --- | --- | --- | +| `provider` | String | Required Field | The name for whichever storage provider will be used to create/store the volume snapshots. See [your volume snapshot provider's plugin documentation][0] for the appropriate value to use. | +| `config` | map[string]string | None (Optional) | Provider-specific configuration keys/values to be passed to the volume snapshotter plugin. See [your volume snapshot provider's plugin documentation][0] for details. | + + +[0]: ../supported-providers.md diff --git a/site/content/docs/v1.4/backup-reference.md b/site/content/docs/v1.4/backup-reference.md new file mode 100644 index 000000000..6ea8df91c --- /dev/null +++ b/site/content/docs/v1.4/backup-reference.md @@ -0,0 +1,12 @@ +--- +title: "Backup Reference" +layout: docs +--- + +## Exclude Specific Items from Backup + +It is possible to exclude individual items from being backed up, even if they match the resource/namespace/label selectors defined in the backup spec. To do this, label the item as follows: + +```bash +kubectl label -n / velero.io/exclude-from-backup=true +``` diff --git a/site/docs/main/basic-install.md b/site/content/docs/v1.4/basic-install.md similarity index 98% rename from site/docs/main/basic-install.md rename to site/content/docs/v1.4/basic-install.md index 064d2e6c3..8ce2ff4b0 100644 --- a/site/docs/main/basic-install.md +++ b/site/content/docs/v1.4/basic-install.md @@ -1,4 +1,7 @@ -# Basic Install +--- +title: "Basic Install" +layout: docs +--- - [Basic Install](#basic-install) - [Prerequisites](#prerequisites) diff --git a/site/content/docs/v1.4/build-from-source.md b/site/content/docs/v1.4/build-from-source.md new file mode 100644 index 000000000..6fbadc119 --- /dev/null +++ b/site/content/docs/v1.4/build-from-source.md @@ -0,0 +1,161 @@ +--- +title: "Build from source" +layout: docs +--- + +## Prerequisites + +* Access to a Kubernetes cluster, version 1.7 or later. +* A DNS server on the cluster +* `kubectl` installed +* [Go][5] installed (minimum version 1.8) + +## Get the source + +### Option 1) Get latest (recommended) + +```bash +mkdir $HOME/go +export GOPATH=$HOME/go +go get github.com/vmware-tanzu/velero +``` + +Where `go` is your [import path][4] for Go. + +For Go development, it is recommended to add the Go import path (`$HOME/go` in this example) to your path. + +### Option 2) Release archive + +Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/vmware-tanzu/velero`. + +Note that the Makefile targets assume building from a git repository. When building from an archive, you will be limited to the `go build` commands described below. + +## Build + +There are a number of different ways to build `velero` depending on your needs. This section outlines the main possibilities. + +When building by using `make`, it will place the binaries under `_output/bin/$GOOS/$GOARCH`. For example, you will find the binary for darwin here: `_output/bin/darwin/amd64/velero`, and the binary for linux here: `_output/bin/linux/amd64/velero`. `make` will also splice version and git commit information in so that `velero version` displays proper output. + +Note: `velero install` will also use the version information to determine which tagged image to deploy. If you would like to overwrite what image gets deployed, use the `image` flag (see below for instructions on how to build images). + +### Build the binary + +To build the `velero` binary on your local machine, compiled for your OS and architecture, run one of these two commands: + +```bash +go build ./cmd/velero +``` + +```bash +make local +``` + +### Cross compiling + +To build the velero binary targeting linux/amd64 within a build container on your local machine, run: + +```bash +make build +``` + +For any specific platform, run `make build--`. + +For example, to build for the Mac, run `make build-darwin-amd64`. + +Velero's `Makefile` has a convenience target, `all-build`, that builds the following platforms: + +* linux-amd64 +* linux-arm +* linux-arm64 +* linux-ppc64le +* darwin-amd64 +* windows-amd64 + +## Making images and updating Velero + +If after installing Velero you would like to change the image used by its deployment to one that contains your code changes, you may do so by updating the image: + +```bash +kubectl -n velero set image deploy/velero velero=myimagerepo/velero:$VERSION +``` + +To build a Velero container image, first set the `$REGISTRY` environment variable. For example, if you want to build the `gcr.io/my-registry/velero-amd64:main` image, set `$REGISTRY` to `gcr.io/my-registry`. If this variable is not set, the default is `velero`. + +Optionally, set the `$VERSION` environment variable to change the image tag. Then, run: + +```bash +make container +``` + +For any specific platform, run `ARCH=- make container` + +For example, to build an image for the Power (ppc64le), run: + +```bash +ARCH=linux-ppc64le make container +``` +_Note: By default, ARCH is set to linux-amd64_ + +To push your image to the registry. For example, if you want to push the `gcr.io/my-registry/velero-amd64:main` image, run: + +```bash +make push +``` + +For any specific platform, run `ARCH=- make push` + +For example, to push image for the Power (ppc64le), run: + +```bash +ARCH=linux-ppc64le make push +``` +_Note: By default, ARCH is set to linux-amd64_ + +To create and push your manifest to the registry. For example, if you want to create and push the `gcr.io/my-registry/velero:main` manifest, run: + +```bash +make manifest +``` + +For any specific platform, run `MANIFEST_PLATFORMS= make manifest` + +For example, to create and push manifest only for amd64, run: + +```bash +MANIFEST_PLATFORMS=amd64 make manifest +``` +_Note: By default, MANIFEST_PLATFORMS is set to amd64, ppc64le_ + +To run the entire workflow, run: + +`REGISTRY=<$REGISTRY> VERSION=<$VERSION> ARCH=- MANIFEST_PLATFORMS= make container push manifest` + +For example, to run the workflow only for amd64 + +```bash +REGISTRY=myrepo VERSION=foo MANIFEST_PLATFORMS=amd64 make container push manifest +``` + +_Note: By default, ARCH is set to linux-amd64_ + +For example, to run the workflow only for ppc64le + +```bash +REGISTRY=myrepo VERSION=foo ARCH=linux-ppc64le MANIFEST_PLATFORMS=ppc64le make container push manifest +``` + +For example, to run the workflow for all supported platforms + +```bash +REGISTRY=myrepo VERSION=foo make all-containers all-push all-manifests +``` + +Note: if you want to update the image but not change its name, you will have to trigger Kubernetes to pick up the new image. One way of doing so is by deleting the Velero deployment pod: + +```bash +kubectl -n velero delete pods -l deploy=velero +``` + +[4]: https://blog.golang.org/organizing-go-code +[5]: https://golang.org/doc/install +[22]: https://github.com/vmware-tanzu/velero/releases diff --git a/site/docs/v1.4/code-standards.md b/site/content/docs/v1.4/code-standards.md similarity index 99% rename from site/docs/v1.4/code-standards.md rename to site/content/docs/v1.4/code-standards.md index 00a179546..f97d023ac 100644 --- a/site/docs/v1.4/code-standards.md +++ b/site/content/docs/v1.4/code-standards.md @@ -1,4 +1,7 @@ -# Code Standards +--- +title: "Code Standards" +layout: docs +--- ## Adding a changelog diff --git a/site/content/docs/v1.4/contributions/ibm-config.md b/site/content/docs/v1.4/contributions/ibm-config.md new file mode 100644 index 000000000..299492bc0 --- /dev/null +++ b/site/content/docs/v1.4/contributions/ibm-config.md @@ -0,0 +1,99 @@ +--- +title: "Use IBM Cloud Object Storage as Velero's storage destination." +layout: docs +--- +You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. + +To set up IBM Cloud Object Storage (COS) as Velero's destination, you: + +* Download an official release of Velero +* Create your COS instance +* Create an S3 bucket +* Define a service that can store data in the bucket +* Configure and start the Velero server + +## Download Velero + +1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform. + + _We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of +Velero. The tarballs for each release contain the `velero` command-line client. The code in the main branch +of the Velero repository is under active development and is not guaranteed to be stable!_ + +1. Extract the tarball: + + ```bash + tar -xvf .tar.gz -C /dir/to/extract/to + ``` + + We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. + +1. Move the `velero` binary from the Velero directory to somewhere in your PATH. + +## Create COS instance +If you don’t have a COS instance, you can create a new one, according to the detailed instructions in [Creating a new resource instance][1]. + +## Create an S3 bucket +Velero requires an object storage bucket to store backups in. See instructions in [Create some buckets to store your data][2]. + +## Define a service that can store data in the bucket. +The process of creating service credentials is described in [Service credentials][3]. +Several comments: + +1. The Velero service will write its backup into the bucket, so it requires the “Writer” access role. + +2. Velero uses an AWS S3 compatible API. Which means it authenticates using a signature created from a pair of access and secret keys — a set of HMAC credentials. You can create these HMAC credentials by specifying `{“HMAC”:true}` as an optional inline parameter. See step 3 in the [Service credentials][3] guide. + +3. After successfully creating a Service credential, you can view the JSON definition of the credential. Under the `cos_hmac_keys` entry there are `access_key_id` and `secret_access_key`. We will use them in the next step. + +4. Create a Velero-specific credentials file (`credentials-velero`) in your local directory: + + ``` + [default] + aws_access_key_id= + aws_secret_access_key= + ``` + + where the access key id and secret are the values that we got above. + +## Install and start Velero + +Install Velero, including all prerequisites, into the cluster and start the deployment. This will create a namespace called `velero`, and place a deployment named `velero` in it. + +```bash +velero install \ + --provider aws \ + --bucket \ + --secret-file ./credentials-velero \ + --use-volume-snapshots=false \ + --backup-location-config region=,s3ForcePathStyle="true",s3Url= +``` + +Velero does not currently have a volume snapshot plugin for IBM Cloud, so creating volume snapshots is disabled. + +Additionally, you can specify `--use-restic` to enable restic support, and `--wait` to wait for the deployment to be ready. + +(Optional) Specify [CPU and memory resource requests and limits][15] for the Velero/restic pods. + +Once the installation is complete, remove the default `VolumeSnapshotLocation` that was created by `velero install`, since it's specific to AWS and won't work for IBM Cloud: + +```bash +kubectl -n velero delete volumesnapshotlocation.velero.io default +``` + +For more complex installation needs, use either the Helm chart, or add `--dry-run -o yaml` options for generating the YAML representation for the installation. + +## Installing the nginx example (optional) + +If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`: + +Uncomment `storageClassName: ` and replace with your `StorageClass` name. + +[0]: namespace.md +[1]: https://console.bluemix.net/docs/services/cloud-object-storage/basics/order-storage.html#creating-a-new-resource-instance +[2]: https://console.bluemix.net/docs/services/cloud-object-storage/getting-started.html#create-buckets +[3]: https://console.bluemix.net/docs/services/cloud-object-storage/iam/service-credentials.html#service-credentials +[4]: https://www.ibm.com/support/knowledgecenter/SSBS6K_2.1.0/kc_welcome_containers.html +[5]: https://console.bluemix.net/docs/containers/container_index.html#container_index +[14]: http://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html +[15]: customize-installation.md#customize-resource-requests-and-limits diff --git a/site/docs/v1.4/contributions/minio.md b/site/content/docs/v1.4/contributions/minio.md similarity index 99% rename from site/docs/v1.4/contributions/minio.md rename to site/content/docs/v1.4/contributions/minio.md index c0b27538b..c0416c286 100644 --- a/site/docs/v1.4/contributions/minio.md +++ b/site/content/docs/v1.4/contributions/minio.md @@ -1,4 +1,7 @@ -## Quick start evaluation install with Minio +--- +title: "Quick start evaluation install with Minio" +layout: docs +--- The following example sets up the Velero server and client, then backs up and restores a sample application. diff --git a/site/docs/v1.4/contributions/oracle-config.md b/site/content/docs/v1.4/contributions/oracle-config.md similarity index 99% rename from site/docs/v1.4/contributions/oracle-config.md rename to site/content/docs/v1.4/contributions/oracle-config.md index 2cc0671f6..3cfa80c5a 100644 --- a/site/docs/v1.4/contributions/oracle-config.md +++ b/site/content/docs/v1.4/contributions/oracle-config.md @@ -1,4 +1,7 @@ -# Use Oracle Cloud as a Backup Storage Provider for Velero +--- +title: "Use Oracle Cloud as a Backup Storage Provider for Velero" +layout: docs +--- ## Introduction diff --git a/site/docs/v1.4/csi.md b/site/content/docs/v1.4/csi.md similarity index 98% rename from site/docs/v1.4/csi.md rename to site/content/docs/v1.4/csi.md index cd1b80bd3..928f57965 100644 --- a/site/docs/v1.4/csi.md +++ b/site/content/docs/v1.4/csi.md @@ -1,4 +1,7 @@ -# Container Storage Interface Snapshot Support in Velero +--- +title: "Container Storage Interface Snapshot Support in Velero" +layout: docs +--- _This feature is under development. Documentation may not be up-to-date and features may not work as expected._ diff --git a/site/docs/v1.4/custom-plugins.md b/site/content/docs/v1.4/custom-plugins.md similarity index 99% rename from site/docs/v1.4/custom-plugins.md rename to site/content/docs/v1.4/custom-plugins.md index 992039adc..075d9a77a 100644 --- a/site/docs/v1.4/custom-plugins.md +++ b/site/content/docs/v1.4/custom-plugins.md @@ -1,4 +1,7 @@ -# Plugins +--- +title: "Plugins" +layout: docs +--- Velero has a plugin architecture that allows users to add their own custom functionality to Velero backups & restores without having to modify/recompile the core Velero binary. To add custom functionality, users simply create their own binary containing implementations of Velero's plugin kinds (described below), plus a small amount of boilerplate code to expose the plugin implementations to Velero. This binary is added to a container image that serves as an init container for the Velero server pod and copies the binary into a shared emptyDir volume for the Velero server to access. diff --git a/site/docs/v1.4/customize-installation.md b/site/content/docs/v1.4/customize-installation.md similarity index 99% rename from site/docs/v1.4/customize-installation.md rename to site/content/docs/v1.4/customize-installation.md index 770e988c8..6d4fcc4d8 100644 --- a/site/docs/v1.4/customize-installation.md +++ b/site/content/docs/v1.4/customize-installation.md @@ -1,4 +1,7 @@ -# Customize Velero Install +--- +title: "Customize Velero Install" +layout: docs +--- - [Customize Velero Install](#customize-velero-install) - [Plugins](#plugins) diff --git a/site/content/docs/v1.4/debugging-install.md b/site/content/docs/v1.4/debugging-install.md new file mode 100644 index 000000000..9c2067b34 --- /dev/null +++ b/site/content/docs/v1.4/debugging-install.md @@ -0,0 +1,74 @@ +--- +title: "Debugging Installation Issues" +layout: docs +--- + +## General + +### `invalid configuration: no configuration has been provided` +This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the +following locations: +* the path specified by the `--kubeconfig` flag, if any +* the path specified by the `$KUBECONFIG` environment variable, if any +* `~/.kube/config` + +### Backups or restores stuck in `New` phase +This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: +``` +kubectl -n velero describe pods +kubectl -n velero logs deployment/velero +``` + + +## AWS + +### `NoCredentialProviders: no valid providers in chain` + +#### Using credentials +This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `credentials-velero` file is formatted properly and has the correct values: + + ``` + [default] + aws_access_key_id= + aws_secret_access_key= + ``` + +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +#### Using kube2iam +This means that Velero can't read the content of the S3 bucket. Ensure the following: + +* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. +* The new Velero role has all the permissions listed in the documentation regarding S3. + + +## Azure + +### `Failed to refresh the Token` or `adal: Refresh request failed` +This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted +properly into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + + +## GCE/GKE + +### `open credentials/cloud: no such file or directory` +This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly +into the Velero server pod. Ensure the following: + +* The `cloud-credentials` secret exists in the Velero server's namespace +* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file +* The `cloud-credentials` secret is defined as a volume for the Velero deployment +* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` + +[0]: azure-config.md#create-service-principal diff --git a/site/content/docs/v1.4/debugging-restores.md b/site/content/docs/v1.4/debugging-restores.md new file mode 100644 index 000000000..eb834b0bc --- /dev/null +++ b/site/content/docs/v1.4/debugging-restores.md @@ -0,0 +1,109 @@ +--- +title: "Debugging Restores" +layout: docs +--- + +* [Example][0] +* [Structure][1] + +## Example + +When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: + +``` +NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR +backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT +backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT +backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT +backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT +``` + +To delve into the warnings and errors into more detail, you can use `velero restore describe`: + +```bash +velero restore describe backup-test-20170726180512 +``` + +The output looks like this: + +``` +Name: backup-test-20170726180512 +Namespace: velero +Labels: +Annotations: + +Backup: backup-test + +Namespaces: + Included: * + Excluded: + +Resources: + Included: serviceaccounts + Excluded: nodes, events, events.events.k8s.io + Cluster-scoped: auto + +Namespace mappings: + +Label selector: + +Restore PVs: auto + +Phase: Completed + +Validation errors: + +Warnings: + Velero: + Cluster: + Namespaces: + velero: serviceaccounts "velero" already exists + serviceaccounts "default" already exists + kube-public: serviceaccounts "default" already exists + kube-system: serviceaccounts "attachdetach-controller" already exists + serviceaccounts "certificate-controller" already exists + serviceaccounts "cronjob-controller" already exists + serviceaccounts "daemon-set-controller" already exists + serviceaccounts "default" already exists + serviceaccounts "deployment-controller" already exists + serviceaccounts "disruption-controller" already exists + serviceaccounts "endpoint-controller" already exists + serviceaccounts "generic-garbage-collector" already exists + serviceaccounts "horizontal-pod-autoscaler" already exists + serviceaccounts "job-controller" already exists + serviceaccounts "kube-dns" already exists + serviceaccounts "namespace-controller" already exists + serviceaccounts "node-controller" already exists + serviceaccounts "persistent-volume-binder" already exists + serviceaccounts "pod-garbage-collector" already exists + serviceaccounts "replicaset-controller" already exists + serviceaccounts "replication-controller" already exists + serviceaccounts "resourcequota-controller" already exists + serviceaccounts "service-account-controller" already exists + serviceaccounts "service-controller" already exists + serviceaccounts "statefulset-controller" already exists + serviceaccounts "ttl-controller" already exists + default: serviceaccounts "default" already exists + +Errors: + Velero: + Cluster: + Namespaces: +``` + +## Structure + +Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the +restore looks "normal" and all resources referenced in the backup exist in some form, although some +of them may have been pre-existing). + +Both errors and warnings are structured in the same way: + +* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). + +* `Cluster`: A list of issues related to the restore of cluster-scoped resources. + +* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. + +[0]: #example +[1]: #structure diff --git a/site/content/docs/v1.4/development.md b/site/content/docs/v1.4/development.md new file mode 100644 index 000000000..c805a27da --- /dev/null +++ b/site/content/docs/v1.4/development.md @@ -0,0 +1,33 @@ +--- +title: "Development " +layout: docs +--- + +## Update generated files + +Run `make update` to regenerate files if you make the following changes: + +* Add/edit/remove command line flags and/or their help text +* Add/edit/remove commands or subcommands +* Add new API types +* Add/edit/remove plugin protobuf message or service definitions + +The following files are automatically generated from the source code: + +* The clientset +* Listers +* Shared informers +* Documentation +* Protobuf/gRPC types + +You can run `make verify` to ensure that all generated files (clientset, listers, shared informers, docs) are up to date. + +## Test + +To run unit tests, use `make test`. + +## Vendor dependencies + +If you need to add or update the vendored dependencies, see [Vendoring dependencies][11]. + +[11]: vendoring-dependencies.md diff --git a/site/docs/main/disaster-case.md b/site/content/docs/v1.4/disaster-case.md similarity index 97% rename from site/docs/main/disaster-case.md rename to site/content/docs/v1.4/disaster-case.md index c9f126a8b..6b73e6716 100644 --- a/site/docs/main/disaster-case.md +++ b/site/content/docs/v1.4/disaster-case.md @@ -1,4 +1,7 @@ -# Disaster recovery +--- +title: "Disaster recovery" +layout: docs +--- *Using Schedules and Read-Only Backup Storage Locations* diff --git a/site/content/docs/v1.4/examples.md b/site/content/docs/v1.4/examples.md new file mode 100644 index 000000000..c73ae2b23 --- /dev/null +++ b/site/content/docs/v1.4/examples.md @@ -0,0 +1,66 @@ +--- +title: "Examples" +layout: docs +--- + +After you set up the Velero server, try these examples: + +### Basic example (without PersistentVolumes) + +1. Start the sample nginx app: + + ```bash + kubectl apply -f examples/nginx-app/base.yaml + ``` + +1. Create a backup: + + ```bash + velero backup create nginx-backup --include-namespaces nginx-example + ``` + +1. Simulate a disaster: + + ```bash + kubectl delete namespaces nginx-example + ``` + + Wait for the namespace to be deleted. + +1. Restore your lost resources: + + ```bash + velero restore create --from-backup nginx-backup + ``` + +### Snapshot example (with PersistentVolumes) + +> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks. + +1. Start the sample nginx app: + + ```bash + kubectl apply -f examples/nginx-app/with-pv.yaml + ``` + +1. Create a backup with PV snapshotting: + + ```bash + velero backup create nginx-backup --include-namespaces nginx-example + ``` + +1. Simulate a disaster: + + ```bash + kubectl delete namespaces nginx-example + ``` + + Because the default [reclaim policy][1] for dynamically-provisioned PVs is "Delete", these commands should trigger your cloud provider to delete the disk that backs the PV. Deletion is asynchronous, so this may take some time. **Before continuing to the next step, check your cloud provider to confirm that the disk no longer exists.** + +1. Restore your lost resources: + + ```bash + velero restore create --from-backup nginx-backup + ``` + +[1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming diff --git a/site/docs/main/faq.md b/site/content/docs/v1.4/faq.md similarity index 72% rename from site/docs/main/faq.md rename to site/content/docs/v1.4/faq.md index 35eb793e6..9af2d5935 100644 --- a/site/docs/main/faq.md +++ b/site/content/docs/v1.4/faq.md @@ -1,3 +1,6 @@ -# FAQ +--- +title: "FAQ" +layout: docs +--- Our FAQ has been moved to here: https://github.com/vmware-tanzu/velero/wiki/Velero-FAQ. \ No newline at end of file diff --git a/site/docs/v1.4/hooks.md b/site/content/docs/v1.4/hooks.md similarity index 99% rename from site/docs/v1.4/hooks.md rename to site/content/docs/v1.4/hooks.md index 6ea1dae69..a648ac204 100644 --- a/site/docs/v1.4/hooks.md +++ b/site/content/docs/v1.4/hooks.md @@ -1,4 +1,7 @@ -# Hooks +--- +title: "Hooks" +layout: docs +--- Velero currently supports executing commands in containers in pods during a backup. diff --git a/site/docs/main/how-velero-works.md b/site/content/docs/v1.4/how-velero-works.md similarity index 99% rename from site/docs/main/how-velero-works.md rename to site/content/docs/v1.4/how-velero-works.md index 543ab2f94..45889caef 100644 --- a/site/docs/main/how-velero-works.md +++ b/site/content/docs/v1.4/how-velero-works.md @@ -1,4 +1,7 @@ -# How Velero Works +--- +title: "How Velero Works" +layout: docs +--- Each Velero operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Velero also includes controllers that process the custom resources to perform backups, restores, and all related operations. diff --git a/site/content/docs/v1.4/image-tagging.md b/site/content/docs/v1.4/image-tagging.md new file mode 100644 index 000000000..fbfb15617 --- /dev/null +++ b/site/content/docs/v1.4/image-tagging.md @@ -0,0 +1,24 @@ +--- +title: "Image tagging policy" +layout: docs +--- + +This document describes Velero's image tagging policy. + +## Released versions + +`velero/velero:` + +Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/vmware-tanzu/velero` repository has a matching image, e.g. `velero/velero:v1.0.0`. + +### Latest + +`velero/velero:latest` + +The `latest` tag follows the most recently released version of Velero. + +## Development + +`velero/velero:main` + +The `main` tag follows the latest commit to land on the `main` branch. diff --git a/site/docs/v1.4/img/README.md b/site/content/docs/v1.4/img/README.md similarity index 100% rename from site/docs/v1.4/img/README.md rename to site/content/docs/v1.4/img/README.md diff --git a/site/docs/v1.4/img/backup-process.png b/site/content/docs/v1.4/img/backup-process.png similarity index 100% rename from site/docs/v1.4/img/backup-process.png rename to site/content/docs/v1.4/img/backup-process.png diff --git a/site/docs/v1.4/img/velero.png b/site/content/docs/v1.4/img/velero.png similarity index 100% rename from site/docs/v1.4/img/velero.png rename to site/content/docs/v1.4/img/velero.png diff --git a/site/content/docs/v1.4/locations.md b/site/content/docs/v1.4/locations.md new file mode 100644 index 000000000..b5d8ca3fc --- /dev/null +++ b/site/content/docs/v1.4/locations.md @@ -0,0 +1,167 @@ +--- +title: "Backup Storage Locations and Volume Snapshot Locations" +layout: docs +--- + +## Overview + +Velero has two custom resources, `BackupStorageLocation` and `VolumeSnapshotLocation`, that are used to configure where Velero backups and their associated persistent volume snapshots are stored. + +A `BackupStorageLocation` is defined as a bucket, a prefix within that bucket under which all Velero data should be stored, and a set of additional provider-specific fields (e.g. AWS region, Azure storage account, etc.) The [API documentation][1] captures the configurable parameters for each in-tree provider. + +A `VolumeSnapshotLocation` is defined entirely by provider-specific fields (e.g. AWS region, Azure resource group, Portworx snapshot type, etc.) The [API documentation][2] captures the configurable parameters for each in-tree provider. + +The user can pre-configure one or more possible `BackupStorageLocations` and one or more `VolumeSnapshotLocations`, and can select *at backup creation time* the location in which the backup and associated snapshots should be stored. + +This configuration design enables a number of different use cases, including: + +- Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) +- Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region +- For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud + +## Limitations / Caveats + +- Velero only supports a single set of credentials *per provider*. It's not yet possible to use different credentials for different locations, if they're for the same provider. + +- Volume snapshots are still limited by where your provider allows you to create snapshots. For example, AWS and Azure do not allow you to create a volume snapshot in a different region than where the volume is. If you try to take a Velero backup using a volume snapshot location with a different region than where your cluster's volumes are, the backup will fail. + +- Each Velero backup has one `BackupStorageLocation`, and one `VolumeSnapshotLocation` per volume provider. It is not possible (yet) to send a single Velero backup to multiple backup storage locations simultaneously, or a single volume snapshot to multiple locations simultaneously. However, you can always set up multiple scheduled backups that differ only in the storage locations used if redundancy of backups across locations is important. + +- Cross-provider snapshots are not supported. If you have a cluster with more than one type of volume (e.g. EBS and Portworx), but you only have a `VolumeSnapshotLocation` configured for EBS, then Velero will **only** snapshot the EBS volumes. + +- Restic data is stored under a prefix/subdirectory of the main Velero bucket, and will go into the bucket corresponding to the `BackupStorageLocation` selected by the user at backup creation time. + +## Examples + +Let's look at some examples of how we can use this configuration mechanism to address some common use cases: + +#### Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) + +During server configuration: + +```shell +velero snapshot-location create ebs-us-east-1 \ + --provider aws \ + --config region=us-east-1 + +velero snapshot-location create portworx-cloud \ + --provider portworx \ + --config type=cloud +``` + +During backup creation: + +```shell +velero backup create full-cluster-backup \ + --volume-snapshot-locations ebs-us-east-1,portworx-cloud +``` + +Alternately, since in this example there's only one possible volume snapshot location configured for each of our two providers (`ebs-us-east-1` for `aws`, and `portworx-cloud` for `portworx`), Velero doesn't require them to be explicitly specified when creating the backup: + +```shell +velero backup create full-cluster-backup +``` + +#### Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region + +During server configuration: + +```shell +velero backup-location create default \ + --provider aws \ + --bucket velero-backups \ + --config region=us-east-1 + +velero backup-location create s3-alt-region \ + --provider aws \ + --bucket velero-backups-alt \ + --config region=us-west-1 +``` + +During backup creation: + +```shell +# The Velero server will automatically store backups in the backup storage location named "default" if +# one is not specified when creating the backup. You can alter which backup storage location is used +# by default by setting the --default-backup-storage-location flag on the `velero server` command (run +# by the Velero deployment) to the name of a different backup storage location. +velero backup create full-cluster-backup +``` + +Or: + +```shell +velero backup create full-cluster-alternate-location-backup \ + --storage-location s3-alt-region +``` + +#### For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud + +During server configuration: + +```shell +velero snapshot-location create portworx-local \ + --provider portworx \ + --config type=local + +velero snapshot-location create portworx-cloud \ + --provider portworx \ + --config type=cloud +``` + +During backup creation: + +```shell +# Note that since in this example we have two possible volume snapshot locations for the Portworx +# provider, we need to explicitly specify which one to use when creating a backup. Alternately, +# you can set the --default-volume-snapshot-locations flag on the `velero server` command (run by +# the Velero deployment) to specify which location should be used for each provider by default, in +# which case you don't need to specify it when creating a backup. +velero backup create local-snapshot-backup \ + --volume-snapshot-locations portworx-local +``` + +Or: + +```shell +velero backup create cloud-snapshot-backup \ + --volume-snapshot-locations portworx-cloud +``` + +#### Use a single location + +If you don't have a use case for more than one location, it's still easy to use Velero. Let's assume you're running on AWS, in the `us-west-1` region: + +During server configuration: + +```shell +velero backup-location create default \ + --provider aws \ + --bucket velero-backups \ + --config region=us-west-1 + +velero snapshot-location create ebs-us-west-1 \ + --provider aws \ + --config region=us-west-1 +``` + +During backup creation: + +```shell +# Velero will automatically use your configured backup storage location and volume snapshot location. +# Nothing needs to be specified when creating a backup. +velero backup create full-cluster-backup +``` + +## Additional Use Cases + +1. If you're using Azure's AKS, you may want to store your volume snapshots outside of the "infrastructure" resource group that is automatically created when you create your AKS cluster. This is possible using a `VolumeSnapshotLocation`, by specifying a `resourceGroup` under the `config` section of the snapshot location. See the [Azure volume snapshot location documentation][3] for details. + +1. If you're using Azure, you may want to store your Velero backups across multiple storage accounts and/or resource groups/subscriptions. This is possible using a `BackupStorageLocation`, by specifying a `storageAccount`, `resourceGroup` and/or `subscriptionId`, respectively, under the `config` section of the backup location. See the [Azure backup storage location documentation][4] for details. + + + +[1]: api-types/backupstoragelocation.md +[2]: api-types/volumesnapshotlocation.md +[3]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md +[4]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md diff --git a/site/docs/v1.4/migration-case.md b/site/content/docs/v1.4/migration-case.md similarity index 98% rename from site/docs/v1.4/migration-case.md rename to site/content/docs/v1.4/migration-case.md index c1fa1cd6f..e95323133 100644 --- a/site/docs/v1.4/migration-case.md +++ b/site/content/docs/v1.4/migration-case.md @@ -1,4 +1,7 @@ -# Cluster migration +--- +title: "Cluster migration" +layout: docs +--- *Using Backups and Restores* diff --git a/site/content/docs/v1.4/namespace.md b/site/content/docs/v1.4/namespace.md new file mode 100644 index 000000000..14e2c6179 --- /dev/null +++ b/site/content/docs/v1.4/namespace.md @@ -0,0 +1,22 @@ +--- +title: "Run in a non-default namespace" +layout: docs +--- + +The Velero installation and backups by default are run in the `velero` namespace. However, it is possible to use a different namespace. + +### 1) Customize the namespace during install + +Use the `--namespace` flag, in conjunction with the other flags in the `velero install` command (as shown in the [the Velero install instructions][0]). This will inform Velero where to install. + +### 2) Customize the namespace for operational commands + +To have namespace consistency, specify the namespace for all Velero operational commands to be the same as the namespace used to install Velero: + +```bash +velero client config set namespace= +``` + +Alternatively, you may use the global `--namespace` flag with any operational command to tell Velero where to run. + +[0]: basic-install.md#install-the-cli diff --git a/site/docs/main/on-premises.md b/site/content/docs/v1.4/on-premises.md similarity index 98% rename from site/docs/main/on-premises.md rename to site/content/docs/v1.4/on-premises.md index 03a9f73d0..5570ee56b 100644 --- a/site/docs/main/on-premises.md +++ b/site/content/docs/v1.4/on-premises.md @@ -1,4 +1,7 @@ -# On-Premises Environments +--- +title: "On-Premises Environments" +layout: docs +--- You can run Velero in an on-premises cluster in different ways depending on your requirements. diff --git a/site/docs/main/output-file-format.md b/site/content/docs/v1.4/output-file-format.md similarity index 99% rename from site/docs/main/output-file-format.md rename to site/content/docs/v1.4/output-file-format.md index 887743451..a7ab0ca0a 100644 --- a/site/docs/main/output-file-format.md +++ b/site/content/docs/v1.4/output-file-format.md @@ -1,4 +1,7 @@ -# Output file format +--- +title: "Output file format" +layout: docs +--- A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `velero backup create `). diff --git a/site/content/docs/v1.4/overview-plugins.md b/site/content/docs/v1.4/overview-plugins.md new file mode 100644 index 000000000..037601d51 --- /dev/null +++ b/site/content/docs/v1.4/overview-plugins.md @@ -0,0 +1,29 @@ +--- +title: "Velero plugin system" +layout: docs +--- + +Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. + +For server installation, Velero requires that at least one plugin is added (with the `--plugins` flag). The plugin will be either of the type object store or volume snapshotter, or a plugin that contains both. An exception to this is that when the user is not configuring a backup storage location or a snapshot storage location at the time of install, this flag is optional. + +Any plugin can be added after Velero has been installed by using the command `velero plugin add `. + +Example with a dockerhub image: `velero plugin add velero/velero-plugin-for-aws:v1.0.0`. + +In the same way, any plugin can be removed by using the command `velero plugin remove `. + +## Creating a new plugin + +Anyone can add integrations for any platform to provide additional backup and volume storage without modifying the Velero codebase. To write a plugin for a new backup or volume storage platform, take a look at our [example repo][1] and at our documentation for [Custom plugins][2]. + +## Adding a new plugin + +After you publish your plugin on your own repository, open a PR that adds a link to it under the appropriate list of [supported providers][3] page in our documentation. + +You can also add the [`velero-plugin` GitHub Topic][4] to your repo, and it will be shown under the aggregated list of repositories automatically. + +[1]: https://github.com/vmware-tanzu/velero-plugin-example/ +[2]: custom-plugins.md +[3]: supported-providers.md +[4]: https://github.com/topics/velero-plugin diff --git a/site/content/docs/v1.4/rbac.md b/site/content/docs/v1.4/rbac.md new file mode 100644 index 000000000..a9c22b9f1 --- /dev/null +++ b/site/content/docs/v1.4/rbac.md @@ -0,0 +1,50 @@ +--- +title: "Run Velero more securely with restrictive RBAC settings" +layout: docs +--- + +By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. + +**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. + +For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. + +## Set up Roles and RoleBindings + +Here's a sample Role and RoleBinding pair. + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + namespace: YOUR_NAMESPACE_HERE + name: ROLE_NAME_HERE + labels: + component: velero +rules: + - apiGroups: + - velero.io + verbs: + - "*" + resources: + - "*" +``` + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: ROLEBINDING_NAME_HERE +subjects: + - kind: ServiceAccount + name: YOUR_SERVICEACCOUNT_HERE +roleRef: + kind: Role + name: ROLE_NAME_HERE + apiGroup: rbac.authorization.k8s.io +``` + +[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ +[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ +[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +[4]: namespace.md diff --git a/site/docs/v1.4/release-instructions.md b/site/content/docs/v1.4/release-instructions.md similarity index 99% rename from site/docs/v1.4/release-instructions.md rename to site/content/docs/v1.4/release-instructions.md index 39a7ea3e9..441918cee 100644 --- a/site/docs/v1.4/release-instructions.md +++ b/site/content/docs/v1.4/release-instructions.md @@ -1,4 +1,7 @@ -# Release Instructions +--- +title: "Release Instructions" +layout: docs +--- ## Ahead of Time diff --git a/site/docs/v1.4/resource-filtering.md b/site/content/docs/v1.4/resource-filtering.md similarity index 100% rename from site/docs/v1.4/resource-filtering.md rename to site/content/docs/v1.4/resource-filtering.md diff --git a/site/docs/v1.4/restic.md b/site/content/docs/v1.4/restic.md similarity index 99% rename from site/docs/v1.4/restic.md rename to site/content/docs/v1.4/restic.md index 6b27a32ce..504aea248 100644 --- a/site/docs/v1.4/restic.md +++ b/site/content/docs/v1.4/restic.md @@ -1,4 +1,7 @@ -# Restic Integration +--- +title: "Restic Integration" +layout: docs +--- Velero has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic][1]. This support is considered beta quality. Please see the list of [limitations](#limitations) to understand if it currently fits your use case. diff --git a/site/docs/main/restore-reference.md b/site/content/docs/v1.4/restore-reference.md similarity index 98% rename from site/docs/main/restore-reference.md rename to site/content/docs/v1.4/restore-reference.md index 46f4ffb40..6711679ac 100644 --- a/site/docs/main/restore-reference.md +++ b/site/content/docs/v1.4/restore-reference.md @@ -1,4 +1,7 @@ -# Restore Reference +--- +title: "Restore Reference" +layout: docs +--- ## Restoring Into a Different Namespace diff --git a/site/content/docs/v1.4/run-locally.md b/site/content/docs/v1.4/run-locally.md new file mode 100644 index 000000000..ffd735b4f --- /dev/null +++ b/site/content/docs/v1.4/run-locally.md @@ -0,0 +1,52 @@ +--- +title: "Run Velero locally in development" +layout: docs +--- + +Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server +image and redeploy it to the cluster with each change. + +## Run Velero locally with a remote cluster + +Velero runs against the Kubernetes API server as the endpoint (as per the `kubeconfig` configuration), so both the Velero server and client use the same `client-go` to communicate with Kubernetes. This means the Velero server can be run locally just as functionally as if it was running in the remote cluster. + +### Prerequisites + +When running Velero, you will need to ensure that you set up all of the following: + +* Appropriate RBAC permissions in the cluster + * Read access for all data from the source cluster and namespaces + * Write access to the target cluster and namespaces +* Cloud provider credentials + * Read/write access to volumes + * Read/write access to object storage for backup data +* A [BackupStorageLocation][20] object definition for the Velero server +* (Optional) A [VolumeSnapshotLocation][21] object definition for the Velero server, to take PV snapshots + +### 1. Install Velero + +See documentation on how to install Velero in some specific providers: [Install overview][22] + +### 2. Scale deployment down to zero + +After you use the `velero install` command to install Velero into your cluster, you scale the Velero deployment down to 0 so it is not simultaneously being run on the remote cluster and potentially causing things to get out of sync: + +`kubectl scale --replicas=0 deployment velero -n velero` + +#### 3. Start the Velero server locally + +* To run the server locally, use the full path according to the binary you need. Example, if you are on a Mac, and using `AWS` as a provider, this is how to run the binary you built from source using the full path: `AWS_SHARED_CREDENTIALS_FILE= ./_output/bin/darwin/amd64/velero`. Alternatively, you may add the `velero` binary to your `PATH`. + +* Start the server: `velero server [CLI flags]`. The following CLI flags may be useful to customize, but see `velero server --help` for full details: + * `--log-level`: set the Velero server's log level (default `info`, use `debug` for the most logging) + * `--kubeconfig`: set the path to the kubeconfig file the Velero server uses to talk to the Kubernetes apiserver (default `$KUBECONFIG`) + * `--namespace`: the set namespace where the Velero server should look for backups, schedules, restores (default `velero`) + * `--plugin-dir`: set the directory where the Velero server looks for plugins (default `/plugins`) + * `--metrics-address`: set the bind address and port where Prometheus metrics are exposed (default `:8085`) + +[15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file +[16]: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable +[18]: https://eksctl.io/ +[20]: api-types/backupstoragelocation.md +[21]: api-types/volumesnapshotlocation.md +[22]: basic-install.md diff --git a/site/docs/main/self-signed-certificates.md b/site/content/docs/v1.4/self-signed-certificates.md similarity index 92% rename from site/docs/main/self-signed-certificates.md rename to site/content/docs/v1.4/self-signed-certificates.md index aca33d9c1..a24bc32f4 100644 --- a/site/docs/main/self-signed-certificates.md +++ b/site/content/docs/v1.4/self-signed-certificates.md @@ -1,4 +1,7 @@ -# Use Velero with a storage provider secured by a self-signed certificate +--- +title: "Use Velero with a storage provider secured by a self-signed certificate" +layout: docs +--- If you are using an S3-Compatible storage provider that is secured with a self-signed certificate, connections to the object store may fail with a `certificate signed by unknown authority` message. In order to proceed, a certificate bundle may be provided when adding the storage provider. diff --git a/site/docs/v1.4/start-contributing.md b/site/content/docs/v1.4/start-contributing.md similarity index 97% rename from site/docs/v1.4/start-contributing.md rename to site/content/docs/v1.4/start-contributing.md index b0bbca97a..b2af8127a 100644 --- a/site/docs/v1.4/start-contributing.md +++ b/site/content/docs/v1.4/start-contributing.md @@ -1,4 +1,7 @@ -## Start contributing +--- +title: "Start contributing" +layout: docs +--- ### Before you start diff --git a/site/content/docs/v1.4/support-process.md b/site/content/docs/v1.4/support-process.md new file mode 100644 index 000000000..fc06e72e9 --- /dev/null +++ b/site/content/docs/v1.4/support-process.md @@ -0,0 +1,44 @@ +--- +title: "Support Process" +layout: docs +--- + +## Weekly Rotation + +The Velero maintainers use a weekly rotation to manage community support. Each week, a different maintainer is the point person for responding to incoming support issues via Slack, GitHub, and the Google group. The point person is *not* expected to be on-call 24x7. Instead, they choose one or more hour(s) per day to be available/responding to incoming issues. They will communicate to the community what that time slot will be each week. + +## Start of Week + +We will update the public Slack channel's topic to indicate that you are the point person for the week, and what hours you'll be available. + +## During the Week + +### Where we will monitor +- `#velero` public Slack channel in Kubernetes org +- [all Velero-related repos][0] in GitHub (`velero`, `velero-plugin-for-[aws|gcp|microsoft-azure|csi]`, `helm-charts`) +- [Project Velero Google Group][1] + +### GitHub issue flow + +Generally speaking, new GitHub issues will fall into one of several categories. We use the following process for each: + +1. **Feature request** + - Label the issue with `Enhancement/User` or `Enhancement/Dev` + - Leave the issue in the `New Issues` swimlane for triage by product mgmt +1. **Bug** + - Label the issue with `Bug` + - Leave the issue in the `New Issues` swimlane for triage by product mgmt +1. **User question/problem** that does not clearly fall into one of the previous categories + - When you start investigating/responding, label the issue with `Investigating` + - Add comments as you go, so both the user and future support people have as much context as possible + - Use the `Needs Info` label to indicate an issue is waiting for information from the user. Remove/re-add the label as needed. + - If you resolve the issue with the user, close it out + - If the issue ends up being a feature request or a bug, update the title and follow the appropriate process for it + - If the reporter becomes unresponsive after multiple pings, close out the issue due to inactivity and comment that the user can always reach out again as needed + +## End of Week + +We ensure all GitHub issues worked on during the week on are labeled with `Investigating` and `Needs Info` (if appropriate), and have updated comments so the next person can pick them up. + +[0]: https://app.zenhub.com/workspaces/velero-5c59c15e39d47b774b5864e3/board?repos=99143276,112385197,213946861,190224441,214524700,214524630 +[1]: https://groups.google.com/forum/#!forum/projectvelero diff --git a/site/docs/v1.4/supported-providers.md b/site/content/docs/v1.4/supported-providers.md similarity index 99% rename from site/docs/v1.4/supported-providers.md rename to site/content/docs/v1.4/supported-providers.md index 07e304ddc..ae1d25e55 100644 --- a/site/docs/v1.4/supported-providers.md +++ b/site/content/docs/v1.4/supported-providers.md @@ -1,4 +1,7 @@ -# Providers +--- +title: "Providers" +layout: docs +--- Velero supports a variety of storage providers for different backup and snapshot operations. Velero has a plugin system which allows anyone to add compatibility for additional backup and volume storage platforms without modifying the Velero codebase. diff --git a/site/content/docs/v1.4/troubleshooting.md b/site/content/docs/v1.4/troubleshooting.md new file mode 100644 index 000000000..6d0fa998f --- /dev/null +++ b/site/content/docs/v1.4/troubleshooting.md @@ -0,0 +1,126 @@ +--- +title: "Troubleshooting" +layout: docs +--- + +These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. + +- [Troubleshooting](#troubleshooting) + - [Debug installation/ setup issues](#debug-installation-setup-issues) + - [Debug restores](#debug-restores) + - [General troubleshooting information](#general-troubleshooting-information) + - [Getting velero debug logs](#getting-velero-debug-logs) + - [Known issue with restoring LoadBalancer Service](#known-issue-with-restoring-loadbalancer-service) + - [Miscellaneous issues](#miscellaneous-issues) + - [Velero reports `custom resource not found` errors when starting up.](#velero-reports-custom-resource-not-found-errors-when-starting-up) + - [`velero backup logs` returns a `SignatureDoesNotMatch` error](#velero-backup-logs-returns-a-signaturedoesnotmatch-error) + - [Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress](#velero-or-a-pod-it-was-backing-up-restarted-during-a-backup-and-the-backup-is-stuck-inprogress) + - [Velero is not publishing prometheus metrics](#velero-is-not-publishing-prometheus-metrics) + +## Debug installation/ setup issues + +- [Debug installation/setup issues][2] + +## Debug restores + +- [Debug restores][1] + +## General troubleshooting information + +You can use the `velero bug` command to open a [Github issue][4] by launching a browser window with some prepopulated values. Values included are OS, CPU architecture, `kubectl` client and server versions (if available) and the `velero` client version. This information isn't submitted to Github until you click the `Submit new issue` button in the Github UI, so feel free to add, remove or update whatever information you like. + +Some general commands for troubleshooting that may be helpful: + +* `velero backup describe ` - describe the details of a backup +* `velero backup logs ` - fetch the logs for this specific backup. Useful for viewing failures and warnings, including resources that could not be backed up. +* `velero restore describe ` - describe the details of a restore +* `velero restore logs ` - fetch the logs for this specific restore. Useful for viewing failures and warnings, including resources that could not be restored. +* `kubectl logs deployment/velero -n velero` - fetch the logs of the Velero server pod. This provides the output of the Velero server processes. + +### Getting velero debug logs + +You can increase the verbosity of the Velero server by editing your Velero deployment to look like this: + + +``` +kubectl edit deployment/velero -n velero +... + containers: + - name: velero + image: velero/velero:latest + command: + - /velero + args: + - server + - --log-level # Add this line + - debug # Add this line +... +``` + +## Known issue with restoring LoadBalancer Service + +Because of how Kubernetes handles Service objects of `type=LoadBalancer`, when you restore these objects you might encounter an issue with changed values for Service UIDs. Kubernetes automatically generates the name of the cloud resource based on the Service UID, which is different when restored, resulting in a different name for the cloud load balancer. If the DNS CNAME for your application points to the DNS name of your cloud load balancer, you'll need to update the CNAME pointer when you perform a Velero restore. + +Alternatively, you might be able to use the Service's `spec.loadBalancerIP` field to keep connections valid, if your cloud provider supports this value. See [the Kubernetes documentation about Services of Type LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). + +## Miscellaneous issues + +### Velero reports `custom resource not found` errors when starting up. + +Velero's server will not start if the required Custom Resource Definitions are not found in Kubernetes. Run `velero install` again to install any missing custom resource definitions. + +### `velero backup logs` returns a `SignatureDoesNotMatch` error + +Downloading artifacts from object storage utilizes temporary, signed URLs. In the case of S3-compatible +providers, such as Ceph, there may be differences between their implementation and the official S3 +API that cause errors. + +Here are some things to verify if you receive `SignatureDoesNotMatch` errors: + + * Make sure your S3-compatible layer is using [signature version 4][5] (such as Ceph RADOS v12.2.7) + * For Ceph, try using a native Ceph account for credentials instead of external providers such as OpenStack Keystone + +## Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress + +Velero cannot currently resume backups that were interrupted. Backups stuck in the `InProgress` phase can be deleted with `kubectl delete backup -n `. +Backups in the `InProgress` phase have not uploaded any files to object storage. + +## Velero is not publishing prometheus metrics + +Steps to troubleshoot: + +- Confirm that your velero deployment has metrics publishing enabled. The [latest Velero helm charts][6] have been setup with [metrics enabled by default][7]. +- Confirm that the Velero server pod exposes the port on which the metrics server listens on. By default, this value is 8085. + +```yaml + ports: + - containerPort: 8085 + name: metrics + protocol: TCP +``` + +- Confirm that the metric server is listening for and responding to connections on this port. This can be done using [port-forwarding][9] as shown below + +```bash +$ kubectl -n port-forward 8085:8085 +Forwarding from 127.0.0.1:8085 -> 8085 +Forwarding from [::1]:8085 -> 8085 +. +. +. +``` + +Now, visiting http://localhost:8085/metrics on a browser should show the metrics that are being scraped from Velero. + +- Confirm that the Velero server pod has the nessary [annotations][8] for prometheus to scrape metrics. +- Confirm, from the Prometheus UI, that the Velero pod is one of the targets being scraped from Prometheus. + +[1]: debugging-restores.md +[2]: debugging-install.md +[4]: https://github.com/vmware-tanzu/velero/issues +[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html +[6]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero +[7]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L44 +[8]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L49-L52 +[9]: https://kubectl.docs.kubernetes.io/pages/container_debugging/port_forward_to_pods.html +[25]: https://kubernetes.slack.com/messages/velero diff --git a/site/content/docs/v1.4/uninstalling.md b/site/content/docs/v1.4/uninstalling.md new file mode 100644 index 000000000..f0b7b8d17 --- /dev/null +++ b/site/content/docs/v1.4/uninstalling.md @@ -0,0 +1,11 @@ +--- +title: "Uninstalling Velero" +layout: docs +--- + +If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: + +```bash +kubectl delete namespace/velero clusterrolebinding/velero +kubectl delete crds -l component=velero +``` diff --git a/site/docs/v1.4/upgrade-to-1.4.md b/site/content/docs/v1.4/upgrade-to-1.4.md similarity index 96% rename from site/docs/v1.4/upgrade-to-1.4.md rename to site/content/docs/v1.4/upgrade-to-1.4.md index 1088fb10c..02c2d30ca 100644 --- a/site/docs/v1.4/upgrade-to-1.4.md +++ b/site/content/docs/v1.4/upgrade-to-1.4.md @@ -1,4 +1,7 @@ -# Upgrading to Velero 1.4 +--- +title: "Upgrading to Velero 1.4" +layout: docs +--- ## Prerequisites diff --git a/site/content/docs/v1.4/velero-install.md b/site/content/docs/v1.4/velero-install.md new file mode 100644 index 000000000..951cc9f11 --- /dev/null +++ b/site/content/docs/v1.4/velero-install.md @@ -0,0 +1,48 @@ +--- +title: "Velero Install CLI" +layout: docs +--- + +This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. + +_NOTE_: `velero install` will, by default, use the CLI's version information to determine the version of the server compoents to deploy. This behavior may be overridden by using the `--image` flag. Refer to [Building Server Component Container Images][1]. + +## Usage + +This section explains some of the basic flags supported by the `velero install` CLI command. For a complete explanation of the flags, please run `velero install --help` + +```bash +velero install \ + --plugins + --provider \ + --bucket \ + --secret-file \ + --velero-pod-cpu-request \ + --velero-pod-mem-request \ + --velero-pod-cpu-limit \ + --velero-pod-mem-limit \ + [--use-restic] \ + [--restic-pod-cpu-request ] \ + [--restic-pod-mem-request ] \ + [--restic-pod-cpu-limit ] \ + [--restic-pod-mem-limit ] +``` + +The values for the resource requests and limits flags follow the same format as [Kubernetes resource requirements][3] +For plugin container images, please refer to our [supported providers][2] page. + +## Examples + +This section provides examples that serve as a starting point for more customized installations. + +```bash +velero install --provider gcp --plugins velero/velero-plugin-for-gcp:v1.0.0 --bucket mybucket --secret-file ./gcp-service-account.json + +velero install --provider aws --plugins velero/velero-plugin-for-aws:v1.0.0 --bucket backups --provider aws --secret-file ./aws-iam-creds --backup-location-config region=us-east-2 --snapshot-location-config region=us-east-2 --use-restic + +velero install --provider azure --plugins velero/velero-plugin-for-microsoft-azure:v1.0.0 --bucket $BLOB_CONTAINER --secret-file ./credentials-velero --backup-location-config resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,storageAccount=$AZURE_STORAGE_ACCOUNT_ID[,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] --snapshot-location-config apiTimeout=[,resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] +``` + +[1]: build-from-source.md#making-images-and-updating-velero +[2]: supported-providers.md +[3]: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ diff --git a/site/content/docs/v1.4/vendoring-dependencies.md b/site/content/docs/v1.4/vendoring-dependencies.md new file mode 100644 index 000000000..9fc1bcac1 --- /dev/null +++ b/site/content/docs/v1.4/vendoring-dependencies.md @@ -0,0 +1,21 @@ +--- +title: "Vendoring dependencies" +layout: docs +--- + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by following [these +instructions][1]. + +## Adding a new dependency + +Run `dep ensure`. If you want to see verbose output, you can append `-v` as in +`dep ensure -v`. + +## Updating an existing dependency + +Run `dep ensure -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep +[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.4/website-guidelines.md b/site/content/docs/v1.4/website-guidelines.md similarity index 96% rename from site/docs/v1.4/website-guidelines.md rename to site/content/docs/v1.4/website-guidelines.md index 5c13b7d4f..b9329505f 100644 --- a/site/docs/v1.4/website-guidelines.md +++ b/site/content/docs/v1.4/website-guidelines.md @@ -1,4 +1,7 @@ -# Website Guidelines +--- +title: "Website Guidelines" +layout: docs +--- ## Running the website locally diff --git a/site/content/docs/v1.4/zenhub.md b/site/content/docs/v1.4/zenhub.md new file mode 100644 index 000000000..a723fb184 --- /dev/null +++ b/site/content/docs/v1.4/zenhub.md @@ -0,0 +1,18 @@ +--- +title: "ZenHub" +layout: docs +--- + +As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. +GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. + +While GitHub issues, milestones, and labels generally work pretty well, the Velero team has found that product planning requires some additional tooling that GitHub projects do not offer. + +In our effort to minimize tooling while enabling product management insights, we have decided to use [ZenHub Open-Source](https://www.zenhub.com/blog/open-source/) to overlay product and project tracking on top of GitHub. +ZenHub is a GitHub application that provides Kanban visualization, Epic tracking, fine-grained prioritization, and more. It's primary backing storage system is existing GitHub issues along with additional metadata stored in ZenHub's database. + +If you are a Velero user or Velero Developer, you do not _need_ to use ZenHub for your regular workflow (e.g to see open bug reports or feature requests, work on pull requests). However, if you'd like to be able to visualize the high-level project goals and roadmap, you will need to use the free version of ZenHub. + +## Using ZenHub + +ZenHub can be integrated within the GitHub interface using their [Chrome or FireFox extensions](https://www.zenhub.com/extension). In addition, you can use their dedicated [web application](https://app.zenhub.com/workspace/o/vmware-tanzu/velero/boards?filterLogic=all&repos=99143276). diff --git a/site/plugins.md b/site/content/plugins/_index.md similarity index 75% rename from site/plugins.md rename to site/content/plugins/_index.md index d2ac63158..399dd9709 100644 --- a/site/plugins.md +++ b/site/content/plugins/_index.md @@ -1,20 +1,14 @@ --- -layout: page title: Plugins description: Velero Plugins id: plugins +type: plugins --- Velero uses plugins to integrate with a variety of storage systems and Kubernetes platforms to support backup, restore and snapshot operations. Read more about how to use and create plugins [in our docs][1], a detailed list of [supported providers][2], and check out our [plugin-example repo][3]. -
-
- {% include plugins.html %} -
-
- [1]: https://velero.io/docs [2]: https://velero.io/docs/supported-providers/ [3]: https://github.com/vmware-tanzu/velero-plugin-example diff --git a/site/_plugin-list/01-amazon-web-services.md b/site/content/plugins/list/01-amazon-web-services.md similarity index 83% rename from site/_plugin-list/01-amazon-web-services.md rename to site/content/plugins/list/01-amazon-web-services.md index c12d2500f..e12023166 100644 --- a/site/_plugin-list/01-amazon-web-services.md +++ b/site/content/plugins/list/01-amazon-web-services.md @@ -1,8 +1,8 @@ --- title: Amazon Web Services (AWS) link: https://github.com/vmware-tanzu/velero-plugin-for-aws -object-storage: true +objectStorage: true volumesnapshotter: true -supported-by-velero-team: true +supportedByVeleroTeam: true --- This repository contains an object store plugin and a volume snapshotter plugin to support running Velero on Amazon Web Services. diff --git a/site/_plugin-list/01-google-cloud-platform.md b/site/content/plugins/list/01-google-cloud-platform.md similarity index 83% rename from site/_plugin-list/01-google-cloud-platform.md rename to site/content/plugins/list/01-google-cloud-platform.md index 44468a5e6..2be85d0cc 100644 --- a/site/_plugin-list/01-google-cloud-platform.md +++ b/site/content/plugins/list/01-google-cloud-platform.md @@ -1,8 +1,8 @@ --- title: Google Cloud Platform (GCP) link: https://github.com/vmware-tanzu/velero-plugin-for-gcp -object-storage: true +objectStorage: true volumesnapshotter: true -supported-by-velero-team: true +supportedByVeleroTeam: true --- This repository contains an object store plugin and a volume snapshotter plugin to support running Velero on Google Cloud Platform. diff --git a/site/_plugin-list/01-microsoft-azure.md b/site/content/plugins/list/01-microsoft-azure.md similarity index 82% rename from site/_plugin-list/01-microsoft-azure.md rename to site/content/plugins/list/01-microsoft-azure.md index e37ef87db..7f7e8c9ee 100644 --- a/site/_plugin-list/01-microsoft-azure.md +++ b/site/content/plugins/list/01-microsoft-azure.md @@ -1,8 +1,8 @@ --- title: Microsoft Azure link: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure -object-storage: true +objectStorage: true volumesnapshotter: true -supported-by-velero-team: true +supportedByVeleroTeam: true --- This repository contains an object store plugin and a volume snapshotter plugin to support running Velero on Microsoft Azure. diff --git a/site/_plugin-list/01-vsphere.md b/site/content/plugins/list/01-vsphere.md similarity index 74% rename from site/_plugin-list/01-vsphere.md rename to site/content/plugins/list/01-vsphere.md index 92716a9b8..96c870a4f 100644 --- a/site/_plugin-list/01-vsphere.md +++ b/site/content/plugins/list/01-vsphere.md @@ -1,9 +1,9 @@ --- title: VMware vSphere link: https://github.com/vmware-tanzu/velero-plugin-for-vsphere -object-storage: false +objectStorage: false volumesnapshotter: true -local-storage: true -supported-by-velero-team: true +localStorage: true +supportedByVeleroTeam: true --- This repository contains a volume snapshotter plugin to support running Velero on VMware vSphere. diff --git a/site/_plugin-list/05-alibaba-cloud.md b/site/content/plugins/list/05-alibaba-cloud.md similarity index 92% rename from site/_plugin-list/05-alibaba-cloud.md rename to site/content/plugins/list/05-alibaba-cloud.md index b172af1a7..61e4e3ff1 100644 --- a/site/_plugin-list/05-alibaba-cloud.md +++ b/site/content/plugins/list/05-alibaba-cloud.md @@ -1,7 +1,7 @@ --- title: Alibaba Cloud link: https://github.com/AliyunContainerService/velero-plugin -object-storage: true +objectStorage: true volumesnapshotter: true --- Used for backup and restore on Alibaba Cloud through Velero. You need to install and configure velero and the velero-plugin for alibabacloud. diff --git a/site/_plugin-list/05-digitalocean.md b/site/content/plugins/list/05-digitalocean.md similarity index 93% rename from site/_plugin-list/05-digitalocean.md rename to site/content/plugins/list/05-digitalocean.md index 04ad09aee..c49abcee8 100644 --- a/site/_plugin-list/05-digitalocean.md +++ b/site/content/plugins/list/05-digitalocean.md @@ -1,7 +1,7 @@ --- title: DigitalOcean link: https://github.com/digitalocean/velero-plugin -object-storage: true +objectStorage: true volumesnapshotter: true --- DigitalOcean Block Storage provider plugin for Velero. The plugin is designed to create filesystem snapshots of Block Storage backed PersistentVolumes that are used in a Kubernetes cluster running on DigitalOcean. diff --git a/site/_plugin-list/05-hpe-storage.md b/site/content/plugins/list/05-hpe-storage.md similarity index 91% rename from site/_plugin-list/05-hpe-storage.md rename to site/content/plugins/list/05-hpe-storage.md index df3e72cf8..1efb6d58f 100644 --- a/site/_plugin-list/05-hpe-storage.md +++ b/site/content/plugins/list/05-hpe-storage.md @@ -1,7 +1,7 @@ --- title: HPE Storage link: https://github.com/hpe-storage/velero-plugin -object-storage: false +objectStorage: false volumesnapshotter: true --- HPE storage plugin for Velero. To take snapshots of HPE volumes through Velero you need to install and configure the HPE Snapshotter plugin. diff --git a/site/_plugin-list/05-openebs.md b/site/content/plugins/list/05-openebs.md similarity index 84% rename from site/_plugin-list/05-openebs.md rename to site/content/plugins/list/05-openebs.md index 8851ed464..227ef32b2 100644 --- a/site/_plugin-list/05-openebs.md +++ b/site/content/plugins/list/05-openebs.md @@ -1,8 +1,8 @@ --- title: OpenEBS link: https://github.com/openebs/velero-plugin -object-storage: false +objectStorage: false volumesnapshotter: true -local-storage: true +localStorage: true --- To do backup/restore of OpenEBS CStor volumes through Velero utility, you need to install and configure OpenEBS velero-plugin. diff --git a/site/_plugin-list/05-openshift.md b/site/content/plugins/list/05-openshift.md similarity index 100% rename from site/_plugin-list/05-openshift.md rename to site/content/plugins/list/05-openshift.md diff --git a/site/_plugin-list/05-portworx.md b/site/content/plugins/list/05-portworx.md similarity index 82% rename from site/_plugin-list/05-portworx.md rename to site/content/plugins/list/05-portworx.md index b8874fa1f..5136a1e5c 100644 --- a/site/_plugin-list/05-portworx.md +++ b/site/content/plugins/list/05-portworx.md @@ -1,8 +1,8 @@ --- title: Portworx link: https://github.com/portworx/velero-plugin -object-storage: false +objectStorage: false volumesnapshotter: true -local-storage: true +localStorage: true --- To take snapshots of Portworx volumes through Velero you need to install and configure the Portworx plugin. diff --git a/site/_plugin-list/05-storj.md b/site/content/plugins/list/05-storj.md similarity index 85% rename from site/_plugin-list/05-storj.md rename to site/content/plugins/list/05-storj.md index b2f3203ac..ae8f118ca 100644 --- a/site/_plugin-list/05-storj.md +++ b/site/content/plugins/list/05-storj.md @@ -1,8 +1,8 @@ --- title: Storj link: https://github.com/storj-thirdparty/velero-plugin -object-storage: true +objectStorage: true volumesnapshotter: false -local-storage: false +localStorage: false --- This repository contains a Velero object store plugin to support backup/restore from Velero to Storj decentralized file object storage. diff --git a/site/_plugin-list/10-container-storage-interface.md b/site/content/plugins/list/10-container-storage-interface.md similarity index 84% rename from site/_plugin-list/10-container-storage-interface.md rename to site/content/plugins/list/10-container-storage-interface.md index e891dbd17..21ed41db7 100644 --- a/site/_plugin-list/10-container-storage-interface.md +++ b/site/content/plugins/list/10-container-storage-interface.md @@ -1,11 +1,11 @@ --- title: Container Storage Interface (CSI) link: https://github.com/vmware-tanzu/velero-plugin-for-csi -object-storage: false +objectStorage: false volumesnapshotter: true -local-storage: true +localStorage: true beta: true -supported-by-velero-team: true +supportedByVeleroTeam: true --- This repository contains Velero plugins for snapshotting CSI backed PVCs using the CSI beta snapshot APIs. These plugins are currently in beta as of the Velero 1.4 release and will follow the CSI volumesnapshotting APIs in upstream Kubernetes to GA. diff --git a/site/content/plugins/list/index.md b/site/content/plugins/list/index.md new file mode 100644 index 000000000..3d65eaa0f --- /dev/null +++ b/site/content/plugins/list/index.md @@ -0,0 +1,3 @@ +--- +headless: true +--- \ No newline at end of file diff --git a/site/_posts/2019-04-09-Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters.md b/site/content/posts/2019-04-09-Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters.md similarity index 97% rename from site/_posts/2019-04-09-Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters.md rename to site/content/posts/2019-04-09-Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters.md index 1a2e47498..141c69a55 100644 --- a/site/_posts/2019-04-09-Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters.md +++ b/site/content/posts/2019-04-09-Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters.md @@ -1,6 +1,6 @@ --- title: Velero is an Open Source Tool to Back up and Migrate Kubernetes Clusters -redirect_from: /Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters/ +slug: Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters # image: https://placehold.it/200x200 excerpt: Velero is an open source tool to safely back up, recover, and migrate Kubernetes clusters and persistent volumes. It works both on premises and in a public cloud. author_name: Velero Team diff --git a/site/_posts/2019-05-20-velero-1.0-has-arrived.md b/site/content/posts/2019-05-20-velero-1.0-has-arrived.md similarity index 98% rename from site/_posts/2019-05-20-velero-1.0-has-arrived.md rename to site/content/posts/2019-05-20-velero-1.0-has-arrived.md index 7f5b0dce8..4c43d592b 100644 --- a/site/_posts/2019-05-20-velero-1.0-has-arrived.md +++ b/site/content/posts/2019-05-20-velero-1.0-has-arrived.md @@ -1,6 +1,6 @@ --- -title: Velero 1.0 Has Arrived: Delivering Enhanced Stability, Usability and Extensibility Features -redirect_from: /velero-1.0-has-arrived/ +title: "Velero 1.0 Has Arrived: Delivering Enhanced Stability, Usability and Extensibility Features" +slug: velero-1.0-has-arrived # image: https://placehold.it/200x200 excerpt: Just three months after the release of Velero 0.11, the community’s momentum continues with the delivery of the landmark version 1.0 release. author_name: Tom Spoonemore diff --git a/site/_posts/2019-08-22-announcing-velero-1.1.md b/site/content/posts/2019-08-22-announcing-velero-1.1.md similarity index 98% rename from site/_posts/2019-08-22-announcing-velero-1.1.md rename to site/content/posts/2019-08-22-announcing-velero-1.1.md index 573df97fd..8a7300af4 100644 --- a/site/_posts/2019-08-22-announcing-velero-1.1.md +++ b/site/content/posts/2019-08-22-announcing-velero-1.1.md @@ -1,6 +1,6 @@ --- -title: Announcing Velero 1.1: Improved restic Support and More Visibility -redirect_from: /announcing-velero-1.1/ +title: "Announcing Velero 1.1: Improved restic Support and More Visibility" +slug: announcing-velero-1.1 # image: https://placehold.it/200x200 excerpt: For this release, we’ve focused on improving Velero’s restic integration - making repository locks shorter lived, giving more visibility into restic repositories when migrating clusters, and expanding support to more volume types. author_name: Nolan Brubaker diff --git a/site/_posts/2019-10-01-announcing-gh-move.md b/site/content/posts/2019-10-01-announcing-gh-move.md similarity index 99% rename from site/_posts/2019-10-01-announcing-gh-move.md rename to site/content/posts/2019-10-01-announcing-gh-move.md index d95c84a1b..3bac6a37b 100644 --- a/site/_posts/2019-10-01-announcing-gh-move.md +++ b/site/content/posts/2019-10-01-announcing-gh-move.md @@ -1,6 +1,6 @@ --- title: Announcing a new GitHub home for Velero -redirect_from: /announcing-gh-move/ +slug: announcing-gh-move image: /img/posts/vmware-tanzu.png excerpt: The next Velero release (v1.2) will be built out of a new GitHub organization, and we have significant changes to our plugins. author_name: Carlisia Campos diff --git a/site/_posts/2019-10-08-Velero-v1-1-on-vSphere.md b/site/content/posts/2019-10-08-Velero-v1-1-on-vSphere.md similarity index 99% rename from site/_posts/2019-10-08-Velero-v1-1-on-vSphere.md rename to site/content/posts/2019-10-08-Velero-v1-1-on-vSphere.md index eb94cec25..be0c0103d 100644 --- a/site/_posts/2019-10-08-Velero-v1-1-on-vSphere.md +++ b/site/content/posts/2019-10-08-Velero-v1-1-on-vSphere.md @@ -1,6 +1,6 @@ --- title: Velero v1.1 backing up and restoring apps on vSphere -redirect_from: /Velero-v1-1-on-vSphere/ +slug: Velero-v1-1-on-vSphere image: /img/posts/vsphere-logo.jpg excerpt: A How-To guide to run Velero on vSphere. author_name: Cormac Hogan diff --git a/site/_posts/2019-10-10-Velero-v1-1-Stateful-Backup-vSphere.md b/site/content/posts/2019-10-10-Velero-v1-1-Stateful-Backup-vSphere.md similarity index 99% rename from site/_posts/2019-10-10-Velero-v1-1-Stateful-Backup-vSphere.md rename to site/content/posts/2019-10-10-Velero-v1-1-Stateful-Backup-vSphere.md index e3fb7152f..13579f3e7 100644 --- a/site/_posts/2019-10-10-Velero-v1-1-Stateful-Backup-vSphere.md +++ b/site/content/posts/2019-10-10-Velero-v1-1-Stateful-Backup-vSphere.md @@ -1,6 +1,6 @@ --- title: Velero v1.1 backing up and restoring Stateful apps on vSphere -redirect_from: /Velero-v1-1-Stateful-Backup-vSphere/ +slug: Velero-v1-1-Stateful-Backup-vSphere image: /img/posts/cassandra.gif excerpt: This post demonstrates how Velero can be used on Kubernetes running on vSphere to backup a Stateful application. For the purposes of this example, we will backup and restore a Cassandra NoSQL database management system. author_name: Cormac Hogan diff --git a/site/_posts/2019-11-07-Velero-1.2-Sets-Sail.md b/site/content/posts/2019-11-07-Velero-1.2-Sets-Sail.md similarity index 99% rename from site/_posts/2019-11-07-Velero-1.2-Sets-Sail.md rename to site/content/posts/2019-11-07-Velero-1.2-Sets-Sail.md index 633db3c4c..5b8aa15f2 100644 --- a/site/_posts/2019-11-07-Velero-1.2-Sets-Sail.md +++ b/site/content/posts/2019-11-07-Velero-1.2-Sets-Sail.md @@ -2,6 +2,7 @@ title: Velero 1.2 Sets Sail by Shifting Plugins Out of Tree, Adding a Structural Schema, and Sharpening Usability excerpt: With this release, we’ve focused on extracting in-tree cloud provider plugins into their own repositories, making further usability improvements to the restic integration, preparing for the general availability of Kubernetes custom resource definitions (CRDs) by adding a structural schema to our CRDs, and many other new features and usability improvements. author_name: Steve Kriss +slug: Velero-1.2-Sets-Sail categories: ['velero','release'] image: /img/posts/sailboat.jpg # Tag should match author to drive author pages diff --git a/site/_posts/2020-03-02-Velero-1.3-Voyage-Continues.md b/site/content/posts/2020-03-02-Velero-1.3-Voyage-Continues.md similarity index 99% rename from site/_posts/2020-03-02-Velero-1.3-Voyage-Continues.md rename to site/content/posts/2020-03-02-Velero-1.3-Voyage-Continues.md index 2ae94be8f..b3b4802f8 100644 --- a/site/_posts/2020-03-02-Velero-1.3-Voyage-Continues.md +++ b/site/content/posts/2020-03-02-Velero-1.3-Voyage-Continues.md @@ -2,6 +2,7 @@ title: "Velero 1.3: Improved CRD Backups/Restores, Multi-Arch Docker Images, and More!" excerpt: Velero 1.3 includes improvements to CRD backups and restores, multi-arch Docker images including support for arm/arm64 and ppc64le, and many other usability and stability enhancements. This release includes significant contributions by community members, and we’re thrilled to be able to partner with you all in continuing to improve Velero. author_name: Steve Kriss +slug: Velero-1.3-Voyage-Continues categories: ['velero','release'] image: /img/posts/post-1.3.jpg # Tag should match author to drive author pages diff --git a/site/_posts/2020-05-26-Velero-1.4-Community-Wave.md b/site/content/posts/2020-05-26-Velero-1.4-Community-Wave.md similarity index 99% rename from site/_posts/2020-05-26-Velero-1.4-Community-Wave.md rename to site/content/posts/2020-05-26-Velero-1.4-Community-Wave.md index 55b5cbccf..9ff7cdb8d 100644 --- a/site/_posts/2020-05-26-Velero-1.4-Community-Wave.md +++ b/site/content/posts/2020-05-26-Velero-1.4-Community-Wave.md @@ -2,6 +2,7 @@ title: "Velero 1.4: Introducing Beta CSI Support, Backup Progress Tracking, and Much More!" excerpt: Riding a wave of community contributions, Velero 1.4 introduces beta CSI support, improvements to backup progress tracking, and more. A major focus for 1.4 was addressing issues raised by the community, and we are proud to be able to deliver improvements that matter to you. author_name: Nolan Brubaker +slug: Velero-1.4-Community-Wave categories: ['velero','release'] image: /img/posts/post-1.4.jpg # Tag should match author to drive author pages diff --git a/site/_posts/2020-05-27-CSI-integration.md b/site/content/posts/2020-05-27-CSI-integration.md similarity index 100% rename from site/_posts/2020-05-27-CSI-integration.md rename to site/content/posts/2020-05-27-CSI-integration.md diff --git a/site/content/posts/_index.md b/site/content/posts/_index.md new file mode 100644 index 000000000..7a9079e1e --- /dev/null +++ b/site/content/posts/_index.md @@ -0,0 +1,7 @@ +--- +title: Blog +description: Velero Blog +id: blog +url: /blog +outputs: ["HTML", "RSS"] +--- \ No newline at end of file diff --git a/site/resources.md b/site/content/resources/_index.md similarity index 89% rename from site/resources.md rename to site/content/resources/_index.md index c1a54c70d..6f5230b78 100644 --- a/site/resources.md +++ b/site/content/resources/_index.md @@ -1,5 +1,4 @@ --- -layout: page title: Resources description: Velero Resources id: resources @@ -9,10 +8,10 @@ Here you will find external resources about Velero, such as videos, podcasts, an ## All community meetings * Community Meetings Playlist -{% youtube videoseries?list=PL7bmigfV0EqQRysvqvqOtRNk4L5S7uqwM %} +{{< youtube "videoseries?list=PL7bmigfV0EqQRysvqvqOtRNk4L5S7uqwM" >}} * Velero Demo and Deep Dives Playlist -{% youtube videoseries?list=PL7bmigfV0EqT82eQaVCslWWM4k4d63KyK %} +{{< youtube "videoseries?list=PL7bmigfV0EqT82eQaVCslWWM4k4d63KyK" >}} ## Podcast shows @@ -24,32 +23,32 @@ Here you will find external resources about Velero, such as videos, podcasts, an * Kubecon NA 2019 - How to Backup and Restore Your Kubernetes Cluster - Annette Clewett & Dylan Murray, Red Hat: - {% youtube JyzgS-KKuoo %} + {{< youtube JyzgS-KKuoo >}} * Kubernetes Back Up, Restore and Migration with Velero - A NewStack interview, with guests: Carlisia Campos, Tom Spoonemore, and Efri Nattel-Shayo: - {% youtube 71NoY5CIcQ8 %} + {{< youtube 71NoY5CIcQ8 >}} * How to migrate applications between Kubernetes clusters using Velero: - {% youtube IZlwKMoqBqE %} + {{< youtube IZlwKMoqBqE >}} * TGIK 080: Velero 1.0: - {% youtube tj5Ey2bHsfM %} + {{< youtube tj5Ey2bHsfM >}} * Watch our recent webinar on backup and migration strategies: - {% youtube csrSPt3HFtg %} + {{< youtube csrSPt3HFtg >}} * Velero demo by Just me and Opensource - [ Kube 45 ] Velero - Backup & Restore Kubernetes Cluster: - {% youtube C9hzrexaIDA %} + {{< youtube C9hzrexaIDA >}} ## Blog posts diff --git a/site/css/styles.scss b/site/css/styles.scss deleted file mode 100644 index 0977fd727..000000000 --- a/site/css/styles.scss +++ /dev/null @@ -1,3 +0,0 @@ ---- ---- -@import '../_scss/styles'; diff --git a/site/_data/default.yml b/site/data/docs/default.yml similarity index 100% rename from site/_data/default.yml rename to site/data/docs/default.yml diff --git a/site/_data/main-toc.yml b/site/data/docs/main-toc.yml similarity index 100% rename from site/_data/main-toc.yml rename to site/data/docs/main-toc.yml diff --git a/site/_data/toc-mapping.yml b/site/data/docs/toc-mapping.yml similarity index 100% rename from site/_data/toc-mapping.yml rename to site/data/docs/toc-mapping.yml diff --git a/site/_data/v010-toc.yml b/site/data/docs/v010-toc.yml similarity index 100% rename from site/_data/v010-toc.yml rename to site/data/docs/v010-toc.yml diff --git a/site/_data/v011-toc.yml b/site/data/docs/v011-toc.yml similarity index 100% rename from site/_data/v011-toc.yml rename to site/data/docs/v011-toc.yml diff --git a/site/_data/v1-0-0-toc.yml b/site/data/docs/v1-0-0-toc.yml similarity index 100% rename from site/_data/v1-0-0-toc.yml rename to site/data/docs/v1-0-0-toc.yml diff --git a/site/_data/v1-1-0-toc.yml b/site/data/docs/v1-1-0-toc.yml similarity index 100% rename from site/_data/v1-1-0-toc.yml rename to site/data/docs/v1-1-0-toc.yml diff --git a/site/_data/v1-2-0-toc.yml b/site/data/docs/v1-2-0-toc.yml similarity index 100% rename from site/_data/v1-2-0-toc.yml rename to site/data/docs/v1-2-0-toc.yml diff --git a/site/_data/v1-3-0-toc.yml b/site/data/docs/v1-3-0-toc.yml similarity index 100% rename from site/_data/v1-3-0-toc.yml rename to site/data/docs/v1-3-0-toc.yml diff --git a/site/_data/v1-3-1-toc.yml b/site/data/docs/v1-3-1-toc.yml similarity index 100% rename from site/_data/v1-3-1-toc.yml rename to site/data/docs/v1-3-1-toc.yml diff --git a/site/_data/v1-3-2-toc.yml b/site/data/docs/v1-3-2-toc.yml similarity index 100% rename from site/_data/v1-3-2-toc.yml rename to site/data/docs/v1-3-2-toc.yml diff --git a/site/_data/v1-4-toc.yml b/site/data/docs/v1-4-toc.yml similarity index 100% rename from site/_data/v1-4-toc.yml rename to site/data/docs/v1-4-toc.yml diff --git a/site/_data/v7-1-toc.yml b/site/data/docs/v7-1-toc.yml similarity index 100% rename from site/_data/v7-1-toc.yml rename to site/data/docs/v7-1-toc.yml diff --git a/site/_data/v7-toc.yml b/site/data/docs/v7-toc.yml similarity index 100% rename from site/_data/v7-toc.yml rename to site/data/docs/v7-toc.yml diff --git a/site/_data/v8-1-toc.yml b/site/data/docs/v8-1-toc.yml similarity index 100% rename from site/_data/v8-1-toc.yml rename to site/data/docs/v8-1-toc.yml diff --git a/site/_data/v8-toc.yml b/site/data/docs/v8-toc.yml similarity index 100% rename from site/_data/v8-toc.yml rename to site/data/docs/v8-toc.yml diff --git a/site/_data/v9-toc.yml b/site/data/docs/v9-toc.yml similarity index 100% rename from site/_data/v9-toc.yml rename to site/data/docs/v9-toc.yml diff --git a/site/docs/index.md b/site/docs/index.md deleted file mode 100644 index 83a68cb30..000000000 --- a/site/docs/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Velero Documentation -description: Velero Documentation / Velero Docs -redirect_to: -- LATEST ---- diff --git a/site/docs/v0.5.0/api-types/README.md b/site/docs/v0.5.0/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.5.0/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.6.0/api-types/README.md b/site/docs/v0.6.0/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.6.0/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.7.0/api-types/README.md b/site/docs/v0.7.0/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.7.0/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.7.1/api-types/README.md b/site/docs/v0.7.1/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.7.1/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.7.1/vendoring-dependencies.md b/site/docs/v0.7.1/vendoring-dependencies.md deleted file mode 100644 index ce5f9a9d4..000000000 --- a/site/docs/v0.7.1/vendoring-dependencies.md +++ /dev/null @@ -1,23 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by running - -``` -go get -u github.com/golang/dep/cmd/dep -``` - -Dep currently pulls in a bit more than we'd like, so -we have created a script to remove these extra files: `hack/dep-save.sh`. - -## Adding a new dependency - -Run `hack/dep-save.sh`. If you want to see verbose output, you can append `-v` as in -`hack/dep-save.sh -v`. - -## Updating an existing dependency - -Run `hack/dep-save.sh -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep diff --git a/site/docs/v0.8.0/api-types/README.md b/site/docs/v0.8.0/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.8.0/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.8.1/api-types/README.md b/site/docs/v0.8.1/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.8.1/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.8.1/faq.md b/site/docs/v0.8.1/faq.md deleted file mode 100644 index f83829ec9..000000000 --- a/site/docs/v0.8.1/faq.md +++ /dev/null @@ -1,25 +0,0 @@ -# FAQ - -## When is it appropriate to use Ark instead of etcd's built in backup/restore? - -Etcd's backup/restore tooling is good for recovering from data loss in a single etcd cluster. For -example, it is a good idea to take a backup of etcd prior to upgrading etcd istelf. For more -sophisticated management of your Kubernetes cluster backups and restores, we feel that Ark is -generally a better approach. It gives you the ability to throw away an unstable cluster and restore -your Kubernetes resources and data into a new cluster, which you can't do easily just by backing up -and restoring etcd. - -Examples of cases where Ark is useful: - -* you don't have access to etcd (e.g. you're running on GKE) -* backing up both Kubernetes resources and persistent volume state -* cluster migrations -* backing up a subset of your Kubernetes resources -* backing up Kubernetes resources that are stored across multiple etcd clusters (for example if you - run a custom apiserver) - -## Will Ark restore my Kubernetes resources exactly the way they were before? - -Yes, with some exceptions. For example, when Ark restores pods it deletes the `nodeName` from the -pod so that it can be scheduled onto a new node. You can see some more examples of the differences -in [pod_action.go](https://github.com/heptio/ark/blob/main/pkg/restore/pod_action.go) diff --git a/site/docs/v0.8.1/plugins.md b/site/docs/v0.8.1/plugins.md deleted file mode 100644 index 1cb2ae391..000000000 --- a/site/docs/v0.8.1/plugins.md +++ /dev/null @@ -1,35 +0,0 @@ -# Plugins - -Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores -without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary -containing an implementation of one of Ark's plugin kinds (described below), plus a small amount of boilerplate code to -expose the plugin implementation to Ark. This binary is added to a container image that serves as an init container for -the Ark server pod and copies the binary into a shared emptyDir volume for the Ark server to access. - -A fully-functional [sample plugin repository][1] is provided to serve as a convenient starting point for plugin authors. - -## Plugin Kinds - -Ark currently supports the following kinds of plugins: - -- **Object Store** - persists and retrieves backups, backup logs and restore logs -- **Block Store** - creates volume snapshots (during backup) and restores volumes from snapshots (during restore) -- **Backup Item Action** - executes arbitrary logic for individual items prior to storing them in a backup file -- **Restore Item Action** - executes arbitrary logic for individual items prior to restoring them into a cluster - -## Plugin Naming - -Ark relies on a naming convention to identify plugins. Each plugin binary should be named `ark--`, -where `plugin-kind` is one of `objectstore`, `blockstore`, `backupitemaction`, or `restoreitemaction`, and `name` is -unique within the plugin kind. - -## Plugin Logging - -Ark provides a [logger][2] that can be used by plugins to log structured information to the main Ark server log or -per-backup/restore logs. See the [sample repository][1] for an example of how to instantiate and use the logger -within your plugin. - - - -[1]: https://github.com/heptio/ark-plugin-example -[2]: https://github.com/heptio/ark/blob/main/pkg/plugin/logger.go diff --git a/site/docs/v0.8.1/vendoring-dependencies.md b/site/docs/v0.8.1/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v0.8.1/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v0.9.0/api-types/README.md b/site/docs/v0.9.0/api-types/README.md deleted file mode 100644 index 46bcea71d..000000000 --- a/site/docs/v0.9.0/api-types/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Table of Contents - -## API types - -* [Backup][1] - -[1]: backup.md diff --git a/site/docs/v0.9.0/api-types/backup.md b/site/docs/v0.9.0/api-types/backup.md deleted file mode 100644 index feef7c3dc..000000000 --- a/site/docs/v0.9.0/api-types/backup.md +++ /dev/null @@ -1,138 +0,0 @@ -# Backup API Type - -## Use - -The `Backup` API type is used as a request for the Ark Server to perform a backup. Once created, the -Ark Server immediately starts the backup process. - -## API GroupVersion - -Backup belongs to the API group version `ark.heptio.com/v1`. - -## Definition - -Here is a sample `Backup` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: ark.heptio.com/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Backup -# Standard Kubernetes metadata. Required. -metadata: - # Backup name. May be any valid Kubernetes object name. Required. - name: a - # Backup namespace. Required. In version 0.7.0 and later, can be any string. Must be the namespace of the Ark server. - namespace: heptio-ark -# Parameters about the backup. Required. -spec: - # Array of namespaces to include in the backup. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the backup. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the backup. For example, if a - # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the backup. Optional. - labelSelector: - matchLabels: - app: ark - component: server - # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and - # AWS. Valid values are true, false, and null/unset. If unset, Ark performs snapshots as long as - # a persistent volume provider is configured for Ark. - snapshotVolumes: null - # The amount of time before this backup is eligible for garbage collection. - ttl: 24h0m0s - # Actions to perform at different times during a backup. The only hook currently supported is - # executing a command in a container in a pod using the pod exec API. Optional. - hooks: - # Array of hooks that are applicable to specific resources. Optional. - resources: - - - # Name of the hook. Will be displayed in backup log. - name: my-hook - # Array of namespaces to which this hook applies. If unspecified, the hook applies to all - # namespaces. Optional. - includedNamespaces: - - '*' - # Array of namespaces to which this hook does not apply. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to which this hook applies. The only resource supported at this time is - # pods. - includedResources: - - pods - # Array of resources to which this hook does not apply. Optional. - excludedResources: [] - # This hook only applies to objects matching this label selector. Optional. - labelSelector: - matchLabels: - app: ark - component: server - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - # DEPRECATED. Use pre instead. - hooks: - # Same content as pre below. - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - pre: - - - # The type of hook. This must be "exec". - exec: - # The name of the container where the command will be executed. If unspecified, the - # first container in the pod will be used. Optional. - container: my-container - # The command to execute, specified as an array. Required. - command: - - /bin/uname - - -a - # How to handle an error executing the command. Valid values are Fail and Continue. - # Defaults to Fail. Optional. - onError: Fail - # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. - timeout: 10s - # An array of hooks to run after all custom actions and additional items have been - # processed. Currently only "exec" hooks are supported. - post: - # Same content as pre above. -# Status about the Backup. Users should not set any data here. -status: - # The date and time when the Backup is eligible for garbage collection. - expiration: null - # The current phase. Valid values are New, FailedValidation, InProgress, Completed, Failed. - phase: "" - # An array of any validation errors encountered. - validationErrors: null - # The version of this Backup. The only version currently supported is 1. - version: 1 - # Information about PersistentVolumes needed during restores. - volumeBackups: - # Each key is the name of a PersistentVolume. - some-pv-name: - # The ID used by the cloud provider for the snapshot created for this Backup. - snapshotID: snap-1234 - # The type of the volume in the cloud provider API. - type: io1 - # The availability zone where the volume resides in the cloud provider. - availabilityZone: my-zone - # The amount of provisioned IOPS for the volume. Optional. - iops: 10000 -``` diff --git a/site/docs/v0.9.0/cli-reference/README.md b/site/docs/v0.9.0/cli-reference/README.md deleted file mode 100644 index 29bebb516..000000000 --- a/site/docs/v0.9.0/cli-reference/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Command line reference - -The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. - -[The files in the CLI reference directory][1] in the repository enumerate each of the possible `ark` commands and their flags. -This information is available in the CLI, using the `--help` flag. - -## Running the client - -We recommend that you [download a pre-built release][26], but you can also build and run the `ark` executable. - -## Kubernetes cluster credentials - -In general, Ark will search for your cluster credentials in the following order: -* `--kubeconfig` command line flag -* `$KUBECONFIG` environment variable -* In-cluster credentials--this only works when you are running Ark in a pod - -[1]: https://github.com/heptio/ark/tree/main/docs/cli-reference -[26]: https://github.com/heptio/ark/releases diff --git a/site/docs/v0.9.0/extend.md b/site/docs/v0.9.0/extend.md deleted file mode 100644 index 0a96b8e3e..000000000 --- a/site/docs/v0.9.0/extend.md +++ /dev/null @@ -1,9 +0,0 @@ -# Extend Ark - -Ark includes mechanisms for extending the core functionality to meet your individual backup/restore needs: - -* [Hooks][27] allow you to specify commands to be executed within running pods during a backup. This is useful if you need to run a workload-specific command prior to taking a backup (for example, to flush disk buffers or to freeze a database). -* [Plugins][28] allow you to develop custom object/block storage back-ends or per-item backup/restore actions that can execute arbitrary logic, including modifying the items being backed up/restored. Plugins can be used by Ark without needing to be compiled into the core Ark binary. - -[27]: hooks.md -[28]: plugins.md diff --git a/site/docs/v0.9.0/hooks.md b/site/docs/v0.9.0/hooks.md deleted file mode 100644 index 5097f4090..000000000 --- a/site/docs/v0.9.0/hooks.md +++ /dev/null @@ -1,54 +0,0 @@ -# Hooks - -Heptio Ark currently supports executing commands in containers in pods during a backup. - -## Backup Hooks - -When performing a backup, you can specify one or more commands to execute in a container in a pod -when that pod is being backed up. - -Ark versions prior to v0.7.0 only support hooks that execute prior to any custom action processing -("pre" hooks). - -As of version v0.7.0, Ark also supports "post" hooks - these execute after all custom actions have -completed, as well as after all the additional items specified by custom actions have been backed -up. - -An example of when you might use both pre and post hooks is freezing a file system. If you want to -ensure that all pending disk I/O operations have completed prior to taking a snapshot, you could use -a pre hook to run `fsfreeze --freeze`. Next, Ark would take a snapshot of the disk. Finally, you -could use a post hook to run `fsfreeze --unfreeze`. - -There are two ways to specify hooks: annotations on the pod itself, and in the Backup spec. - -### Specifying Hooks As Pod Annotations - -You can use the following annotations on a pod to make Ark execute a hook when backing up the pod: - -#### Pre hooks - -| Annotation Name | Description | -| --- | --- | -| `pre.hook.backup.ark.heptio.com/container` | The container where the command should be executed. Defaults to the first container in the pod. Optional. | -| `pre.hook.backup.ark.heptio.com/command` | The command to execute. If you need multiple arguments, specify the command as a JSON array, such as `["/usr/bin/uname", "-a"]` | -| `pre.hook.backup.ark.heptio.com/on-error` | What to do if the command returns a non-zero exit code. Defaults to Fail. Valid values are Fail and Continue. Optional. | -| `pre.hook.backup.ark.heptio.com/timeout` | How long to wait for the command to execute. The hook is considered in error if the command exceeds the timeout. Defaults to 30s. Optional. | - -Ark v0.7.0+ continues to support the original (deprecated) way to specify pre hooks - without the -`pre.` prefix in the annotation names (e.g. `hook.backup.ark.heptio.com/container`). - -#### Post hooks (v0.7.0+) - -| Annotation Name | Description | -| --- | --- | -| `post.hook.backup.ark.heptio.com/container` | The container where the command should be executed. Defaults to the first container in the pod. Optional. | -| `post.hook.backup.ark.heptio.com/command` | The command to execute. If you need multiple arguments, specify the command as a JSON array, such as `["/usr/bin/uname", "-a"]` | -| `post.hook.backup.ark.heptio.com/on-error` | What to do if the command returns a non-zero exit code. Defaults to Fail. Valid values are Fail and Continue. Optional. | -| `post.hook.backup.ark.heptio.com/timeout` | How long to wait for the command to execute. The hook is considered in error if the command exceeds the timeout. Defaults to 30s. Optional. | - -### Specifying Hooks in the Backup Spec - -Please see the documentation on the [Backup API Type][1] for how to specify hooks in the Backup -spec. - -[1]: api-types/backup.md diff --git a/site/docs/v0.9.0/output-file-format.md b/site/docs/v0.9.0/output-file-format.md deleted file mode 100644 index 8541e3a82..000000000 --- a/site/docs/v0.9.0/output-file-format.md +++ /dev/null @@ -1,99 +0,0 @@ -# Output file format - -A backup is a gzip-compressed tar file whose name matches the Backup API resource's `metadata.name` (what is specified during `ark backup create `). - -In cloud object storage, each backup file is stored in its own subdirectory in the bucket specified in the Ark server configuration. This subdirectory includes an additional file called `ark-backup.json`. The JSON file lists all information about your associated Backup resource, including any default values. This gives you a complete historical record of the backup configuration. The JSON file also specifies `status.version`, which corresponds to the output file format. - -The directory structure in your cloud storage looks something like: - -``` -rootBucket/ - backup1234/ - ark-backup.json - backup1234.tar.gz -``` - -## Example backup JSON file - -``` -{ - "kind": "Backup", - "apiVersion": "ark.heptio.com/v1", - "metadata": { - "name": "test-backup", - "namespace": "heptio-ark", - "selfLink": "/apis/ark.heptio.com/v1/namespaces/heptio-ark/backups/testtest", - "uid": "a12345cb-75f5-11e7-b4c2-abcdef123456", - "resourceVersion": "337075", - "creationTimestamp": "2017-07-31T13:39:15Z" - }, - "spec": { - "includedNamespaces": [ - "*" - ], - "excludedNamespaces": null, - "includedResources": [ - "*" - ], - "excludedResources": null, - "labelSelector": null, - "snapshotVolumes": true, - "ttl": "24h0m0s" - }, - "status": { - "version": 1, - "expiration": "2017-08-01T13:39:15Z", - "phase": "Completed", - "volumeBackups": { - "pvc-e1e2d345-7583-11e7-b4c2-abcdef123456": { - "snapshotID": "snap-04b1a8e11dfb33ab0", - "type": "gp2", - "iops": 100 - } - }, - "validationErrors": null - } -} -``` -Note that this file includes detailed info about your volume snapshots in the `status.volumeBackups` field, which can be helpful if you want to manually check them in your cloud provider GUI. - -## file format version: 1 - -When unzipped, a typical backup directory (e.g. `backup1234.tar.gz`) looks like the following: - -``` -resources/ - persistentvolumes/ - cluster/ - pv01.json - ... - configmaps/ - namespaces/ - namespace1/ - myconfigmap.json - ... - namespace2/ - ... - pods/ - namespaces/ - namespace1/ - mypod.json - ... - namespace2/ - ... - jobs/ - namespaces/ - namespace1/ - awesome-job.json - ... - namespace2/ - ... - deployments/ - namespaces/ - namespace1/ - cool-deployment.json - ... - namespace2/ - ... - ... -``` diff --git a/site/docs/v0.9.0/plugins.md b/site/docs/v0.9.0/plugins.md deleted file mode 100644 index 1cb2ae391..000000000 --- a/site/docs/v0.9.0/plugins.md +++ /dev/null @@ -1,35 +0,0 @@ -# Plugins - -Heptio Ark has a plugin architecture that allows users to add their own custom functionality to Ark backups & restores -without having to modify/recompile the core Ark binary. To add custom functionality, users simply create their own binary -containing an implementation of one of Ark's plugin kinds (described below), plus a small amount of boilerplate code to -expose the plugin implementation to Ark. This binary is added to a container image that serves as an init container for -the Ark server pod and copies the binary into a shared emptyDir volume for the Ark server to access. - -A fully-functional [sample plugin repository][1] is provided to serve as a convenient starting point for plugin authors. - -## Plugin Kinds - -Ark currently supports the following kinds of plugins: - -- **Object Store** - persists and retrieves backups, backup logs and restore logs -- **Block Store** - creates volume snapshots (during backup) and restores volumes from snapshots (during restore) -- **Backup Item Action** - executes arbitrary logic for individual items prior to storing them in a backup file -- **Restore Item Action** - executes arbitrary logic for individual items prior to restoring them into a cluster - -## Plugin Naming - -Ark relies on a naming convention to identify plugins. Each plugin binary should be named `ark--`, -where `plugin-kind` is one of `objectstore`, `blockstore`, `backupitemaction`, or `restoreitemaction`, and `name` is -unique within the plugin kind. - -## Plugin Logging - -Ark provides a [logger][2] that can be used by plugins to log structured information to the main Ark server log or -per-backup/restore logs. See the [sample repository][1] for an example of how to instantiate and use the logger -within your plugin. - - - -[1]: https://github.com/heptio/ark-plugin-example -[2]: https://github.com/heptio/ark/blob/main/pkg/plugin/logger.go diff --git a/site/docs/v0.9.0/vendoring-dependencies.md b/site/docs/v0.9.0/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v0.9.0/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.0.0/vendoring-dependencies.md b/site/docs/v1.0.0/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.0.0/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.1.0/vendoring-dependencies.md b/site/docs/v1.1.0/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.1.0/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.2.0/rbac.md b/site/docs/v1.2.0/rbac.md deleted file mode 100644 index d8686bf6e..000000000 --- a/site/docs/v1.2.0/rbac.md +++ /dev/null @@ -1,47 +0,0 @@ -# Run Velero more securely with restrictive RBAC settings - -By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. - -**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. - -For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. - -## Set up Roles and RoleBindings - -Here's a sample Role and RoleBinding pair. - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - namespace: YOUR_NAMESPACE_HERE - name: ROLE_NAME_HERE - labels: - component: velero -rules: - - apiGroups: - - velero.io - verbs: - - "*" - resources: - - "*" -``` - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: ROLEBINDING_NAME_HERE -subjects: - - kind: ServiceAccount - name: YOUR_SERVICEACCOUNT_HERE -roleRef: - kind: Role - name: ROLE_NAME_HERE - apiGroup: rbac.authorization.k8s.io -``` - -[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ -[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ -[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ -[4]: namespace.md diff --git a/site/docs/v1.2.0/vendoring-dependencies.md b/site/docs/v1.2.0/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.2.0/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.0/debugging-install.md b/site/docs/v1.3.0/debugging-install.md deleted file mode 100644 index 4abc5a3e1..000000000 --- a/site/docs/v1.3.0/debugging-install.md +++ /dev/null @@ -1,71 +0,0 @@ -# Debugging Installation Issues - -## General - -### `invalid configuration: no configuration has been provided` -This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the -following locations: -* the path specified by the `--kubeconfig` flag, if any -* the path specified by the `$KUBECONFIG` environment variable, if any -* `~/.kube/config` - -### Backups or restores stuck in `New` phase -This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: -``` -kubectl -n velero describe pods -kubectl -n velero logs deployment/velero -``` - - -## AWS - -### `NoCredentialProviders: no valid providers in chain` - -#### Using credentials -This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `credentials-velero` file is formatted properly and has the correct values: - - ``` - [default] - aws_access_key_id= - aws_secret_access_key= - ``` - -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -#### Using kube2iam -This means that Velero can't read the content of the S3 bucket. Ensure the following: - -* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. -* The new Velero role has all the permissions listed in the documentation regarding S3. - - -## Azure - -### `Failed to refresh the Token` or `adal: Refresh request failed` -This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted -properly into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - - -## GCE/GKE - -### `open credentials/cloud: no such file or directory` -This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -[0]: azure-config.md#create-service-principal diff --git a/site/docs/v1.3.0/debugging-restores.md b/site/docs/v1.3.0/debugging-restores.md deleted file mode 100644 index d50d4aacb..000000000 --- a/site/docs/v1.3.0/debugging-restores.md +++ /dev/null @@ -1,106 +0,0 @@ -# Debugging Restores - -* [Example][0] -* [Structure][1] - -## Example - -When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: - -``` -NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR -backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT -backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT -backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT -backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT -``` - -To delve into the warnings and errors into more detail, you can use `velero restore describe`: - -```bash -velero restore describe backup-test-20170726180512 -``` - -The output looks like this: - -``` -Name: backup-test-20170726180512 -Namespace: velero -Labels: -Annotations: - -Backup: backup-test - -Namespaces: - Included: * - Excluded: - -Resources: - Included: serviceaccounts - Excluded: nodes, events, events.events.k8s.io - Cluster-scoped: auto - -Namespace mappings: - -Label selector: - -Restore PVs: auto - -Phase: Completed - -Validation errors: - -Warnings: - Velero: - Cluster: - Namespaces: - velero: serviceaccounts "velero" already exists - serviceaccounts "default" already exists - kube-public: serviceaccounts "default" already exists - kube-system: serviceaccounts "attachdetach-controller" already exists - serviceaccounts "certificate-controller" already exists - serviceaccounts "cronjob-controller" already exists - serviceaccounts "daemon-set-controller" already exists - serviceaccounts "default" already exists - serviceaccounts "deployment-controller" already exists - serviceaccounts "disruption-controller" already exists - serviceaccounts "endpoint-controller" already exists - serviceaccounts "generic-garbage-collector" already exists - serviceaccounts "horizontal-pod-autoscaler" already exists - serviceaccounts "job-controller" already exists - serviceaccounts "kube-dns" already exists - serviceaccounts "namespace-controller" already exists - serviceaccounts "node-controller" already exists - serviceaccounts "persistent-volume-binder" already exists - serviceaccounts "pod-garbage-collector" already exists - serviceaccounts "replicaset-controller" already exists - serviceaccounts "replication-controller" already exists - serviceaccounts "resourcequota-controller" already exists - serviceaccounts "service-account-controller" already exists - serviceaccounts "service-controller" already exists - serviceaccounts "statefulset-controller" already exists - serviceaccounts "ttl-controller" already exists - default: serviceaccounts "default" already exists - -Errors: - Velero: - Cluster: - Namespaces: -``` - -## Structure - -Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the -restore looks "normal" and all resources referenced in the backup exist in some form, although some -of them may have been pre-existing). - -Both errors and warnings are structured in the same way: - -* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). - -* `Cluster`: A list of issues related to the restore of cluster-scoped resources. - -* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. - -[0]: #example -[1]: #structure diff --git a/site/docs/v1.3.0/rbac.md b/site/docs/v1.3.0/rbac.md deleted file mode 100644 index d8686bf6e..000000000 --- a/site/docs/v1.3.0/rbac.md +++ /dev/null @@ -1,47 +0,0 @@ -# Run Velero more securely with restrictive RBAC settings - -By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. - -**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. - -For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. - -## Set up Roles and RoleBindings - -Here's a sample Role and RoleBinding pair. - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - namespace: YOUR_NAMESPACE_HERE - name: ROLE_NAME_HERE - labels: - component: velero -rules: - - apiGroups: - - velero.io - verbs: - - "*" - resources: - - "*" -``` - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: ROLEBINDING_NAME_HERE -subjects: - - kind: ServiceAccount - name: YOUR_SERVICEACCOUNT_HERE -roleRef: - kind: Role - name: ROLE_NAME_HERE - apiGroup: rbac.authorization.k8s.io -``` - -[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ -[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ -[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ -[4]: namespace.md diff --git a/site/docs/v1.3.0/vendoring-dependencies.md b/site/docs/v1.3.0/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.3.0/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.1/api-types/backup.md b/site/docs/v1.3.1/api-types/backup.md deleted file mode 100644 index 70120a921..000000000 --- a/site/docs/v1.3.1/api-types/backup.md +++ /dev/null @@ -1,143 +0,0 @@ -# Backup API Type - -## Use - -The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the -Velero Server immediately starts the backup process. - -## API GroupVersion - -Backup belongs to the API group version `velero.io/v1`. - -## Definition - -Here is a sample `Backup` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: velero.io/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Backup -# Standard Kubernetes metadata. Required. -metadata: - # Backup name. May be any valid Kubernetes object name. Required. - name: a - # Backup namespace. Must be the namespace of the Velero server. Required. - namespace: velero -# Parameters about the backup. Required. -spec: - # Array of namespaces to include in the backup. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the backup. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the backup. For example, if a - # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the backup. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and - # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as - # a persistent volume provider is configured for Velero. - snapshotVolumes: null - # Where to store the tarball and logs. - storageLocation: aws-primary - # The list of locations in which to store volume snapshots created for this backup. - volumeSnapshotLocations: - - aws-primary - - gcp-primary - # The amount of time before this backup is eligible for garbage collection. If not specified, - # a default value of 30 days will be used. The default can be configured on the velero server - # by passing the flag --default-backup-ttl. - ttl: 24h0m0s - # Actions to perform at different times during a backup. The only hook currently supported is - # executing a command in a container in a pod using the pod exec API. Optional. - hooks: - # Array of hooks that are applicable to specific resources. Optional. - resources: - - - # Name of the hook. Will be displayed in backup log. - name: my-hook - # Array of namespaces to which this hook applies. If unspecified, the hook applies to all - # namespaces. Optional. - includedNamespaces: - - '*' - # Array of namespaces to which this hook does not apply. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to which this hook applies. The only resource supported at this time is - # pods. - includedResources: - - pods - # Array of resources to which this hook does not apply. Optional. - excludedResources: [] - # This hook only applies to objects matching this label selector. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - pre: - - - # The type of hook. This must be "exec". - exec: - # The name of the container where the command will be executed. If unspecified, the - # first container in the pod will be used. Optional. - container: my-container - # The command to execute, specified as an array. Required. - command: - - /bin/uname - - -a - # How to handle an error executing the command. Valid values are Fail and Continue. - # Defaults to Fail. Optional. - onError: Fail - # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. - timeout: 10s - # An array of hooks to run after all custom actions and additional items have been - # processed. Currently only "exec" hooks are supported. - post: - # Same content as pre above. -# Status about the Backup. Users should not set any data here. -status: - # The version of this Backup. The only version currently supported is 1. - version: 1 - # The date and time when the Backup is eligible for garbage collection. - expiration: null - # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. - phase: "" - # An array of any validation errors encountered. - validationErrors: null - # Date/time when the backup started being processed. - startTimestamp: 2019-04-29T15:58:43Z - # Date/time when the backup finished being processed. - completionTimestamp: 2019-04-29T15:58:56Z - # Number of volume snapshots that Velero tried to create for this backup. - volumeSnapshotsAttempted: 2 - # Number of volume snapshots that Velero successfully created for this backup. - volumeSnapshotsCompleted: 1 - # Number of warnings that were logged by the backup. - warnings: 2 - # Number of errors that were logged by the backup. - errors: 0 - -``` diff --git a/site/docs/v1.3.1/debugging-install.md b/site/docs/v1.3.1/debugging-install.md deleted file mode 100644 index 4abc5a3e1..000000000 --- a/site/docs/v1.3.1/debugging-install.md +++ /dev/null @@ -1,71 +0,0 @@ -# Debugging Installation Issues - -## General - -### `invalid configuration: no configuration has been provided` -This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the -following locations: -* the path specified by the `--kubeconfig` flag, if any -* the path specified by the `$KUBECONFIG` environment variable, if any -* `~/.kube/config` - -### Backups or restores stuck in `New` phase -This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: -``` -kubectl -n velero describe pods -kubectl -n velero logs deployment/velero -``` - - -## AWS - -### `NoCredentialProviders: no valid providers in chain` - -#### Using credentials -This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `credentials-velero` file is formatted properly and has the correct values: - - ``` - [default] - aws_access_key_id= - aws_secret_access_key= - ``` - -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -#### Using kube2iam -This means that Velero can't read the content of the S3 bucket. Ensure the following: - -* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. -* The new Velero role has all the permissions listed in the documentation regarding S3. - - -## Azure - -### `Failed to refresh the Token` or `adal: Refresh request failed` -This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted -properly into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - - -## GCE/GKE - -### `open credentials/cloud: no such file or directory` -This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -[0]: azure-config.md#create-service-principal diff --git a/site/docs/v1.3.1/debugging-restores.md b/site/docs/v1.3.1/debugging-restores.md deleted file mode 100644 index d50d4aacb..000000000 --- a/site/docs/v1.3.1/debugging-restores.md +++ /dev/null @@ -1,106 +0,0 @@ -# Debugging Restores - -* [Example][0] -* [Structure][1] - -## Example - -When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: - -``` -NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR -backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT -backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT -backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT -backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT -``` - -To delve into the warnings and errors into more detail, you can use `velero restore describe`: - -```bash -velero restore describe backup-test-20170726180512 -``` - -The output looks like this: - -``` -Name: backup-test-20170726180512 -Namespace: velero -Labels: -Annotations: - -Backup: backup-test - -Namespaces: - Included: * - Excluded: - -Resources: - Included: serviceaccounts - Excluded: nodes, events, events.events.k8s.io - Cluster-scoped: auto - -Namespace mappings: - -Label selector: - -Restore PVs: auto - -Phase: Completed - -Validation errors: - -Warnings: - Velero: - Cluster: - Namespaces: - velero: serviceaccounts "velero" already exists - serviceaccounts "default" already exists - kube-public: serviceaccounts "default" already exists - kube-system: serviceaccounts "attachdetach-controller" already exists - serviceaccounts "certificate-controller" already exists - serviceaccounts "cronjob-controller" already exists - serviceaccounts "daemon-set-controller" already exists - serviceaccounts "default" already exists - serviceaccounts "deployment-controller" already exists - serviceaccounts "disruption-controller" already exists - serviceaccounts "endpoint-controller" already exists - serviceaccounts "generic-garbage-collector" already exists - serviceaccounts "horizontal-pod-autoscaler" already exists - serviceaccounts "job-controller" already exists - serviceaccounts "kube-dns" already exists - serviceaccounts "namespace-controller" already exists - serviceaccounts "node-controller" already exists - serviceaccounts "persistent-volume-binder" already exists - serviceaccounts "pod-garbage-collector" already exists - serviceaccounts "replicaset-controller" already exists - serviceaccounts "replication-controller" already exists - serviceaccounts "resourcequota-controller" already exists - serviceaccounts "service-account-controller" already exists - serviceaccounts "service-controller" already exists - serviceaccounts "statefulset-controller" already exists - serviceaccounts "ttl-controller" already exists - default: serviceaccounts "default" already exists - -Errors: - Velero: - Cluster: - Namespaces: -``` - -## Structure - -Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the -restore looks "normal" and all resources referenced in the backup exist in some form, although some -of them may have been pre-existing). - -Both errors and warnings are structured in the same way: - -* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). - -* `Cluster`: A list of issues related to the restore of cluster-scoped resources. - -* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. - -[0]: #example -[1]: #structure diff --git a/site/docs/v1.3.1/rbac.md b/site/docs/v1.3.1/rbac.md deleted file mode 100644 index d8686bf6e..000000000 --- a/site/docs/v1.3.1/rbac.md +++ /dev/null @@ -1,47 +0,0 @@ -# Run Velero more securely with restrictive RBAC settings - -By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. - -**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. - -For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. - -## Set up Roles and RoleBindings - -Here's a sample Role and RoleBinding pair. - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - namespace: YOUR_NAMESPACE_HERE - name: ROLE_NAME_HERE - labels: - component: velero -rules: - - apiGroups: - - velero.io - verbs: - - "*" - resources: - - "*" -``` - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: ROLEBINDING_NAME_HERE -subjects: - - kind: ServiceAccount - name: YOUR_SERVICEACCOUNT_HERE -roleRef: - kind: Role - name: ROLE_NAME_HERE - apiGroup: rbac.authorization.k8s.io -``` - -[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ -[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ -[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ -[4]: namespace.md diff --git a/site/docs/v1.3.1/vendoring-dependencies.md b/site/docs/v1.3.1/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.3.1/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.2/api-types/backup.md b/site/docs/v1.3.2/api-types/backup.md deleted file mode 100644 index 70120a921..000000000 --- a/site/docs/v1.3.2/api-types/backup.md +++ /dev/null @@ -1,143 +0,0 @@ -# Backup API Type - -## Use - -The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the -Velero Server immediately starts the backup process. - -## API GroupVersion - -Backup belongs to the API group version `velero.io/v1`. - -## Definition - -Here is a sample `Backup` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: velero.io/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Backup -# Standard Kubernetes metadata. Required. -metadata: - # Backup name. May be any valid Kubernetes object name. Required. - name: a - # Backup namespace. Must be the namespace of the Velero server. Required. - namespace: velero -# Parameters about the backup. Required. -spec: - # Array of namespaces to include in the backup. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the backup. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the backup. For example, if a - # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the backup. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and - # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as - # a persistent volume provider is configured for Velero. - snapshotVolumes: null - # Where to store the tarball and logs. - storageLocation: aws-primary - # The list of locations in which to store volume snapshots created for this backup. - volumeSnapshotLocations: - - aws-primary - - gcp-primary - # The amount of time before this backup is eligible for garbage collection. If not specified, - # a default value of 30 days will be used. The default can be configured on the velero server - # by passing the flag --default-backup-ttl. - ttl: 24h0m0s - # Actions to perform at different times during a backup. The only hook currently supported is - # executing a command in a container in a pod using the pod exec API. Optional. - hooks: - # Array of hooks that are applicable to specific resources. Optional. - resources: - - - # Name of the hook. Will be displayed in backup log. - name: my-hook - # Array of namespaces to which this hook applies. If unspecified, the hook applies to all - # namespaces. Optional. - includedNamespaces: - - '*' - # Array of namespaces to which this hook does not apply. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to which this hook applies. The only resource supported at this time is - # pods. - includedResources: - - pods - # Array of resources to which this hook does not apply. Optional. - excludedResources: [] - # This hook only applies to objects matching this label selector. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - pre: - - - # The type of hook. This must be "exec". - exec: - # The name of the container where the command will be executed. If unspecified, the - # first container in the pod will be used. Optional. - container: my-container - # The command to execute, specified as an array. Required. - command: - - /bin/uname - - -a - # How to handle an error executing the command. Valid values are Fail and Continue. - # Defaults to Fail. Optional. - onError: Fail - # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. - timeout: 10s - # An array of hooks to run after all custom actions and additional items have been - # processed. Currently only "exec" hooks are supported. - post: - # Same content as pre above. -# Status about the Backup. Users should not set any data here. -status: - # The version of this Backup. The only version currently supported is 1. - version: 1 - # The date and time when the Backup is eligible for garbage collection. - expiration: null - # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. - phase: "" - # An array of any validation errors encountered. - validationErrors: null - # Date/time when the backup started being processed. - startTimestamp: 2019-04-29T15:58:43Z - # Date/time when the backup finished being processed. - completionTimestamp: 2019-04-29T15:58:56Z - # Number of volume snapshots that Velero tried to create for this backup. - volumeSnapshotsAttempted: 2 - # Number of volume snapshots that Velero successfully created for this backup. - volumeSnapshotsCompleted: 1 - # Number of warnings that were logged by the backup. - warnings: 2 - # Number of errors that were logged by the backup. - errors: 0 - -``` diff --git a/site/docs/v1.3.2/api-types/schedule.md b/site/docs/v1.3.2/api-types/schedule.md deleted file mode 100644 index ec7e471a6..000000000 --- a/site/docs/v1.3.2/api-types/schedule.md +++ /dev/null @@ -1,132 +0,0 @@ -# Schedule API Type - -## Use - -The `Schedule` API type is used as a repeatable request for the Velero server to perform a backup for a given cron notation. Once created, the -Velero Server will start the backup process. It will then wait for the next valid point of the given cron expression and execute the backup -process on a repeating basis. - -## API GroupVersion - -Schedule belongs to the API group version `velero.io/v1`. - -## Definition - -Here is a sample `Schedule` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: velero.io/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Schedule -# Standard Kubernetes metadata. Required. -metadata: - # Schedule name. May be any valid Kubernetes object name. Required. - name: a - # Schedule namespace. Must be the namespace of the Velero server. Required. - namespace: velero -# Parameters about the scheduled backup. Required. -spec: - # Schedule is a Cron expression defining when to run the Backup - schedule: 0 7 * * * - # Template is the spec that should be used for each backup triggered by this schedule. - template: - # Array of namespaces to include in the scheduled backup. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the scheduled backup. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the scheduled backup. For example, if a - # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the scheduled backup. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and - # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as - # a persistent volume provider is configured for Velero. - snapshotVolumes: null - # Where to store the tarball and logs. - storageLocation: aws-primary - # The list of locations in which to store volume snapshots created for backups under this schedule. - volumeSnapshotLocations: - - aws-primary - - gcp-primary - # The amount of time before backups created on this schedule are eligible for garbage collection. If not specified, - # a default value of 30 days will be used. The default can be configured on the velero server - # by passing the flag --default-backup-ttl. - ttl: 24h0m0s - # Actions to perform at different times during a backup. The only hook currently supported is - # executing a command in a container in a pod using the pod exec API. Optional. - hooks: - # Array of hooks that are applicable to specific resources. Optional. - resources: - - - # Name of the hook. Will be displayed in backup log. - name: my-hook - # Array of namespaces to which this hook applies. If unspecified, the hook applies to all - # namespaces. Optional. - includedNamespaces: - - '*' - # Array of namespaces to which this hook does not apply. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to which this hook applies. The only resource supported at this time is - # pods. - includedResources: - - pods - # Array of resources to which this hook does not apply. Optional. - excludedResources: [] - # This hook only applies to objects matching this label selector. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - pre: - - - # The type of hook. This must be "exec". - exec: - # The name of the container where the command will be executed. If unspecified, the - # first container in the pod will be used. Optional. - container: my-container - # The command to execute, specified as an array. Required. - command: - - /bin/uname - - -a - # How to handle an error executing the command. Valid values are Fail and Continue. - # Defaults to Fail. Optional. - onError: Fail - # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. - timeout: 10s - # An array of hooks to run after all custom actions and additional items have been - # processed. Currently only "exec" hooks are supported. - post: - # Same content as pre above. -status: - # The current phase of the latest scheduled backup. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. - phase: "" - # Date/time of the last backup for a given schedule - lastBackup: - # An array of any validation errors encountered. - validationErrors: -``` diff --git a/site/docs/v1.3.2/api-types/volumesnapshotlocation.md b/site/docs/v1.3.2/api-types/volumesnapshotlocation.md deleted file mode 100644 index 8f3588dcb..000000000 --- a/site/docs/v1.3.2/api-types/volumesnapshotlocation.md +++ /dev/null @@ -1,38 +0,0 @@ -# Velero Volume Snapshot Location - -## Volume Snapshot Location - -A volume snapshot location is the location in which to store the volume snapshots created for a backup. - -Velero can be configured to take snapshots of volumes from multiple providers. Velero also allows you to configure multiple possible `VolumeSnapshotLocation` per provider, although you can only select one location per provider at backup time. - -Each VolumeSnapshotLocation describes a provider + location. These are represented in the cluster via the `VolumeSnapshotLocation` CRD. Velero must have at least one `VolumeSnapshotLocation` per cloud provider. - -A sample YAML `VolumeSnapshotLocation` looks like the following: - -```yaml -apiVersion: velero.io/v1 -kind: VolumeSnapshotLocation -metadata: - name: aws-default - namespace: velero -spec: - provider: aws - config: - region: us-west-2 - profile: "default" -``` - -### Parameter Reference - -The configurable parameters are as follows: - -#### Main config parameters - -| Key | Type | Default | Meaning | -| --- | --- | --- | --- | -| `provider` | String | Required Field | The name for whichever storage provider will be used to create/store the volume snapshots. See [your volume snapshot provider's plugin documentation][0] for the appropriate value to use. | -| `config` | map[string]string | None (Optional) | Provider-specific configuration keys/values to be passed to the volume snapshotter plugin. See [your volume snapshot provider's plugin documentation][0] for details. | - - -[0]: ../supported-providers.md diff --git a/site/docs/v1.3.2/debugging-install.md b/site/docs/v1.3.2/debugging-install.md deleted file mode 100644 index 4abc5a3e1..000000000 --- a/site/docs/v1.3.2/debugging-install.md +++ /dev/null @@ -1,71 +0,0 @@ -# Debugging Installation Issues - -## General - -### `invalid configuration: no configuration has been provided` -This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the -following locations: -* the path specified by the `--kubeconfig` flag, if any -* the path specified by the `$KUBECONFIG` environment variable, if any -* `~/.kube/config` - -### Backups or restores stuck in `New` phase -This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: -``` -kubectl -n velero describe pods -kubectl -n velero logs deployment/velero -``` - - -## AWS - -### `NoCredentialProviders: no valid providers in chain` - -#### Using credentials -This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `credentials-velero` file is formatted properly and has the correct values: - - ``` - [default] - aws_access_key_id= - aws_secret_access_key= - ``` - -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -#### Using kube2iam -This means that Velero can't read the content of the S3 bucket. Ensure the following: - -* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. -* The new Velero role has all the permissions listed in the documentation regarding S3. - - -## Azure - -### `Failed to refresh the Token` or `adal: Refresh request failed` -This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted -properly into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - - -## GCE/GKE - -### `open credentials/cloud: no such file or directory` -This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -[0]: azure-config.md#create-service-principal diff --git a/site/docs/v1.3.2/debugging-restores.md b/site/docs/v1.3.2/debugging-restores.md deleted file mode 100644 index d50d4aacb..000000000 --- a/site/docs/v1.3.2/debugging-restores.md +++ /dev/null @@ -1,106 +0,0 @@ -# Debugging Restores - -* [Example][0] -* [Structure][1] - -## Example - -When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: - -``` -NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR -backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT -backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT -backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT -backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT -``` - -To delve into the warnings and errors into more detail, you can use `velero restore describe`: - -```bash -velero restore describe backup-test-20170726180512 -``` - -The output looks like this: - -``` -Name: backup-test-20170726180512 -Namespace: velero -Labels: -Annotations: - -Backup: backup-test - -Namespaces: - Included: * - Excluded: - -Resources: - Included: serviceaccounts - Excluded: nodes, events, events.events.k8s.io - Cluster-scoped: auto - -Namespace mappings: - -Label selector: - -Restore PVs: auto - -Phase: Completed - -Validation errors: - -Warnings: - Velero: - Cluster: - Namespaces: - velero: serviceaccounts "velero" already exists - serviceaccounts "default" already exists - kube-public: serviceaccounts "default" already exists - kube-system: serviceaccounts "attachdetach-controller" already exists - serviceaccounts "certificate-controller" already exists - serviceaccounts "cronjob-controller" already exists - serviceaccounts "daemon-set-controller" already exists - serviceaccounts "default" already exists - serviceaccounts "deployment-controller" already exists - serviceaccounts "disruption-controller" already exists - serviceaccounts "endpoint-controller" already exists - serviceaccounts "generic-garbage-collector" already exists - serviceaccounts "horizontal-pod-autoscaler" already exists - serviceaccounts "job-controller" already exists - serviceaccounts "kube-dns" already exists - serviceaccounts "namespace-controller" already exists - serviceaccounts "node-controller" already exists - serviceaccounts "persistent-volume-binder" already exists - serviceaccounts "pod-garbage-collector" already exists - serviceaccounts "replicaset-controller" already exists - serviceaccounts "replication-controller" already exists - serviceaccounts "resourcequota-controller" already exists - serviceaccounts "service-account-controller" already exists - serviceaccounts "service-controller" already exists - serviceaccounts "statefulset-controller" already exists - serviceaccounts "ttl-controller" already exists - default: serviceaccounts "default" already exists - -Errors: - Velero: - Cluster: - Namespaces: -``` - -## Structure - -Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the -restore looks "normal" and all resources referenced in the backup exist in some form, although some -of them may have been pre-existing). - -Both errors and warnings are structured in the same way: - -* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). - -* `Cluster`: A list of issues related to the restore of cluster-scoped resources. - -* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. - -[0]: #example -[1]: #structure diff --git a/site/docs/v1.3.2/examples.md b/site/docs/v1.3.2/examples.md deleted file mode 100644 index 40b284ec3..000000000 --- a/site/docs/v1.3.2/examples.md +++ /dev/null @@ -1,63 +0,0 @@ -## Examples - -After you set up the Velero server, try these examples: - -### Basic example (without PersistentVolumes) - -1. Start the sample nginx app: - - ```bash - kubectl apply -f examples/nginx-app/base.yaml - ``` - -1. Create a backup: - - ```bash - velero backup create nginx-backup --include-namespaces nginx-example - ``` - -1. Simulate a disaster: - - ```bash - kubectl delete namespaces nginx-example - ``` - - Wait for the namespace to be deleted. - -1. Restore your lost resources: - - ```bash - velero restore create --from-backup nginx-backup - ``` - -### Snapshot example (with PersistentVolumes) - -> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks. - -1. Start the sample nginx app: - - ```bash - kubectl apply -f examples/nginx-app/with-pv.yaml - ``` - -1. Create a backup with PV snapshotting: - - ```bash - velero backup create nginx-backup --include-namespaces nginx-example - ``` - -1. Simulate a disaster: - - ```bash - kubectl delete namespaces nginx-example - ``` - - Because the default [reclaim policy][1] for dynamically-provisioned PVs is "Delete", these commands should trigger your cloud provider to delete the disk that backs the PV. Deletion is asynchronous, so this may take some time. **Before continuing to the next step, check your cloud provider to confirm that the disk no longer exists.** - -1. Restore your lost resources: - - ```bash - velero restore create --from-backup nginx-backup - ``` - -[1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming diff --git a/site/docs/v1.3.2/image-tagging.md b/site/docs/v1.3.2/image-tagging.md deleted file mode 100644 index b0080ef1c..000000000 --- a/site/docs/v1.3.2/image-tagging.md +++ /dev/null @@ -1,21 +0,0 @@ -# Image tagging policy - -This document describes Velero's image tagging policy. - -## Released versions - -`velero/velero:` - -Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/vmware-tanzu/velero` repository has a matching image, e.g. `velero/velero:v1.0.0`. - -### Latest - -`velero/velero:latest` - -The `latest` tag follows the most recently released version of Velero. - -## Development - -`velero/velero:main` - -The `main` tag follows the latest commit to land on the `main` branch. diff --git a/site/docs/v1.3.2/locations.md b/site/docs/v1.3.2/locations.md deleted file mode 100644 index ca28239a7..000000000 --- a/site/docs/v1.3.2/locations.md +++ /dev/null @@ -1,164 +0,0 @@ -# Backup Storage Locations and Volume Snapshot Locations - -## Overview - -Velero has two custom resources, `BackupStorageLocation` and `VolumeSnapshotLocation`, that are used to configure where Velero backups and their associated persistent volume snapshots are stored. - -A `BackupStorageLocation` is defined as a bucket, a prefix within that bucket under which all Velero data should be stored, and a set of additional provider-specific fields (e.g. AWS region, Azure storage account, etc.) The [API documentation][1] captures the configurable parameters for each in-tree provider. - -A `VolumeSnapshotLocation` is defined entirely by provider-specific fields (e.g. AWS region, Azure resource group, Portworx snapshot type, etc.) The [API documentation][2] captures the configurable parameters for each in-tree provider. - -The user can pre-configure one or more possible `BackupStorageLocations` and one or more `VolumeSnapshotLocations`, and can select *at backup creation time* the location in which the backup and associated snapshots should be stored. - -This configuration design enables a number of different use cases, including: - -- Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) -- Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region -- For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud - -## Limitations / Caveats - -- Velero only supports a single set of credentials *per provider*. It's not yet possible to use different credentials for different locations, if they're for the same provider. - -- Volume snapshots are still limited by where your provider allows you to create snapshots. For example, AWS and Azure do not allow you to create a volume snapshot in a different region than where the volume is. If you try to take a Velero backup using a volume snapshot location with a different region than where your cluster's volumes are, the backup will fail. - -- Each Velero backup has one `BackupStorageLocation`, and one `VolumeSnapshotLocation` per volume provider. It is not possible (yet) to send a single Velero backup to multiple backup storage locations simultaneously, or a single volume snapshot to multiple locations simultaneously. However, you can always set up multiple scheduled backups that differ only in the storage locations used if redundancy of backups across locations is important. - -- Cross-provider snapshots are not supported. If you have a cluster with more than one type of volume (e.g. EBS and Portworx), but you only have a `VolumeSnapshotLocation` configured for EBS, then Velero will **only** snapshot the EBS volumes. - -- Restic data is stored under a prefix/subdirectory of the main Velero bucket, and will go into the bucket corresponding to the `BackupStorageLocation` selected by the user at backup creation time. - -## Examples - -Let's look at some examples of how we can use this configuration mechanism to address some common use cases: - -#### Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) - -During server configuration: - -```shell -velero snapshot-location create ebs-us-east-1 \ - --provider aws \ - --config region=us-east-1 - -velero snapshot-location create portworx-cloud \ - --provider portworx \ - --config type=cloud -``` - -During backup creation: - -```shell -velero backup create full-cluster-backup \ - --volume-snapshot-locations ebs-us-east-1,portworx-cloud -``` - -Alternately, since in this example there's only one possible volume snapshot location configured for each of our two providers (`ebs-us-east-1` for `aws`, and `portworx-cloud` for `portworx`), Velero doesn't require them to be explicitly specified when creating the backup: - -```shell -velero backup create full-cluster-backup -``` - -#### Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region - -During server configuration: - -```shell -velero backup-location create default \ - --provider aws \ - --bucket velero-backups \ - --config region=us-east-1 - -velero backup-location create s3-alt-region \ - --provider aws \ - --bucket velero-backups-alt \ - --config region=us-west-1 -``` - -During backup creation: - -```shell -# The Velero server will automatically store backups in the backup storage location named "default" if -# one is not specified when creating the backup. You can alter which backup storage location is used -# by default by setting the --default-backup-storage-location flag on the `velero server` command (run -# by the Velero deployment) to the name of a different backup storage location. -velero backup create full-cluster-backup -``` - -Or: - -```shell -velero backup create full-cluster-alternate-location-backup \ - --storage-location s3-alt-region -``` - -#### For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud - -During server configuration: - -```shell -velero snapshot-location create portworx-local \ - --provider portworx \ - --config type=local - -velero snapshot-location create portworx-cloud \ - --provider portworx \ - --config type=cloud -``` - -During backup creation: - -```shell -# Note that since in this example we have two possible volume snapshot locations for the Portworx -# provider, we need to explicitly specify which one to use when creating a backup. Alternately, -# you can set the --default-volume-snapshot-locations flag on the `velero server` command (run by -# the Velero deployment) to specify which location should be used for each provider by default, in -# which case you don't need to specify it when creating a backup. -velero backup create local-snapshot-backup \ - --volume-snapshot-locations portworx-local -``` - -Or: - -```shell -velero backup create cloud-snapshot-backup \ - --volume-snapshot-locations portworx-cloud -``` - -#### Use a single location - -If you don't have a use case for more than one location, it's still easy to use Velero. Let's assume you're running on AWS, in the `us-west-1` region: - -During server configuration: - -```shell -velero backup-location create default \ - --provider aws \ - --bucket velero-backups \ - --config region=us-west-1 - -velero snapshot-location create ebs-us-west-1 \ - --provider aws \ - --config region=us-west-1 -``` - -During backup creation: - -```shell -# Velero will automatically use your configured backup storage location and volume snapshot location. -# Nothing needs to be specified when creating a backup. -velero backup create full-cluster-backup -``` - -## Additional Use Cases - -1. If you're using Azure's AKS, you may want to store your volume snapshots outside of the "infrastructure" resource group that is automatically created when you create your AKS cluster. This is possible using a `VolumeSnapshotLocation`, by specifying a `resourceGroup` under the `config` section of the snapshot location. See the [Azure volume snapshot location documentation][3] for details. - -1. If you're using Azure, you may want to store your Velero backups across multiple storage accounts and/or resource groups/subscriptions. This is possible using a `BackupStorageLocation`, by specifying a `storageAccount`, `resourceGroup` and/or `subscriptionId`, respectively, under the `config` section of the backup location. See the [Azure backup storage location documentation][4] for details. - - - -[1]: api-types/backupstoragelocation.md -[2]: api-types/volumesnapshotlocation.md -[3]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md -[4]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md diff --git a/site/docs/v1.3.2/overview-plugins.md b/site/docs/v1.3.2/overview-plugins.md deleted file mode 100644 index 74eb3b0fb..000000000 --- a/site/docs/v1.3.2/overview-plugins.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Velero plugin system - -Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. - -For server installation, Velero requires that at least one plugin is added (with the `--plugins` flag). The plugin will be either of the type object store or volume snapshotter, or a plugin that contains both. An exception to this is that when the user is not configuring a backup storage location or a snapshot storage location at the time of install, this flag is optional. - -Any plugin can be added after Velero has been installed by using the command `velero plugin add `. - -Example with a dockerhub image: `velero plugin add velero/velero-plugin-for-aws:v1.0.0`. - -In the same way, any plugin can be removed by using the command `velero plugin remove `. - -## Creating a new plugin - -Anyone can add integrations for any platform to provide additional backup and volume storage without modifying the Velero codebase. To write a plugin for a new backup or volume storage platform, take a look at our [example repo][1] and at our documentation for [Custom plugins][2]. - -## Adding a new plugin - -After you publish your plugin on your own repository, open a PR that adds a link to it under the appropriate list of [supported providers][3] page in our documentation. - -You can also add the [`velero-plugin` GitHub Topic][4] to your repo, and it will be shown under the aggregated list of repositories automatically. - -[1]: https://github.com/vmware-tanzu/velero-plugin-example/ -[2]: custom-plugins.md -[3]: supported-providers.md -[4]: https://github.com/topics/velero-plugin diff --git a/site/docs/v1.3.2/rbac.md b/site/docs/v1.3.2/rbac.md deleted file mode 100644 index d8686bf6e..000000000 --- a/site/docs/v1.3.2/rbac.md +++ /dev/null @@ -1,47 +0,0 @@ -# Run Velero more securely with restrictive RBAC settings - -By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. - -**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. - -For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. - -## Set up Roles and RoleBindings - -Here's a sample Role and RoleBinding pair. - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - namespace: YOUR_NAMESPACE_HERE - name: ROLE_NAME_HERE - labels: - component: velero -rules: - - apiGroups: - - velero.io - verbs: - - "*" - resources: - - "*" -``` - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: ROLEBINDING_NAME_HERE -subjects: - - kind: ServiceAccount - name: YOUR_SERVICEACCOUNT_HERE -roleRef: - kind: Role - name: ROLE_NAME_HERE - apiGroup: rbac.authorization.k8s.io -``` - -[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ -[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ -[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ -[4]: namespace.md diff --git a/site/docs/v1.3.2/run-locally.md b/site/docs/v1.3.2/run-locally.md deleted file mode 100644 index 913cbc122..000000000 --- a/site/docs/v1.3.2/run-locally.md +++ /dev/null @@ -1,49 +0,0 @@ -# Run Velero locally in development - -Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server -image and redeploy it to the cluster with each change. - -## Run Velero locally with a remote cluster - -Velero runs against the Kubernetes API server as the endpoint (as per the `kubeconfig` configuration), so both the Velero server and client use the same `client-go` to communicate with Kubernetes. This means the Velero server can be run locally just as functionally as if it was running in the remote cluster. - -### Prerequisites - -When running Velero, you will need to ensure that you set up all of the following: - -* Appropriate RBAC permissions in the cluster - * Read access for all data from the source cluster and namespaces - * Write access to the target cluster and namespaces -* Cloud provider credentials - * Read/write access to volumes - * Read/write access to object storage for backup data -* A [BackupStorageLocation][20] object definition for the Velero server -* (Optional) A [VolumeSnapshotLocation][21] object definition for the Velero server, to take PV snapshots - -### 1. Install Velero - -See documentation on how to install Velero in some specific providers: [Install overview][22] - -### 2. Scale deployment down to zero - -After you use the `velero install` command to install Velero into your cluster, you scale the Velero deployment down to 0 so it is not simultaneously being run on the remote cluster and potentially causing things to get out of sync: - -`kubectl scale --replicas=0 deployment velero -n velero` - -#### 3. Start the Velero server locally - -* To run the server locally, use the full path according to the binary you need. Example, if you are on a Mac, and using `AWS` as a provider, this is how to run the binary you built from source using the full path: `AWS_SHARED_CREDENTIALS_FILE= ./_output/bin/darwin/amd64/velero`. Alternatively, you may add the `velero` binary to your `PATH`. - -* Start the server: `velero server [CLI flags]`. The following CLI flags may be useful to customize, but see `velero server --help` for full details: - * `--log-level`: set the Velero server's log level (default `info`, use `debug` for the most logging) - * `--kubeconfig`: set the path to the kubeconfig file the Velero server uses to talk to the Kubernetes apiserver (default `$KUBECONFIG`) - * `--namespace`: the set namespace where the Velero server should look for backups, schedules, restores (default `velero`) - * `--plugin-dir`: set the directory where the Velero server looks for plugins (default `/plugins`) - * `--metrics-address`: set the bind address and port where Prometheus metrics are exposed (default `:8085`) - -[15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file -[16]: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable -[18]: https://eksctl.io/ -[20]: api-types/backupstoragelocation.md -[21]: api-types/volumesnapshotlocation.md -[22]: basic-install.md diff --git a/site/docs/v1.3.2/support-process.md b/site/docs/v1.3.2/support-process.md deleted file mode 100644 index c4bdf82a0..000000000 --- a/site/docs/v1.3.2/support-process.md +++ /dev/null @@ -1,41 +0,0 @@ -# Support Process - -## Weekly Rotation - -The Velero maintainers use a weekly rotation to manage community support. Each week, a different maintainer is the point person for responding to incoming support issues via Slack, GitHub, and the Google group. The point person is *not* expected to be on-call 24x7. Instead, they choose one or more hour(s) per day to be available/responding to incoming issues. They will communicate to the community what that time slot will be each week. - -## Start of Week - -We will update the public Slack channel's topic to indicate that you are the point person for the week, and what hours you'll be available. - -## During the Week - -### Where we will monitor -- `#velero` public Slack channel in Kubernetes org -- [all Velero-related repos][0] in GitHub (`velero`, `velero-plugin-for-[aws|gcp|microsoft-azure|csi]`, `helm-charts`) -- [Project Velero Google Group][1] - -### GitHub issue flow - -Generally speaking, new GitHub issues will fall into one of several categories. We use the following process for each: - -1. **Feature request** - - Label the issue with `Enhancement/User` or `Enhancement/Dev` - - Leave the issue in the `New Issues` swimlane for triage by product mgmt -1. **Bug** - - Label the issue with `Bug` - - Leave the issue in the `New Issues` swimlane for triage by product mgmt -1. **User question/problem** that does not clearly fall into one of the previous categories - - When you start investigating/responding, label the issue with `Investigating` - - Add comments as you go, so both the user and future support people have as much context as possible - - Use the `Needs Info` label to indicate an issue is waiting for information from the user. Remove/re-add the label as needed. - - If you resolve the issue with the user, close it out - - If the issue ends up being a feature request or a bug, update the title and follow the appropriate process for it - - If the reporter becomes unresponsive after multiple pings, close out the issue due to inactivity and comment that the user can always reach out again as needed - -## End of Week - -We ensure all GitHub issues worked on during the week on are labeled with `Investigating` and `Needs Info` (if appropriate), and have updated comments so the next person can pick them up. - -[0]: https://app.zenhub.com/workspaces/velero-5c59c15e39d47b774b5864e3/board?repos=99143276,112385197,213946861,190224441,214524700,214524630 -[1]: https://groups.google.com/forum/#!forum/projectvelero diff --git a/site/docs/v1.3.2/troubleshooting.md b/site/docs/v1.3.2/troubleshooting.md deleted file mode 100644 index 984d8f714..000000000 --- a/site/docs/v1.3.2/troubleshooting.md +++ /dev/null @@ -1,123 +0,0 @@ -# Troubleshooting - -These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. - -- [Troubleshooting](#troubleshooting) - - [Debug installation/ setup issues](#debug-installation-setup-issues) - - [Debug restores](#debug-restores) - - [General troubleshooting information](#general-troubleshooting-information) - - [Getting velero debug logs](#getting-velero-debug-logs) - - [Known issue with restoring LoadBalancer Service](#known-issue-with-restoring-loadbalancer-service) - - [Miscellaneous issues](#miscellaneous-issues) - - [Velero reports `custom resource not found` errors when starting up.](#velero-reports-custom-resource-not-found-errors-when-starting-up) - - [`velero backup logs` returns a `SignatureDoesNotMatch` error](#velero-backup-logs-returns-a-signaturedoesnotmatch-error) - - [Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress](#velero-or-a-pod-it-was-backing-up-restarted-during-a-backup-and-the-backup-is-stuck-inprogress) - - [Velero is not publishing prometheus metrics](#velero-is-not-publishing-prometheus-metrics) - -## Debug installation/ setup issues - -- [Debug installation/setup issues][2] - -## Debug restores - -- [Debug restores][1] - -## General troubleshooting information - -You can use the `velero bug` command to open a [Github issue][4] by launching a browser window with some prepopulated values. Values included are OS, CPU architecture, `kubectl` client and server versions (if available) and the `velero` client version. This information isn't submitted to Github until you click the `Submit new issue` button in the Github UI, so feel free to add, remove or update whatever information you like. - -Some general commands for troubleshooting that may be helpful: - -* `velero backup describe ` - describe the details of a backup -* `velero backup logs ` - fetch the logs for this specific backup. Useful for viewing failures and warnings, including resources that could not be backed up. -* `velero restore describe ` - describe the details of a restore -* `velero restore logs ` - fetch the logs for this specific restore. Useful for viewing failures and warnings, including resources that could not be restored. -* `kubectl logs deployment/velero -n velero` - fetch the logs of the Velero server pod. This provides the output of the Velero server processes. - -### Getting velero debug logs - -You can increase the verbosity of the Velero server by editing your Velero deployment to look like this: - - -``` -kubectl edit deployment/velero -n velero -... - containers: - - name: velero - image: velero/velero:latest - command: - - /velero - args: - - server - - --log-level # Add this line - - debug # Add this line -... -``` - -## Known issue with restoring LoadBalancer Service - -Because of how Kubernetes handles Service objects of `type=LoadBalancer`, when you restore these objects you might encounter an issue with changed values for Service UIDs. Kubernetes automatically generates the name of the cloud resource based on the Service UID, which is different when restored, resulting in a different name for the cloud load balancer. If the DNS CNAME for your application points to the DNS name of your cloud load balancer, you'll need to update the CNAME pointer when you perform a Velero restore. - -Alternatively, you might be able to use the Service's `spec.loadBalancerIP` field to keep connections valid, if your cloud provider supports this value. See [the Kubernetes documentation about Services of Type LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). - -## Miscellaneous issues - -### Velero reports `custom resource not found` errors when starting up. - -Velero's server will not start if the required Custom Resource Definitions are not found in Kubernetes. Run `velero install` again to install any missing custom resource definitions. - -### `velero backup logs` returns a `SignatureDoesNotMatch` error - -Downloading artifacts from object storage utilizes temporary, signed URLs. In the case of S3-compatible -providers, such as Ceph, there may be differences between their implementation and the official S3 -API that cause errors. - -Here are some things to verify if you receive `SignatureDoesNotMatch` errors: - - * Make sure your S3-compatible layer is using [signature version 4][5] (such as Ceph RADOS v12.2.7) - * For Ceph, try using a native Ceph account for credentials instead of external providers such as OpenStack Keystone - -## Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress - -Velero cannot currently resume backups that were interrupted. Backups stuck in the `InProgress` phase can be deleted with `kubectl delete backup -n `. -Backups in the `InProgress` phase have not uploaded any files to object storage. - -## Velero is not publishing prometheus metrics - -Steps to troubleshoot: - -- Confirm that your velero deployment has metrics publishing enabled. The [latest Velero helm charts][6] have been setup with [metrics enabled by default][7]. -- Confirm that the Velero server pod exposes the port on which the metrics server listens on. By default, this value is 8085. - -```yaml - ports: - - containerPort: 8085 - name: metrics - protocol: TCP -``` - -- Confirm that the metric server is listening for and responding to connections on this port. This can be done using [port-forwarding][9] as shown below - -```bash -$ kubectl -n port-forward 8085:8085 -Forwarding from 127.0.0.1:8085 -> 8085 -Forwarding from [::1]:8085 -> 8085 -. -. -. -``` - -Now, visiting http://localhost:8085/metrics on a browser should show the metrics that are being scraped from Velero. - -- Confirm that the Velero server pod has the nessary [annotations][8] for prometheus to scrape metrics. -- Confirm, from the Prometheus UI, that the Velero pod is one of the targets being scraped from Prometheus. - -[1]: debugging-restores.md -[2]: debugging-install.md -[4]: https://github.com/vmware-tanzu/velero/issues -[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html -[6]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero -[7]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L44 -[8]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L49-L52 -[9]: https://kubectl.docs.kubernetes.io/pages/container_debugging/port_forward_to_pods.html -[25]: https://kubernetes.slack.com/messages/velero diff --git a/site/docs/v1.3.2/uninstalling.md b/site/docs/v1.3.2/uninstalling.md deleted file mode 100644 index 727bc1aa0..000000000 --- a/site/docs/v1.3.2/uninstalling.md +++ /dev/null @@ -1,8 +0,0 @@ -# Uninstalling Velero - -If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: - -```bash -kubectl delete namespace/velero clusterrolebinding/velero -kubectl delete crds -l component=velero -``` diff --git a/site/docs/v1.3.2/vendoring-dependencies.md b/site/docs/v1.3.2/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.3.2/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.3.2/zenhub.md b/site/docs/v1.3.2/zenhub.md deleted file mode 100644 index 45298b3a2..000000000 --- a/site/docs/v1.3.2/zenhub.md +++ /dev/null @@ -1,15 +0,0 @@ -# ZenHub - -As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. -GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. - -While GitHub issues, milestones, and labels generally work pretty well, the Velero team has found that product planning requires some additional tooling that GitHub projects do not offer. - -In our effort to minimize tooling while enabling product management insights, we have decided to use [ZenHub Open-Source](https://www.zenhub.com/blog/open-source/) to overlay product and project tracking on top of GitHub. -ZenHub is a GitHub application that provides Kanban visualization, Epic tracking, fine-grained prioritization, and more. It's primary backing storage system is existing GitHub issues along with additional metadata stored in ZenHub's database. - -If you are a Velero user or Velero Developer, you do not _need_ to use ZenHub for your regular workflow (e.g to see open bug reports or feature requests, work on pull requests). However, if you'd like to be able to visualize the high-level project goals and roadmap, you will need to use the free version of ZenHub. - -## Using ZenHub - -ZenHub can be integrated within the GitHub interface using their [Chrome or FireFox extensions](https://www.zenhub.com/extension). In addition, you can use their dedicated [web application](https://app.zenhub.com/workspace/o/vmware-tanzu/velero/boards?filterLogic=all&repos=99143276). diff --git a/site/docs/v1.4/api-types/README.md b/site/docs/v1.4/api-types/README.md deleted file mode 100644 index 2ba83cc5e..000000000 --- a/site/docs/v1.4/api-types/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Table of Contents - -## API types - -Here we list the API types that have some functionality that you can only configure via json/yaml vs the `velero` cli -(hooks) - -* [Backup][1] -* [Restore][2] -* [Schedule][3] -* [BackupStorageLocation][4] -* [VolumeSnapshotLocation][5] - -[1]: backup.md -[2]: restore.md -[3]: schedule.md -[4]: backupstoragelocation.md -[5]: volumesnapshotlocation.md diff --git a/site/docs/v1.4/api-types/backup.md b/site/docs/v1.4/api-types/backup.md deleted file mode 100644 index 70120a921..000000000 --- a/site/docs/v1.4/api-types/backup.md +++ /dev/null @@ -1,143 +0,0 @@ -# Backup API Type - -## Use - -The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the -Velero Server immediately starts the backup process. - -## API GroupVersion - -Backup belongs to the API group version `velero.io/v1`. - -## Definition - -Here is a sample `Backup` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: velero.io/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Backup -# Standard Kubernetes metadata. Required. -metadata: - # Backup name. May be any valid Kubernetes object name. Required. - name: a - # Backup namespace. Must be the namespace of the Velero server. Required. - namespace: velero -# Parameters about the backup. Required. -spec: - # Array of namespaces to include in the backup. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the backup. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the backup. For example, if a - # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the backup. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and - # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as - # a persistent volume provider is configured for Velero. - snapshotVolumes: null - # Where to store the tarball and logs. - storageLocation: aws-primary - # The list of locations in which to store volume snapshots created for this backup. - volumeSnapshotLocations: - - aws-primary - - gcp-primary - # The amount of time before this backup is eligible for garbage collection. If not specified, - # a default value of 30 days will be used. The default can be configured on the velero server - # by passing the flag --default-backup-ttl. - ttl: 24h0m0s - # Actions to perform at different times during a backup. The only hook currently supported is - # executing a command in a container in a pod using the pod exec API. Optional. - hooks: - # Array of hooks that are applicable to specific resources. Optional. - resources: - - - # Name of the hook. Will be displayed in backup log. - name: my-hook - # Array of namespaces to which this hook applies. If unspecified, the hook applies to all - # namespaces. Optional. - includedNamespaces: - - '*' - # Array of namespaces to which this hook does not apply. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to which this hook applies. The only resource supported at this time is - # pods. - includedResources: - - pods - # Array of resources to which this hook does not apply. Optional. - excludedResources: [] - # This hook only applies to objects matching this label selector. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - pre: - - - # The type of hook. This must be "exec". - exec: - # The name of the container where the command will be executed. If unspecified, the - # first container in the pod will be used. Optional. - container: my-container - # The command to execute, specified as an array. Required. - command: - - /bin/uname - - -a - # How to handle an error executing the command. Valid values are Fail and Continue. - # Defaults to Fail. Optional. - onError: Fail - # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. - timeout: 10s - # An array of hooks to run after all custom actions and additional items have been - # processed. Currently only "exec" hooks are supported. - post: - # Same content as pre above. -# Status about the Backup. Users should not set any data here. -status: - # The version of this Backup. The only version currently supported is 1. - version: 1 - # The date and time when the Backup is eligible for garbage collection. - expiration: null - # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. - phase: "" - # An array of any validation errors encountered. - validationErrors: null - # Date/time when the backup started being processed. - startTimestamp: 2019-04-29T15:58:43Z - # Date/time when the backup finished being processed. - completionTimestamp: 2019-04-29T15:58:56Z - # Number of volume snapshots that Velero tried to create for this backup. - volumeSnapshotsAttempted: 2 - # Number of volume snapshots that Velero successfully created for this backup. - volumeSnapshotsCompleted: 1 - # Number of warnings that were logged by the backup. - warnings: 2 - # Number of errors that were logged by the backup. - errors: 0 - -``` diff --git a/site/docs/v1.4/api-types/restore.md b/site/docs/v1.4/api-types/restore.md deleted file mode 100644 index 2044d4725..000000000 --- a/site/docs/v1.4/api-types/restore.md +++ /dev/null @@ -1,89 +0,0 @@ -# Restore API Type - -## Use - -The `Restore` API type is used as a request for the Velero server to perform a Restore. Once created, the -Velero Server immediately starts the Restore process. - -## API GroupVersion - -Restore belongs to the API group version `velero.io/v1`. - -## Definition - -Here is a sample `Restore` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: velero.io/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Restore -# Standard Kubernetes metadata. Required. -metadata: - # Restore name. May be any valid Kubernetes object name. Required. - name: a-very-special-backup-0000111122223333 - # Restore namespace. Must be the namespace of the Velero server. Required. - namespace: velero -# Parameters about the restore. Required. -spec: - # BackupName is the unique name of the Velero backup to restore from. - backupName: a-very-special-backup - # Array of namespaces to include in the restore. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the restore. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the restore. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the restore. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the restore. For example, if a - # PersistentVolumeClaim is included in the restore, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the restore. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # 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: - namespace-backup-from: namespace-to-restore-to - # RestorePVs specifies whether to restore all included PVs - # from snapshot (via the cloudprovider). - restorePVs: true - # ScheduleName is the unique name of the Velero schedule - # to restore from. If specified, and BackupName is empty, Velero will - # restore from the most recent successful backup created from this schedule. - scheduleName: my-scheduled-backup-name -# RestoreStatus captures the current status of a Velero restore. Users should not set any data here. -status: - # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. - phase: "" - # An array of any validation errors encountered. - validationErrors: null - # Number of warnings that were logged by the restore. - warnings: 2 - # Errors is a count of all error messages that were generated - # during execution of the restore. The actual errors are stored in object - # storage. - errors: 0 - # FailureReason is an error that caused the entire restore - # to fail. - failureReason: - -``` diff --git a/site/docs/v1.4/api-types/schedule.md b/site/docs/v1.4/api-types/schedule.md deleted file mode 100644 index ec7e471a6..000000000 --- a/site/docs/v1.4/api-types/schedule.md +++ /dev/null @@ -1,132 +0,0 @@ -# Schedule API Type - -## Use - -The `Schedule` API type is used as a repeatable request for the Velero server to perform a backup for a given cron notation. Once created, the -Velero Server will start the backup process. It will then wait for the next valid point of the given cron expression and execute the backup -process on a repeating basis. - -## API GroupVersion - -Schedule belongs to the API group version `velero.io/v1`. - -## Definition - -Here is a sample `Schedule` object with each of the fields documented: - -```yaml -# Standard Kubernetes API Version declaration. Required. -apiVersion: velero.io/v1 -# Standard Kubernetes Kind declaration. Required. -kind: Schedule -# Standard Kubernetes metadata. Required. -metadata: - # Schedule name. May be any valid Kubernetes object name. Required. - name: a - # Schedule namespace. Must be the namespace of the Velero server. Required. - namespace: velero -# Parameters about the scheduled backup. Required. -spec: - # Schedule is a Cron expression defining when to run the Backup - schedule: 0 7 * * * - # Template is the spec that should be used for each backup triggered by this schedule. - template: - # Array of namespaces to include in the scheduled backup. If unspecified, all namespaces are included. - # Optional. - includedNamespaces: - - '*' - # Array of namespaces to exclude from the scheduled backup. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to include in the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. If unspecified, all resources are included. Optional. - includedResources: - - '*' - # Array of resources to exclude from the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods') - # or fully-qualified. Optional. - excludedResources: - - storageclasses.storage.k8s.io - # Whether or not to include cluster-scoped resources. Valid values are true, false, and - # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded - # resources and the label selector). If false, no cluster-scoped resources are included. If unset, - # all cluster-scoped resources are included if and only if all namespaces are included and there are - # no excluded namespaces. Otherwise, if there is at least one namespace specified in either - # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed - # up are those associated with namespace-scoped resources included in the scheduled backup. For example, if a - # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is - # cluster-scoped) would also be backed up. - includeClusterResources: null - # Individual objects must match this label selector to be included in the scheduled backup. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and - # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as - # a persistent volume provider is configured for Velero. - snapshotVolumes: null - # Where to store the tarball and logs. - storageLocation: aws-primary - # The list of locations in which to store volume snapshots created for backups under this schedule. - volumeSnapshotLocations: - - aws-primary - - gcp-primary - # The amount of time before backups created on this schedule are eligible for garbage collection. If not specified, - # a default value of 30 days will be used. The default can be configured on the velero server - # by passing the flag --default-backup-ttl. - ttl: 24h0m0s - # Actions to perform at different times during a backup. The only hook currently supported is - # executing a command in a container in a pod using the pod exec API. Optional. - hooks: - # Array of hooks that are applicable to specific resources. Optional. - resources: - - - # Name of the hook. Will be displayed in backup log. - name: my-hook - # Array of namespaces to which this hook applies. If unspecified, the hook applies to all - # namespaces. Optional. - includedNamespaces: - - '*' - # Array of namespaces to which this hook does not apply. Optional. - excludedNamespaces: - - some-namespace - # Array of resources to which this hook applies. The only resource supported at this time is - # pods. - includedResources: - - pods - # Array of resources to which this hook does not apply. Optional. - excludedResources: [] - # This hook only applies to objects matching this label selector. Optional. - labelSelector: - matchLabels: - app: velero - component: server - # An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported. - pre: - - - # The type of hook. This must be "exec". - exec: - # The name of the container where the command will be executed. If unspecified, the - # first container in the pod will be used. Optional. - container: my-container - # The command to execute, specified as an array. Required. - command: - - /bin/uname - - -a - # How to handle an error executing the command. Valid values are Fail and Continue. - # Defaults to Fail. Optional. - onError: Fail - # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. - timeout: 10s - # An array of hooks to run after all custom actions and additional items have been - # processed. Currently only "exec" hooks are supported. - post: - # Same content as pre above. -status: - # The current phase of the latest scheduled backup. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. - phase: "" - # Date/time of the last backup for a given schedule - lastBackup: - # An array of any validation errors encountered. - validationErrors: -``` diff --git a/site/docs/v1.4/api-types/volumesnapshotlocation.md b/site/docs/v1.4/api-types/volumesnapshotlocation.md deleted file mode 100644 index 8f3588dcb..000000000 --- a/site/docs/v1.4/api-types/volumesnapshotlocation.md +++ /dev/null @@ -1,38 +0,0 @@ -# Velero Volume Snapshot Location - -## Volume Snapshot Location - -A volume snapshot location is the location in which to store the volume snapshots created for a backup. - -Velero can be configured to take snapshots of volumes from multiple providers. Velero also allows you to configure multiple possible `VolumeSnapshotLocation` per provider, although you can only select one location per provider at backup time. - -Each VolumeSnapshotLocation describes a provider + location. These are represented in the cluster via the `VolumeSnapshotLocation` CRD. Velero must have at least one `VolumeSnapshotLocation` per cloud provider. - -A sample YAML `VolumeSnapshotLocation` looks like the following: - -```yaml -apiVersion: velero.io/v1 -kind: VolumeSnapshotLocation -metadata: - name: aws-default - namespace: velero -spec: - provider: aws - config: - region: us-west-2 - profile: "default" -``` - -### Parameter Reference - -The configurable parameters are as follows: - -#### Main config parameters - -| Key | Type | Default | Meaning | -| --- | --- | --- | --- | -| `provider` | String | Required Field | The name for whichever storage provider will be used to create/store the volume snapshots. See [your volume snapshot provider's plugin documentation][0] for the appropriate value to use. | -| `config` | map[string]string | None (Optional) | Provider-specific configuration keys/values to be passed to the volume snapshotter plugin. See [your volume snapshot provider's plugin documentation][0] for details. | - - -[0]: ../supported-providers.md diff --git a/site/docs/v1.4/backup-reference.md b/site/docs/v1.4/backup-reference.md deleted file mode 100644 index 797230d67..000000000 --- a/site/docs/v1.4/backup-reference.md +++ /dev/null @@ -1,9 +0,0 @@ -# Backup Reference - -## Exclude Specific Items from Backup - -It is possible to exclude individual items from being backed up, even if they match the resource/namespace/label selectors defined in the backup spec. To do this, label the item as follows: - -```bash -kubectl label -n / velero.io/exclude-from-backup=true -``` diff --git a/site/docs/v1.4/build-from-source.md b/site/docs/v1.4/build-from-source.md deleted file mode 100644 index 0536d8efd..000000000 --- a/site/docs/v1.4/build-from-source.md +++ /dev/null @@ -1,158 +0,0 @@ -# Build from source - -## Prerequisites - -* Access to a Kubernetes cluster, version 1.7 or later. -* A DNS server on the cluster -* `kubectl` installed -* [Go][5] installed (minimum version 1.8) - -## Get the source - -### Option 1) Get latest (recommended) - -```bash -mkdir $HOME/go -export GOPATH=$HOME/go -go get github.com/vmware-tanzu/velero -``` - -Where `go` is your [import path][4] for Go. - -For Go development, it is recommended to add the Go import path (`$HOME/go` in this example) to your path. - -### Option 2) Release archive - -Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/vmware-tanzu/velero`. - -Note that the Makefile targets assume building from a git repository. When building from an archive, you will be limited to the `go build` commands described below. - -## Build - -There are a number of different ways to build `velero` depending on your needs. This section outlines the main possibilities. - -When building by using `make`, it will place the binaries under `_output/bin/$GOOS/$GOARCH`. For example, you will find the binary for darwin here: `_output/bin/darwin/amd64/velero`, and the binary for linux here: `_output/bin/linux/amd64/velero`. `make` will also splice version and git commit information in so that `velero version` displays proper output. - -Note: `velero install` will also use the version information to determine which tagged image to deploy. If you would like to overwrite what image gets deployed, use the `image` flag (see below for instructions on how to build images). - -### Build the binary - -To build the `velero` binary on your local machine, compiled for your OS and architecture, run one of these two commands: - -```bash -go build ./cmd/velero -``` - -```bash -make local -``` - -### Cross compiling - -To build the velero binary targeting linux/amd64 within a build container on your local machine, run: - -```bash -make build -``` - -For any specific platform, run `make build--`. - -For example, to build for the Mac, run `make build-darwin-amd64`. - -Velero's `Makefile` has a convenience target, `all-build`, that builds the following platforms: - -* linux-amd64 -* linux-arm -* linux-arm64 -* linux-ppc64le -* darwin-amd64 -* windows-amd64 - -## Making images and updating Velero - -If after installing Velero you would like to change the image used by its deployment to one that contains your code changes, you may do so by updating the image: - -```bash -kubectl -n velero set image deploy/velero velero=myimagerepo/velero:$VERSION -``` - -To build a Velero container image, first set the `$REGISTRY` environment variable. For example, if you want to build the `gcr.io/my-registry/velero-amd64:main` image, set `$REGISTRY` to `gcr.io/my-registry`. If this variable is not set, the default is `velero`. - -Optionally, set the `$VERSION` environment variable to change the image tag. Then, run: - -```bash -make container -``` - -For any specific platform, run `ARCH=- make container` - -For example, to build an image for the Power (ppc64le), run: - -```bash -ARCH=linux-ppc64le make container -``` -_Note: By default, ARCH is set to linux-amd64_ - -To push your image to the registry. For example, if you want to push the `gcr.io/my-registry/velero-amd64:main` image, run: - -```bash -make push -``` - -For any specific platform, run `ARCH=- make push` - -For example, to push image for the Power (ppc64le), run: - -```bash -ARCH=linux-ppc64le make push -``` -_Note: By default, ARCH is set to linux-amd64_ - -To create and push your manifest to the registry. For example, if you want to create and push the `gcr.io/my-registry/velero:main` manifest, run: - -```bash -make manifest -``` - -For any specific platform, run `MANIFEST_PLATFORMS= make manifest` - -For example, to create and push manifest only for amd64, run: - -```bash -MANIFEST_PLATFORMS=amd64 make manifest -``` -_Note: By default, MANIFEST_PLATFORMS is set to amd64, ppc64le_ - -To run the entire workflow, run: - -`REGISTRY=<$REGISTRY> VERSION=<$VERSION> ARCH=- MANIFEST_PLATFORMS= make container push manifest` - -For example, to run the workflow only for amd64 - -```bash -REGISTRY=myrepo VERSION=foo MANIFEST_PLATFORMS=amd64 make container push manifest -``` - -_Note: By default, ARCH is set to linux-amd64_ - -For example, to run the workflow only for ppc64le - -```bash -REGISTRY=myrepo VERSION=foo ARCH=linux-ppc64le MANIFEST_PLATFORMS=ppc64le make container push manifest -``` - -For example, to run the workflow for all supported platforms - -```bash -REGISTRY=myrepo VERSION=foo make all-containers all-push all-manifests -``` - -Note: if you want to update the image but not change its name, you will have to trigger Kubernetes to pick up the new image. One way of doing so is by deleting the Velero deployment pod: - -```bash -kubectl -n velero delete pods -l deploy=velero -``` - -[4]: https://blog.golang.org/organizing-go-code -[5]: https://golang.org/doc/install -[22]: https://github.com/vmware-tanzu/velero/releases diff --git a/site/docs/v1.4/contributions/ibm-config.md b/site/docs/v1.4/contributions/ibm-config.md deleted file mode 100644 index ea90167a3..000000000 --- a/site/docs/v1.4/contributions/ibm-config.md +++ /dev/null @@ -1,96 +0,0 @@ -# Use IBM Cloud Object Storage as Velero's storage destination. -You can deploy Velero on IBM [Public][5] or [Private][4] clouds, or even on any other Kubernetes cluster, but anyway you can use IBM Cloud Object Store as a destination for Velero's backups. - -To set up IBM Cloud Object Storage (COS) as Velero's destination, you: - -* Download an official release of Velero -* Create your COS instance -* Create an S3 bucket -* Define a service that can store data in the bucket -* Configure and start the Velero server - -## Download Velero - -1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform. - - _We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of -Velero. The tarballs for each release contain the `velero` command-line client. The code in the main branch -of the Velero repository is under active development and is not guaranteed to be stable!_ - -1. Extract the tarball: - - ```bash - tar -xvf .tar.gz -C /dir/to/extract/to - ``` - - We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps. - -1. Move the `velero` binary from the Velero directory to somewhere in your PATH. - -## Create COS instance -If you don’t have a COS instance, you can create a new one, according to the detailed instructions in [Creating a new resource instance][1]. - -## Create an S3 bucket -Velero requires an object storage bucket to store backups in. See instructions in [Create some buckets to store your data][2]. - -## Define a service that can store data in the bucket. -The process of creating service credentials is described in [Service credentials][3]. -Several comments: - -1. The Velero service will write its backup into the bucket, so it requires the “Writer” access role. - -2. Velero uses an AWS S3 compatible API. Which means it authenticates using a signature created from a pair of access and secret keys — a set of HMAC credentials. You can create these HMAC credentials by specifying `{“HMAC”:true}` as an optional inline parameter. See step 3 in the [Service credentials][3] guide. - -3. After successfully creating a Service credential, you can view the JSON definition of the credential. Under the `cos_hmac_keys` entry there are `access_key_id` and `secret_access_key`. We will use them in the next step. - -4. Create a Velero-specific credentials file (`credentials-velero`) in your local directory: - - ``` - [default] - aws_access_key_id= - aws_secret_access_key= - ``` - - where the access key id and secret are the values that we got above. - -## Install and start Velero - -Install Velero, including all prerequisites, into the cluster and start the deployment. This will create a namespace called `velero`, and place a deployment named `velero` in it. - -```bash -velero install \ - --provider aws \ - --bucket \ - --secret-file ./credentials-velero \ - --use-volume-snapshots=false \ - --backup-location-config region=,s3ForcePathStyle="true",s3Url= -``` - -Velero does not currently have a volume snapshot plugin for IBM Cloud, so creating volume snapshots is disabled. - -Additionally, you can specify `--use-restic` to enable restic support, and `--wait` to wait for the deployment to be ready. - -(Optional) Specify [CPU and memory resource requests and limits][15] for the Velero/restic pods. - -Once the installation is complete, remove the default `VolumeSnapshotLocation` that was created by `velero install`, since it's specific to AWS and won't work for IBM Cloud: - -```bash -kubectl -n velero delete volumesnapshotlocation.velero.io default -``` - -For more complex installation needs, use either the Helm chart, or add `--dry-run -o yaml` options for generating the YAML representation for the installation. - -## Installing the nginx example (optional) - -If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`: - -Uncomment `storageClassName: ` and replace with your `StorageClass` name. - -[0]: namespace.md -[1]: https://console.bluemix.net/docs/services/cloud-object-storage/basics/order-storage.html#creating-a-new-resource-instance -[2]: https://console.bluemix.net/docs/services/cloud-object-storage/getting-started.html#create-buckets -[3]: https://console.bluemix.net/docs/services/cloud-object-storage/iam/service-credentials.html#service-credentials -[4]: https://www.ibm.com/support/knowledgecenter/SSBS6K_2.1.0/kc_welcome_containers.html -[5]: https://console.bluemix.net/docs/containers/container_index.html#container_index -[14]: http://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html -[15]: customize-installation.md#customize-resource-requests-and-limits diff --git a/site/docs/v1.4/debugging-install.md b/site/docs/v1.4/debugging-install.md deleted file mode 100644 index 4abc5a3e1..000000000 --- a/site/docs/v1.4/debugging-install.md +++ /dev/null @@ -1,71 +0,0 @@ -# Debugging Installation Issues - -## General - -### `invalid configuration: no configuration has been provided` -This typically means that no `kubeconfig` file can be found for the Velero client to use. Velero looks for a kubeconfig in the -following locations: -* the path specified by the `--kubeconfig` flag, if any -* the path specified by the `$KUBECONFIG` environment variable, if any -* `~/.kube/config` - -### Backups or restores stuck in `New` phase -This means that the Velero controllers are not processing the backups/restores, which usually happens because the Velero server is not running. Check the pod description and logs for errors: -``` -kubectl -n velero describe pods -kubectl -n velero logs deployment/velero -``` - - -## AWS - -### `NoCredentialProviders: no valid providers in chain` - -#### Using credentials -This means that the secret containing the AWS IAM user credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `credentials-velero` file is formatted properly and has the correct values: - - ``` - [default] - aws_access_key_id= - aws_secret_access_key= - ``` - -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -#### Using kube2iam -This means that Velero can't read the content of the S3 bucket. Ensure the following: - -* There is a Trust Policy document allowing the role used by kube2iam to assume Velero's role, as stated in the AWS config documentation. -* The new Velero role has all the permissions listed in the documentation regarding S3. - - -## Azure - -### `Failed to refresh the Token` or `adal: Refresh request failed` -This means that the secrets containing the Azure service principal credentials for Velero has not been created/mounted -properly into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has all of the expected keys and each one has the correct value (see [setup instructions][0]) -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - - -## GCE/GKE - -### `open credentials/cloud: no such file or directory` -This means that the secret containing the GCE service account credentials for Velero has not been created/mounted properly -into the Velero server pod. Ensure the following: - -* The `cloud-credentials` secret exists in the Velero server's namespace -* The `cloud-credentials` secret has a single key, `cloud`, whose value is the contents of the `credentials-velero` file -* The `cloud-credentials` secret is defined as a volume for the Velero deployment -* The `cloud-credentials` secret is being mounted into the Velero server pod at `/credentials` - -[0]: azure-config.md#create-service-principal diff --git a/site/docs/v1.4/debugging-restores.md b/site/docs/v1.4/debugging-restores.md deleted file mode 100644 index d50d4aacb..000000000 --- a/site/docs/v1.4/debugging-restores.md +++ /dev/null @@ -1,106 +0,0 @@ -# Debugging Restores - -* [Example][0] -* [Structure][1] - -## Example - -When Velero finishes a Restore, its status changes to "Completed" regardless of whether or not there are issues during the process. The number of warnings and errors are indicated in the output columns from `velero restore get`: - -``` -NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR -backup-test-20170726180512 backup-test Completed 155 76 2017-07-26 11:41:14 -0400 EDT -backup-test-20170726180513 backup-test Completed 121 14 2017-07-26 11:48:24 -0400 EDT -backup-test-2-20170726180514 backup-test-2 Completed 0 0 2017-07-26 13:31:21 -0400 EDT -backup-test-2-20170726180515 backup-test-2 Completed 0 1 2017-07-26 13:32:59 -0400 EDT -``` - -To delve into the warnings and errors into more detail, you can use `velero restore describe`: - -```bash -velero restore describe backup-test-20170726180512 -``` - -The output looks like this: - -``` -Name: backup-test-20170726180512 -Namespace: velero -Labels: -Annotations: - -Backup: backup-test - -Namespaces: - Included: * - Excluded: - -Resources: - Included: serviceaccounts - Excluded: nodes, events, events.events.k8s.io - Cluster-scoped: auto - -Namespace mappings: - -Label selector: - -Restore PVs: auto - -Phase: Completed - -Validation errors: - -Warnings: - Velero: - Cluster: - Namespaces: - velero: serviceaccounts "velero" already exists - serviceaccounts "default" already exists - kube-public: serviceaccounts "default" already exists - kube-system: serviceaccounts "attachdetach-controller" already exists - serviceaccounts "certificate-controller" already exists - serviceaccounts "cronjob-controller" already exists - serviceaccounts "daemon-set-controller" already exists - serviceaccounts "default" already exists - serviceaccounts "deployment-controller" already exists - serviceaccounts "disruption-controller" already exists - serviceaccounts "endpoint-controller" already exists - serviceaccounts "generic-garbage-collector" already exists - serviceaccounts "horizontal-pod-autoscaler" already exists - serviceaccounts "job-controller" already exists - serviceaccounts "kube-dns" already exists - serviceaccounts "namespace-controller" already exists - serviceaccounts "node-controller" already exists - serviceaccounts "persistent-volume-binder" already exists - serviceaccounts "pod-garbage-collector" already exists - serviceaccounts "replicaset-controller" already exists - serviceaccounts "replication-controller" already exists - serviceaccounts "resourcequota-controller" already exists - serviceaccounts "service-account-controller" already exists - serviceaccounts "service-controller" already exists - serviceaccounts "statefulset-controller" already exists - serviceaccounts "ttl-controller" already exists - default: serviceaccounts "default" already exists - -Errors: - Velero: - Cluster: - Namespaces: -``` - -## Structure - -Errors appear for incomplete or partial restores. Warnings appear for non-blocking issues (e.g. the -restore looks "normal" and all resources referenced in the backup exist in some form, although some -of them may have been pre-existing). - -Both errors and warnings are structured in the same way: - -* `Velero`: A list of system-related issues encountered by the Velero server (e.g. couldn't read directory). - -* `Cluster`: A list of issues related to the restore of cluster-scoped resources. - -* `Namespaces`: A map of namespaces to the list of issues related to the restore of their respective resources. - -[0]: #example -[1]: #structure diff --git a/site/docs/v1.4/development.md b/site/docs/v1.4/development.md deleted file mode 100644 index cf3b3c4fc..000000000 --- a/site/docs/v1.4/development.md +++ /dev/null @@ -1,30 +0,0 @@ -# Development - -## Update generated files - -Run `make update` to regenerate files if you make the following changes: - -* Add/edit/remove command line flags and/or their help text -* Add/edit/remove commands or subcommands -* Add new API types -* Add/edit/remove plugin protobuf message or service definitions - -The following files are automatically generated from the source code: - -* The clientset -* Listers -* Shared informers -* Documentation -* Protobuf/gRPC types - -You can run `make verify` to ensure that all generated files (clientset, listers, shared informers, docs) are up to date. - -## Test - -To run unit tests, use `make test`. - -## Vendor dependencies - -If you need to add or update the vendored dependencies, see [Vendoring dependencies][11]. - -[11]: vendoring-dependencies.md diff --git a/site/docs/v1.4/examples.md b/site/docs/v1.4/examples.md deleted file mode 100644 index 40b284ec3..000000000 --- a/site/docs/v1.4/examples.md +++ /dev/null @@ -1,63 +0,0 @@ -## Examples - -After you set up the Velero server, try these examples: - -### Basic example (without PersistentVolumes) - -1. Start the sample nginx app: - - ```bash - kubectl apply -f examples/nginx-app/base.yaml - ``` - -1. Create a backup: - - ```bash - velero backup create nginx-backup --include-namespaces nginx-example - ``` - -1. Simulate a disaster: - - ```bash - kubectl delete namespaces nginx-example - ``` - - Wait for the namespace to be deleted. - -1. Restore your lost resources: - - ```bash - velero restore create --from-backup nginx-backup - ``` - -### Snapshot example (with PersistentVolumes) - -> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks. - -1. Start the sample nginx app: - - ```bash - kubectl apply -f examples/nginx-app/with-pv.yaml - ``` - -1. Create a backup with PV snapshotting: - - ```bash - velero backup create nginx-backup --include-namespaces nginx-example - ``` - -1. Simulate a disaster: - - ```bash - kubectl delete namespaces nginx-example - ``` - - Because the default [reclaim policy][1] for dynamically-provisioned PVs is "Delete", these commands should trigger your cloud provider to delete the disk that backs the PV. Deletion is asynchronous, so this may take some time. **Before continuing to the next step, check your cloud provider to confirm that the disk no longer exists.** - -1. Restore your lost resources: - - ```bash - velero restore create --from-backup nginx-backup - ``` - -[1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming diff --git a/site/docs/v1.4/image-tagging.md b/site/docs/v1.4/image-tagging.md deleted file mode 100644 index b0080ef1c..000000000 --- a/site/docs/v1.4/image-tagging.md +++ /dev/null @@ -1,21 +0,0 @@ -# Image tagging policy - -This document describes Velero's image tagging policy. - -## Released versions - -`velero/velero:` - -Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/vmware-tanzu/velero` repository has a matching image, e.g. `velero/velero:v1.0.0`. - -### Latest - -`velero/velero:latest` - -The `latest` tag follows the most recently released version of Velero. - -## Development - -`velero/velero:main` - -The `main` tag follows the latest commit to land on the `main` branch. diff --git a/site/docs/v1.4/locations.md b/site/docs/v1.4/locations.md deleted file mode 100644 index ca28239a7..000000000 --- a/site/docs/v1.4/locations.md +++ /dev/null @@ -1,164 +0,0 @@ -# Backup Storage Locations and Volume Snapshot Locations - -## Overview - -Velero has two custom resources, `BackupStorageLocation` and `VolumeSnapshotLocation`, that are used to configure where Velero backups and their associated persistent volume snapshots are stored. - -A `BackupStorageLocation` is defined as a bucket, a prefix within that bucket under which all Velero data should be stored, and a set of additional provider-specific fields (e.g. AWS region, Azure storage account, etc.) The [API documentation][1] captures the configurable parameters for each in-tree provider. - -A `VolumeSnapshotLocation` is defined entirely by provider-specific fields (e.g. AWS region, Azure resource group, Portworx snapshot type, etc.) The [API documentation][2] captures the configurable parameters for each in-tree provider. - -The user can pre-configure one or more possible `BackupStorageLocations` and one or more `VolumeSnapshotLocations`, and can select *at backup creation time* the location in which the backup and associated snapshots should be stored. - -This configuration design enables a number of different use cases, including: - -- Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) -- Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region -- For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud - -## Limitations / Caveats - -- Velero only supports a single set of credentials *per provider*. It's not yet possible to use different credentials for different locations, if they're for the same provider. - -- Volume snapshots are still limited by where your provider allows you to create snapshots. For example, AWS and Azure do not allow you to create a volume snapshot in a different region than where the volume is. If you try to take a Velero backup using a volume snapshot location with a different region than where your cluster's volumes are, the backup will fail. - -- Each Velero backup has one `BackupStorageLocation`, and one `VolumeSnapshotLocation` per volume provider. It is not possible (yet) to send a single Velero backup to multiple backup storage locations simultaneously, or a single volume snapshot to multiple locations simultaneously. However, you can always set up multiple scheduled backups that differ only in the storage locations used if redundancy of backups across locations is important. - -- Cross-provider snapshots are not supported. If you have a cluster with more than one type of volume (e.g. EBS and Portworx), but you only have a `VolumeSnapshotLocation` configured for EBS, then Velero will **only** snapshot the EBS volumes. - -- Restic data is stored under a prefix/subdirectory of the main Velero bucket, and will go into the bucket corresponding to the `BackupStorageLocation` selected by the user at backup creation time. - -## Examples - -Let's look at some examples of how we can use this configuration mechanism to address some common use cases: - -#### Take snapshots of more than one kind of persistent volume in a single Velero backup (e.g. in a cluster with both EBS volumes and Portworx volumes) - -During server configuration: - -```shell -velero snapshot-location create ebs-us-east-1 \ - --provider aws \ - --config region=us-east-1 - -velero snapshot-location create portworx-cloud \ - --provider portworx \ - --config type=cloud -``` - -During backup creation: - -```shell -velero backup create full-cluster-backup \ - --volume-snapshot-locations ebs-us-east-1,portworx-cloud -``` - -Alternately, since in this example there's only one possible volume snapshot location configured for each of our two providers (`ebs-us-east-1` for `aws`, and `portworx-cloud` for `portworx`), Velero doesn't require them to be explicitly specified when creating the backup: - -```shell -velero backup create full-cluster-backup -``` - -#### Have some Velero backups go to a bucket in an eastern USA region, and others go to a bucket in a western USA region - -During server configuration: - -```shell -velero backup-location create default \ - --provider aws \ - --bucket velero-backups \ - --config region=us-east-1 - -velero backup-location create s3-alt-region \ - --provider aws \ - --bucket velero-backups-alt \ - --config region=us-west-1 -``` - -During backup creation: - -```shell -# The Velero server will automatically store backups in the backup storage location named "default" if -# one is not specified when creating the backup. You can alter which backup storage location is used -# by default by setting the --default-backup-storage-location flag on the `velero server` command (run -# by the Velero deployment) to the name of a different backup storage location. -velero backup create full-cluster-backup -``` - -Or: - -```shell -velero backup create full-cluster-alternate-location-backup \ - --storage-location s3-alt-region -``` - -#### For volume providers that support it (e.g. Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud - -During server configuration: - -```shell -velero snapshot-location create portworx-local \ - --provider portworx \ - --config type=local - -velero snapshot-location create portworx-cloud \ - --provider portworx \ - --config type=cloud -``` - -During backup creation: - -```shell -# Note that since in this example we have two possible volume snapshot locations for the Portworx -# provider, we need to explicitly specify which one to use when creating a backup. Alternately, -# you can set the --default-volume-snapshot-locations flag on the `velero server` command (run by -# the Velero deployment) to specify which location should be used for each provider by default, in -# which case you don't need to specify it when creating a backup. -velero backup create local-snapshot-backup \ - --volume-snapshot-locations portworx-local -``` - -Or: - -```shell -velero backup create cloud-snapshot-backup \ - --volume-snapshot-locations portworx-cloud -``` - -#### Use a single location - -If you don't have a use case for more than one location, it's still easy to use Velero. Let's assume you're running on AWS, in the `us-west-1` region: - -During server configuration: - -```shell -velero backup-location create default \ - --provider aws \ - --bucket velero-backups \ - --config region=us-west-1 - -velero snapshot-location create ebs-us-west-1 \ - --provider aws \ - --config region=us-west-1 -``` - -During backup creation: - -```shell -# Velero will automatically use your configured backup storage location and volume snapshot location. -# Nothing needs to be specified when creating a backup. -velero backup create full-cluster-backup -``` - -## Additional Use Cases - -1. If you're using Azure's AKS, you may want to store your volume snapshots outside of the "infrastructure" resource group that is automatically created when you create your AKS cluster. This is possible using a `VolumeSnapshotLocation`, by specifying a `resourceGroup` under the `config` section of the snapshot location. See the [Azure volume snapshot location documentation][3] for details. - -1. If you're using Azure, you may want to store your Velero backups across multiple storage accounts and/or resource groups/subscriptions. This is possible using a `BackupStorageLocation`, by specifying a `storageAccount`, `resourceGroup` and/or `subscriptionId`, respectively, under the `config` section of the backup location. See the [Azure backup storage location documentation][4] for details. - - - -[1]: api-types/backupstoragelocation.md -[2]: api-types/volumesnapshotlocation.md -[3]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md -[4]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md diff --git a/site/docs/v1.4/namespace.md b/site/docs/v1.4/namespace.md deleted file mode 100644 index 9a3d62808..000000000 --- a/site/docs/v1.4/namespace.md +++ /dev/null @@ -1,19 +0,0 @@ -# Run in a non-default namespace - -The Velero installation and backups by default are run in the `velero` namespace. However, it is possible to use a different namespace. - -### 1) Customize the namespace during install - -Use the `--namespace` flag, in conjunction with the other flags in the `velero install` command (as shown in the [the Velero install instructions][0]). This will inform Velero where to install. - -### 2) Customize the namespace for operational commands - -To have namespace consistency, specify the namespace for all Velero operational commands to be the same as the namespace used to install Velero: - -```bash -velero client config set namespace= -``` - -Alternatively, you may use the global `--namespace` flag with any operational command to tell Velero where to run. - -[0]: basic-install.md#install-the-cli diff --git a/site/docs/v1.4/overview-plugins.md b/site/docs/v1.4/overview-plugins.md deleted file mode 100644 index 74eb3b0fb..000000000 --- a/site/docs/v1.4/overview-plugins.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Velero plugin system - -Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. - -For server installation, Velero requires that at least one plugin is added (with the `--plugins` flag). The plugin will be either of the type object store or volume snapshotter, or a plugin that contains both. An exception to this is that when the user is not configuring a backup storage location or a snapshot storage location at the time of install, this flag is optional. - -Any plugin can be added after Velero has been installed by using the command `velero plugin add `. - -Example with a dockerhub image: `velero plugin add velero/velero-plugin-for-aws:v1.0.0`. - -In the same way, any plugin can be removed by using the command `velero plugin remove `. - -## Creating a new plugin - -Anyone can add integrations for any platform to provide additional backup and volume storage without modifying the Velero codebase. To write a plugin for a new backup or volume storage platform, take a look at our [example repo][1] and at our documentation for [Custom plugins][2]. - -## Adding a new plugin - -After you publish your plugin on your own repository, open a PR that adds a link to it under the appropriate list of [supported providers][3] page in our documentation. - -You can also add the [`velero-plugin` GitHub Topic][4] to your repo, and it will be shown under the aggregated list of repositories automatically. - -[1]: https://github.com/vmware-tanzu/velero-plugin-example/ -[2]: custom-plugins.md -[3]: supported-providers.md -[4]: https://github.com/topics/velero-plugin diff --git a/site/docs/v1.4/rbac.md b/site/docs/v1.4/rbac.md deleted file mode 100644 index d8686bf6e..000000000 --- a/site/docs/v1.4/rbac.md +++ /dev/null @@ -1,47 +0,0 @@ -# Run Velero more securely with restrictive RBAC settings - -By default Velero runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Velero can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Velero components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access. - -**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster. - -For more information about RBAC and access control generally in Kubernetes, see the Kubernetes documentation about [access control][1], [managing service accounts][2], and [RBAC authorization][3]. - -## Set up Roles and RoleBindings - -Here's a sample Role and RoleBinding pair. - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - namespace: YOUR_NAMESPACE_HERE - name: ROLE_NAME_HERE - labels: - component: velero -rules: - - apiGroups: - - velero.io - verbs: - - "*" - resources: - - "*" -``` - -```yaml -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: ROLEBINDING_NAME_HERE -subjects: - - kind: ServiceAccount - name: YOUR_SERVICEACCOUNT_HERE -roleRef: - kind: Role - name: ROLE_NAME_HERE - apiGroup: rbac.authorization.k8s.io -``` - -[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ -[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ -[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ -[4]: namespace.md diff --git a/site/docs/v1.4/run-locally.md b/site/docs/v1.4/run-locally.md deleted file mode 100644 index 913cbc122..000000000 --- a/site/docs/v1.4/run-locally.md +++ /dev/null @@ -1,49 +0,0 @@ -# Run Velero locally in development - -Running the Velero server locally can speed up iterative development. This eliminates the need to rebuild the Velero server -image and redeploy it to the cluster with each change. - -## Run Velero locally with a remote cluster - -Velero runs against the Kubernetes API server as the endpoint (as per the `kubeconfig` configuration), so both the Velero server and client use the same `client-go` to communicate with Kubernetes. This means the Velero server can be run locally just as functionally as if it was running in the remote cluster. - -### Prerequisites - -When running Velero, you will need to ensure that you set up all of the following: - -* Appropriate RBAC permissions in the cluster - * Read access for all data from the source cluster and namespaces - * Write access to the target cluster and namespaces -* Cloud provider credentials - * Read/write access to volumes - * Read/write access to object storage for backup data -* A [BackupStorageLocation][20] object definition for the Velero server -* (Optional) A [VolumeSnapshotLocation][21] object definition for the Velero server, to take PV snapshots - -### 1. Install Velero - -See documentation on how to install Velero in some specific providers: [Install overview][22] - -### 2. Scale deployment down to zero - -After you use the `velero install` command to install Velero into your cluster, you scale the Velero deployment down to 0 so it is not simultaneously being run on the remote cluster and potentially causing things to get out of sync: - -`kubectl scale --replicas=0 deployment velero -n velero` - -#### 3. Start the Velero server locally - -* To run the server locally, use the full path according to the binary you need. Example, if you are on a Mac, and using `AWS` as a provider, this is how to run the binary you built from source using the full path: `AWS_SHARED_CREDENTIALS_FILE= ./_output/bin/darwin/amd64/velero`. Alternatively, you may add the `velero` binary to your `PATH`. - -* Start the server: `velero server [CLI flags]`. The following CLI flags may be useful to customize, but see `velero server --help` for full details: - * `--log-level`: set the Velero server's log level (default `info`, use `debug` for the most logging) - * `--kubeconfig`: set the path to the kubeconfig file the Velero server uses to talk to the Kubernetes apiserver (default `$KUBECONFIG`) - * `--namespace`: the set namespace where the Velero server should look for backups, schedules, restores (default `velero`) - * `--plugin-dir`: set the directory where the Velero server looks for plugins (default `/plugins`) - * `--metrics-address`: set the bind address and port where Prometheus metrics are exposed (default `:8085`) - -[15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file -[16]: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable -[18]: https://eksctl.io/ -[20]: api-types/backupstoragelocation.md -[21]: api-types/volumesnapshotlocation.md -[22]: basic-install.md diff --git a/site/docs/v1.4/support-process.md b/site/docs/v1.4/support-process.md deleted file mode 100644 index c4bdf82a0..000000000 --- a/site/docs/v1.4/support-process.md +++ /dev/null @@ -1,41 +0,0 @@ -# Support Process - -## Weekly Rotation - -The Velero maintainers use a weekly rotation to manage community support. Each week, a different maintainer is the point person for responding to incoming support issues via Slack, GitHub, and the Google group. The point person is *not* expected to be on-call 24x7. Instead, they choose one or more hour(s) per day to be available/responding to incoming issues. They will communicate to the community what that time slot will be each week. - -## Start of Week - -We will update the public Slack channel's topic to indicate that you are the point person for the week, and what hours you'll be available. - -## During the Week - -### Where we will monitor -- `#velero` public Slack channel in Kubernetes org -- [all Velero-related repos][0] in GitHub (`velero`, `velero-plugin-for-[aws|gcp|microsoft-azure|csi]`, `helm-charts`) -- [Project Velero Google Group][1] - -### GitHub issue flow - -Generally speaking, new GitHub issues will fall into one of several categories. We use the following process for each: - -1. **Feature request** - - Label the issue with `Enhancement/User` or `Enhancement/Dev` - - Leave the issue in the `New Issues` swimlane for triage by product mgmt -1. **Bug** - - Label the issue with `Bug` - - Leave the issue in the `New Issues` swimlane for triage by product mgmt -1. **User question/problem** that does not clearly fall into one of the previous categories - - When you start investigating/responding, label the issue with `Investigating` - - Add comments as you go, so both the user and future support people have as much context as possible - - Use the `Needs Info` label to indicate an issue is waiting for information from the user. Remove/re-add the label as needed. - - If you resolve the issue with the user, close it out - - If the issue ends up being a feature request or a bug, update the title and follow the appropriate process for it - - If the reporter becomes unresponsive after multiple pings, close out the issue due to inactivity and comment that the user can always reach out again as needed - -## End of Week - -We ensure all GitHub issues worked on during the week on are labeled with `Investigating` and `Needs Info` (if appropriate), and have updated comments so the next person can pick them up. - -[0]: https://app.zenhub.com/workspaces/velero-5c59c15e39d47b774b5864e3/board?repos=99143276,112385197,213946861,190224441,214524700,214524630 -[1]: https://groups.google.com/forum/#!forum/projectvelero diff --git a/site/docs/v1.4/troubleshooting.md b/site/docs/v1.4/troubleshooting.md deleted file mode 100644 index 984d8f714..000000000 --- a/site/docs/v1.4/troubleshooting.md +++ /dev/null @@ -1,123 +0,0 @@ -# Troubleshooting - -These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server. - -- [Troubleshooting](#troubleshooting) - - [Debug installation/ setup issues](#debug-installation-setup-issues) - - [Debug restores](#debug-restores) - - [General troubleshooting information](#general-troubleshooting-information) - - [Getting velero debug logs](#getting-velero-debug-logs) - - [Known issue with restoring LoadBalancer Service](#known-issue-with-restoring-loadbalancer-service) - - [Miscellaneous issues](#miscellaneous-issues) - - [Velero reports `custom resource not found` errors when starting up.](#velero-reports-custom-resource-not-found-errors-when-starting-up) - - [`velero backup logs` returns a `SignatureDoesNotMatch` error](#velero-backup-logs-returns-a-signaturedoesnotmatch-error) - - [Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress](#velero-or-a-pod-it-was-backing-up-restarted-during-a-backup-and-the-backup-is-stuck-inprogress) - - [Velero is not publishing prometheus metrics](#velero-is-not-publishing-prometheus-metrics) - -## Debug installation/ setup issues - -- [Debug installation/setup issues][2] - -## Debug restores - -- [Debug restores][1] - -## General troubleshooting information - -You can use the `velero bug` command to open a [Github issue][4] by launching a browser window with some prepopulated values. Values included are OS, CPU architecture, `kubectl` client and server versions (if available) and the `velero` client version. This information isn't submitted to Github until you click the `Submit new issue` button in the Github UI, so feel free to add, remove or update whatever information you like. - -Some general commands for troubleshooting that may be helpful: - -* `velero backup describe ` - describe the details of a backup -* `velero backup logs ` - fetch the logs for this specific backup. Useful for viewing failures and warnings, including resources that could not be backed up. -* `velero restore describe ` - describe the details of a restore -* `velero restore logs ` - fetch the logs for this specific restore. Useful for viewing failures and warnings, including resources that could not be restored. -* `kubectl logs deployment/velero -n velero` - fetch the logs of the Velero server pod. This provides the output of the Velero server processes. - -### Getting velero debug logs - -You can increase the verbosity of the Velero server by editing your Velero deployment to look like this: - - -``` -kubectl edit deployment/velero -n velero -... - containers: - - name: velero - image: velero/velero:latest - command: - - /velero - args: - - server - - --log-level # Add this line - - debug # Add this line -... -``` - -## Known issue with restoring LoadBalancer Service - -Because of how Kubernetes handles Service objects of `type=LoadBalancer`, when you restore these objects you might encounter an issue with changed values for Service UIDs. Kubernetes automatically generates the name of the cloud resource based on the Service UID, which is different when restored, resulting in a different name for the cloud load balancer. If the DNS CNAME for your application points to the DNS name of your cloud load balancer, you'll need to update the CNAME pointer when you perform a Velero restore. - -Alternatively, you might be able to use the Service's `spec.loadBalancerIP` field to keep connections valid, if your cloud provider supports this value. See [the Kubernetes documentation about Services of Type LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). - -## Miscellaneous issues - -### Velero reports `custom resource not found` errors when starting up. - -Velero's server will not start if the required Custom Resource Definitions are not found in Kubernetes. Run `velero install` again to install any missing custom resource definitions. - -### `velero backup logs` returns a `SignatureDoesNotMatch` error - -Downloading artifacts from object storage utilizes temporary, signed URLs. In the case of S3-compatible -providers, such as Ceph, there may be differences between their implementation and the official S3 -API that cause errors. - -Here are some things to verify if you receive `SignatureDoesNotMatch` errors: - - * Make sure your S3-compatible layer is using [signature version 4][5] (such as Ceph RADOS v12.2.7) - * For Ceph, try using a native Ceph account for credentials instead of external providers such as OpenStack Keystone - -## Velero (or a pod it was backing up) restarted during a backup and the backup is stuck InProgress - -Velero cannot currently resume backups that were interrupted. Backups stuck in the `InProgress` phase can be deleted with `kubectl delete backup -n `. -Backups in the `InProgress` phase have not uploaded any files to object storage. - -## Velero is not publishing prometheus metrics - -Steps to troubleshoot: - -- Confirm that your velero deployment has metrics publishing enabled. The [latest Velero helm charts][6] have been setup with [metrics enabled by default][7]. -- Confirm that the Velero server pod exposes the port on which the metrics server listens on. By default, this value is 8085. - -```yaml - ports: - - containerPort: 8085 - name: metrics - protocol: TCP -``` - -- Confirm that the metric server is listening for and responding to connections on this port. This can be done using [port-forwarding][9] as shown below - -```bash -$ kubectl -n port-forward 8085:8085 -Forwarding from 127.0.0.1:8085 -> 8085 -Forwarding from [::1]:8085 -> 8085 -. -. -. -``` - -Now, visiting http://localhost:8085/metrics on a browser should show the metrics that are being scraped from Velero. - -- Confirm that the Velero server pod has the nessary [annotations][8] for prometheus to scrape metrics. -- Confirm, from the Prometheus UI, that the Velero pod is one of the targets being scraped from Prometheus. - -[1]: debugging-restores.md -[2]: debugging-install.md -[4]: https://github.com/vmware-tanzu/velero/issues -[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html -[6]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero -[7]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L44 -[8]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L49-L52 -[9]: https://kubectl.docs.kubernetes.io/pages/container_debugging/port_forward_to_pods.html -[25]: https://kubernetes.slack.com/messages/velero diff --git a/site/docs/v1.4/uninstalling.md b/site/docs/v1.4/uninstalling.md deleted file mode 100644 index 727bc1aa0..000000000 --- a/site/docs/v1.4/uninstalling.md +++ /dev/null @@ -1,8 +0,0 @@ -# Uninstalling Velero - -If you would like to completely uninstall Velero from your cluster, the following commands will remove all resources created by `velero install`: - -```bash -kubectl delete namespace/velero clusterrolebinding/velero -kubectl delete crds -l component=velero -``` diff --git a/site/docs/v1.4/velero-install.md b/site/docs/v1.4/velero-install.md deleted file mode 100644 index 58718d16c..000000000 --- a/site/docs/v1.4/velero-install.md +++ /dev/null @@ -1,45 +0,0 @@ -# Velero Install CLI - -This document serves as a guide to using the `velero install` CLI command to install `velero` server components into your kubernetes cluster. - -_NOTE_: `velero install` will, by default, use the CLI's version information to determine the version of the server compoents to deploy. This behavior may be overridden by using the `--image` flag. Refer to [Building Server Component Container Images][1]. - -## Usage - -This section explains some of the basic flags supported by the `velero install` CLI command. For a complete explanation of the flags, please run `velero install --help` - -```bash -velero install \ - --plugins - --provider \ - --bucket \ - --secret-file \ - --velero-pod-cpu-request \ - --velero-pod-mem-request \ - --velero-pod-cpu-limit \ - --velero-pod-mem-limit \ - [--use-restic] \ - [--restic-pod-cpu-request ] \ - [--restic-pod-mem-request ] \ - [--restic-pod-cpu-limit ] \ - [--restic-pod-mem-limit ] -``` - -The values for the resource requests and limits flags follow the same format as [Kubernetes resource requirements][3] -For plugin container images, please refer to our [supported providers][2] page. - -## Examples - -This section provides examples that serve as a starting point for more customized installations. - -```bash -velero install --provider gcp --plugins velero/velero-plugin-for-gcp:v1.0.0 --bucket mybucket --secret-file ./gcp-service-account.json - -velero install --provider aws --plugins velero/velero-plugin-for-aws:v1.0.0 --bucket backups --provider aws --secret-file ./aws-iam-creds --backup-location-config region=us-east-2 --snapshot-location-config region=us-east-2 --use-restic - -velero install --provider azure --plugins velero/velero-plugin-for-microsoft-azure:v1.0.0 --bucket $BLOB_CONTAINER --secret-file ./credentials-velero --backup-location-config resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,storageAccount=$AZURE_STORAGE_ACCOUNT_ID[,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] --snapshot-location-config apiTimeout=[,resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] -``` - -[1]: build-from-source.md#making-images-and-updating-velero -[2]: supported-providers.md -[3]: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ diff --git a/site/docs/v1.4/vendoring-dependencies.md b/site/docs/v1.4/vendoring-dependencies.md deleted file mode 100644 index 1729f21ec..000000000 --- a/site/docs/v1.4/vendoring-dependencies.md +++ /dev/null @@ -1,18 +0,0 @@ -# Vendoring dependencies - -## Overview - -We are using [dep][0] to manage dependencies. You can install it by following [these -instructions][1]. - -## Adding a new dependency - -Run `dep ensure`. If you want to see verbose output, you can append `-v` as in -`dep ensure -v`. - -## Updating an existing dependency - -Run `dep ensure -update [ ...]` to update one or more dependencies. - -[0]: https://github.com/golang/dep -[1]: https://golang.github.io/dep/docs/installation.html diff --git a/site/docs/v1.4/zenhub.md b/site/docs/v1.4/zenhub.md deleted file mode 100644 index 45298b3a2..000000000 --- a/site/docs/v1.4/zenhub.md +++ /dev/null @@ -1,15 +0,0 @@ -# ZenHub - -As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. -GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents. - -While GitHub issues, milestones, and labels generally work pretty well, the Velero team has found that product planning requires some additional tooling that GitHub projects do not offer. - -In our effort to minimize tooling while enabling product management insights, we have decided to use [ZenHub Open-Source](https://www.zenhub.com/blog/open-source/) to overlay product and project tracking on top of GitHub. -ZenHub is a GitHub application that provides Kanban visualization, Epic tracking, fine-grained prioritization, and more. It's primary backing storage system is existing GitHub issues along with additional metadata stored in ZenHub's database. - -If you are a Velero user or Velero Developer, you do not _need_ to use ZenHub for your regular workflow (e.g to see open bug reports or feature requests, work on pull requests). However, if you'd like to be able to visualize the high-level project goals and roadmap, you will need to use the free version of ZenHub. - -## Using ZenHub - -ZenHub can be integrated within the GitHub interface using their [Chrome or FireFox extensions](https://www.zenhub.com/extension). In addition, you can use their dedicated [web application](https://app.zenhub.com/workspace/o/vmware-tanzu/velero/boards?filterLogic=all&repos=99143276). diff --git a/site/index.html b/site/index.html deleted file mode 100644 index cdc7b86cc..000000000 --- a/site/index.html +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -id: home -description: Backup and migrate Kubernetes resources and persistent volumes -backgrounds: - case_study: light-blue - team: dark-blue -hero: - banner: /img/heroes/velero.svg - headline: Backup and migrate Kubernetes resources and persistent volumes - content: Velero is an open source tool to safely backup and restore, perform disaster recovery, and migrate Kubernetes cluster resources and persistent volumes. - cta_link1: - text: Latest Release Information - url: /blog/velero-1.4-community-wave/ - cta_link2: - text: Download Velero - url: https://github.com/vmware-tanzu/velero/releases/latest - promo1: - icon: /img/disaster-recover-icon.svg - title: Disaster Recovery - content: Reduces time to recovery in case of infrastructure loss, data corruption, and/or service outages. - promo2: - icon: /img/data-migration-icon.svg - title: Data Migration - content: Enables cluster portability by easily migrating Kubernetes resources from one cluster to another​. - promo3: - icon: /img/data-protection-icon.svg - title: Data Protection - content: Offers key data protection features such as scheduled backups, retention schedules, and pre or post-backup hooks for custom actions. -secondary_ctas: - cta1: - title: Introduction to Velero - url: /blog/Velero-is-an-Open-Source-Tool-to-Back-up-and-Migrate-Kubernetes-Clusters/ - content: Learn about Velero and how to protect your Kubernetes resources and volumes. - cta2: - title: How Do You Use Velero? - url: https://github.com/vmware-tanzu/velero/issues/1327 - content: See how Velero is helping others and tell the world how you use Velero. -#reference: -# title: Lorem Ipsum -# content: Lorem ipsum dolor sit amet, consectetur adipiscing elit. -# links: -# ISO: http://www.example.com -# OVA: http://www.example.com -# Amazon Machine Image: http://www.example.com -# Google Compute Engine Image: http://www.example.com -# Azure VHD: http://www.example.com ---- -
-
-
-
-

{{ page.hero.headline }}

-

{{ page.hero.content }}

-
-
- {{ page.hero.cta_link1.text }} - {{ page.hero.cta_link2.text }} -
-
-
-
-
-
-
-
-
-
-
- {{ page.hero.promo1.title }} -
- {% if page.hero.promo1.url or size > 0 %} -
{{ page.hero.promo1.title }}
- {% else %} -
{{ page.hero.promo1.title }}
- {% endif %} -

{{ page.hero.promo1.content }}

-
-
-
-
-
-
-
- {{ page.hero.promo2.title }} -
- {% if page.hero.promo2.url or size > 0 %} -
{{ page.hero.promo2.title }}
- {% else %} -
{{ page.hero.promo2.title }}
- {% endif %} -

{{ page.hero.promo2.content }}

-
-
-
-
-
-
-
- {{ page.hero.promo3.title }} -
- {% if page.hero.promo3.url or size > 0 %} -
{{ page.hero.promo3.title }}
- {% else %} -
{{ page.hero.promo3.title }}
- {% endif %} -

{{ page.hero.promo3.content }}

-
-
-
-
-
-
-
-
-
-
-
- {{ page.secondary_ctas.cta1.title }} -
-

{{ page.secondary_ctas.cta1.content }}

-
-
-
- {{ page.secondary_ctas.cta2.title }} -
-

{{ page.secondary_ctas.cta2.content }}

-
-
-
-
- - - -
-
-
-
-

Features

-
-
- {% assign limit = 3 %} - {% include case-studies-alternating.html %} -
-
- -
-
-
-
-

Blog Highlights

-
-
- {% assign limit = 3 %} - {% include blog-posts.html %} -
-
- See All Posts -
-
-
-
- -
-
- {% include contributors.html %} -
-
diff --git a/site/layouts/_default/_markup/render-image.html b/site/layouts/_default/_markup/render-image.html new file mode 100644 index 000000000..41bf8b52e --- /dev/null +++ b/site/layouts/_default/_markup/render-image.html @@ -0,0 +1,11 @@ +{{ $link := .Destination }} +{{ if not (strings.HasPrefix $link "http") }} + {{ if strings.HasSuffix .Page.Parent.RelPermalink "docs/" }} + {{ $link = printf "%s%s" .Page.RelPermalink .Destination }} + {{ else }} + {{ $link = printf "%s%s" .Page.Parent.RelPermalink .Destination }} + {{ end }} +{{ end }} +

+ {{ .Text }} +

\ No newline at end of file diff --git a/site/layouts/_default/_markup/render-link.html b/site/layouts/_default/_markup/render-link.html new file mode 100644 index 000000000..d69b894aa --- /dev/null +++ b/site/layouts/_default/_markup/render-link.html @@ -0,0 +1,5 @@ +{{ $link := .Destination }} +{{ if not (strings.HasPrefix $link "http") }} + {{ $link = (.Page.GetPage .Destination).RelPermalink }} +{{ end }} +{{ .Text | safeHTML }} \ No newline at end of file diff --git a/site/layouts/_default/baseof.html b/site/layouts/_default/baseof.html new file mode 100644 index 000000000..e74353484 --- /dev/null +++ b/site/layouts/_default/baseof.html @@ -0,0 +1,40 @@ + + + + + + + + + {{ $options := (dict "targetPath" "styles.css" "outputStyle" "compressed" "enableSourceMap" true) }} + {{ $styles := resources.Get "styles.scss" | toCSS $options | resources.Fingerprint }} + + {{ block "title" . }}{{ .Site.Title }} {{ .Page.Title }}{{ end }} + + +
+
+ {{ .Render "site-header" }} + {{ block "main" . }} +
+
+
+

{{ .Title }}

+
+
+
+
+
+
+ {{ block "content" . }} + {{ .Content }} + {{ end }} +
+
+
+ {{ end }} + {{ .Render "footer" }} +
+
+ + \ No newline at end of file diff --git a/site/layouts/_default/footer.html b/site/layouts/_default/footer.html new file mode 100644 index 000000000..61a2d4da2 --- /dev/null +++ b/site/layouts/_default/footer.html @@ -0,0 +1,64 @@ +
+
+
+
+
{{ .Site.Params.footer.title }}
+

{{ .Site.Params.footer.content }}

+
+
+

{{ .Site.Params.footer.cta_title }}

+ {{ .Site.Params.footer.cta_text }} +
+
+
+
+ +
+
+
+
+ +
+
+ +
+
+
+
+ © {{ now.Format "2006" }} {{ .Site.Params.Author }}. + +
+
+
+
+ + + + + + + + + diff --git a/site/layouts/_default/section.html b/site/layouts/_default/section.html new file mode 100644 index 000000000..288894a0e --- /dev/null +++ b/site/layouts/_default/section.html @@ -0,0 +1,3 @@ +{{ define "content" }} + {{ .Content }} +{{ end }} \ No newline at end of file diff --git a/site/_includes/site-header.html b/site/layouts/_default/site-header.html similarity index 73% rename from site/_includes/site-header.html rename to site/layouts/_default/site-header.html index 7f10baf59..b3e487517 100644 --- a/site/_includes/site-header.html +++ b/site/layouts/_default/site-header.html @@ -1,11 +1,11 @@
+ \ No newline at end of file diff --git a/site/layouts/partials/blog-posts.html b/site/layouts/partials/blog-posts.html new file mode 100644 index 000000000..61b78203e --- /dev/null +++ b/site/layouts/partials/blog-posts.html @@ -0,0 +1,14 @@ +
+ {{ $posts := (.Scratch.Get "posts") }} + + {{ range $index, $post := $posts }} + {{ partial "blog-post-card.html" . }} + + {{ $currentIndex := add $index 1 }} + {{ $row := mod $currentIndex 3 }} + {{ if and (eq $row 0) (ne $currentIndex (len $posts)) }} +
+
+ {{ end }} + {{ end }} +
\ No newline at end of file diff --git a/site/layouts/partials/case-studies-alternating.html b/site/layouts/partials/case-studies-alternating.html new file mode 100644 index 000000000..aed0dfe1f --- /dev/null +++ b/site/layouts/partials/case-studies-alternating.html @@ -0,0 +1,33 @@ +
+ {{ $caseStudies := .Site.GetPage "/casestudies" }} + {{ $caseStudyBackground := .Params.backgrounds.case_study }} + {{ $limit := .Scratch.Get "limit" }} + {{ range $index, $page := sort (first $limit $caseStudies.Resources) "Name" "asc" }} +
+ {{ $iconClassName := "" }} + {{ $bodyClassName := "" }} + + {{ if not (modBool $index 2) }} + {{ $iconClassName = "order-md-last" }} + {{ $bodyClassName = "order-md-first" }} + {{ end }} + + {{ if .Params.icon }} +
+ {{ .Title }} +
+ {{ end }} +
+
+ {{ if .Title }} +
{{ .Title }}
+ {{ end }} +

{{ .Content }}

+ {{ range $key, $val := .Params.links }} + {{ $key }} + {{ end }} +
+
+
+ {{ end }} +
diff --git a/site/layouts/partials/contributors.html b/site/layouts/partials/contributors.html new file mode 100644 index 000000000..0b7eb0e8b --- /dev/null +++ b/site/layouts/partials/contributors.html @@ -0,0 +1,32 @@ +
+
+

The {{ .Site.Title }} Team

+
+
+
+
+

{{ .Site.Title }} is released as open source software and provides community support through our GitHub + project page. + If you encounter an issue or have a question, feel free to reach out on the GitHub issues page + for {{ .Site.Title }}.

+

The Velero project team welcomes contributions from the community, please see our contributing + documentation. +

+
+
+
+ {{ $contributors := .Site.GetPage "/contributors" }} + {{ range $contributors.Resources }} +
+
+ Person +
+
{{ .Params.first_name }} {{ .Params.last_name }}
+ {{ .Content }} +
+
+
+ {{ end }} +
\ No newline at end of file diff --git a/site/layouts/partials/head-docs.html b/site/layouts/partials/head-docs.html new file mode 100644 index 000000000..4eb6e72a7 --- /dev/null +++ b/site/layouts/partials/head-docs.html @@ -0,0 +1,11 @@ + + + + + + + {{ $options := (dict "targetPath" "styles.css" "outputStyle" "compressed" "enableSourceMap" true) }} + {{ $styles := resources.Get "styles.scss" | toCSS $options | resources.Fingerprint }} + + {{/* TODO {% seo %}*/}} + diff --git a/site/layouts/partials/plugins.html b/site/layouts/partials/plugins.html new file mode 100644 index 000000000..443fb3100 --- /dev/null +++ b/site/layouts/partials/plugins.html @@ -0,0 +1,58 @@ +
+
+
+ {{ $limit := int (.Scratch.Get "limit") }} + {{ $pages := sort (.Site.GetPage "/plugins/list").Resources "Name" }} + + {{ if gt $limit 0 }} + {{ $pages = first $limit $pages }} + {{ end }} + + {{ range $index, $page := $pages }} +
+
+
+
+
+
+
+ {{ if .Params.link }} +
{{ .Title }}
+ {{ else }} +
{{ .Title }}
+ {{ end }} +

{{ .Content }}

+ {{ if .Params.objectStorage }} + + {{ end }} + {{ if .Params.volumesnapshotter }} + + {{ end }} + {{ if .Params.localStorage }} + + {{ end }} + {{ if .Params.supportedByVeleroTeam }} + + {{ end }} + {{ if .Params.BackupItemAction }} + + {{ end }} + {{ if .Params.RestoreItemAction }} + + {{ end }} + {{ if .Params.beta }} + + {{ end }} +
+
+
+ {{ $currentIndex := add $index 1 }} + {{ $row := mod $currentIndex 3 }} + {{ if eq $row 0 }} +
+
+ {{ end }} + {{ end }} +
+
+
diff --git a/site/layouts/partials/related-posts.html b/site/layouts/partials/related-posts.html new file mode 100644 index 000000000..847587bae --- /dev/null +++ b/site/layouts/partials/related-posts.html @@ -0,0 +1,6 @@ +
Related Content
+
+ {{ range .Site.RegularPages.Related . | first 2 }} + {{ partial "blog-post-card.html" . }} + {{ end }} +
\ No newline at end of file diff --git a/site/layouts/plugins/list.html b/site/layouts/plugins/list.html new file mode 100644 index 000000000..dd9b41ce1 --- /dev/null +++ b/site/layouts/plugins/list.html @@ -0,0 +1,9 @@ +{{ define "content" }} + {{ .Content }} + +
+
+ {{ partial "plugins.html" . }} +
+
+{{ end }} \ No newline at end of file diff --git a/site/layouts/posts/section.html b/site/layouts/posts/section.html new file mode 100644 index 000000000..b064097fd --- /dev/null +++ b/site/layouts/posts/section.html @@ -0,0 +1,4 @@ +{{ define "content" }} + {{ .Scratch.Set "posts" (.Site.GetPage "/posts").Pages }} + {{ partial "blog-posts.html" . }} +{{ end }} \ No newline at end of file diff --git a/site/layouts/posts/single.html b/site/layouts/posts/single.html new file mode 100644 index 000000000..7440772df --- /dev/null +++ b/site/layouts/posts/single.html @@ -0,0 +1,42 @@ +{{ define "main" }} +
+
+
+

{{ .Title }}

+
+
+
+
+
+
+
+
+ {{ if .Params.author_avatar }} +
+ {{ .Params.author_name }} +
+ {{ end }} + +
+ {{ .Params.author_name }} +
+
+ +
+ {{ .Date.Format "January 02, 2006" }} +
+
+ +
+ {{ .Content }} +
+
+
+
+ +
+
+ {{ partial "related-posts.html" . }} +
+
+{{ end }} \ No newline at end of file diff --git a/site/layouts/robots.txt b/site/layouts/robots.txt new file mode 100644 index 000000000..e087884e6 --- /dev/null +++ b/site/layouts/robots.txt @@ -0,0 +1 @@ +Sitemap: /sitemap.xml diff --git a/site/layouts/shortcodes/youtube.html b/site/layouts/shortcodes/youtube.html new file mode 100644 index 000000000..86e3f3624 --- /dev/null +++ b/site/layouts/shortcodes/youtube.html @@ -0,0 +1,14 @@ + + +{{- $pc := .Page.Site.Config.Privacy.YouTube -}} +{{- if not $pc.Disable -}} + {{- $ytHost := cond $pc.PrivacyEnhanced "www.youtube-nocookie.com" "www.youtube.com" -}} + {{- $id := .Get "id" | default (.Get 0) -}} + {{- $class := .Get "class" | default (.Get 1) }} +
+ +
+{{ end -}} \ No newline at end of file diff --git a/site/favicon.ico b/site/static/favicon.ico similarity index 100% rename from site/favicon.ico rename to site/static/favicon.ico diff --git a/site/css/fonts/IcoMoon/IcoMoon-Free.ttf b/site/static/fonts/IcoMoon/IcoMoon-Free.ttf similarity index 100% rename from site/css/fonts/IcoMoon/IcoMoon-Free.ttf rename to site/static/fonts/IcoMoon/IcoMoon-Free.ttf diff --git a/site/css/fonts/Metropolis/Metropolis-Bold.woff b/site/static/fonts/Metropolis/Metropolis-Bold.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-Bold.woff rename to site/static/fonts/Metropolis/Metropolis-Bold.woff diff --git a/site/css/fonts/Metropolis/Metropolis-BoldItalic.woff b/site/static/fonts/Metropolis/Metropolis-BoldItalic.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-BoldItalic.woff rename to site/static/fonts/Metropolis/Metropolis-BoldItalic.woff diff --git a/site/css/fonts/Metropolis/Metropolis-Light.woff b/site/static/fonts/Metropolis/Metropolis-Light.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-Light.woff rename to site/static/fonts/Metropolis/Metropolis-Light.woff diff --git a/site/css/fonts/Metropolis/Metropolis-LightItalic.woff b/site/static/fonts/Metropolis/Metropolis-LightItalic.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-LightItalic.woff rename to site/static/fonts/Metropolis/Metropolis-LightItalic.woff diff --git a/site/css/fonts/Metropolis/Metropolis-Medium.woff b/site/static/fonts/Metropolis/Metropolis-Medium.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-Medium.woff rename to site/static/fonts/Metropolis/Metropolis-Medium.woff diff --git a/site/css/fonts/Metropolis/Metropolis-MediumItalic.woff b/site/static/fonts/Metropolis/Metropolis-MediumItalic.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-MediumItalic.woff rename to site/static/fonts/Metropolis/Metropolis-MediumItalic.woff diff --git a/site/css/fonts/Metropolis/Metropolis-Regular.woff b/site/static/fonts/Metropolis/Metropolis-Regular.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-Regular.woff rename to site/static/fonts/Metropolis/Metropolis-Regular.woff diff --git a/site/css/fonts/Metropolis/Metropolis-RegularItalic.woff b/site/static/fonts/Metropolis/Metropolis-RegularItalic.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-RegularItalic.woff rename to site/static/fonts/Metropolis/Metropolis-RegularItalic.woff diff --git a/site/css/fonts/Metropolis/Metropolis-SemiBold.woff b/site/static/fonts/Metropolis/Metropolis-SemiBold.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-SemiBold.woff rename to site/static/fonts/Metropolis/Metropolis-SemiBold.woff diff --git a/site/css/fonts/Metropolis/Metropolis-SemiBoldItalic.woff b/site/static/fonts/Metropolis/Metropolis-SemiBoldItalic.woff similarity index 100% rename from site/css/fonts/Metropolis/Metropolis-SemiBoldItalic.woff rename to site/static/fonts/Metropolis/Metropolis-SemiBoldItalic.woff diff --git a/site/css/fonts/Metropolis/Open Font License.md b/site/static/fonts/Metropolis/Open Font License.md similarity index 100% rename from site/css/fonts/Metropolis/Open Font License.md rename to site/static/fonts/Metropolis/Open Font License.md diff --git a/site/css/fonts/Metropolis/README.md b/site/static/fonts/Metropolis/README.md similarity index 100% rename from site/css/fonts/Metropolis/README.md rename to site/static/fonts/Metropolis/README.md diff --git a/site/img/Velero.svg b/site/static/img/Velero.svg similarity index 100% rename from site/img/Velero.svg rename to site/static/img/Velero.svg diff --git a/site/img/adopters/BitGo.svg b/site/static/img/adopters/BitGo.svg similarity index 100% rename from site/img/adopters/BitGo.svg rename to site/static/img/adopters/BitGo.svg diff --git a/site/img/adopters/DellEMC.png b/site/static/img/adopters/DellEMC.png similarity index 100% rename from site/img/adopters/DellEMC.png rename to site/static/img/adopters/DellEMC.png diff --git a/site/img/adopters/banzaicloud.svg b/site/static/img/adopters/banzaicloud.svg similarity index 100% rename from site/img/adopters/banzaicloud.svg rename to site/static/img/adopters/banzaicloud.svg diff --git a/site/img/adopters/bugsnag.svg b/site/static/img/adopters/bugsnag.svg similarity index 100% rename from site/img/adopters/bugsnag.svg rename to site/static/img/adopters/bugsnag.svg diff --git a/site/img/adopters/kyma.svg b/site/static/img/adopters/kyma.svg similarity index 100% rename from site/img/adopters/kyma.svg rename to site/static/img/adopters/kyma.svg diff --git a/site/img/adopters/mayadata.svg b/site/static/img/adopters/mayadata.svg similarity index 100% rename from site/img/adopters/mayadata.svg rename to site/static/img/adopters/mayadata.svg diff --git a/site/img/adopters/nirmata.svg b/site/static/img/adopters/nirmata.svg similarity index 100% rename from site/img/adopters/nirmata.svg rename to site/static/img/adopters/nirmata.svg diff --git a/site/img/adopters/okteto.svg b/site/static/img/adopters/okteto.svg similarity index 100% rename from site/img/adopters/okteto.svg rename to site/static/img/adopters/okteto.svg diff --git a/site/img/adopters/redhat.svg b/site/static/img/adopters/redhat.svg similarity index 100% rename from site/img/adopters/redhat.svg rename to site/static/img/adopters/redhat.svg diff --git a/site/img/adopters/sighup.svg b/site/static/img/adopters/sighup.svg similarity index 100% rename from site/img/adopters/sighup.svg rename to site/static/img/adopters/sighup.svg diff --git a/site/img/case-study-icons/case-study-1.svg b/site/static/img/case-study-icons/case-study-1.svg similarity index 100% rename from site/img/case-study-icons/case-study-1.svg rename to site/static/img/case-study-icons/case-study-1.svg diff --git a/site/img/case-study-icons/case-study-2.svg b/site/static/img/case-study-icons/case-study-2.svg similarity index 100% rename from site/img/case-study-icons/case-study-2.svg rename to site/static/img/case-study-icons/case-study-2.svg diff --git a/site/img/case-study-icons/case-study-3.svg b/site/static/img/case-study-icons/case-study-3.svg similarity index 100% rename from site/img/case-study-icons/case-study-3.svg rename to site/static/img/case-study-icons/case-study-3.svg diff --git a/site/img/contributors/ashish-amarnath.png b/site/static/img/contributors/ashish-amarnath.png similarity index 100% rename from site/img/contributors/ashish-amarnath.png rename to site/static/img/contributors/ashish-amarnath.png diff --git a/site/img/contributors/carlisia-campos.png b/site/static/img/contributors/carlisia-campos.png similarity index 100% rename from site/img/contributors/carlisia-campos.png rename to site/static/img/contributors/carlisia-campos.png diff --git a/site/img/contributors/cormac-pic.png b/site/static/img/contributors/cormac-pic.png similarity index 100% rename from site/img/contributors/cormac-pic.png rename to site/static/img/contributors/cormac-pic.png diff --git a/site/img/contributors/michael-michael.png b/site/static/img/contributors/michael-michael.png similarity index 100% rename from site/img/contributors/michael-michael.png rename to site/static/img/contributors/michael-michael.png diff --git a/site/img/contributors/nolan-brubaker.png b/site/static/img/contributors/nolan-brubaker.png similarity index 100% rename from site/img/contributors/nolan-brubaker.png rename to site/static/img/contributors/nolan-brubaker.png diff --git a/site/img/contributors/person.png b/site/static/img/contributors/person.png similarity index 100% rename from site/img/contributors/person.png rename to site/static/img/contributors/person.png diff --git a/site/img/contributors/stephanie-bauman.png b/site/static/img/contributors/stephanie-bauman.png similarity index 100% rename from site/img/contributors/stephanie-bauman.png rename to site/static/img/contributors/stephanie-bauman.png diff --git a/site/img/contributors/tim-hinderliter.png b/site/static/img/contributors/tim-hinderliter.png similarity index 100% rename from site/img/contributors/tim-hinderliter.png rename to site/static/img/contributors/tim-hinderliter.png diff --git a/site/img/contributors/tom-spoonemore.png b/site/static/img/contributors/tom-spoonemore.png similarity index 100% rename from site/img/contributors/tom-spoonemore.png rename to site/static/img/contributors/tom-spoonemore.png diff --git a/site/img/data-migration-icon.svg b/site/static/img/data-migration-icon.svg similarity index 100% rename from site/img/data-migration-icon.svg rename to site/static/img/data-migration-icon.svg diff --git a/site/img/data-protection-icon.svg b/site/static/img/data-protection-icon.svg similarity index 100% rename from site/img/data-protection-icon.svg rename to site/static/img/data-protection-icon.svg diff --git a/site/img/disaster-recover-icon.svg b/site/static/img/disaster-recover-icon.svg similarity index 100% rename from site/img/disaster-recover-icon.svg rename to site/static/img/disaster-recover-icon.svg diff --git a/site/img/heroes/velero.svg b/site/static/img/heroes/velero.svg similarity index 100% rename from site/img/heroes/velero.svg rename to site/static/img/heroes/velero.svg diff --git a/site/img/posts/cassandra.gif b/site/static/img/posts/cassandra.gif similarity index 100% rename from site/img/posts/cassandra.gif rename to site/static/img/posts/cassandra.gif diff --git a/site/img/posts/csi-announce-blog.jpg b/site/static/img/posts/csi-announce-blog.jpg similarity index 100% rename from site/img/posts/csi-announce-blog.jpg rename to site/static/img/posts/csi-announce-blog.jpg diff --git a/site/img/posts/post-1.3.jpg b/site/static/img/posts/post-1.3.jpg similarity index 100% rename from site/img/posts/post-1.3.jpg rename to site/static/img/posts/post-1.3.jpg diff --git a/site/img/posts/post-1.4.jpg b/site/static/img/posts/post-1.4.jpg similarity index 100% rename from site/img/posts/post-1.4.jpg rename to site/static/img/posts/post-1.4.jpg diff --git a/site/img/posts/post-sample-figure-1.png b/site/static/img/posts/post-sample-figure-1.png similarity index 100% rename from site/img/posts/post-sample-figure-1.png rename to site/static/img/posts/post-sample-figure-1.png diff --git a/site/img/posts/sailboat.jpg b/site/static/img/posts/sailboat.jpg similarity index 100% rename from site/img/posts/sailboat.jpg rename to site/static/img/posts/sailboat.jpg diff --git a/site/img/posts/sample.png b/site/static/img/posts/sample.png similarity index 100% rename from site/img/posts/sample.png rename to site/static/img/posts/sample.png diff --git a/site/img/posts/vmware-tanzu.png b/site/static/img/posts/vmware-tanzu.png similarity index 100% rename from site/img/posts/vmware-tanzu.png rename to site/static/img/posts/vmware-tanzu.png diff --git a/site/img/posts/vsphere-logo.jpg b/site/static/img/posts/vsphere-logo.jpg similarity index 100% rename from site/img/posts/vsphere-logo.jpg rename to site/static/img/posts/vsphere-logo.jpg diff --git a/site/img/vm-logo.png b/site/static/img/vm-logo.png similarity index 100% rename from site/img/vm-logo.png rename to site/static/img/vm-logo.png diff --git a/site/img/vsphere-tutorial-icons/Minio.png b/site/static/img/vsphere-tutorial-icons/Minio.png similarity index 100% rename from site/img/vsphere-tutorial-icons/Minio.png rename to site/static/img/vsphere-tutorial-icons/Minio.png diff --git a/site/img/vsphere-tutorial-icons/minio-nginx-backup.png b/site/static/img/vsphere-tutorial-icons/minio-nginx-backup.png similarity index 100% rename from site/img/vsphere-tutorial-icons/minio-nginx-backup.png rename to site/static/img/vsphere-tutorial-icons/minio-nginx-backup.png diff --git a/site/img/vsphere-tutorial-icons/nginx-restore-new-ip.png b/site/static/img/vsphere-tutorial-icons/nginx-restore-new-ip.png similarity index 100% rename from site/img/vsphere-tutorial-icons/nginx-restore-new-ip.png rename to site/static/img/vsphere-tutorial-icons/nginx-restore-new-ip.png diff --git a/site/img/vsphere-tutorial-icons/nginx.png b/site/static/img/vsphere-tutorial-icons/nginx.png similarity index 100% rename from site/img/vsphere-tutorial-icons/nginx.png rename to site/static/img/vsphere-tutorial-icons/nginx.png diff --git a/site/js/jquery.matchHeight.js b/site/static/js/jquery.matchHeight.js similarity index 100% rename from site/js/jquery.matchHeight.js rename to site/static/js/jquery.matchHeight.js diff --git a/site/js/scripts.js b/site/static/js/scripts.js similarity index 100% rename from site/js/scripts.js rename to site/static/js/scripts.js diff --git a/site/survey.md b/site/survey.md deleted file mode 100644 index 062fd96c9..000000000 --- a/site/survey.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: page -title: Survey -description: Velero Survey -redirect_to: https://buff.ly/2YYnEQX ---- \ No newline at end of file