Unverified Commit ac50b457 authored by Abigail McCarthy's avatar Abigail McCarthy Committed by GitHub
Browse files

add hugo default TOC (#2866)


* add hugo default TOC
Signed-off-by: default avatarAbigail McCarthy <mabigail@vmware.com>

* point contributors to style guide (#2872)
Signed-off-by: default avatarAbigail McCarthy <mabigail@vmware.com>

* add hugo default TOC
Signed-off-by: default avatarAbigail McCarthy <mabigail@vmware.com>

* remove unused links
Signed-off-by: default avatarAbigail McCarthy <mabigail@vmware.com>
parent 9cf35d9b
Showing with 49 additions and 144 deletions
+49 -144
---
toc: "false"
cascade:
version: main
toc: "true"
---
![100]
......
......@@ -3,15 +3,6 @@ title: "Basic Install"
layout: docs
---
- [Basic Install](#basic-install)
- [Prerequisites](#prerequisites)
- [Install the CLI](#install-the-cli)
- [Option 1: macOS - Homebrew](#option-1-macos---homebrew)
- [Option 2: GitHub release](#option-2-github-release)
- [Option 3: Windows - Chocolatey](#option-3-windows---chocolatey)
- [Install and configure the server components](#install-and-configure-the-server-components)
- [Command line Autocompletion](#command-line-autocompletion)
Use this doc to get a basic installation of Velero.
Refer [this document](customize-installation.md) to customize your installation.
......
......@@ -14,13 +14,13 @@ See [Set up Velero on your platform][3] for how to configure Velero for a produc
If you encounter issues with installing or configuring, see [Debugging Installation Issues](debugging-install.md).
### Prerequisites
## Prerequisites
* Access to a Kubernetes cluster, version 1.7 or later. **Note:** restic support requires Kubernetes version 1.10 or later, or an earlier version with the mount propagation feature enabled. Restic support is not required for this example, but may be of interest later. See [Restic Integration][17].
* A DNS server on the cluster
* `kubectl` installed
### Download Velero
## Download Velero
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
......@@ -38,7 +38,7 @@ of the Velero repository is under active development and is not guaranteed to be
1. Move the `velero` binary from the Velero directory to somewhere in your PATH.
#### MacOS Installation
### MacOS Installation
On Mac, you can use [HomeBrew](https://brew.sh) to install the `velero` client:
......@@ -46,7 +46,7 @@ On Mac, you can use [HomeBrew](https://brew.sh) to install the `velero` client:
brew install velero
```
### Set up server
## Set up server
These instructions start the Velero server and a Minio instance that is accessible from within the cluster only. See [Expose Minio outside your cluster][31] for information about configuring your cluster for outside access to Minio. Outside access is required to access logs and run `velero describe` commands.
......@@ -92,7 +92,7 @@ These instructions start the Velero server and a Minio instance that is accessib
kubectl get deployments --namespace=nginx-example
```
### Back up
## Back up
1. Create a backup for any object that matches the `app=nginx` label selector:
......@@ -138,7 +138,7 @@ These instructions start the Velero server and a Minio instance that is accessib
NOTE: You might need to wait for a few minutes for the namespace to be fully cleaned up.
### Restore
## Restore
1. Run:
......@@ -171,7 +171,7 @@ velero restore describe <RESTORE_NAME>
For more information, see [the debugging information][18].
### Clean up
## Clean up
If you want to delete any backups you created, including data in object storage and persistent
volume snapshots, you can run:
......
......@@ -9,7 +9,7 @@ Integrating Container Storage Interface (CSI) snapshot support into Velero enabl
By supporting CSI snapshot APIs, Velero can support any volume provider that has a CSI driver, without requiring a Velero-specific plugin to be available.
# Prerequisites
## Prerequisites
The following are the prerequisites for using Velero to take Container Storage Interface (CSI) snapshots:
......@@ -17,7 +17,7 @@ The following are the prerequisites for using Velero to take Container Storage I
1. The cluster is running a CSI driver capable of support volume snapshots at the [v1beta1 API level](https://kubernetes.io/blog/2019/12/09/kubernetes-1-17-feature-cis-volume-snapshot-beta/).
1. When restoring CSI volumesnapshots across clusters, the name of the CSI driver in the destination cluster is the same as that on the source cluster to ensure cross cluster portability of CSI volumesnapshots
# Installing Velero with CSI support
## Installing Velero with CSI support
Ensure that the Velero server is running with the `EnableCSI` feature flag. See [Enabling Features][1] for more information.
Also, the Velero [CSI plugin][2] ([Docker Hub][3]) is necessary to integrate with the CSI volume snapshot APIs.
......@@ -34,7 +34,7 @@ velero install \
To include the status of CSI objects associated with a Velero backup in `velero backup describe` output, run `velero client config set features=EnableCSI`.
See [Enabling Features][1] for more information about managing client-side feature flags.
# Implementation Choices
## Implementation Choices
This section documents some of the choices made during implementation of the Velero [CSI plugin][2]:
......@@ -45,12 +45,12 @@ This section documents some of the choices made during implementation of the Vel
velero.io/csi-volumesnapshot-class: "true"
```
# Roadmap
## Roadmap
Velero's support level for CSI volume snapshotting will follow upstream Kubernetes support for the feature, and will reach general availability sometime
after volume snapshotting is GA in upstream Kubernetes. Beta support is expected to launch in Velero v1.4.
# How it Works - Overview
## How it Works - Overview
Velero's CSI support does not rely on the Velero VolumeSnapshotter plugin interface.
......
......@@ -3,34 +3,6 @@ title: "Customize Velero Install"
layout: docs
---
- [Customize Velero Install](#customize-velero-install)
- [Plugins](#plugins)
- [Install in any namespace](#install-in-any-namespace)
- [Use non-file-based identity mechanisms](#use-non-file-based-identity-mechanisms)
- [Enable restic integration](#enable-restic-integration)
- [Enable default use of restic to backup pod volumes](#default-pod-volume-backup-to-restic)
- [Enable features](#enable-features)
- [Enable server side features](#enable-server-side-features)
- [Enable client side features](#enable-client-side-features)
- [Customize resource requests and limits](#customize-resource-requests-and-limits)
- [Install with custom resource requests and limits](#install-with-custom-resource-requests-and-limits)
- [Update resource requests and limits after install](#update-resource-requests-and-limits-after-install)
- [Configure more than one storage location for backups or volume snapshots](#configure-more-than-one-storage-location-for-backups-or-volume-snapshots)
- [Do not configure a backup storage location during install](#do-not-configure-a-backup-storage-location-during-install)
- [Install an additional volume snapshot provider](#install-an-additional-volume-snapshot-provider)
- [Generate YAML only](#generate-yaml-only)
- [Use a storage provider secured by a self-signed certificate](#use-a-storage-provider-secured-by-a-self-signed-certificate)
- [Additional options](#additional-options)
- [Optional Velero CLI configurations](#optional-velero-cli-configurations)
- [Enabling shell autocompletion](#enabling-shell-autocompletion)
- [Bash on Linux](#bash-on-linux)
- [Install bash-completion](#install-bash-completion)
- [Enable Velero CLI autocompletion for Bash on Linux](#enable-velero-cli-autocompletion-for-bash-on-linux)
- [Bash on macOS](#bash-on-macos)
- [Install bash-completion](#install-bash-completion-1)
- [Enable Velero CLI autocompletion for Bash on macOS](#enable-velero-cli-autocompletion-for-bash-on-macos)
- [Autocompletion on Zsh](#autocompletion-on-zsh)
## Plugins
During install, Velero requires that at least one plugin is added (with the `--plugins` flag). Please see the documentation under [Plugins](overview-plugins.md)
......
......@@ -3,9 +3,6 @@ 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`:
......@@ -104,6 +101,3 @@ Both errors and warnings are structured in the same way:
* `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
......@@ -5,7 +5,7 @@ layout: docs
After you set up the Velero server, try these examples:
### Basic example (without PersistentVolumes)
## Basic example (without PersistentVolumes)
1. Start the sample nginx app:
......@@ -33,7 +33,7 @@ After you set up the Velero server, try these examples:
velero restore create --from-backup nginx-backup
```
### Snapshot example (with PersistentVolumes)
## Snapshot example (with PersistentVolumes)
> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks.
......
......@@ -35,7 +35,7 @@ This configuration design enables a number of different use cases, including:
Let's look at some examples of how you 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
### Take snapshots of more than one kind of persistent volume in a single Velero backup
During server configuration:
......@@ -62,7 +62,7 @@ Alternately, since in this example there's only one possible volume snapshot loc
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
### 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:
......@@ -95,7 +95,7 @@ velero backup create full-cluster-alternate-location-backup \
--storage-location s3-alt-region
```
#### For volume providers that support it (like Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud
### For volume providers that support it (like Portworx), have some snapshots be stored locally on the cluster and have others be stored in the cloud
During server configuration:
......@@ -128,7 +128,7 @@ velero backup create cloud-snapshot-backup \
--volume-snapshot-locations portworx-cloud
```
#### Use a single location
### 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:
......
......@@ -5,11 +5,11 @@ 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
## 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
## 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:
......
......@@ -14,16 +14,16 @@ velero restore create RESTORE_NAME \
```
## What happens when user removes restore objects
A **restore** object represents the restore operation. There are two types of deletion for restore objects:
### 1. Deleting with **`velero restore delete`**
1. Deleting with **`velero restore delete`**.
This command will delete the custom resource representing it, along with its individual log and results files. But, it will not delete any objects that were created by it from your cluster.
### 2. Deleting with **`kubectl -n velero delete restore`**
2. Deleting with **`kubectl -n velero delete restore`**.
This command will delete the custom resource representing the restore, but will not delete log/results files from object storage, or any objects that were created during the restore in your cluster.
## Restore command-line options
To see all commands for restores, run : `velero restore --help`
To see all options associated with a specific command, provide the --help flag to that command. For example, **`velero restore create --help`** shows all options associated with the **create** command.
### To List all options of restore use : **`velero restore --help`**
To list all options of restore, use **`velero restore --help`**
```Usage:
velero restore [command]
......
......@@ -3,12 +3,12 @@ title: "Start contributing"
layout: docs
---
### Before you start
## Before you start
* Please familiarize yourself with the [Code of Conduct][1] before contributing.
* Also, see [CONTRIBUTING.md][2] for instructions on the developer certificate of origin that we require.
### Finding your way around
## Finding your way around
You may join the Velero community and contribute in many different ways, including helping us design or test new features. For any significant feature we consider adding, we start with a design document. You may find a list of in progress new designs here: https://github.com/vmware-tanzu/velero/pulls?q=is%3Aopen+is%3Apr+label%3ADesign. Feel free to review and help us with your input.
......@@ -18,9 +18,7 @@ For information on how to connect with our maintainers and community, join our o
Please browse our list of resources, including a playlist of past online community meetings, blog posts, and other resources to help you get familiar with our project: [Velero resources](https://velero.io/resources/).
If you are thinking about contributing documentation, make sure to review our [documentation style guide](style-guide.md) and [website guidelines](website-guidelines.md).
### Contributing
## Contributing
If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under `Contribute`.
......
......@@ -5,18 +5,6 @@ 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]
......
---
toc: "false"
cascade:
version: v1.4
toc: "true"
---
![100]
......
......@@ -3,15 +3,6 @@ title: "Basic Install"
layout: docs
---
- [Basic Install](#basic-install)
- [Prerequisites](#prerequisites)
- [Install the CLI](#install-the-cli)
- [Option 1: macOS - Homebrew](#option-1-macos---homebrew)
- [Option 2: GitHub release](#option-2-github-release)
- [Option 3: Windows - Chocolatey](#option-3-windows---chocolatey)
- [Install and configure the server components](#install-and-configure-the-server-components)
- [Command line Autocompletion](#command-line-autocompletion)
Use this doc to get a basic installation of Velero.
Refer [this document](customize-installation.md) to customize your installation.
......
......@@ -14,13 +14,13 @@ See [Set up Velero on your platform][3] for how to configure Velero for a produc
If you encounter issues with installing or configuring, see [Debugging Installation Issues](debugging-install.md).
### Prerequisites
## Prerequisites
* Access to a Kubernetes cluster, version 1.7 or later. **Note:** restic support requires Kubernetes version 1.10 or later, or an earlier version with the mount propagation feature enabled. Restic support is not required for this example, but may be of interest later. See [Restic Integration][17].
* A DNS server on the cluster
* `kubectl` installed
### Download Velero
## Download Velero
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
......@@ -38,7 +38,7 @@ of the Velero repository is under active development and is not guaranteed to be
1. Move the `velero` binary from the Velero directory to somewhere in your PATH.
#### MacOS Installation
### MacOS Installation
On Mac, you can use [HomeBrew](https://brew.sh) to install the `velero` client:
......@@ -46,7 +46,7 @@ On Mac, you can use [HomeBrew](https://brew.sh) to install the `velero` client:
brew install velero
```
### Set up server
## Set up server
These instructions start the Velero server and a Minio instance that is accessible from within the cluster only. See [Expose Minio outside your cluster][31] for information about configuring your cluster for outside access to Minio. Outside access is required to access logs and run `velero describe` commands.
......@@ -91,7 +91,7 @@ These instructions start the Velero server and a Minio instance that is accessib
kubectl get deployments --namespace=nginx-example
```
### Back up
## Back up
1. Create a backup for any object that matches the `app=nginx` label selector:
......@@ -137,7 +137,7 @@ These instructions start the Velero server and a Minio instance that is accessib
NOTE: You might need to wait for a few minutes for the namespace to be fully cleaned up.
### Restore
## Restore
1. Run:
......@@ -170,7 +170,7 @@ velero restore describe <RESTORE_NAME>
For more information, see [the debugging information][18].
### Clean up
## Clean up
If you want to delete any backups you created, including data in object storage and persistent
volume snapshots, you can run:
......
......@@ -9,7 +9,7 @@ Integrating Container Storage Interface (CSI) snapshot support into Velero enabl
By supporting CSI snapshot APIs, Velero can support any volume provider that has a CSI driver, without requiring a Velero-specific plugin to be available.
# Prerequisites
# #Prerequisites
The following are the prerequisites for using Velero to take Container Storage Interface (CSI) snapshots:
......@@ -17,7 +17,7 @@ The following are the prerequisites for using Velero to take Container Storage I
1. The cluster is running a CSI driver capable of support volume snapshots at the [v1beta1 API level](https://kubernetes.io/blog/2019/12/09/kubernetes-1-17-feature-cis-volume-snapshot-beta/).
1. When restoring CSI volumesnapshots across clusters, the name of the CSI driver in the destination cluster is the same as that on the source cluster to ensure cross cluster portability of CSI volumesnapshots
# Installing Velero with CSI support
## Installing Velero with CSI support
Ensure that the Velero server is running with the `EnableCSI` feature flag. See [Enabling Features][1] for more information.
Also, the Velero [CSI plugin][2] ([Docker Hub][3]) is necessary to integrate with the CSI volume snapshot APIs.
......@@ -34,23 +34,23 @@ velero install \
To include the status of CSI objects associated with a Velero backup in `velero backup describe` output, run `velero client config set features=EnableCSI`.
See [Enabling Features][1] for more information about managing client-side feature flags.
# Implementation Choices
## Implementation Choices
This section documents some of the choices made during implementation of the Velero [CSI plugin][2]:
1. Volumesnapshots created by the plugin will be retained only for the lifetime of the backup even if the `DeletionPolicy` on the volumesnapshotclass is set to `Retain`. To accomplish this, during deletion of the backup the prior to deleting the volumesnapshot, volumesnapshotcontent object will be patched to set its `DeletionPolicy` to `Delete`. Thus deleting volumesnapshot object will result in cascade delete of the volumesnapshotcontent and the snapshot in the storage provider.
1. Volumesnapshotcontent objects created during a velero backup that are dangling, unbound to a volumesnapshot object, will also be discovered, through labels, and deleted on backup deletion.
# Known Limitations
## Known Limitations
1. The Velero [CSI plugin](https://github.com/vmware-tanzu/velero-plugin-for-csi/), to backup CSI backed PVCs, will choose the first VolumeSnapshotClass in the cluster that has the same driver name. _[Issue #17](https://github.com/vmware-tanzu/velero-plugin-for-csi/issues/17)_
# Roadmap
## Roadmap
Velero's support level for CSI volume snapshotting will follow upstream Kubernetes support for the feature, and will reach general availability sometime
after volume snapshotting is GA in upstream Kubernetes. Beta support is expected to launch in Velero v1.4.
# How it Works - Overview
## How it Works - Overview
Velero's CSI support does not rely on the Velero VolumeSnapshotter plugin interface.
......
......@@ -3,33 +3,6 @@ title: "Customize Velero Install"
layout: docs
---
- [Customize Velero Install](#customize-velero-install)
- [Plugins](#plugins)
- [Install in any namespace](#install-in-any-namespace)
- [Use non-file-based identity mechanisms](#use-non-file-based-identity-mechanisms)
- [Enable restic integration](#enable-restic-integration)
- [Enable features](#enable-features)
- [Enable server side features](#enable-server-side-features)
- [Enable client side features](#enable-client-side-features)
- [Customize resource requests and limits](#customize-resource-requests-and-limits)
- [Install with custom resource requests and limits](#install-with-custom-resource-requests-and-limits)
- [Update resource requests and limits after install](#update-resource-requests-and-limits-after-install)
- [Configure more than one storage location for backups or volume snapshots](#configure-more-than-one-storage-location-for-backups-or-volume-snapshots)
- [Do not configure a backup storage location during install](#do-not-configure-a-backup-storage-location-during-install)
- [Install an additional volume snapshot provider](#install-an-additional-volume-snapshot-provider)
- [Generate YAML only](#generate-yaml-only)
- [Use a storage provider secured by a self-signed certificate](#use-a-storage-provider-secured-by-a-self-signed-certificate)
- [Additional options](#additional-options)
- [Optional Velero CLI configurations](#optional-velero-cli-configurations)
- [Enabling shell autocompletion](#enabling-shell-autocompletion)
- [Bash on Linux](#bash-on-linux)
- [Install bash-completion](#install-bash-completion)
- [Enable Velero CLI autocompletion for Bash on Linux](#enable-velero-cli-autocompletion-for-bash-on-linux)
- [Bash on macOS](#bash-on-macos)
- [Install bash-completion](#install-bash-completion-1)
- [Enable Velero CLI autocompletion for Bash on macOS](#enable-velero-cli-autocompletion-for-bash-on-macos)
- [Autocompletion on Zsh](#autocompletion-on-zsh)
## Plugins
During install, Velero requires that at least one plugin is added (with the `--plugins` flag). Please see the documentation under [Plugins](overview-plugins.md)
......
......@@ -3,9 +3,6 @@ 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`:
......@@ -104,6 +101,3 @@ Both errors and warnings are structured in the same way:
* `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
......@@ -5,7 +5,7 @@ layout: docs
After you set up the Velero server, try these examples:
### Basic example (without PersistentVolumes)
## Basic example (without PersistentVolumes)
1. Start the sample nginx app:
......@@ -33,7 +33,7 @@ After you set up the Velero server, try these examples:
velero restore create --from-backup nginx-backup
```
### Snapshot example (with PersistentVolumes)
## Snapshot example (with PersistentVolumes)
> NOTE: For Azure, you must run Kubernetes version 1.7.2 or later to support PV snapshotting of managed disks.
......
......@@ -35,7 +35,7 @@ This configuration design enables a number of different use cases, including:
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)
### 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:
......@@ -62,7 +62,7 @@ Alternately, since in this example there's only one possible volume snapshot loc
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
### 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:
......@@ -95,7 +95,7 @@ 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
### 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:
......@@ -128,7 +128,7 @@ velero backup create cloud-snapshot-backup \
--volume-snapshot-locations portworx-cloud
```
#### Use a single location
### 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:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment