mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-05-31 11:26:22 +00:00
Merge pull request #9844 from velero-io/copilot/replace-vmware-tanzu-velero
Some checks failed
Run the E2E test on kind / get-go-version (push) Failing after 56s
Run the E2E test on kind / build (push) Has been skipped
Run the E2E test on kind / setup-test-matrix (push) Successful in 3s
Run the E2E test on kind / run-e2e-test (push) Has been skipped
Main CI / get-go-version (push) Successful in 13s
Main CI / Build (push) Failing after 34s
Close stale issues and PRs / stale (push) Successful in 13s
Some checks failed
Run the E2E test on kind / get-go-version (push) Failing after 56s
Run the E2E test on kind / build (push) Has been skipped
Run the E2E test on kind / setup-test-matrix (push) Successful in 3s
Run the E2E test on kind / run-e2e-test (push) Has been skipped
Main CI / get-go-version (push) Successful in 13s
Main CI / Build (push) Failing after 34s
Close stale issues and PRs / stale (push) Successful in 13s
Update `/site` docs repo references to `velero-io/velero` with `velero-plugin-for-csi` kept on `vmware-tanzu`
This commit is contained in:
1
changelogs/unreleased/9844-Copilot
Normal file
1
changelogs/unreleased/9844-Copilot
Normal file
@@ -0,0 +1 @@
|
||||
Replace vmware-tanzu/velero GitHub org references with velero-io/velero (#9844)
|
||||
@@ -14,7 +14,7 @@ If you are running a build on Ubuntu you will need the following packages:
|
||||
|
||||
|
||||
# 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. Clone down your own fork, or clone the main repo `git clone https://github.com/velero-io/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/
|
||||
|
||||
@@ -13,7 +13,7 @@ hero:
|
||||
url: /blog/Velero-1.11/
|
||||
cta_link2:
|
||||
text: Download Velero
|
||||
url: https://github.com/vmware-tanzu/velero/releases/latest
|
||||
url: https://github.com/velero-io/velero/releases/latest
|
||||
promo1:
|
||||
icon: /img/disaster-recover-icon.svg
|
||||
title: Disaster Recovery
|
||||
@@ -33,6 +33,6 @@ secondary_ctas:
|
||||
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
|
||||
url: https://github.com/velero-io/velero/issues/1327
|
||||
content: See how Velero is helping others and tell the world how you use Velero.
|
||||
---
|
||||
@@ -5,11 +5,11 @@ id: community
|
||||
---
|
||||
## Do you want to help build Velero?
|
||||
|
||||
If you’re a newcomer, check out the “[Good first issue](https://github.com/vmware-tanzu/velero/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+issue%22)” and “[Help wanted](https://github.com/vmware-tanzu/velero/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3A%22Help+wanted%22+)” labels in the Velero repository.
|
||||
If you’re a newcomer, check out the “[Good first issue](https://github.com/velero-io/velero/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+issue%22)” and “[Help wanted](https://github.com/velero-io/velero/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3A%22Help+wanted%22+)” labels in the Velero repository.
|
||||
|
||||
If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing](https://velero.io/docs/main/start-contributing/) documentation for guidance on how to setup Velero for development.
|
||||
|
||||
You can follow the work we do, see our milestones, and our backlog on our [GitHub project boards](https://github.com/vmware-tanzu/velero/projects).
|
||||
You can follow the work we do, see our milestones, and our backlog on our [GitHub project boards](https://github.com/velero-io/velero/projects).
|
||||
|
||||
* Follow us on Twitter at [@projectvelero](https://twitter.com/projectvelero)
|
||||
* Join our Kubernetes Slack channel and talk to over 800 other community members: [#velero-users](https://kubernetes.slack.com/messages/velero-users)
|
||||
@@ -19,4 +19,4 @@ Bi-weekly community meeting alternating every week between Beijing Friendly tim
|
||||
* US/Europe friendly - we start at 10am ET(bound to ET) / 7am PT / 3pm CET / 10pm(11pm) CST - [Convert to your time zone](https://dateful.com/convert/est-edt-eastern-time?t=10) - [Google meet link](https://meet.google.com/dyr-djtj-sko)
|
||||
* Read and comment on the [meeting notes](https://hackmd.io/fCDVjqGuTG23CoOWQpoEVg)
|
||||
* See previous community meetings on our [YouTube Channel](https://www.youtube.com/playlist?list=PL7bmigfV0EqQRysvqvqOtRNk4L5S7uqwM)
|
||||
* Have a question to discuss in the community meeting? Please add it to our [Q&A Discussion board](https://github.com/vmware-tanzu/velero/discussions/categories/community-support-q-a)
|
||||
* Have a question to discuss in the community meeting? Please add it to our [Q&A Discussion board](https://github.com/velero-io/velero/discussions/categories/community-support-q-a)
|
||||
|
||||
@@ -39,11 +39,11 @@ If you are ready to jump in and test, add code, or help with documentation, foll
|
||||
|
||||
See [the list of releases][6] to find out about feature changes.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/workflows/Main%20CI/badge.svg
|
||||
[2]: https://github.com/vmware-tanzu/velero/actions?query=workflow%3A"Main+CI"
|
||||
[1]: https://github.com/velero-io/velero/workflows/Main%20CI/badge.svg
|
||||
[2]: https://github.com/velero-io/velero/actions?query=workflow%3A"Main+CI"
|
||||
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[6]: https://github.com/vmware-tanzu/velero/releases
|
||||
[4]: https://github.com/velero-io/velero/issues
|
||||
[6]: https://github.com/velero-io/velero/releases
|
||||
|
||||
[9]: https://kubernetes.io/docs/setup/
|
||||
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
|
||||
|
||||
@@ -123,4 +123,4 @@ HooksFailed: 0
|
||||
|
||||
|
||||
[1]: api-types/backup.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/main/examples/nginx-app/with-pv.yaml
|
||||
[2]: https://github.com/velero-io/velero/blob/main/examples/nginx-app/with-pv.yaml
|
||||
|
||||
@@ -106,7 +106,7 @@ By this way, schedule is the owner of it created backups. This is useful for som
|
||||
|
||||
Please do notice there is also side effect that may not be expected. Because schedule is the owner, when the schedule is deleted, the related backups CR (Just backup CR is deleted. Backup data still exists in object store and snapshots) will be deleted by k8s GC controller, too, but Velero controller will sync these backups from object store's metadata into k8s. Then k8s GC controller and Velero controller will fight over whether these backups should exist all through.
|
||||
|
||||
If there is possibility the schedule will be disable to not create backup anymore, and the created backups are still useful. Please do not enable this option. For detail, please reference to [Backups created by a schedule with useOwnerReferenceInBackup set do not get synced properly](https://github.com/vmware-tanzu/velero/issues/4093).
|
||||
If there is possibility the schedule will be disable to not create backup anymore, and the created backups are still useful. Please do not enable this option. For detail, please reference to [Backups created by a schedule with useOwnerReferenceInBackup set do not get synced properly](https://github.com/velero-io/velero/issues/4093).
|
||||
|
||||
Some GitOps tools have configurations to avoid pruning the day 2 backups generated from the schedule.
|
||||
For example, the ArgoCD has two ways to do that:
|
||||
|
||||
@@ -8,7 +8,7 @@ Refer [this document](customize-installation.md) to customize your installation,
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Access to a Kubernetes cluster, v1.16 or later, with DNS and container networking enabled. For more information on supported Kubernetes versions, see the Velero [compatibility matrix](https://github.com/vmware-tanzu/velero#velero-compatibility-matrix).
|
||||
- Access to a Kubernetes cluster, v1.16 or later, with DNS and container networking enabled. For more information on supported Kubernetes versions, see the Velero [compatibility matrix](https://github.com/velero-io/velero#velero-compatibility-matrix).
|
||||
- `kubectl` installed locally
|
||||
|
||||
Velero uses object storage to store backups and associated artifacts. It also optionally integrates with supported block storage systems to snapshot your persistent volumes. Before beginning the installation process, you should identify the object storage provider and optional block storage provider(s) you'll be using from the list of [compatible providers][0].
|
||||
@@ -65,7 +65,7 @@ _Note: if your object storage provider is different than your volume snapshot pr
|
||||
Please refer to [this part of the documentation][5].
|
||||
|
||||
[0]: supported-providers.md
|
||||
[1]: https://github.com/vmware-tanzu/velero/releases/latest
|
||||
[1]: https://github.com/velero-io/velero/releases/latest
|
||||
[2]: on-premises.md
|
||||
[3]: overview-plugins.md
|
||||
[4]: customize-installation.md#install-an-additional-volume-snapshot-provider
|
||||
|
||||
@@ -17,7 +17,7 @@ layout: docs
|
||||
```bash
|
||||
mkdir $HOME/go
|
||||
export GOPATH=$HOME/go
|
||||
go get github.com/vmware-tanzu/velero
|
||||
go get github.com/velero-io/velero
|
||||
```
|
||||
|
||||
Where `go` is your [import path][4] for Go.
|
||||
@@ -26,7 +26,7 @@ For Go development, it is recommended to add the Go import path (`$HOME/go` in t
|
||||
|
||||
### 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`.
|
||||
Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/velero-io/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.
|
||||
|
||||
@@ -193,6 +193,6 @@ 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
|
||||
[22]: https://github.com/velero-io/velero/releases
|
||||
[23]: https://docs.docker.com/buildx/working-with-buildx/
|
||||
[24]: https://github.com/docker/buildx
|
||||
|
||||
@@ -82,15 +82,15 @@ Example:
|
||||
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
||||
corev1listers "k8s.io/client-go/listers/core/v1"
|
||||
|
||||
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
|
||||
velerov1client "github.com/vmware-tanzu/velero/pkg/generated/clientset/versioned/typed/velero/v1"
|
||||
velerov1api "github.com/velero-io/velero/pkg/apis/velero/v1"
|
||||
velerov1client "github.com/velero-io/velero/pkg/generated/clientset/versioned/typed/velero/v1"
|
||||
)
|
||||
|
||||
## Mocks
|
||||
|
||||
We use a package to generate mocks for our interfaces.
|
||||
|
||||
Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/main/pkg/podvolume/mocks/restorer.go
|
||||
Example: if you want to change this mock: https://github.com/velero-io/velero/blob/main/pkg/podvolume/mocks/restorer.go
|
||||
|
||||
Run:
|
||||
|
||||
|
||||
@@ -14,9 +14,9 @@ To set up IBM Cloud Object Storage (COS) as Velero's destination, you:
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -34,9 +34,9 @@ brew install velero
|
||||
|
||||
### Option 2: GitHub release
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
@@ -81,13 +81,13 @@ These instructions start the Velero server and a Minio instance that is accessib
|
||||
--backup-location-config region=minio,s3ForcePathStyle="true",s3Url=http://minio.velero.svc:9000
|
||||
```
|
||||
|
||||
* This example assumes that it is running within a local cluster without a volume provider capable of snapshots, so no `VolumeSnapshotLocation` is created (`--use-volume-snapshots=false`). You may need to update AWS plugin version to one that is [compatible](https://github.com/vmware-tanzu/velero-plugin-for-aws#compatibility) with the version of Velero you are installing.
|
||||
* This example assumes that it is running within a local cluster without a volume provider capable of snapshots, so no `VolumeSnapshotLocation` is created (`--use-volume-snapshots=false`). You may need to update AWS plugin version to one that is [compatible](https://github.com/velero-io/velero-plugin-for-aws#compatibility) with the version of Velero you are installing.
|
||||
|
||||
* Additionally, you can specify `--use-node-agent` to enable File System Backup support, and `--wait` to wait for the deployment to be ready.
|
||||
|
||||
* This example also assumes you have named your Minio bucket "velero".
|
||||
|
||||
* Please make sure to set parameter `s3ForcePathStyle=true`. The parameter is used to set the Velero integrated AWS SDK data query address style. There are two types of the address: [virtual-host and path-style](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html). If the `s3ForcePathStyle=true` is not set, the default value is false, then the AWS SDK will query in virtual-host style, but the MinIO server only support path-style address by default. The miss match will mean Velero can upload data to MinIO, but **cannot download from MinIO**. This [link](https://github.com/vmware-tanzu/velero/issues/7268) is an example of this issue.
|
||||
* Please make sure to set parameter `s3ForcePathStyle=true`. The parameter is used to set the Velero integrated AWS SDK data query address style. There are two types of the address: [virtual-host and path-style](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html). If the `s3ForcePathStyle=true` is not set, the default value is false, then the AWS SDK will query in virtual-host style, but the MinIO server only support path-style address by default. The miss match will mean Velero can upload data to MinIO, but **cannot download from MinIO**. This [link](https://github.com/velero-io/velero/issues/7268) is an example of this issue.
|
||||
It can be resolved by two ways:
|
||||
* Set `s3ForcePathStyle=true` for parameter `--backup-location-config` when installing Velero. This is the preferred way.
|
||||
* Make MinIO server support virtual-host style address. Add the [MINIO_DOMAIN environment variable](https://min.io/docs/minio/linux/reference/minio-server/settings/core.html#id5) for MinIO server will do the magic.
|
||||
@@ -296,6 +296,6 @@ In this case:
|
||||
[3]: ../customize-installation.md
|
||||
[17]: ../file-system-backup.md
|
||||
[18]: ../debugging-restores.md
|
||||
[26]: https://github.com/vmware-tanzu/velero/releases
|
||||
[26]: https://github.com/velero-io/velero/releases
|
||||
[30]: https://godoc.org/github.com/robfig/cron
|
||||
[32]: ../self-signed-certificates.md
|
||||
|
||||
@@ -17,10 +17,10 @@ layout: docs
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest release](https://github.com/vmware-tanzu/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
1. Download the [latest release](https://github.com/velero-io/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
|
||||
```
|
||||
wget https://github.com/vmware-tanzu/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
wget https://github.com/velero-io/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
**NOTE:** Its strongly recommend that you use an official release 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!
|
||||
|
||||
@@ -67,7 +67,7 @@ On source cluster, Velero needs to manipulate CSI snapshots through the CSI volu
|
||||
|
||||
To integrate Velero with the CSI volume snapshot APIs, you must enable the `EnableCSI` feature flag.
|
||||
|
||||
From release-1.14, the `github.com/vmware-tanzu/velero-plugin-for-csi` repository, which is the Velero CSI plugin, is merged into the `github.com/vmware-tanzu/velero` repository.
|
||||
From release-1.14, the `github.com/vmware-tanzu/velero-plugin-for-csi` repository, which is the Velero CSI plugin, is merged into the `github.com/velero-io/velero` repository.
|
||||
The reasons to merge the CSI plugin are:
|
||||
* The VolumeSnapshot data mover depends on the CSI plugin, it's reasonabe to integrate them.
|
||||
* This change reduces the Velero deploying complexity.
|
||||
@@ -406,7 +406,7 @@ The `RestorePVC` serves as an intermediate Persistent Volume Claim (PVC) utilize
|
||||
Sometimes, `RestorePVC` needs to be configured to increase the performance of restore operations. [This document][19] outlines advanced configuration options for `RestorePVC`, allowing users to fine-tune access modes and storage class settings based on their storage provider's capabilities.
|
||||
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/pull/5968
|
||||
[1]: https://github.com/velero-io/velero/pull/5968
|
||||
[2]: csi.md
|
||||
[3]: file-system-backup.md
|
||||
[4]: https://kubernetes.io/blog/2020/12/10/kubernetes-1.20-volume-snapshot-moves-to-ga/
|
||||
@@ -422,7 +422,7 @@ Sometimes, `RestorePVC` needs to be configured to increase the performance of re
|
||||
[15]: data-movement-node-selection.md
|
||||
[16]: data-movement-backup-pvc-configuration.md
|
||||
[17]: backup-repository-configuration.md
|
||||
[18]: https://github.com/vmware-tanzu/velero/pull/7576
|
||||
[18]: https://github.com/velero-io/velero/pull/7576
|
||||
[19]: data-movement-restore-pvc-configuration.md
|
||||
[20]: node-agent-prepare-queue-length.md
|
||||
[21]: data-movement-cache-volume.md
|
||||
|
||||
@@ -8,7 +8,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. This page gives an overview of how to add support for CSI snapshots to Velero.
|
||||
|
||||
## Notice
|
||||
From release-1.14, the `github.com/vmware-tanzu/velero-plugin-for-csi` repository, which is the Velero CSI plugin, is merged into the `github.com/vmware-tanzu/velero` repository.
|
||||
From release-1.14, the `github.com/vmware-tanzu/velero-plugin-for-csi` repository, which is the Velero CSI plugin, is merged into the `github.com/velero-io/velero` repository.
|
||||
The reasons to merge the CSI plugin are:
|
||||
* The VolumeSnapshot data mover depends on the CSI plugin, it's reasonabe to integrate them.
|
||||
* This change reduces the Velero deploying complexity.
|
||||
@@ -130,7 +130,7 @@ The `DeletionPolicy` on the VolumeSnapshotContent will be the same as the `Delet
|
||||
|
||||
When the Velero backup expires, the VolumeSnapshot objects will be deleted and the VolumeSnapshotContent objects will be updated to have a `DeletionPolicy` of `Delete`, to free space on the storage system.
|
||||
|
||||
**Note:** The AWS, Microsoft Azure, and Google Cloud Platform (GCP) Velero plugins version 1.4 and later are able to snapshot and restore persistent volumes provisioned by a CSI driver via the APIs of the cloud provider, without having to install Velero CSI plugins. See the [AWS](https://github.com/vmware-tanzu/velero-plugin-for-aws), [Microsoft Azure](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure), and [Google Cloud Platform (GCP)](https://github.com/vmware-tanzu/velero-plugin-for-gcp) Velero plugin repo for more information on supported CSI drivers.
|
||||
**Note:** The AWS, Microsoft Azure, and Google Cloud Platform (GCP) Velero plugins version 1.4 and later are able to snapshot and restore persistent volumes provisioned by a CSI driver via the APIs of the cloud provider, without having to install Velero CSI plugins. See the [AWS](https://github.com/velero-io/velero-plugin-for-aws), [Microsoft Azure](https://github.com/velero-io/velero-plugin-for-microsoft-azure), and [Google Cloud Platform (GCP)](https://github.com/velero-io/velero-plugin-for-gcp) Velero plugin repo for more information on supported CSI drivers.
|
||||
From v1.14, no need to install the CSI plugin, because it is integrated into the Velero code base.
|
||||
|
||||
[1]: customize-installation.md#enable-server-side-features
|
||||
|
||||
@@ -47,7 +47,7 @@ When naming your plugin, keep in mind that the full name needs to conform to the
|
||||
- example-with-dash.io/azure
|
||||
```
|
||||
|
||||
You will need to give your plugin(s) the full name when registering them by calling the appropriate `RegisterX` function: <https://github.com/vmware-tanzu/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
You will need to give your plugin(s) the full name when registering them by calling the appropriate `RegisterX` function: <https://github.com/velero-io/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
|
||||
## Plugin Kinds
|
||||
|
||||
@@ -117,5 +117,5 @@ Once parsed into a `[]string`, the features can then be registered using the `Ne
|
||||
|
||||
Velero adds the `LD_LIBRARY_PATH` into the list of environment variables to provide the convenience for plugins that requires C libraries/extensions in the runtime.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero-plugin-example
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/logger.go
|
||||
[1]: https://github.com/velero-io/velero-plugin-example
|
||||
[2]: https://github.com/velero-io/velero/blob/main/pkg/plugin/logger.go
|
||||
|
||||
@@ -523,16 +523,16 @@ The new workflow is:
|
||||
```
|
||||
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/releases/latest
|
||||
[1]: https://github.com/velero-io/velero/releases/latest
|
||||
[2]: namespace.md
|
||||
[3]: file-system-backup.md
|
||||
[4]: on-premises.md
|
||||
[6]: velero-install.md#usage
|
||||
[7]: https://github.com/vmware-tanzu/velero/issues/2077
|
||||
[8]: https://github.com/vmware-tanzu/velero/issues/2311
|
||||
[7]: https://github.com/velero-io/velero/issues/2077
|
||||
[8]: https://github.com/velero-io/velero/issues/2311
|
||||
[9]: self-signed-certificates.md
|
||||
[10]: csi.md
|
||||
[11]: https://github.com/vmware-tanzu/velero/blob/main/pkg/apis/velero/v1/constants.go
|
||||
[11]: https://github.com/velero-io/velero/blob/main/pkg/apis/velero/v1/constants.go
|
||||
[12]: csi-snapshot-data-movement.md
|
||||
[13]: performance-guidance.md
|
||||
[14]: repository-maintenance.md
|
||||
|
||||
@@ -199,7 +199,7 @@ The other VGDP instances will run on nodes, which instance type is `Standard_B4m
|
||||
}
|
||||
```
|
||||
|
||||
Velero data mover supports to use different StorageClass to create backupPVC by [design](https://github.com/vmware-tanzu/velero/pull/7982).
|
||||
Velero data mover supports to use different StorageClass to create backupPVC by [design](https://github.com/velero-io/velero/pull/7982).
|
||||
|
||||
In this example, if the backup target PVC's StorageClass is `kibishii-storage-class`, its backupPVC should use StorageClass `worker-storagepolicy`. Because the final StorageClass is `worker-storagepolicy`, the backupPod uses the loadAffinity specified by `loadAffinity`'s elements with `StorageClass` field set to `worker-storagepolicy`. backupPod will be assigned to nodes, which instance type is `Standard_B2ms`.
|
||||
|
||||
|
||||
@@ -121,7 +121,7 @@ kubectl create cm node-agent-config -n velero --from-file=node-agent-config.json
|
||||
### Pod Labels
|
||||
Add customized labels for data mover pods to support third-party integrations and environment-specific requirements.
|
||||
|
||||
If `podLabels` is configured, it supersedes Velero's [in-tree third-party labels](https://github.com/vmware-tanzu/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L19-L21).
|
||||
If `podLabels` is configured, it supersedes Velero's [in-tree third-party labels](https://github.com/velero-io/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L19-L21).
|
||||
If `podLabels` is not configured, Velero uses the in-tree third-party labels for compatibility with common cloud providers and networking solutions.
|
||||
|
||||
The configurations work for DataUpload, DataDownload, PodVolumeBackup, and PodVolumeRestore pods.
|
||||
@@ -142,7 +142,7 @@ The configurations work for DataUpload, DataDownload, PodVolumeBackup, and PodVo
|
||||
### Pod Annotations
|
||||
Add customized annotations for data mover pods to support third-party integrations and pod-level configuration.
|
||||
|
||||
If `podAnnotations` is configured, it supersedes Velero's [in-tree third-party annotations](https://github.com/vmware-tanzu/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L23-L25).
|
||||
If `podAnnotations` is configured, it supersedes Velero's [in-tree third-party annotations](https://github.com/velero-io/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L23-L25).
|
||||
If `podAnnotations` is not configured, Velero uses the in-tree third-party annotations for compatibility with common cloud providers and networking solutions.
|
||||
|
||||
The configurations work for DataUpload, DataDownload, PodVolumeBackup, and PodVolumeRestore pods.
|
||||
|
||||
@@ -5,7 +5,7 @@ layout: docs
|
||||
|
||||
After you set up the Velero server, you can clone the examples used in the following sections by running the following:
|
||||
```
|
||||
git clone https://github.com/vmware-tanzu/velero.git
|
||||
git clone https://github.com/velero-io/velero.git
|
||||
cd velero
|
||||
```
|
||||
|
||||
|
||||
@@ -539,7 +539,7 @@ which is used to backup pod volume data
|
||||
the backup storage
|
||||
|
||||
For more details, refer to [kopia architecture](https://kopia.io/docs/advanced/architecture/) and
|
||||
Velero's [Unified Repository & Kopia Integration Design](https://github.com/vmware-tanzu/velero/blob/main/design/Implemented/unified-repo-and-kopia-integration/unified-repo-and-kopia-integration.md)
|
||||
Velero's [Unified Repository & Kopia Integration Design](https://github.com/velero-io/velero/blob/main/design/Implemented/unified-repo-and-kopia-integration/unified-repo-and-kopia-integration.md)
|
||||
|
||||
### Custom resource and controllers
|
||||
Velero has three custom resource definitions and associated controllers:
|
||||
@@ -745,7 +745,7 @@ Velero still effectively manage restic repository, though you cannot write any n
|
||||
[1]: https://github.com/restic/restic
|
||||
[2]: https://github.com/kopia/kopia
|
||||
[3]: customize-installation.md#enable-file-system-backup
|
||||
[4]: https://github.com/vmware-tanzu/velero/releases/
|
||||
[4]: https://github.com/velero-io/velero/releases/
|
||||
[5]: https://kubernetes.io/docs/concepts/storage/volumes/#local
|
||||
[6]: https://kubernetes.io/docs/concepts/storage/volumes/#mount-propagation
|
||||
[7]: https://github.com/bitsbeats/velero-pvc-watcher
|
||||
@@ -758,7 +758,7 @@ Velero still effectively manage restic repository, though you cannot write any n
|
||||
[14]: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/
|
||||
[15]: customize-installation.md#customize-resource-requests-and-limits
|
||||
[16]: performance-guidance.md
|
||||
[17]: https://github.com/vmware-tanzu/velero/blob/main/GOVERNANCE.md#deprecation-policy
|
||||
[17]: https://github.com/velero-io/velero/blob/main/GOVERNANCE.md#deprecation-policy
|
||||
[18]: backup-repository-configuration.md
|
||||
[19]: node-agent-concurrency.md
|
||||
[20]: node-agent-prepare-queue-length.md
|
||||
|
||||
@@ -9,7 +9,7 @@ This document describes Velero's image tagging policy.
|
||||
|
||||
`velero/velero:<SemVer>`
|
||||
|
||||
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, `velero/velero:v1.0.0`.
|
||||
Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/velero-io/velero` repository has a matching image, `velero/velero:v1.0.0`.
|
||||
|
||||
### Latest
|
||||
|
||||
|
||||
@@ -306,8 +306,8 @@ velero snapshot-location set <vsl-name> \
|
||||
|
||||
[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
|
||||
[3]: https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md
|
||||
[4]: https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md
|
||||
[5]: /plugins
|
||||
[6]: overview-plugins.md
|
||||
[7]: https://kubernetes.io/docs/concepts/configuration/secret/
|
||||
|
||||
@@ -4,7 +4,7 @@ layout: docs
|
||||
toc: "true"
|
||||
---
|
||||
|
||||
There are some guidelines maintainers need to follow. We list them here for quick reference, especially for new maintainers. These guidelines apply to all projects in the Velero org, including the main project, the Velero Helm chart, and all other [related repositories](https://github.com/vmware-tanzu/velero/blob/main/GOVERNANCE.md#code-repositories).
|
||||
There are some guidelines maintainers need to follow. We list them here for quick reference, especially for new maintainers. These guidelines apply to all projects in the Velero org, including the main project, the Velero Helm chart, and all other [related repositories](https://github.com/velero-io/velero/blob/main/GOVERNANCE.md#code-repositories).
|
||||
|
||||
Please be sure to also go through the guidance under the entire [Contribute](start-contributing/) section.
|
||||
|
||||
@@ -14,12 +14,12 @@ Please be sure to also go through the guidance under the entire [Contribute](sta
|
||||
- As you review a PR that is not yet ready to merge, please check if the "request review" needs to be refreshed for any reviewer (this is better than @mention at them)
|
||||
- Refrain from @mention other maintainers to review the PR unless it is an immediate need. All maintainers already get notified through the automated add to the "request review". If it is an urgent need, please add a helpful message as to why it is so people can properly prioritize work.
|
||||
- There is no need to manually request reviewers: after the PR is created, all maintainers will be automatically added to the list (note: feel free to remove people if they are on PTO, etc).
|
||||
- Be familiar with the [lazy consensus](https://github.com/vmware-tanzu/velero/blob/main/GOVERNANCE.md#lazy-consensus) policy for the project.
|
||||
- Be familiar with the [lazy consensus](https://github.com/velero-io/velero/blob/main/GOVERNANCE.md#lazy-consensus) policy for the project.
|
||||
|
||||
Some tips for doing reviews:
|
||||
- There are some [code standards and general guidelines](https://velero.io/docs/main/code-standards) we aim for
|
||||
- We have [guidelines for writing and reviewing documentation](https://velero.io/docs/main/style-guide/)
|
||||
- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/vmware-tanzu/velero/blob/main/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/vmware-tanzu/velero/tree/main/design/implemented) folder.
|
||||
- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/velero-io/velero/blob/main/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/velero-io/velero/tree/main/design/implemented) folder.
|
||||
|
||||
|
||||
## Creating a release
|
||||
@@ -34,4 +34,4 @@ Maintainers are expected to participate in the community support rotation. We ha
|
||||
Maintainers for the Velero project are highly involved with the open source community. All the online community meetings for the project are listed in our [community](community) page.
|
||||
|
||||
## How do I become a maintainer?
|
||||
The Velero project welcomes contributors of all kinds. We are also always on the look out for a high level of engagement from contributors and opportunities to bring in new maintainers. If this is of interest, take a look at how [adding a maintainer](https://github.com/vmware-tanzu/velero/blob/main/GOVERNANCE.md#maintainers) is decided.
|
||||
The Velero project welcomes contributors of all kinds. We are also always on the look out for a high level of engagement from contributors and opportunities to bring in new maintainers. If this is of interest, take a look at how [adding a maintainer](https://github.com/velero-io/velero/blob/main/GOVERNANCE.md#maintainers) is decided.
|
||||
|
||||
@@ -19,7 +19,7 @@ Before migrating you should consider the following,
|
||||
|
||||
## Migration Scenario
|
||||
|
||||
This scenario steps through the migration of resources from Cluster 1 to Cluster 2. In this scenario, both clusters are using the same cloud provider, AWS, and Velero's [AWS plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws).
|
||||
This scenario steps through the migration of resources from Cluster 1 to Cluster 2. In this scenario, both clusters are using the same cloud provider, AWS, and Velero's [AWS plugin](https://github.com/velero-io/velero-plugin-for-aws).
|
||||
|
||||
1. On Cluster 1, make sure Velero is installed and points to an object storage location using the `--bucket` flag.
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ After you publish your plugin on your own repository, open a PR that adds a link
|
||||
|
||||
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/
|
||||
[1]: https://github.com/velero-io/velero-plugin-example/
|
||||
[2]: custom-plugins.md
|
||||
[3]: supported-providers.md
|
||||
[4]: https://github.com/topics/velero-plugin
|
||||
|
||||
@@ -26,5 +26,5 @@ Plugins the Velero core team is responsible include all those listed in [the Vel
|
||||
1. If all e2e tests pass, go to the GitHub release page of the plugin (`https://github.com/vmware-tanzu/<plugin-name>/releases`) and manually create a release for the new tag.
|
||||
1. Copy and paste the content of the new changelog file into the release description field.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/blob/c8dfd648bbe85db0184ea53296de4220895497e6/test/e2e/velero_utils.go#L27
|
||||
[2]: https://github.com/vmware-tanzu/velero/tree/main/test/e2e
|
||||
[1]: https://github.com/velero-io/velero/blob/c8dfd648bbe85db0184ea53296de4220895497e6/test/e2e/velero_utils.go#L27
|
||||
[2]: https://github.com/velero-io/velero/tree/main/test/e2e
|
||||
|
||||
@@ -7,9 +7,9 @@ This page covers the steps to perform when releasing a new version of Velero.
|
||||
|
||||
## General notes
|
||||
- Please read the documented variables in each script to understand what they are for and how to properly format their values.
|
||||
- You will need to have an upstream remote configured to use to the [vmware-tanzu/velero](https://github.com/vmware-tanzu/velero) repository.
|
||||
- You will need to have an upstream remote configured to use to the [velero-io/velero](https://github.com/velero-io/velero) repository.
|
||||
You can check this using `git remote -v`.
|
||||
The release script ([`tag-release.sh`](https://github.com/vmware-tanzu/velero/blob/main/hack/release-tools/tag-release.sh)) will use `upstream` as the default remote name if it is not specified using the environment variable `REMOTE`.
|
||||
The release script ([`tag-release.sh`](https://github.com/velero-io/velero/blob/main/hack/release-tools/tag-release.sh)) will use `upstream` as the default remote name if it is not specified using the environment variable `REMOTE`.
|
||||
- GA release: major and minor releases only. Example: 1.0 (major), 1.5 (minor).
|
||||
- Pre-releases: Any release leading up to a GA. Example: 1.4.0-beta.1, 1.5.0-rc.1
|
||||
- RC releases: Release Candidate, contains everything that is supposed to ship with the GA release. This is still a pre-release.
|
||||
@@ -77,7 +77,7 @@ For each major or minor release, create and publish a blog post to let folks kno
|
||||
- Remove the pre-release docs table of contents mapping entry from `site/data/toc-mapping.yml`.
|
||||
- Remove all references to the pre-release docs from `site/config.yml`.
|
||||
1. Create the "Upgrade to $major.minor" page if it does not already exist ([example](https://velero.io/docs/v1.5/upgrade-to-1.5/)).
|
||||
If it already exists, update any usage of the previous version string within this file to use the new version string instead ([example](https://github.com/vmware-tanzu/velero/pull/2941/files#diff-d594f8fd0901fed79c39aab4b348193d)).
|
||||
If it already exists, update any usage of the previous version string within this file to use the new version string instead ([example](https://github.com/velero-io/velero/pull/2941/files#diff-d594f8fd0901fed79c39aab4b348193d)).
|
||||
This needs to be done in both the versioned and the `main` folders.
|
||||
1. Review and submit PR
|
||||
- Follow the additional instructions at `site/README-HUGO.md` to complete the docs generation process.
|
||||
@@ -88,7 +88,7 @@ For each major or minor release, create and publish a blog post to let folks kno
|
||||
The image of velero is built based on [Distroless docker image](https://github.com/GoogleContainerTools/distroless).
|
||||
For the reproducibility of the release, before the release candidate is tagged, we need to make sure the in the Dockerfile
|
||||
on the release branch, the base image is referenced by digest, such as
|
||||
https://github.com/vmware-tanzu/velero/blob/release-1.7/Dockerfile#L53-L54
|
||||
https://github.com/velero-io/velero/blob/release-1.7/Dockerfile#L53-L54
|
||||
|
||||
## Velero release
|
||||
### Notes
|
||||
@@ -108,11 +108,11 @@ https://github.com/vmware-tanzu/velero/blob/release-1.7/Dockerfile#L53-L54
|
||||
1. Create a tagged release and push it to GitHub
|
||||
- Run `VELERO_VERSION=v1.9.0-rc.1 REMOTE=<upstream-remote> GITHUB_TOKEN=REDACTED ON_RELEASE_BRANCH=TRUE ./hack/release-tools/tag-release.sh publish`.
|
||||
1. Publish the release
|
||||
- Navigate to the draft GitHub release at https://github.com/vmware-tanzu/velero/releases and edit the release.
|
||||
- Navigate to the draft GitHub release at https://github.com/velero-io/velero/releases and edit the release.
|
||||
- If this is a patch release (e.g. `v1.9.1`), note that the full `CHANGELOG-1.9.md` contents will be included in the body of the GitHub release. You need to delete the previous releases' content (e.g. `v1.9.0`'s changelog) so that only the latest patch release's changelog shows.
|
||||
- Do a quick review for formatting.
|
||||
- **Note:** the `goreleaser` process should have detected if it's a pre-release version and, if so, checked the box at the bottom of the GitHub release page appropriately, but it's always worth double-checking.
|
||||
- Verify that GitHub has built and pushed all the images (it takes a while): https://github.com/vmware-tanzu/velero/actions
|
||||
- Verify that GitHub has built and pushed all the images (it takes a while): https://github.com/velero-io/velero/actions
|
||||
- Verify that the images are on Docker Hub: https://hub.docker.com/r/velero/velero/tags
|
||||
- Verify that the assets were published to the GitHub release
|
||||
- Publish the release.
|
||||
@@ -176,4 +176,4 @@ What to include:
|
||||
|
||||
[1]: https://velero.io/blog
|
||||
[2]: website-guidelines.md
|
||||
[3]: https://github.com/vmware-tanzu/velero/tree/main/test/e2e
|
||||
[3]: https://github.com/velero-io/velero/tree/main/test/e2e
|
||||
|
||||
@@ -200,5 +200,5 @@ Note that priority class configuration is only read from the global configuratio
|
||||
[1]: velero-install.md#usage
|
||||
[2]: node-agent-concurrency.md
|
||||
[3]: backup-repository-configuration.md#full-maintenance-interval-customization
|
||||
[4]: https://github.com/vmware-tanzu/velero/blob/d5a2e7e6b9512e8ba52ec269ed5ce9a0fa23548c/pkg/util/third_party.go#L19-L21
|
||||
[5]: https://github.com/vmware-tanzu/velero/blob/d5a2e7e6b9512e8ba52ec269ed5ce9a0fa23548c/pkg/util/third_party.go#L23-L25
|
||||
[4]: https://github.com/velero-io/velero/blob/d5a2e7e6b9512e8ba52ec269ed5ce9a0fa23548c/pkg/util/third_party.go#L19-L21
|
||||
[5]: https://github.com/velero-io/velero/blob/d5a2e7e6b9512e8ba52ec269ed5ce9a0fa23548c/pkg/util/third_party.go#L23-L25
|
||||
|
||||
@@ -217,7 +217,7 @@ data:
|
||||
|
||||
Velero removes PVC's `volume.kubernetes.io/selected-node` annotation during restore, so that the restored PVC could be provisioned appropriately according to ```WaitForFirstConsumer``` rules, storage topologies and the restored pod's schedule result, etc.
|
||||
|
||||
For more information of how this selected-node annotation matters to PVC restore, see issue https://github.com/vmware-tanzu/velero/issues/9053.
|
||||
For more information of how this selected-node annotation matters to PVC restore, see issue https://github.com/velero-io/velero/issues/9053.
|
||||
|
||||
## Restoring into a different namespace
|
||||
|
||||
|
||||
@@ -144,7 +144,7 @@ You will need to change this setting on the server to make it work.
|
||||
|
||||
**Note:** The `--insecure-skip-tls-verify` flag is insecure and susceptible to man-in-the-middle attacks and meant to help your testing and developing scenarios in an on-premises environment. Using this flag in production is not recommended.
|
||||
|
||||
Velero provides a way for you to skip TLS verification on the object store when using the [AWS provider plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) or [File System Backup](file-system-backup.md) by passing the `--insecure-skip-tls-verify` flag with the following Velero commands,
|
||||
Velero provides a way for you to skip TLS verification on the object store when using the [AWS provider plugin](https://github.com/velero-io/velero-plugin-for-aws) or [File System Backup](file-system-backup.md) by passing the `--insecure-skip-tls-verify` flag with the following Velero commands,
|
||||
|
||||
* velero backup describe
|
||||
* velero backup download
|
||||
|
||||
@@ -16,7 +16,7 @@ To make a design pull request, you can copy the template found in the `design/_t
|
||||
|
||||
## 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.
|
||||
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/velero-io/velero/pulls?q=is%3Aopen+is%3Apr+label%3ADesign. Feel free to review and help us with your input.
|
||||
|
||||
You can also vote on issues using :+1: and :-1:, as explained in our [Feature enhancement request][3] and [Bug issue][4] templates. This will help us quantify importance and prioritize issues.
|
||||
|
||||
@@ -28,7 +28,7 @@ Please browse our list of resources, including a playlist of past online communi
|
||||
|
||||
If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under `Contribute`.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/blob/main/CODE_OF_CONDUCT.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/main/CONTRIBUTING.md
|
||||
[3]: https://github.com/vmware-tanzu/velero/blob/main/.github/ISSUE_TEMPLATE/feature-enhancement-request.md
|
||||
[4]: https://github.com/vmware-tanzu/velero/blob/main/.github/ISSUE_TEMPLATE/bug_report.md
|
||||
[1]: https://github.com/velero-io/velero/blob/main/CODE_OF_CONDUCT.md
|
||||
[2]: https://github.com/velero-io/velero/blob/main/CONTRIBUTING.md
|
||||
[3]: https://github.com/velero-io/velero/blob/main/.github/ISSUE_TEMPLATE/feature-enhancement-request.md
|
||||
[4]: https://github.com/velero-io/velero/blob/main/.github/ISSUE_TEMPLATE/bug_report.md
|
||||
|
||||
@@ -6,7 +6,7 @@ layout: docs
|
||||
|
||||
Velero provides best effort support through the process on this page for the current version of Velero and n-1 Velero version, including all patch releases in the supported minor releases. For example, if the current version is 1.9, the Velero maintainers would offer best effort support for v1.9 and v1.8. If you have a question about a previous Velero version (for example, 1.7), please note that maintainers may ask you to upgrade to a supported version before doing any investigation into your issue.
|
||||
|
||||
For more information about Velero testing and supported Kubernetes versions, see Velero's [compatibility matrix](https://github.com/vmware-tanzu/velero/blob/main/README.md#velero-compatibility-matrix).
|
||||
For more information about Velero testing and supported Kubernetes versions, see Velero's [compatibility matrix](https://github.com/velero-io/velero/blob/main/README.md#velero-compatibility-matrix).
|
||||
|
||||
|
||||
## Weekly Rotation
|
||||
|
||||
@@ -432,7 +432,7 @@ For detailed information, see [Cache PVC Configuration for Data Movement Restore
|
||||
|
||||
Add customized labels for data mover pods to support third-party integrations and environment-specific requirements.
|
||||
|
||||
If `podLabels` is configured, it supersedes Velero's [in-tree third-party labels](https://github.com/vmware-tanzu/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L19-L21).
|
||||
If `podLabels` is configured, it supersedes Velero's [in-tree third-party labels](https://github.com/velero-io/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L19-L21).
|
||||
If `podLabels` is not configured, Velero uses the in-tree third-party labels for compatibility with common cloud providers and networking solutions.
|
||||
|
||||
The configurations work for DataUpload, DataDownload, PodVolumeBackup, and PodVolumeRestore pods.
|
||||
@@ -465,7 +465,7 @@ The configurations work for DataUpload, DataDownload, PodVolumeBackup, and PodVo
|
||||
|
||||
Add customized annotations for data mover pods to support third-party integrations and pod-level configuration.
|
||||
|
||||
If `podAnnotations` is configured, it supersedes Velero's [in-tree third-party annotations](https://github.com/vmware-tanzu/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L23-L25).
|
||||
If `podAnnotations` is configured, it supersedes Velero's [in-tree third-party annotations](https://github.com/velero-io/velero/blob/94f64639cee09c5caaa65b65ab5f42175f41c101/pkg/util/third_party.go#L23-L25).
|
||||
If `podAnnotations` is not configured, Velero uses the in-tree third-party annotations for compatibility with common cloud providers and networking solutions.
|
||||
|
||||
The configurations work for DataUpload, DataDownload, PodVolumeBackup, and PodVolumeRestore pods.
|
||||
|
||||
@@ -11,13 +11,13 @@ Velero supports a variety of storage providers for different backup and snapshot
|
||||
|
||||
| Provider | Object Store | Volume Snapshotter | Plugin Provider Repo | Setup Instructions | Parameters |
|
||||
|-----------------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-----------------------------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Amazon Web Services (AWS)](https://aws.amazon.com) | AWS S3 | AWS EBS | [Velero plugin for AWS](https://github.com/vmware-tanzu/velero-plugin-for-aws) | [AWS Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-aws#setup) | [BackupStorageLocation](https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/volumesnapshotlocation.md) |
|
||||
| [Google Cloud Platform (GCP)](https://cloud.google.com) | [Google Cloud Storage](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) | [Google Compute Engine Disks](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) | [Velero plugin for GCP](https://github.com/vmware-tanzu/velero-plugin-for-gcp) | [GCP Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-gcp#setup) | [BackupStorageLocation](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) |
|
||||
| [Microsoft Azure](https://azure.com) | Azure Blob Storage | Azure Managed Disks | [Velero plugin for Microsoft Azure](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure) | [Azure Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure#setup) | [BackupStorageLocation](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md) |
|
||||
| [VMware vSphere](https://www.vmware.com/ca/products/vsphere.html) | 🚫 | vSphere Volumes | [VMware vSphere](https://github.com/vmware-tanzu/velero-plugin-for-vsphere) | [vSphere Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-vsphere#velero-plugin-for-vsphere-installation-and-configuration-details) | 🚫 |
|
||||
| [Amazon Web Services (AWS)](https://aws.amazon.com) | AWS S3 | AWS EBS | [Velero plugin for AWS](https://github.com/velero-io/velero-plugin-for-aws) | [AWS Plugin Setup](https://github.com/velero-io/velero-plugin-for-aws#setup) | [BackupStorageLocation](https://github.com/velero-io/velero-plugin-for-aws/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/velero-io/velero-plugin-for-aws/blob/main/volumesnapshotlocation.md) |
|
||||
| [Google Cloud Platform (GCP)](https://cloud.google.com) | [Google Cloud Storage](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) | [Google Compute Engine Disks](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) | [Velero plugin for GCP](https://github.com/velero-io/velero-plugin-for-gcp) | [GCP Plugin Setup](https://github.com/velero-io/velero-plugin-for-gcp#setup) | [BackupStorageLocation](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) |
|
||||
| [Microsoft Azure](https://azure.com) | Azure Blob Storage | Azure Managed Disks | [Velero plugin for Microsoft Azure](https://github.com/velero-io/velero-plugin-for-microsoft-azure) | [Azure Plugin Setup](https://github.com/velero-io/velero-plugin-for-microsoft-azure#setup) | [BackupStorageLocation](https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md) |
|
||||
| [VMware vSphere](https://www.vmware.com/ca/products/vsphere.html) | 🚫 | vSphere Volumes | [VMware vSphere](https://github.com/velero-io/velero-plugin-for-vsphere) | [vSphere Plugin Setup](https://github.com/velero-io/velero-plugin-for-vsphere#velero-plugin-for-vsphere-installation-and-configuration-details) | 🚫 |
|
||||
{{< /table >}}
|
||||
|
||||
Contact: [#Velero Slack](https://kubernetes.slack.com/messages/velero), [GitHub Issues](https://github.com/vmware-tanzu/velero/issues)
|
||||
Contact: [#Velero Slack](https://kubernetes.slack.com/messages/velero), [GitHub Issues](https://github.com/velero-io/velero/issues)
|
||||
|
||||
## Provider plugins maintained by the Velero community
|
||||
{{< table caption="Community supported providers" >}}
|
||||
@@ -62,9 +62,9 @@ In the case you want to take volume snapshots but didn't find a plugin for your
|
||||
[3]: contributions/minio.md
|
||||
[4]: https://github.com/StackPointCloud/ark-plugin-digitalocean
|
||||
[5]: http://www.noobaa.com/
|
||||
[6]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/backupstoragelocation.md
|
||||
[6]: https://github.com/velero-io/velero-plugin-for-aws/blob/main/backupstoragelocation.md
|
||||
[7]: contributions/tencent-config.md
|
||||
[25]: https://github.com/hpe-storage/velero-plugin
|
||||
[30]: file-system-backup.md
|
||||
[36]: https://github.com/vmware-tanzu/velero-plugin-for-gcp#setup
|
||||
[36]: https://github.com/velero-io/velero-plugin-for-gcp#setup
|
||||
[38]: https://www.cloudian.com/
|
||||
|
||||
@@ -21,7 +21,7 @@ files in this directory are gitignored so you may configure your setup according
|
||||
1. [Docker](https://docs.docker.com/install/) v19.03 or newer
|
||||
1. A Kubernetes cluster v1.16 or greater (does not have to be Kind)
|
||||
1. [Tilt](https://docs.tilt.dev/install.html) v0.12.0 or newer
|
||||
1. Clone the [Velero project](https://github.com/vmware-tanzu/velero) repository
|
||||
1. Clone the [Velero project](https://github.com/velero-io/velero) repository
|
||||
locally
|
||||
1. Access to an S3 object storage
|
||||
1. Clone any [provider plugin(s)](https://velero.io/plugins/) you want to make changes to and deploy (optional, must be configured to be deployed by the Velero Tilt's setup, [more info below](#provider-plugins))
|
||||
@@ -114,7 +114,7 @@ Below are some ways to configure a backup storage location for Velero.
|
||||
Follow the provider documentation to provision the storage. We have a [list of all known object storage providers](supported-providers/) with corresponding plugins for Velero.
|
||||
|
||||
#### Using MinIO as an object storage
|
||||
Note: to use MinIO as an object storage, you will need to use the [`AWS` plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws), and configure the storage location with the `spec.provider` set to `aws` and the `spec.config.region` set to `minio`. Example:
|
||||
Note: to use MinIO as an object storage, you will need to use the [`AWS` plugin](https://github.com/velero-io/velero-plugin-for-aws), and configure the storage location with the `spec.provider` set to `aws` and the `spec.config.region` set to `minio`. Example:
|
||||
```
|
||||
spec:
|
||||
config:
|
||||
@@ -140,7 +140,7 @@ necessary to expose MinIO outside the cluster.
|
||||
|
||||
1) As a standalone MinIO instance running locally in a Docker container
|
||||
|
||||
See [these instructions](https://github.com/vmware-tanzu/velero/discussions/3381) to run MinIO locally on your computer, as a standalone as opposed to running it on a Pod.
|
||||
See [these instructions](https://github.com/velero-io/velero/discussions/3381) to run MinIO locally on your computer, as a standalone as opposed to running it on a Pod.
|
||||
|
||||
Please see our [locations documentation](locations/) to learn more how backup locations work.
|
||||
|
||||
|
||||
@@ -235,12 +235,12 @@ If the ownership conflict error(`maintenance must be run by designated user`) al
|
||||
Velero doesn't handle the conflict by design.
|
||||
To resolve it, please use Kopia maintenance CLI to set the ownership correctly, e.g. `kopia maintenance set --owner=default@default`.
|
||||
|
||||
Please refer to [Issue 9007](https://github.com/vmware-tanzu/velero/issues/9007) for more information.
|
||||
Please refer to [Issue 9007](https://github.com/velero-io/velero/issues/9007) for more information.
|
||||
|
||||
[1]: debugging-restores.md
|
||||
[2]: debugging-install.md
|
||||
[3]: file-system-backup.md
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[4]: https://github.com/velero-io/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
|
||||
|
||||
@@ -20,7 +20,7 @@ If you're not yet running at least Velero v1.17, see the following:
|
||||
- [Upgrading to v1.16][9]
|
||||
- [Upgrading to v1.17][10]
|
||||
|
||||
Before upgrading, check the [Velero compatibility matrix](https://github.com/vmware-tanzu/velero#velero-compatibility-matrix) to make sure your version of Kubernetes is supported by the new version of Velero.
|
||||
Before upgrading, check the [Velero compatibility matrix](https://github.com/velero-io/velero#velero-compatibility-matrix) to make sure your version of Kubernetes is supported by the new version of Velero.
|
||||
|
||||
## Instructions
|
||||
|
||||
|
||||
@@ -57,14 +57,14 @@ Feedback and discussion are available on [the mailing list][24].
|
||||
|
||||
See [the list of releases][6] to find out about feature changes.
|
||||
|
||||
[1]: https://travis-ci.org/vmware-tanzu/velero.svg?branch=main
|
||||
[2]: https://travis-ci.org/vmware-tanzu/velero
|
||||
[1]: https://travis-ci.org/velero-io/velero.svg?branch=main
|
||||
[2]: https://travis-ci.org/velero-io/velero
|
||||
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[5]: https://github.com/vmware-tanzu/velero/blob/main/CONTRIBUTING.md
|
||||
[6]: https://github.com/vmware-tanzu/velero/releases
|
||||
[4]: https://github.com/velero-io/velero/issues
|
||||
[5]: https://github.com/velero-io/velero/blob/main/CONTRIBUTING.md
|
||||
[6]: https://github.com/velero-io/velero/releases
|
||||
|
||||
[8]: https://github.com/vmware-tanzu/velero/blob/main/CODE_OF_CONDUCT.md
|
||||
[8]: https://github.com/velero-io/velero/blob/main/CODE_OF_CONDUCT.md
|
||||
[9]: https://kubernetes.io/docs/setup/
|
||||
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
|
||||
[11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
|
||||
|
||||
@@ -14,9 +14,9 @@ If you do not have the `aws` CLI locally installed, follow the [user guide][5] t
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -25,9 +25,9 @@ consider using Premium Managed Disks, which are SSD backed.
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ layout: docs
|
||||
```bash
|
||||
mkdir $HOME/go
|
||||
export GOPATH=$HOME/go
|
||||
go get github.com/vmware-tanzu/velero
|
||||
go get github.com/velero-io/velero
|
||||
```
|
||||
|
||||
Where `go` is your [import path][4] for Go.
|
||||
@@ -32,7 +32,7 @@ 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`.
|
||||
Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/velero-io/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.
|
||||
|
||||
@@ -235,13 +235,13 @@ If you need to add or update the vendored dependencies, see [Vendoring dependenc
|
||||
[3]: #build
|
||||
[4]: https://blog.golang.org/organizing-go-code
|
||||
[5]: https://golang.org/doc/install
|
||||
[6]: https://github.com/vmware-tanzu/velero/tree/main/examples
|
||||
[6]: https://github.com/velero-io/velero/tree/main/examples
|
||||
[7]: #run
|
||||
[8]: config-definition.md
|
||||
[10]: #vendoring-dependencies
|
||||
[11]: vendoring-dependencies.md
|
||||
[12]: #test
|
||||
[13]: https://github.com/vmware-tanzu/velero/blob/main/hack/generate-proto.sh
|
||||
[13]: https://github.com/velero-io/velero/blob/main/hack/generate-proto.sh
|
||||
[14]: https://grpc.io/docs/quickstart/go.html#install-protocol-buffers-v3
|
||||
[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
|
||||
@@ -250,4 +250,4 @@ If you need to add or update the vendored dependencies, see [Vendoring dependenc
|
||||
[19]: ../examples/README.md
|
||||
[20]: api-types/backupstoragelocation.md
|
||||
[21]: api-types/volumesnapshotlocation.md
|
||||
[22]: https://github.com/vmware-tanzu/velero/releases
|
||||
[22]: https://github.com/velero-io/velero/releases
|
||||
|
||||
@@ -25,7 +25,7 @@ Examples of cases where Velero is useful:
|
||||
|
||||
Yes, with some exceptions. For example, when Velero 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/vmware-tanzu/velero/blob/main/pkg/restore/pod_action.go)
|
||||
in [pod_action.go](https://github.com/velero-io/velero/blob/main/pkg/restore/pod_action.go)
|
||||
|
||||
## I'm using Velero in multiple clusters. Should I use the same bucket to store all of my backups?
|
||||
|
||||
|
||||
@@ -12,9 +12,9 @@ If you do not have the `gcloud` and `gsutil` CLIs locally installed, follow the
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -22,9 +22,9 @@ If you encounter issues with installing or configuring, see [Debugging Installat
|
||||
|
||||
### Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
@@ -268,6 +268,6 @@ In this case:
|
||||
[3]: install-overview.md
|
||||
[17]: restic.md
|
||||
[18]: debugging-restores.md
|
||||
[26]: https://github.com/vmware-tanzu/velero/releases
|
||||
[26]: https://github.com/velero-io/velero/releases
|
||||
[30]: https://godoc.org/github.com/robfig/cron
|
||||
[31]: #expose-minio-outside-your-cluster
|
||||
|
||||
@@ -80,5 +80,5 @@ velero backup logs nginx-hook-test | grep hookCommand
|
||||
|
||||
|
||||
[1]: api-types/backup.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.0.0/examples/nginx-app/with-pv.yaml
|
||||
[2]: https://github.com/velero-io/velero/blob/v1.0.0/examples/nginx-app/with-pv.yaml
|
||||
[3]: cloud-common.md
|
||||
|
||||
@@ -14,9 +14,9 @@ To set up IBM Cloud Object Storage (COS) as Velero's destination, you:
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This document describes Velero's image tagging policy.
|
||||
|
||||
`gcr.io/heptio-images/velero:<SemVer>`
|
||||
|
||||
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. `gcr.io/heptio-images/velero:v1.0.0`.
|
||||
Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/velero-io/velero` repository has a matching image, e.g. `gcr.io/heptio-images/velero:v1.0.0`.
|
||||
|
||||
### Latest
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ kubectl scale --namespace heptio-ark deployment/ark --replicas 0
|
||||
ARCH="amd64"
|
||||
|
||||
# Download the velero client/example tarball to and unpack
|
||||
curl -L https://github.com/vmware-tanzu/velero/releases/download/v0.11.0/velero-v0.11.0-${OS}-${ARCH}.tar.gz --output velero-v0.11.0-${OS}-${ARCH}.tar.gz
|
||||
curl -L https://github.com/velero-io/velero/releases/download/v0.11.0/velero-v0.11.0-${OS}-${ARCH}.tar.gz --output velero-v0.11.0-${OS}-${ARCH}.tar.gz
|
||||
tar xvf velero-v0.11.0-${OS}-${ARCH}.tar.gz
|
||||
|
||||
# Create the prerequisite CRDs and namespace
|
||||
|
||||
@@ -17,10 +17,10 @@ layout: docs
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest release](https://github.com/vmware-tanzu/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
1. Download the [latest release](https://github.com/velero-io/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
|
||||
```
|
||||
wget https://github.com/vmware-tanzu/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
wget https://github.com/velero-io/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
*We strongly recommend that you use an official release 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!*
|
||||
|
||||
@@ -25,7 +25,7 @@ When naming your plugin, keep in mind that the name needs to conform to these ru
|
||||
- example-with-dash.io/azure
|
||||
```
|
||||
|
||||
You will need to give your plugin(s) a name when registering them by calling the appropriate `RegisterX` function: <https://github.com/vmware-tanzu/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
You will need to give your plugin(s) a name when registering them by calling the appropriate `RegisterX` function: <https://github.com/velero-io/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
|
||||
## Plugin Kinds
|
||||
|
||||
@@ -80,6 +80,6 @@ Then, in your plugin's implementation, you can read this ConfigMap to fetch the
|
||||
for an example of this -- in particular, the `getPluginConfig(...)` function.
|
||||
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero-plugin-example
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/logger.go
|
||||
[3]: https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restic_restore_action.go
|
||||
[1]: https://github.com/velero-io/velero-plugin-example
|
||||
[2]: https://github.com/velero-io/velero/blob/main/pkg/plugin/logger.go
|
||||
[3]: https://github.com/velero-io/velero/blob/main/pkg/restore/restic_restore_action.go
|
||||
|
||||
@@ -330,7 +330,7 @@ on to running other init containers/the main containers.
|
||||
|
||||
[1]: https://github.com/restic/restic
|
||||
[2]: install-overview.md
|
||||
[3]: https://github.com/vmware-tanzu/velero/releases/
|
||||
[3]: https://github.com/velero-io/velero/releases/
|
||||
[4]: https://kubernetes.io/docs/concepts/storage/volumes/#local
|
||||
[5]: http://restic.readthedocs.io/en/latest/100_references.html#terminology
|
||||
[6]: https://kubernetes.io/docs/concepts/storage/volumes/#mount-propagation
|
||||
|
||||
@@ -60,10 +60,10 @@ After you publish your plugin, open a PR that adds your plugin to the appropriat
|
||||
[5]: ibm-config.md
|
||||
[6]: https://docs.portworx.com/scheduler/kubernetes/ark.html
|
||||
[7]: https://github.com/StackPointCloud/ark-plugin-digitalocean
|
||||
[8]: https://github.com/vmware-tanzu/velero-plugin-example/
|
||||
[8]: https://github.com/velero-io/velero-plugin-example/
|
||||
[9]: get-started.md
|
||||
[10]: https://kubernetes.slack.com/messages/velero
|
||||
[11]: https://github.com/vmware-tanzu/velero/issues
|
||||
[11]: https://github.com/velero-io/velero/issues
|
||||
[12]: https://github.com/aws/aws-sdk-go
|
||||
[13]: https://portworx.slack.com/messages/px-k8s
|
||||
[14]: https://github.com/portworx/ark-plugin/issues
|
||||
|
||||
@@ -73,6 +73,6 @@ Backups in the `InProgress` phase have not uploaded any files to object storage.
|
||||
|
||||
[1]: debugging-restores.md
|
||||
[2]: debugging-install.md
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[4]: https://github.com/velero-io/velero/issues
|
||||
[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
||||
[25]: https://kubernetes.slack.com/messages/velero
|
||||
|
||||
@@ -143,5 +143,5 @@ _*backups created prior to v0.10 stored snapshot metadata in the `status.volumeB
|
||||
```
|
||||
|
||||
[0]: https://velero.io/docs/v0.11.0/migrating-to-velero
|
||||
[1]: https://github.com/vmware-tanzu/velero/releases/tag/v0.11.1
|
||||
[2]: https://github.com/vmware-tanzu/velero/releases/tag/v1.0.0
|
||||
[1]: https://github.com/velero-io/velero/releases/tag/v0.11.1
|
||||
[2]: https://github.com/velero-io/velero/releases/tag/v1.0.0
|
||||
|
||||
@@ -45,11 +45,11 @@ If you are ready to jump in and test, add code, or help with documentation, foll
|
||||
|
||||
See [the list of releases][6] to find out about feature changes.
|
||||
|
||||
[1]: https://travis-ci.org/vmware-tanzu/velero.svg?branch=main
|
||||
[2]: https://travis-ci.org/vmware-tanzu/velero
|
||||
[1]: https://travis-ci.org/velero-io/velero.svg?branch=main
|
||||
[2]: https://travis-ci.org/velero-io/velero
|
||||
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[6]: https://github.com/vmware-tanzu/velero/releases
|
||||
[4]: https://github.com/velero-io/velero/issues
|
||||
[6]: https://github.com/velero-io/velero/releases
|
||||
|
||||
[9]: https://kubernetes.io/docs/setup/
|
||||
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
|
||||
|
||||
@@ -14,9 +14,9 @@ If you do not have the `aws` CLI locally installed, follow the [user guide][5] t
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -25,9 +25,9 @@ consider using Premium Managed Disks, which are SSD backed.
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ layout: docs
|
||||
```bash
|
||||
mkdir $HOME/go
|
||||
export GOPATH=$HOME/go
|
||||
go get github.com/vmware-tanzu/velero
|
||||
go get github.com/velero-io/velero
|
||||
```
|
||||
|
||||
Where `go` is your [import path][4] for Go.
|
||||
@@ -26,7 +26,7 @@ For Go development, it is recommended to add the Go import path (`$HOME/go` in t
|
||||
|
||||
### 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`.
|
||||
Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/velero-io/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.
|
||||
|
||||
@@ -100,4 +100,4 @@ 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
|
||||
[22]: https://github.com/velero-io/velero/releases
|
||||
|
||||
@@ -34,5 +34,5 @@ To run unit tests, use `make test`.
|
||||
If you need to add or update the vendored dependencies, see [Vendoring dependencies][11].
|
||||
|
||||
[11]: vendoring-dependencies.md
|
||||
[13]: https://github.com/vmware-tanzu/velero/blob/main/hack/generate-proto.sh
|
||||
[13]: https://github.com/velero-io/velero/blob/main/hack/generate-proto.sh
|
||||
[14]: https://grpc.io/docs/quickstart/go.html#install-protocol-buffers-v3
|
||||
|
||||
@@ -25,7 +25,7 @@ Examples of cases where Velero is useful:
|
||||
|
||||
Yes, with some exceptions. For example, when Velero 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/vmware-tanzu/velero/blob/v1.1.0/pkg/restore/pod_action.go)
|
||||
in [pod_action.go](https://github.com/velero-io/velero/blob/v1.1.0/pkg/restore/pod_action.go)
|
||||
|
||||
## I'm using Velero in multiple clusters. Should I use the same bucket to store all of my backups?
|
||||
|
||||
|
||||
@@ -12,9 +12,9 @@ If you do not have the `gcloud` and `gsutil` CLIs locally installed, follow the
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -22,9 +22,9 @@ If you encounter issues with installing or configuring, see [Debugging Installat
|
||||
|
||||
### Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
@@ -268,6 +268,6 @@ In this case:
|
||||
[3]: install-overview.md
|
||||
[17]: restic.md
|
||||
[18]: debugging-restores.md
|
||||
[26]: https://github.com/vmware-tanzu/velero/releases
|
||||
[26]: https://github.com/velero-io/velero/releases
|
||||
[30]: https://godoc.org/github.com/robfig/cron
|
||||
[31]: #expose-minio-outside-your-cluster
|
||||
|
||||
@@ -80,5 +80,5 @@ velero backup logs nginx-hook-test | grep hookCommand
|
||||
|
||||
|
||||
[1]: api-types/backup.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.1.0/examples/nginx-app/with-pv.yaml
|
||||
[2]: https://github.com/velero-io/velero/blob/v1.1.0/examples/nginx-app/with-pv.yaml
|
||||
[3]: cloud-common.md
|
||||
|
||||
@@ -14,9 +14,9 @@ To set up IBM Cloud Object Storage (COS) as Velero's destination, you:
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This document describes Velero's image tagging policy.
|
||||
|
||||
`gcr.io/heptio-images/velero:<SemVer>`
|
||||
|
||||
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. `gcr.io/heptio-images/velero:v1.0.0`.
|
||||
Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/velero-io/velero` repository has a matching image, e.g. `gcr.io/heptio-images/velero:v1.0.0`.
|
||||
|
||||
### Latest
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ kubectl scale --namespace heptio-ark deployment/ark --replicas 0
|
||||
ARCH="amd64"
|
||||
|
||||
# Download the velero client/example tarball to and unpack
|
||||
curl -L https://github.com/vmware-tanzu/velero/releases/download/v0.11.0/velero-v0.11.0-${OS}-${ARCH}.tar.gz --output velero-v0.11.0-${OS}-${ARCH}.tar.gz
|
||||
curl -L https://github.com/velero-io/velero/releases/download/v0.11.0/velero-v0.11.0-${OS}-${ARCH}.tar.gz --output velero-v0.11.0-${OS}-${ARCH}.tar.gz
|
||||
tar xvf velero-v0.11.0-${OS}-${ARCH}.tar.gz
|
||||
|
||||
# Create the prerequisite CRDs and namespace
|
||||
|
||||
@@ -17,10 +17,10 @@ layout: docs
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest release](https://github.com/vmware-tanzu/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
1. Download the [latest release](https://github.com/velero-io/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
|
||||
```
|
||||
wget https://github.com/vmware-tanzu/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
wget https://github.com/velero-io/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
*We strongly recommend that you use an official release 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!*
|
||||
|
||||
@@ -25,7 +25,7 @@ When naming your plugin, keep in mind that the name needs to conform to these ru
|
||||
- example-with-dash.io/azure
|
||||
```
|
||||
|
||||
You will need to give your plugin(s) a name when registering them by calling the appropriate `RegisterX` function: <https://github.com/vmware-tanzu/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
You will need to give your plugin(s) a name when registering them by calling the appropriate `RegisterX` function: <https://github.com/velero-io/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
|
||||
## Plugin Kinds
|
||||
|
||||
@@ -80,6 +80,6 @@ Then, in your plugin's implementation, you can read this ConfigMap to fetch the
|
||||
for an example of this -- in particular, the `getPluginConfig(...)` function.
|
||||
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero-plugin-example
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.1.0/pkg/plugin/logger.go
|
||||
[3]: https://github.com/vmware-tanzu/velero/blob/v1.1.0/pkg/restore/restic_restore_action.go
|
||||
[1]: https://github.com/velero-io/velero-plugin-example
|
||||
[2]: https://github.com/velero-io/velero/blob/v1.1.0/pkg/plugin/logger.go
|
||||
[3]: https://github.com/velero-io/velero/blob/v1.1.0/pkg/restore/restic_restore_action.go
|
||||
|
||||
@@ -375,7 +375,7 @@ To solve this, a controller was written by Thomann Bits&Beats: [velero-pvc-watch
|
||||
|
||||
[1]: https://github.com/restic/restic
|
||||
[2]: install-overview.md
|
||||
[3]: https://github.com/vmware-tanzu/velero/releases/
|
||||
[3]: https://github.com/velero-io/velero/releases/
|
||||
[4]: https://kubernetes.io/docs/concepts/storage/volumes/#local
|
||||
[5]: http://restic.readthedocs.io/en/latest/100_references.html#terminology
|
||||
[6]: https://kubernetes.io/docs/concepts/storage/volumes/#mount-propagation
|
||||
|
||||
@@ -10,7 +10,7 @@ layout: docs
|
||||
|
||||
### 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 currently 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.
|
||||
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 currently in progress new designs here: https://github.com/velero-io/velero/pulls?q=is%3Aopen+is%3Apr+label%3ADesign. Feel free to review and help us with your input.
|
||||
|
||||
For information on how to connect with our maintainers and community, join our online meetings, or find good first issues, start on our [Velero community](https://velero.io/community/) page.
|
||||
|
||||
@@ -20,5 +20,5 @@ Please browse our list of resources, including a playlist of past online communi
|
||||
|
||||
If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under `Contribute`.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/blob/main/CODE_OF_CONDUCT.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/main/CONTRIBUTING.md
|
||||
[1]: https://github.com/velero-io/velero/blob/main/CODE_OF_CONDUCT.md
|
||||
[2]: https://github.com/velero-io/velero/blob/main/CONTRIBUTING.md
|
||||
|
||||
@@ -61,10 +61,10 @@ After you publish your plugin, open a PR that adds your plugin to the appropriat
|
||||
[5]: ibm-config.md
|
||||
[6]: https://docs.portworx.com/scheduler/kubernetes/ark.html
|
||||
[7]: https://github.com/StackPointCloud/ark-plugin-digitalocean
|
||||
[8]: https://github.com/vmware-tanzu/velero-plugin-example/
|
||||
[8]: https://github.com/velero-io/velero-plugin-example/
|
||||
[9]: get-started.md
|
||||
[10]: https://kubernetes.slack.com/messages/velero
|
||||
[11]: https://github.com/vmware-tanzu/velero/issues
|
||||
[11]: https://github.com/velero-io/velero/issues
|
||||
[12]: https://github.com/aws/aws-sdk-go
|
||||
[13]: https://portworx.slack.com/messages/px-k8s
|
||||
[14]: https://github.com/portworx/ark-plugin/issues
|
||||
|
||||
@@ -73,6 +73,6 @@ Backups in the `InProgress` phase have not uploaded any files to object storage.
|
||||
|
||||
[1]: debugging-restores.md
|
||||
[2]: debugging-install.md
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[4]: https://github.com/velero-io/velero/issues
|
||||
[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
||||
[25]: https://kubernetes.slack.com/messages/velero
|
||||
|
||||
@@ -25,4 +25,4 @@ kubectl patch deployment/velero -n <YOUR_NAMESPACE> \
|
||||
-p='[{"op":"add","path":"/spec/template/spec/containers/0/env/0","value":{"name":"VELERO_NAMESPACE", "valueFrom":{"fieldRef":{"fieldPath":"metadata.namespace"}}}}]'
|
||||
```
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/releases/tag/v1.0.0
|
||||
[1]: https://github.com/velero-io/velero/releases/tag/v1.0.0
|
||||
|
||||
@@ -39,11 +39,11 @@ If you are ready to jump in and test, add code, or help with documentation, foll
|
||||
|
||||
See [the list of releases][6] to find out about feature changes.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/workflows/Main%20CI/badge.svg
|
||||
[2]: https://github.com/vmware-tanzu/velero/actions?query=workflow%3A"Main+CI"
|
||||
[1]: https://github.com/velero-io/velero/workflows/Main%20CI/badge.svg
|
||||
[2]: https://github.com/velero-io/velero/actions?query=workflow%3A"Main+CI"
|
||||
|
||||
[4]: https://github.com/vmware-tanzu/velero/issues
|
||||
[6]: https://github.com/vmware-tanzu/velero/releases
|
||||
[4]: https://github.com/velero-io/velero/issues
|
||||
[6]: https://github.com/velero-io/velero/releases
|
||||
|
||||
[9]: https://kubernetes.io/docs/setup/
|
||||
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
|
||||
|
||||
@@ -104,4 +104,4 @@ Note that the container must support the shell command you use.
|
||||
|
||||
|
||||
[1]: api-types/backup.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/examples/nginx-app/with-pv.yaml
|
||||
[2]: https://github.com/velero-io/velero/blob/v1.10.0/examples/nginx-app/with-pv.yaml
|
||||
|
||||
@@ -72,7 +72,7 @@ By this way, schedule is the owner of it created backups. This is useful for som
|
||||
|
||||
Please do notice there is also side effect that may not be expected. Because schedule is the owner, when the schedule is deleted, the related backups CR (Just backup CR is deleted. Backup data still exists in object store and snapshots) will be deleted by k8s GC controller, too, but Velero controller will sync these backups from object store's metadata into k8s. Then k8s GC controller and Velero controller will fight over whether these backups should exist all through.
|
||||
|
||||
If there is possibility the schedule will be disable to not create backup anymore, and the created backups are still useful. Please do not enable this option. For detail, please reference to [Backups created by a schedule with useOwnerReferenceInBackup set do not get synced properly](https://github.com/vmware-tanzu/velero/issues/4093).
|
||||
If there is possibility the schedule will be disable to not create backup anymore, and the created backups are still useful. Please do not enable this option. For detail, please reference to [Backups created by a schedule with useOwnerReferenceInBackup set do not get synced properly](https://github.com/velero-io/velero/issues/4093).
|
||||
|
||||
|
||||
## Kubernetes API Pagination
|
||||
|
||||
@@ -8,7 +8,7 @@ Refer [this document](customize-installation.md) to customize your installation.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Access to a Kubernetes cluster, v1.16 or later, with DNS and container networking enabled. For more information on supported Kubernetes versions, see the Velero [compatibility matrix](https://github.com/vmware-tanzu/velero#velero-compatibility-matrix).
|
||||
- Access to a Kubernetes cluster, v1.16 or later, with DNS and container networking enabled. For more information on supported Kubernetes versions, see the Velero [compatibility matrix](https://github.com/velero-io/velero#velero-compatibility-matrix).
|
||||
- `kubectl` installed locally
|
||||
|
||||
Velero uses object storage to store backups and associated artifacts. It also optionally integrates with supported block storage systems to snapshot your persistent volumes. Before beginning the installation process, you should identify the object storage provider and optional block storage provider(s) you'll be using from the list of [compatible providers][0].
|
||||
@@ -66,7 +66,7 @@ _Note: if your object storage provider is different than your volume snapshot pr
|
||||
Please refer to [this part of the documentation][5].
|
||||
|
||||
[0]: supported-providers.md
|
||||
[1]: https://github.com/vmware-tanzu/velero/releases/latest
|
||||
[1]: https://github.com/velero-io/velero/releases/latest
|
||||
[2]: on-premises.md
|
||||
[3]: overview-plugins.md
|
||||
[4]: customize-installation.md#install-an-additional-volume-snapshot-provider
|
||||
|
||||
@@ -17,7 +17,7 @@ layout: docs
|
||||
```bash
|
||||
mkdir $HOME/go
|
||||
export GOPATH=$HOME/go
|
||||
go get github.com/vmware-tanzu/velero
|
||||
go get github.com/velero-io/velero
|
||||
```
|
||||
|
||||
Where `go` is your [import path][4] for Go.
|
||||
@@ -26,7 +26,7 @@ For Go development, it is recommended to add the Go import path (`$HOME/go` in t
|
||||
|
||||
### 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`.
|
||||
Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/velero-io/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.
|
||||
|
||||
@@ -194,7 +194,7 @@ 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
|
||||
[22]: https://github.com/velero-io/velero/releases
|
||||
[23]: https://docs.docker.com/buildx/working-with-buildx/
|
||||
[24]: https://github.com/docker/buildx
|
||||
[25]: https://github.com/moby/moby/pull/38738
|
||||
|
||||
@@ -62,15 +62,15 @@ Example:
|
||||
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
||||
corev1listers "k8s.io/client-go/listers/core/v1"
|
||||
|
||||
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
|
||||
velerov1client "github.com/vmware-tanzu/velero/pkg/generated/clientset/versioned/typed/velero/v1"
|
||||
velerov1api "github.com/velero-io/velero/pkg/apis/velero/v1"
|
||||
velerov1client "github.com/velero-io/velero/pkg/generated/clientset/versioned/typed/velero/v1"
|
||||
)
|
||||
|
||||
## Mocks
|
||||
|
||||
We use a package to generate mocks for our interfaces.
|
||||
|
||||
Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/v1.10.0/pkg/podvolume/mocks/restorer.go
|
||||
Example: if you want to change this mock: https://github.com/velero-io/velero/blob/v1.10.0/pkg/podvolume/mocks/restorer.go
|
||||
|
||||
Run:
|
||||
|
||||
|
||||
@@ -14,9 +14,9 @@ To set up IBM Cloud Object Storage (COS) as Velero's destination, you:
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
|
||||
@@ -34,9 +34,9 @@ brew install velero
|
||||
|
||||
### Option 2: GitHub release
|
||||
|
||||
1. Download the [latest official release's](https://github.com/vmware-tanzu/velero/releases) tarball for your client platform.
|
||||
1. Download the [latest official release's](https://github.com/velero-io/velero/releases) tarball for your client platform.
|
||||
|
||||
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
|
||||
_We strongly recommend that you use an [official release](https://github.com/velero-io/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!_
|
||||
|
||||
@@ -81,7 +81,7 @@ These instructions start the Velero server and a Minio instance that is accessib
|
||||
--backup-location-config region=minio,s3ForcePathStyle="true",s3Url=http://minio.velero.svc:9000
|
||||
```
|
||||
|
||||
This example assumes that it is running within a local cluster without a volume provider capable of snapshots, so no `VolumeSnapshotLocation` is created (`--use-volume-snapshots=false`). You may need to update AWS plugin version to one that is [compatible](https://github.com/vmware-tanzu/velero-plugin-for-aws#compatibility) with the version of Velero you are installing.
|
||||
This example assumes that it is running within a local cluster without a volume provider capable of snapshots, so no `VolumeSnapshotLocation` is created (`--use-volume-snapshots=false`). You may need to update AWS plugin version to one that is [compatible](https://github.com/velero-io/velero-plugin-for-aws#compatibility) with the version of Velero you are installing.
|
||||
|
||||
Additionally, you can specify `--use-node-agent` to enable File System Backup support, and `--wait` to wait for the deployment to be ready.
|
||||
|
||||
@@ -291,6 +291,6 @@ In this case:
|
||||
[3]: ../customize-installation.md
|
||||
[17]: ../file-system-backup.md
|
||||
[18]: ../debugging-restores.md
|
||||
[26]: https://github.com/vmware-tanzu/velero/releases
|
||||
[26]: https://github.com/velero-io/velero/releases
|
||||
[30]: https://godoc.org/github.com/robfig/cron
|
||||
[32]: ../self-signed-certificates.md
|
||||
|
||||
@@ -17,10 +17,10 @@ layout: docs
|
||||
|
||||
## Download Velero
|
||||
|
||||
1. Download the [latest release](https://github.com/vmware-tanzu/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
1. Download the [latest release](https://github.com/velero-io/velero/releases/) of Velero to your development environment. This includes the `velero` CLI utility and example Kubernetes manifest files. For example:
|
||||
|
||||
```
|
||||
wget https://github.com/vmware-tanzu/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
wget https://github.com/velero-io/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
**NOTE:** Its strongly recommend that you use an official release 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!
|
||||
|
||||
@@ -68,7 +68,7 @@ When the Velero backup expires, the VolumeSnapshot objects will be deleted and t
|
||||
|
||||
For more details on how each plugin works, see the [CSI plugin repo][2]'s documentation.
|
||||
|
||||
**Note:** The AWS, Microsoft Azure, and Google Cloud Platform (GCP) Velero plugins version 1.4 and later are able to snapshot and restore persistent volumes provisioned by a CSI driver via the APIs of the cloud provider, without having to install Velero CSI plugins. See the [AWS](https://github.com/vmware-tanzu/velero-plugin-for-aws), [Microsoft Azure](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure), and [Google Cloud Platform (GCP)](https://github.com/vmware-tanzu/velero-plugin-for-gcp) Velero plugin repo for more information on supported CSI drivers.
|
||||
**Note:** The AWS, Microsoft Azure, and Google Cloud Platform (GCP) Velero plugins version 1.4 and later are able to snapshot and restore persistent volumes provisioned by a CSI driver via the APIs of the cloud provider, without having to install Velero CSI plugins. See the [AWS](https://github.com/velero-io/velero-plugin-for-aws), [Microsoft Azure](https://github.com/velero-io/velero-plugin-for-microsoft-azure), and [Google Cloud Platform (GCP)](https://github.com/velero-io/velero-plugin-for-gcp) Velero plugin repo for more information on supported CSI drivers.
|
||||
|
||||
[1]: customize-installation.md#enable-server-side-features
|
||||
[2]: https://github.com/vmware-tanzu/velero-plugin-for-csi/
|
||||
|
||||
@@ -47,7 +47,7 @@ When naming your plugin, keep in mind that the full name needs to conform to the
|
||||
- example-with-dash.io/azure
|
||||
```
|
||||
|
||||
You will need to give your plugin(s) the full name when registering them by calling the appropriate `RegisterX` function: <https://github.com/vmware-tanzu/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
You will need to give your plugin(s) the full name when registering them by calling the appropriate `RegisterX` function: <https://github.com/velero-io/velero/blob/0e0f357cef7cf15d4c1d291d3caafff2eeb69c1e/pkg/plugin/framework/server.go#L42-L60>
|
||||
|
||||
## Plugin Kinds
|
||||
|
||||
@@ -111,5 +111,5 @@ Once parsed into a `[]string`, the features can then be registered using the `Ne
|
||||
|
||||
Velero adds the `LD_LIBRARY_PATH` into the list of environment variables to provide the convenience for plugins that requires C libraries/extensions in the runtime.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero-plugin-example
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/pkg/plugin/logger.go
|
||||
[1]: https://github.com/velero-io/velero-plugin-example
|
||||
[2]: https://github.com/velero-io/velero/blob/v1.10.0/pkg/plugin/logger.go
|
||||
|
||||
@@ -378,13 +378,13 @@ If you get an error like `complete:13: command not found: compdef`, then add the
|
||||
compinit
|
||||
```
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/releases/latest
|
||||
[1]: https://github.com/velero-io/velero/releases/latest
|
||||
[2]: namespace.md
|
||||
[3]: file-system-backup.md
|
||||
[4]: on-premises.md
|
||||
[6]: velero-install.md#usage
|
||||
[7]: https://github.com/vmware-tanzu/velero/issues/2077
|
||||
[8]: https://github.com/vmware-tanzu/velero/issues/2311
|
||||
[7]: https://github.com/velero-io/velero/issues/2077
|
||||
[8]: https://github.com/velero-io/velero/issues/2311
|
||||
[9]: self-signed-certificates.md
|
||||
[10]: csi.md
|
||||
[11]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/pkg/apis/velero/v1/constants.go
|
||||
[11]: https://github.com/velero-io/velero/blob/v1.10.0/pkg/apis/velero/v1/constants.go
|
||||
|
||||
@@ -5,7 +5,7 @@ layout: docs
|
||||
|
||||
After you set up the Velero server, you can clone the examples used in the following sections by running the following:
|
||||
```
|
||||
git clone https://github.com/vmware-tanzu/velero.git
|
||||
git clone https://github.com/velero-io/velero.git
|
||||
cd velero
|
||||
```
|
||||
|
||||
|
||||
@@ -492,7 +492,7 @@ which is used to backup pod volume data
|
||||
the backup storage
|
||||
|
||||
For more details, refer to [kopia architecture](https://kopia.io/docs/advanced/architecture/) and
|
||||
Velero's [Unified Repository design](https://github.com/vmware-tanzu/velero/pull/4926)
|
||||
Velero's [Unified Repository design](https://github.com/velero-io/velero/pull/4926)
|
||||
|
||||
### Custom resource and controllers
|
||||
Velero has three custom resource definitions and associated controllers:
|
||||
@@ -588,7 +588,7 @@ To solve this, a controller was written by Thomann Bits&Beats: [velero-pvc-watch
|
||||
[1]: https://github.com/restic/restic
|
||||
[2]: https://github.com/kopia/kopia
|
||||
[3]: customize-installation.md#enable-restic-integration
|
||||
[4]: https://github.com/vmware-tanzu/velero/releases/
|
||||
[4]: https://github.com/velero-io/velero/releases/
|
||||
[5]: https://kubernetes.io/docs/concepts/storage/volumes/#local
|
||||
[6]: https://kubernetes.io/docs/concepts/storage/volumes/#mount-propagation
|
||||
[7]: https://github.com/bitsbeats/velero-pvc-watcher
|
||||
|
||||
@@ -9,7 +9,7 @@ This document describes Velero's image tagging policy.
|
||||
|
||||
`velero/velero:<SemVer>`
|
||||
|
||||
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, `velero/velero:v1.0.0`.
|
||||
Velero follows the [Semantic Versioning](http://semver.org/) standard for releases. Each tag in the `github.com/velero-io/velero` repository has a matching image, `velero/velero:v1.0.0`.
|
||||
|
||||
### Latest
|
||||
|
||||
|
||||
@@ -306,8 +306,8 @@ velero snapshot-location set <vsl-name> \
|
||||
|
||||
[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
|
||||
[3]: https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md
|
||||
[4]: https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md
|
||||
[5]: /plugins
|
||||
[6]: overview-plugins.md
|
||||
[7]: https://kubernetes.io/docs/concepts/configuration/secret/
|
||||
|
||||
@@ -4,7 +4,7 @@ layout: docs
|
||||
toc: "true"
|
||||
---
|
||||
|
||||
There are some guidelines maintainers need to follow. We list them here for quick reference, especially for new maintainers. These guidelines apply to all projects in the Velero org, including the main project, the Velero Helm chart, and all other [related repositories](https://github.com/vmware-tanzu/velero/blob/v1.10.0/GOVERNANCE.md#code-repositories).
|
||||
There are some guidelines maintainers need to follow. We list them here for quick reference, especially for new maintainers. These guidelines apply to all projects in the Velero org, including the main project, the Velero Helm chart, and all other [related repositories](https://github.com/velero-io/velero/blob/v1.10.0/GOVERNANCE.md#code-repositories).
|
||||
|
||||
Please be sure to also go through the guidance under the entire [Contribute](start-contributing/) section.
|
||||
|
||||
@@ -14,12 +14,12 @@ Please be sure to also go through the guidance under the entire [Contribute](sta
|
||||
- As you review a PR that is not yet ready to merge, please check if the "request review" needs to be refreshed for any reviewer (this is better than @mention at them)
|
||||
- Refrain from @mention other maintainers to review the PR unless it is an immediate need. All maintainers already get notified through the automated add to the "request review". If it is an urgent need, please add a helpful message as to why it is so people can properly prioritize work.
|
||||
- There is no need to manually request reviewers: after the PR is created, all maintainers will be automatically added to the list (note: feel free to remove people if they are on PTO, etc).
|
||||
- Be familiar with the [lazy consensus](https://github.com/vmware-tanzu/velero/blob/v1.10.0/GOVERNANCE.md#lazy-consensus) policy for the project.
|
||||
- Be familiar with the [lazy consensus](https://github.com/velero-io/velero/blob/v1.10.0/GOVERNANCE.md#lazy-consensus) policy for the project.
|
||||
|
||||
Some tips for doing reviews:
|
||||
- There are some [code standards and general guidelines](https://velero.io/docs/v1.10/code-standards) we aim for
|
||||
- We have [guidelines for writing and reviewing documentation](https://velero.io/docs/v1.10/style-guide/)
|
||||
- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/vmware-tanzu/velero/blob/v1.10.0/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/vmware-tanzu/velero/tree/main/design/implemented) folder.
|
||||
- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/velero-io/velero/blob/v1.10.0/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/velero-io/velero/tree/main/design/implemented) folder.
|
||||
|
||||
|
||||
## Creating a release
|
||||
@@ -34,4 +34,4 @@ Maintainers are expected to participate in the community support rotation. We ha
|
||||
Maintainers for the Velero project are highly involved with the open source community. All the online community meetings for the project are listed in our [community](community) page.
|
||||
|
||||
## How do I become a maintainer?
|
||||
The Velero project welcomes contributors of all kinds. We are also always on the look out for a high level of engagement from contributors and opportunities to bring in new maintainers. If this is of interest, take a look at how [adding a maintainer](https://github.com/vmware-tanzu/velero/blob/v1.10.0/GOVERNANCE.md#maintainers) is decided.
|
||||
The Velero project welcomes contributors of all kinds. We are also always on the look out for a high level of engagement from contributors and opportunities to bring in new maintainers. If this is of interest, take a look at how [adding a maintainer](https://github.com/velero-io/velero/blob/v1.10.0/GOVERNANCE.md#maintainers) is decided.
|
||||
|
||||
@@ -19,7 +19,7 @@ Before migrating you should consider the following,
|
||||
|
||||
## Migration Scenario
|
||||
|
||||
This scenario steps through the migration of resources from Cluster 1 to Cluster 2. In this scenario, both clusters are using the same cloud provider, AWS, and Velero's [AWS plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws).
|
||||
This scenario steps through the migration of resources from Cluster 1 to Cluster 2. In this scenario, both clusters are using the same cloud provider, AWS, and Velero's [AWS plugin](https://github.com/velero-io/velero-plugin-for-aws).
|
||||
|
||||
1. On Cluster 1, make sure Velero is installed and points to an object storage location using the `--bucket` flag.
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ After you publish your plugin on your own repository, open a PR that adds a link
|
||||
|
||||
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/
|
||||
[1]: https://github.com/velero-io/velero-plugin-example/
|
||||
[2]: custom-plugins.md
|
||||
[3]: supported-providers.md
|
||||
[4]: https://github.com/topics/velero-plugin
|
||||
|
||||
@@ -26,5 +26,5 @@ Plugins the Velero core team is responsible include all those listed in [the Vel
|
||||
1. If all e2e tests pass, go to the GitHub release page of the plugin (`https://github.com/vmware-tanzu/<plugin-name>/releases`) and manually create a release for the new tag.
|
||||
1. Copy and paste the content of the new changelog file into the release description field.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/blob/c8dfd648bbe85db0184ea53296de4220895497e6/test/e2e/velero_utils.go#L27
|
||||
[2]: https://github.com/vmware-tanzu/velero/tree/main/test/e2e
|
||||
[1]: https://github.com/velero-io/velero/blob/c8dfd648bbe85db0184ea53296de4220895497e6/test/e2e/velero_utils.go#L27
|
||||
[2]: https://github.com/velero-io/velero/tree/main/test/e2e
|
||||
|
||||
@@ -7,9 +7,9 @@ This page covers the steps to perform when releasing a new version of Velero.
|
||||
|
||||
## General notes
|
||||
- Please read the documented variables in each script to understand what they are for and how to properly format their values.
|
||||
- You will need to have an upstream remote configured to use to the [vmware-tanzu/velero](https://github.com/vmware-tanzu/velero) repository.
|
||||
- You will need to have an upstream remote configured to use to the [velero-io/velero](https://github.com/velero-io/velero) repository.
|
||||
You can check this using `git remote -v`.
|
||||
The release script ([`tag-release.sh`](https://github.com/vmware-tanzu/velero/blob/v1.10.0/hack/release-tools/tag-release.sh)) will use `upstream` as the default remote name if it is not specified using the environment variable `REMOTE`.
|
||||
The release script ([`tag-release.sh`](https://github.com/velero-io/velero/blob/v1.10.0/hack/release-tools/tag-release.sh)) will use `upstream` as the default remote name if it is not specified using the environment variable `REMOTE`.
|
||||
- GA release: major and minor releases only. Example: 1.0 (major), 1.5 (minor).
|
||||
- Pre-releases: Any release leading up to a GA. Example: 1.4.0-beta.1, 1.5.0-rc.1
|
||||
- RC releases: Release Candidate, contains everything that is supposed to ship with the GA release. This is still a pre-release.
|
||||
@@ -77,7 +77,7 @@ For each major or minor release, create and publish a blog post to let folks kno
|
||||
- Remove the pre-release docs table of contents mapping entry from `site/data/toc-mapping.yml`.
|
||||
- Remove all references to the pre-release docs from `site/config.yml`.
|
||||
1. Create the "Upgrade to $major.minor" page if it does not already exist ([example](https://velero.io/docs/v1.5/upgrade-to-1.5/)).
|
||||
If it already exists, update any usage of the previous version string within this file to use the new version string instead ([example](https://github.com/vmware-tanzu/velero/pull/2941/files#diff-d594f8fd0901fed79c39aab4b348193d)).
|
||||
If it already exists, update any usage of the previous version string within this file to use the new version string instead ([example](https://github.com/velero-io/velero/pull/2941/files#diff-d594f8fd0901fed79c39aab4b348193d)).
|
||||
This needs to be done in both the versioned and the `main` folders.
|
||||
1. Review and submit PR
|
||||
- Follow the additional instructions at `site/README-HUGO.md` to complete the docs generation process.
|
||||
@@ -88,7 +88,7 @@ For each major or minor release, create and publish a blog post to let folks kno
|
||||
The image of velero is built based on [Distroless docker image](https://github.com/GoogleContainerTools/distroless).
|
||||
For the reproducibility of the release, before the release candidate is tagged, we need to make sure the in the Dockerfile
|
||||
on the release branch, the base image is referenced by digest, such as
|
||||
https://github.com/vmware-tanzu/velero/blob/release-1.7/Dockerfile#L53-L54
|
||||
https://github.com/velero-io/velero/blob/release-1.7/Dockerfile#L53-L54
|
||||
|
||||
## Velero release
|
||||
### Notes
|
||||
@@ -108,11 +108,11 @@ https://github.com/vmware-tanzu/velero/blob/release-1.7/Dockerfile#L53-L54
|
||||
1. Create a tagged release and push it to GitHub
|
||||
- Run `VELERO_VERSION=v1.9.0-rc.1 REMOTE=<upstream-remote> GITHUB_TOKEN=REDACTED ON_RELEASE_BRANCH=TRUE ./hack/release-tools/tag-release.sh publish`.
|
||||
1. Publish the release
|
||||
- Navigate to the draft GitHub release at https://github.com/vmware-tanzu/velero/releases and edit the release.
|
||||
- Navigate to the draft GitHub release at https://github.com/velero-io/velero/releases and edit the release.
|
||||
- If this is a patch release (e.g. `v1.9.1`), note that the full `CHANGELOG-1.9.md` contents will be included in the body of the GitHub release. You need to delete the previous releases' content (e.g. `v1.9.0`'s changelog) so that only the latest patch release's changelog shows.
|
||||
- Do a quick review for formatting.
|
||||
- **Note:** the `goreleaser` process should have detected if it's a pre-release version and, if so, checked the box at the bottom of the GitHub release page appropriately, but it's always worth double-checking.
|
||||
- Verify that GitHub has built and pushed all the images (it takes a while): https://github.com/vmware-tanzu/velero/actions
|
||||
- Verify that GitHub has built and pushed all the images (it takes a while): https://github.com/velero-io/velero/actions
|
||||
- Verify that the images are on Docker Hub: https://hub.docker.com/r/velero/velero/tags
|
||||
- Verify that the assets were published to the GitHub release
|
||||
- Publish the release.
|
||||
@@ -176,4 +176,4 @@ What to include:
|
||||
|
||||
[1]: https://velero.io/blog
|
||||
[2]: website-guidelines.md
|
||||
[3]: https://github.com/vmware-tanzu/velero/tree/main/test/e2e
|
||||
[3]: https://github.com/velero-io/velero/tree/main/test/e2e
|
||||
|
||||
@@ -52,7 +52,7 @@ You will need to change this setting on the server to make it work.
|
||||
|
||||
**Note:** The `--insecure-skip-tls-verify` flag is insecure and susceptible to man-in-the-middle attacks and meant to help your testing and developing scenarios in an on-premise environment. Using this flag in production is not recommended.
|
||||
|
||||
Velero provides a way for you to skip TLS verification on the object store when using the [AWS provider plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) or [File System Backup](file-system-backup.md) by passing the `--insecure-skip-tls-verify` flag with the following Velero commands,
|
||||
Velero provides a way for you to skip TLS verification on the object store when using the [AWS provider plugin](https://github.com/velero-io/velero-plugin-for-aws) or [File System Backup](file-system-backup.md) by passing the `--insecure-skip-tls-verify` flag with the following Velero commands,
|
||||
|
||||
* velero backup describe
|
||||
* velero backup download
|
||||
|
||||
@@ -16,7 +16,7 @@ To make a design pull request, you can copy the template found in the `design/_t
|
||||
|
||||
## 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.
|
||||
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/velero-io/velero/pulls?q=is%3Aopen+is%3Apr+label%3ADesign. Feel free to review and help us with your input.
|
||||
|
||||
You can also vote on issues using :+1: and :-1:, as explained in our [Feature enhancement request][3] and [Bug issue][4] templates. This will help us quantify importance and prioritize issues.
|
||||
|
||||
@@ -28,7 +28,7 @@ Please browse our list of resources, including a playlist of past online communi
|
||||
|
||||
If you are ready to jump in and test, add code, or help with documentation, please use the navigation on the left under `Contribute`.
|
||||
|
||||
[1]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/CODE_OF_CONDUCT.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/CONTRIBUTING.md
|
||||
[3]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/.github/ISSUE_TEMPLATE/feature-enhancement-request.md
|
||||
[4]: https://github.com/vmware-tanzu/velero/blob/v1.10.0/.github/ISSUE_TEMPLATE/bug_report.md
|
||||
[1]: https://github.com/velero-io/velero/blob/v1.10.0/CODE_OF_CONDUCT.md
|
||||
[2]: https://github.com/velero-io/velero/blob/v1.10.0/CONTRIBUTING.md
|
||||
[3]: https://github.com/velero-io/velero/blob/v1.10.0/.github/ISSUE_TEMPLATE/feature-enhancement-request.md
|
||||
[4]: https://github.com/velero-io/velero/blob/v1.10.0/.github/ISSUE_TEMPLATE/bug_report.md
|
||||
|
||||
@@ -6,7 +6,7 @@ layout: docs
|
||||
|
||||
Velero provides best effort support through the process on this page for the current version of Velero and n-1 Velero version, including all patch releases in the supported minor releases. For example, if the current version is 1.9, the Velero maintainers would offer best effort support for v1.9 and v1.8. If you have a question about a previous Velero version (for example, 1.7), please note that maintainers may ask you to upgrade to a supported version before doing any investigation into your issue.
|
||||
|
||||
For more information about Velero testing and supported Kubernetes versions, see Velero's [compatibility matrix](https://github.com/vmware-tanzu/velero/blob/v1.10.0/README.md#velero-compatibility-matrix).
|
||||
For more information about Velero testing and supported Kubernetes versions, see Velero's [compatibility matrix](https://github.com/velero-io/velero/blob/v1.10.0/README.md#velero-compatibility-matrix).
|
||||
|
||||
|
||||
## Weekly Rotation
|
||||
|
||||
@@ -11,14 +11,14 @@ Velero supports a variety of storage providers for different backup and snapshot
|
||||
|
||||
| Provider | Object Store | Volume Snapshotter | Plugin Provider Repo | Setup Instructions | Parameters |
|
||||
|-----------------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-----------------------------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Amazon Web Services (AWS)](https://aws.amazon.com) | AWS S3 | AWS EBS | [Velero plugin for AWS](https://github.com/vmware-tanzu/velero-plugin-for-aws) | [AWS Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-aws#setup) | [BackupStorageLocation](https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/volumesnapshotlocation.md) |
|
||||
| [Google Cloud Platform (GCP)](https://cloud.google.com) | [Google Cloud Storage](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) | [Google Compute Engine Disks](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) | [Velero plugin for GCP](https://github.com/vmware-tanzu/velero-plugin-for-gcp) | [GCP Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-gcp#setup) | [BackupStorageLocation](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/vmware-tanzu/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) |
|
||||
| [Microsoft Azure](https://azure.com) | Azure Blob Storage | Azure Managed Disks | [Velero plugin for Microsoft Azure](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure) | [Azure Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure#setup) | [BackupStorageLocation](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md) |
|
||||
| [VMware vSphere](https://www.vmware.com/ca/products/vsphere.html) | 🚫 | vSphere Volumes | [VMware vSphere](https://github.com/vmware-tanzu/velero-plugin-for-vsphere) | [vSphere Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-vsphere#velero-plugin-for-vsphere-installation-and-configuration-details) | 🚫 |
|
||||
| [Amazon Web Services (AWS)](https://aws.amazon.com) | AWS S3 | AWS EBS | [Velero plugin for AWS](https://github.com/velero-io/velero-plugin-for-aws) | [AWS Plugin Setup](https://github.com/velero-io/velero-plugin-for-aws#setup) | [BackupStorageLocation](https://github.com/velero-io/velero-plugin-for-aws/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/velero-io/velero-plugin-for-aws/blob/main/volumesnapshotlocation.md) |
|
||||
| [Google Cloud Platform (GCP)](https://cloud.google.com) | [Google Cloud Storage](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) | [Google Compute Engine Disks](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) | [Velero plugin for GCP](https://github.com/velero-io/velero-plugin-for-gcp) | [GCP Plugin Setup](https://github.com/velero-io/velero-plugin-for-gcp#setup) | [BackupStorageLocation](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/velero-io/velero-plugin-for-gcp/blob/main/volumesnapshotlocation.md) |
|
||||
| [Microsoft Azure](https://azure.com) | Azure Blob Storage | Azure Managed Disks | [Velero plugin for Microsoft Azure](https://github.com/velero-io/velero-plugin-for-microsoft-azure) | [Azure Plugin Setup](https://github.com/velero-io/velero-plugin-for-microsoft-azure#setup) | [BackupStorageLocation](https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md) <br/> [VolumeSnapshotLocation](https://github.com/velero-io/velero-plugin-for-microsoft-azure/blob/main/volumesnapshotlocation.md) |
|
||||
| [VMware vSphere](https://www.vmware.com/ca/products/vsphere.html) | 🚫 | vSphere Volumes | [VMware vSphere](https://github.com/velero-io/velero-plugin-for-vsphere) | [vSphere Plugin Setup](https://github.com/velero-io/velero-plugin-for-vsphere#velero-plugin-for-vsphere-installation-and-configuration-details) | 🚫 |
|
||||
| [Container Storage Interface (CSI)](https://kubernetes.io/blog/2019/01/15/container-storage-interface-ga/)| 🚫 | CSI Volumes | [Velero plugin for CSI](https://github.com/vmware-tanzu/velero-plugin-for-csi/) | [CSI Plugin Setup](https://github.com/vmware-tanzu/velero-plugin-for-csi#kinds-of-plugins-included) | 🚫 |
|
||||
{{< /table >}}
|
||||
|
||||
Contact: [#Velero Slack](https://kubernetes.slack.com/messages/velero), [GitHub Issues](https://github.com/vmware-tanzu/velero/issues)
|
||||
Contact: [#Velero Slack](https://kubernetes.slack.com/messages/velero), [GitHub Issues](https://github.com/velero-io/velero/issues)
|
||||
|
||||
## Provider plugins maintained by the Velero community
|
||||
{{< table caption="Community supported providers" >}}
|
||||
@@ -62,9 +62,9 @@ In the case you want to take volume snapshots but didn't find a plugin for your
|
||||
[3]: contributions/minio.md
|
||||
[4]: https://github.com/StackPointCloud/ark-plugin-digitalocean
|
||||
[5]: http://www.noobaa.com/
|
||||
[6]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/backupstoragelocation.md
|
||||
[6]: https://github.com/velero-io/velero-plugin-for-aws/blob/main/backupstoragelocation.md
|
||||
[7]: contributions/tencent-config.md
|
||||
[25]: https://github.com/hpe-storage/velero-plugin
|
||||
[30]: file-system-backup.md
|
||||
[36]: https://github.com/vmware-tanzu/velero-plugin-for-gcp#setup
|
||||
[36]: https://github.com/velero-io/velero-plugin-for-gcp#setup
|
||||
[38]: https://www.cloudian.com/
|
||||
|
||||
@@ -21,7 +21,7 @@ files in this directory are gitignored so you may configure your setup according
|
||||
1. [Docker](https://docs.docker.com/install/) v19.03 or newer
|
||||
1. A Kubernetes cluster v1.16 or greater (does not have to be Kind)
|
||||
1. [Tilt](https://docs.tilt.dev/install.html) v0.12.0 or newer
|
||||
1. Clone the [Velero project](https://github.com/vmware-tanzu/velero) repository
|
||||
1. Clone the [Velero project](https://github.com/velero-io/velero) repository
|
||||
locally
|
||||
1. Access to an S3 object storage
|
||||
1. Clone any [provider plugin(s)](https://velero.io/plugins/) you want to make changes to and deploy (optional, must be configured to be deployed by the Velero Tilt's setup, [more info below](#provider-plugins))
|
||||
@@ -115,7 +115,7 @@ Below are some ways to configure a backup storage location for Velero.
|
||||
Follow the provider documentation to provision the storage. We have a [list of all known object storage providers](supported-providers/) with corresponding plugins for Velero.
|
||||
|
||||
#### Using MinIO as an object storage
|
||||
Note: to use MinIO as an object storage, you will need to use the [`AWS` plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws), and configure the storage location with the `spec.provider` set to `aws` and the `spec.config.region` set to `minio`. Example:
|
||||
Note: to use MinIO as an object storage, you will need to use the [`AWS` plugin](https://github.com/velero-io/velero-plugin-for-aws), and configure the storage location with the `spec.provider` set to `aws` and the `spec.config.region` set to `minio`. Example:
|
||||
```
|
||||
spec:
|
||||
config:
|
||||
@@ -141,7 +141,7 @@ necessary to expose MinIO outside the cluster.
|
||||
|
||||
1) As a standalone MinIO instance running locally in a Docker container
|
||||
|
||||
See [these instructions](https://github.com/vmware-tanzu/velero/discussions/3381) to run MinIO locally on your computer, as a standalone as opposed to running it on a Pod.
|
||||
See [these instructions](https://github.com/velero-io/velero/discussions/3381) to run MinIO locally on your computer, as a standalone as opposed to running it on a Pod.
|
||||
|
||||
Please see our [locations documentation](locations/) to learn more how backup locations work.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user