Address insensitive language (#2677)

* Change master to main in most uses

Signed-off-by: Nolan Brubaker <brubakern@vmware.com>
pull/2465/head
Nolan Brubaker 2020-07-17 17:59:51 -04:00 committed by GitHub
parent 2376b697af
commit f42c63af1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
246 changed files with 443 additions and 440 deletions

View File

@ -2,7 +2,7 @@ name: build-image
on: on:
push: push:
branches: [ master ] branches: [ main ]
paths: paths:
- 'hack/build-image/Dockerfile' - 'hack/build-image/Dockerfile'

View File

@ -1,8 +1,8 @@
name: Master CI name: Main CI
on: on:
push: push:
branches: [ master ] branches: [ main ]
tags: tags:
- '*' - '*'

View File

@ -20,18 +20,18 @@
* [CHANGELOG-0.3.md][1] * [CHANGELOG-0.3.md][1]
[14]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.4.md [14]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.4.md
[13]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.3.md [13]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.3.md
[12]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.2.md [12]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.2.md
[11]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.1.md [11]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.1.md
[10]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.0.md [10]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.0.md
[9]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.11.md [9]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.11.md
[8]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.10.md [8]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.10.md
[7]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.9.md [7]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.9.md
[6]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.8.md [6]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.8.md
[5]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.7.md [5]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.7.md
[4]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.6.md [4]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.6.md
[3]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.5.md [3]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.5.md
[2]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.4.md [2]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.4.md
[1]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-0.3.md [1]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-0.3.md
[0]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/unreleased [0]: https://github.com/vmware-tanzu/velero/blob/main/changelogs/unreleased

View File

@ -39,7 +39,7 @@ BUILDER_IMAGE_CACHED := $(shell docker images -q ${BUILDER_IMAGE} 2>/dev/null )
local : ARCH ?= $(shell go env GOOS)-$(shell go env GOARCH) local : ARCH ?= $(shell go env GOOS)-$(shell go env GOARCH)
ARCH ?= linux-amd64 ARCH ?= linux-amd64
VERSION ?= master VERSION ?= main
TAG_LATEST ?= false TAG_LATEST ?= false

View File

@ -69,8 +69,8 @@ carefully to ensure a successful upgrade!**
- The `Config` CRD has been replaced by `BackupStorageLocation` and `VolumeSnapshotLocation` CRDs. - The `Config` CRD has been replaced by `BackupStorageLocation` and `VolumeSnapshotLocation` CRDs.
- The interface for external plugins (object/block stores, backup/restore item actions) has changed. If you have authored any custom plugins, they'll - The interface for external plugins (object/block stores, backup/restore item actions) has changed. If you have authored any custom plugins, they'll
need to be updated for v0.10. need to be updated for v0.10.
- The [`ObjectStore.ListCommonPrefixes`](https://github.com/heptio/ark/blob/master/pkg/cloudprovider/object_store.go#L50) signature has changed to add a `prefix` parameter. - The [`ObjectStore.ListCommonPrefixes`](https://github.com/vmware-tanzu/velero/blob/main/pkg/cloudprovider/object_store.go#L50) signature has changed to add a `prefix` parameter.
- Registering plugins has changed. Create a new plugin server with the `NewServer` function, and register plugins with the appropriate functions. See the [`Server`](https://github.com/heptio/ark/blob/master/pkg/plugin/server.go#L37) interface for details. - Registering plugins has changed. Create a new plugin server with the `NewServer` function, and register plugins with the appropriate functions. See the [`Server`](https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/server.go#L37) interface for details.
- The organization of Ark data in object storage has changed. Existing data will need to be moved around to conform to the new layout. - The organization of Ark data in object storage has changed. Existing data will need to be moved around to conform to the new layout.
### All Changes ### All Changes
@ -89,7 +89,7 @@ need to be updated for v0.10.
- [ec013e6f](https://github.com/heptio/ark/commit/ec013e6f) Document upgrading plugins in the deployment - [ec013e6f](https://github.com/heptio/ark/commit/ec013e6f) Document upgrading plugins in the deployment
- [d6162e94](https://github.com/heptio/ark/commit/d6162e94) fix goreleaser bugs - [d6162e94](https://github.com/heptio/ark/commit/d6162e94) fix goreleaser bugs
- [a15df276](https://github.com/heptio/ark/commit/a15df276) Add correct link and change role - [a15df276](https://github.com/heptio/ark/commit/a15df276) Add correct link and change role
- [46bed015](https://github.com/heptio/ark/commit/46bed015) add 0.10 breaking changes warning to readme in master - [46bed015](https://github.com/heptio/ark/commit/46bed015) add 0.10 breaking changes warning to readme in main
- [e3a7d6a2](https://github.com/heptio/ark/commit/e3a7d6a2) add content for issue 994 - [e3a7d6a2](https://github.com/heptio/ark/commit/e3a7d6a2) add content for issue 994
- [400911e9](https://github.com/heptio/ark/commit/400911e9) address docs issue #978 - [400911e9](https://github.com/heptio/ark/commit/400911e9) address docs issue #978
- [b818cc27](https://github.com/heptio/ark/commit/b818cc27) don't require a default provider VSL if there's only 1 - [b818cc27](https://github.com/heptio/ark/commit/b818cc27) don't require a default provider VSL if there's only 1
@ -247,7 +247,7 @@ need to be updated for v0.10.
- [5b89f7b6](https://github.com/heptio/ark/commit/5b89f7b6) Skip backup sync if it already exists in k8s - [5b89f7b6](https://github.com/heptio/ark/commit/5b89f7b6) Skip backup sync if it already exists in k8s
- [c6050845](https://github.com/heptio/ark/commit/c6050845) restore controller: switch to 'c' for receiver name - [c6050845](https://github.com/heptio/ark/commit/c6050845) restore controller: switch to 'c' for receiver name
- [706ae07d](https://github.com/heptio/ark/commit/706ae07d) enable a schedule to be provided as the source for a restore - [706ae07d](https://github.com/heptio/ark/commit/706ae07d) enable a schedule to be provided as the source for a restore
- [aea68414](https://github.com/heptio/ark/commit/aea68414) fix up Slack link in troubleshooting on master branch - [aea68414](https://github.com/heptio/ark/commit/aea68414) fix up Slack link in troubleshooting on main branch
- [bb8e2e91](https://github.com/heptio/ark/commit/bb8e2e91) Document how to run the Ark server locally - [bb8e2e91](https://github.com/heptio/ark/commit/bb8e2e91) Document how to run the Ark server locally
- [dc84e591](https://github.com/heptio/ark/commit/dc84e591) Remove outdated namespace deletion content - [dc84e591](https://github.com/heptio/ark/commit/dc84e591) Remove outdated namespace deletion content
- [23abbc9a](https://github.com/heptio/ark/commit/23abbc9a) fix paths - [23abbc9a](https://github.com/heptio/ark/commit/23abbc9a) fix paths

View File

@ -137,7 +137,7 @@
### Highlights: ### Highlights:
* Ark now has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic](https://github.com/restic/restic). * Ark now has support for backing up and restoring Kubernetes volumes using a free open-source backup tool called [restic](https://github.com/restic/restic).
This provides users an out-of-the-box solution for backing up and restoring almost any type of Kubernetes volume, whether or not it has snapshot support This provides users an out-of-the-box solution for backing up and restoring almost any type of Kubernetes volume, whether or not it has snapshot support
integrated with Ark. For more information, see the [documentation](https://github.com/heptio/ark/blob/master/docs/restic.md). integrated with Ark. For more information, see the [documentation](https://github.com/vmware-tanzu/velero/blob/main/docs/restic.md).
* Support for Prometheus metrics has been added! View total number of backup attempts (including success or failure), total backup size in bytes, and backup * Support for Prometheus metrics has been added! View total number of backup attempts (including success or failure), total backup size in bytes, and backup
durations. More metrics coming in future releases! durations. More metrics coming in future releases!

View File

@ -90,7 +90,7 @@ We fixed a large number of bugs and made some smaller usability improvements in
### All Changes ### All Changes
* Corrected the selfLink for Backup CR in site/docs/master/output-file-format.md (#2292, @RushinthJohn) * Corrected the selfLink for Backup CR in site/docs/main/output-file-format.md (#2292, @RushinthJohn)
* Back up schema-less CustomResourceDefinitions as v1beta1, even if they are retrieved via the v1 endpoint. (#2264, @nrb) * Back up schema-less CustomResourceDefinitions as v1beta1, even if they are retrieved via the v1 endpoint. (#2264, @nrb)
* Bug fix: restic backup volume snapshot to the second location failed (#2244, @jenting) * Bug fix: restic backup volume snapshot to the second location failed (#2244, @jenting)
* Added support of using PV name from volumesnapshotter('SetVolumeID') in case of PV renaming during the restore (#2216, @mynktl) * Added support of using PV name from volumesnapshotter('SetVolumeID') in case of PV renaming during the restore (#2216, @mynktl)

View File

@ -276,7 +276,7 @@ The value for these flags will be stored as annotations.
#### Handling CA certs #### Handling CA certs
In anticipation of a new configuration implementation to handle custom CA certs (as per design doc https://github.com/vmware-tanzu/velero/blob/master/design/custom-ca-support.md), a new flag `velero storage-location create/set --cacert-file mapStringString` is proposed. It sets the configuration to use for creating a secret containing a custom certificate for an S3 location of a plugin provider. Format is provider:path-to-file. In anticipation of a new configuration implementation to handle custom CA certs (as per design doc https://github.com/vmware-tanzu/velero/blob/main/design/custom-ca-support.md), a new flag `velero storage-location create/set --cacert-file mapStringString` is proposed. It sets the configuration to use for creating a secret containing a custom certificate for an S3 location of a plugin provider. Format is provider:path-to-file.
See discussion https://github.com/vmware-tanzu/velero/pull/2259#discussion_r384700723 for more clarification. See discussion https://github.com/vmware-tanzu/velero/pull/2259#discussion_r384700723 for more clarification.
@ -370,4 +370,4 @@ https://github.com/jpeach/contour/tree/1c575c772e9fd747fba72ae41ab99bdae7a01864/
## Security Considerations ## Security Considerations
N/A N/A

View File

@ -306,16 +306,16 @@ Without these objects, the provider-level snapshots cannot be located in order t
[1]: https://kubernetes.io/blog/2018/10/09/introducing-volume-snapshot-alpha-for-kubernetes/ [1]: https://kubernetes.io/blog/2018/10/09/introducing-volume-snapshot-alpha-for-kubernetes/
[2]: https://github.com/kubernetes-csi/external-snapshotter/blob/master/pkg/apis/volumesnapshot/v1alpha1/types.go#L41 [2]: https://github.com/kubernetes-csi/external-snapshotter/blob/master/pkg/apis/volumesnapshot/v1alpha1/types.go#L41
[3]: https://github.com/kubernetes-csi/external-snapshotter/blob/master/pkg/apis/volumesnapshot/v1alpha1/types.go#L161 [3]: https://github.com/kubernetes-csi/external-snapshotter/blob/master/pkg/apis/volumesnapshot/v1alpha1/types.go#L161
[4]: https://github.com/heptio/velero/blob/master/pkg/volume/snapshot.go#L21 [4]: https://github.com/heptio/velero/blob/main/pkg/volume/snapshot.go#L21
[5]: https://github.com/heptio/velero/blob/master/pkg/apis/velero/v1/pod_volume_backup.go#L88 [5]: https://github.com/heptio/velero/blob/main/pkg/apis/velero/v1/pod_volume_backup.go#L88
[6]: https://github.com/heptio/velero-csi-plugin/ [6]: https://github.com/heptio/velero-csi-plugin/
[7]: https://github.com/heptio/velero/blob/master/pkg/plugin/velero/volume_snapshotter.go#L26 [7]: https://github.com/heptio/velero/blob/main/pkg/plugin/velero/volume_snapshotter.go#L26
[8]: https://github.com/heptio/velero/blob/master/pkg/controller/backup_controller.go#L560 [8]: https://github.com/heptio/velero/blob/main/pkg/controller/backup_controller.go#L560
[9]: https://github.com/heptio/velero/blob/master/pkg/persistence/object_store.go#L46 [9]: https://github.com/heptio/velero/blob/main/pkg/persistence/object_store.go#L46
[10]: https://github.com/heptio/velero/blob/master/pkg/apis/velero/v1/labels_annotations.go#L21 [10]: https://github.com/heptio/velero/blob/main/pkg/apis/velero/v1/labels_annotations.go#L21
[11]: https://github.com/heptio/velero/blob/master/pkg/cmd/server/server.go#L471 [11]: https://github.com/heptio/velero/blob/main/pkg/cmd/server/server.go#L471
[12]: https://github.com/heptio/velero/blob/master/pkg/cmd/util/output/backup_describer.go [12]: https://github.com/heptio/velero/blob/main/pkg/cmd/util/output/backup_describer.go
[13]: https://github.com/heptio/velero/blob/master/pkg/cmd/util/output/backup_describer.go#L214 [13]: https://github.com/heptio/velero/blob/main/pkg/cmd/util/output/backup_describer.go#L214
[14]: https://github.com/kubernetes/kubernetes/blob/8ea9edbb0290e9de1e6d274e816a4002892cca6f/pkg/controller/volume/persistentvolume/util/util.go#L69 [14]: https://github.com/kubernetes/kubernetes/blob/8ea9edbb0290e9de1e6d274e816a4002892cca6f/pkg/controller/volume/persistentvolume/util/util.go#L69
[15]: https://github.com/kubernetes/kubernetes/pull/30285 [15]: https://github.com/kubernetes/kubernetes/pull/30285
[16]: https://github.com/kubernetes/kubernetes/blob/master/pkg/apis/core/types.go#L237 [16]: https://github.com/kubernetes/kubernetes/blob/master/pkg/apis/core/types.go#L237

View File

@ -73,8 +73,8 @@ This same approach can be taken for CA bundles. The bundle can be stored in a
secret which is referenced on the BSL and written to a temp file prior to secret which is referenced on the BSL and written to a temp file prior to
invoking Restic. invoking Restic.
[1](https://github.com/vmware-tanzu/velero/blob/master/pkg/restic/repository_manager.go#L238-L245) [1](https://github.com/vmware-tanzu/velero/blob/main/pkg/restic/repository_manager.go#L238-L245)
[2](https://github.com/vmware-tanzu/velero/blob/master/pkg/restic/common.go#L168-L203) [2](https://github.com/vmware-tanzu/velero/blob/main/pkg/restic/common.go#L168-L203)
## Detailed Design ## Detailed Design
@ -126,7 +126,7 @@ would look like:
$ velero client config set cacert PATH $ velero client config set cacert PATH
``` ```
[1]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/master/velero-plugin-for-aws/object_store.go#L135 [1]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/velero-plugin-for-aws/object_store.go#L135
[2]: https://github.com/vmware-tanzu/velero/blob/master/pkg/restic/command.go#L47 [2]: https://github.com/vmware-tanzu/velero/blob/main/pkg/restic/command.go#L47
[3]: https://github.com/restic/restic/blob/master/internal/backend/http_transport.go#L81 [3]: https://github.com/restic/restic/blob/main/internal/backend/http_transport.go#L81
[4]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/master/velero-plugin-for-aws/object_store.go#L154 [4]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/velero-plugin-for-aws/object_store.go#L154

View File

@ -3,7 +3,7 @@
Status: Accepted Status: Accepted
Some features may take a while to get fully implemented, and we don't necessarily want to have long-lived feature branches Some features may take a while to get fully implemented, and we don't necessarily want to have long-lived feature branches
A simple feature flag implementation allows code to be merged into master, but not used unless a flag is set. A simple feature flag implementation allows code to be merged into main, but not used unless a flag is set.
## Goals ## Goals

View File

@ -154,7 +154,7 @@ In order to know the CR created for the particular backup of a volume, Velero ad
- `velero.io/pv-name` with value as volume that is undergoing backup - `velero.io/pv-name` with value as volume that is undergoing backup
Backup name being unique won't cause issues like duplicates in identifying the CR. Backup name being unique won't cause issues like duplicates in identifying the CR.
Labels will be set with the value returned from `GetValidName` function. (https://github.com/vmware-tanzu/velero/blob/master/pkg/label/label.go#L35). Labels will be set with the value returned from `GetValidName` function. (https://github.com/vmware-tanzu/velero/blob/main/pkg/label/label.go#L35).
If Plugin supports showing progress of the operation it is performing, it does following: If Plugin supports showing progress of the operation it is performing, it does following:
- finds the VolumePluginBackup CR related to this backup operation by using `tags` passed in CreateSnapshot call - finds the VolumePluginBackup CR related to this backup operation by using `tags` passed in CreateSnapshot call
@ -281,7 +281,7 @@ In order to know the CR created for the particular restore of a volume, Velero a
- `velero.io/snapshot-id` with value as snapshot id that need to be restored - `velero.io/snapshot-id` with value as snapshot id that need to be restored
- `velero.io/provider` with value as `Provider` in `VolumeSnapshotLocation` - `velero.io/provider` with value as `Provider` in `VolumeSnapshotLocation`
Labels will be set with the value returned from `GetValidName` function. (https://github.com/vmware-tanzu/velero/blob/master/pkg/label/label.go#L35). Labels will be set with the value returned from `GetValidName` function. (https://github.com/vmware-tanzu/velero/blob/main/pkg/label/label.go#L35).
Plugin will be able to identify CR by using snapshotID that it received as parameter of CreateVolumeFromSnapshot API, and plugin's Provider name. Plugin will be able to identify CR by using snapshotID that it received as parameter of CreateVolumeFromSnapshot API, and plugin's Provider name.
It updates the progress of restore operation regularly if plugin supports feature of showing progress. It updates the progress of restore operation regularly if plugin supports feature of showing progress.
@ -376,7 +376,7 @@ In order to know the CR created for the particular backup of a volume, volume sn
Backup name being unique won't cause issues like duplicates in identifying the CR. Backup name being unique won't cause issues like duplicates in identifying the CR.
Plugin need to sanitize the value that can be set for above labels. Label need to be set with the value returned from `GetValidName` function. (https://github.com/vmware-tanzu/velero/blob/master/pkg/label/label.go#L35). Plugin need to sanitize the value that can be set for above labels. Label need to be set with the value returned from `GetValidName` function. (https://github.com/vmware-tanzu/velero/blob/main/pkg/label/label.go#L35).
Though no restrictions are required on the name of CR, as a general practice, volume snapshotter can name this CR with the value same as return value of CreateSnapshot. Though no restrictions are required on the name of CR, as a general practice, volume snapshotter can name this CR with the value same as return value of CreateSnapshot.

View File

@ -32,14 +32,14 @@ It will also update the `spec.volumeName` of the related persistent volume claim
## Detailed Design ## Detailed Design
In `pkg/restore/restore.go`, around [line 872](https://github.com/heptio/velero/blob/master/pkg/restore/restore.go#L872), Velero has special-case code for persistent volumes. In `pkg/restore/restore.go`, around [line 872](https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restore.go#L872), Velero has special-case code for persistent volumes.
This code will be updated to check for the two preconditions described in the previous section. This code will be updated to check for the two preconditions described in the previous section.
If the preconditions are met, the object will be given a new name. If the preconditions are met, the object will be given a new name.
The persistent volume will also be annotated with the original name, e.g. `velero.io/original-pv-name=NAME`. The persistent volume will also be annotated with the original name, e.g. `velero.io/original-pv-name=NAME`.
Importantly, the name change will occur **before** [line 890](https://github.com/heptio/velero/blob/master/pkg/restore/restore.go#L890), where Velero checks to see if it should restore the persistent volume. Importantly, the name change will occur **before** [line 890](https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restore.go#L890), where Velero checks to see if it should restore the persistent volume.
Additionally, the old and new persistent volume names will be recorded in a new field that will be added to the `context` struct, `renamedPVs map[string]string`. Additionally, the old and new persistent volume names will be recorded in a new field that will be added to the `context` struct, `renamedPVs map[string]string`.
In the special-case code for persistent volume claims starting on [line 987](https://github.com/heptio/velero/blob/master/pkg/restore/restore.go#L987), Velero will check to see if the claimed persistent volume has been renamed by looking in `ctx.renamedPVs`. In the special-case code for persistent volume claims starting on [line 987](https://github.com/heptio/velero/blob/main/pkg/restore/restore.go#L987), Velero will check to see if the claimed persistent volume has been renamed by looking in `ctx.renamedPVs`.
If so, Velero will update the persistent volume claim's `spec.volumeName` to the new name. If so, Velero will update the persistent volume claim's `spec.volumeName` to the new name.
## Alternatives Considered ## Alternatives Considered

View File

@ -14,9 +14,6 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# docker-push is invoked by the CI/CD system to deploy docker images to Docker Hub.
# It will build images for all commits to master and all git tags.
# The highest, non-prerelease semantic version will also be given the `latest` tag.
set +x set +x
@ -37,7 +34,7 @@ if ls ${change_log_file} 1> /dev/null 2>&1; then
echo "changelog for PR ${pr_number} exists" echo "changelog for PR ${pr_number} exists"
exit 0 exit 0
else else
echo "PR ${pr_number} is missing a changelog. Please refer https://velero.io/docs/master/code-standards/#adding-a-changelog and add a changelog." echo "PR ${pr_number} is missing a changelog. Please refer https://velero.io/docs/main/code-standards/#adding-a-changelog and add a changelog."
exit 1 exit 1
fi fi

View File

@ -15,7 +15,7 @@
# limitations under the License. # limitations under the License.
# docker-push is invoked by the CI/CD system to deploy docker images to Docker Hub. # docker-push is invoked by the CI/CD system to deploy docker images to Docker Hub.
# It will build images for all commits to master and all git tags. # It will build images for all commits to main and all git tags.
# The highest, non-prerelease semantic version will also be given the `latest` tag. # The highest, non-prerelease semantic version will also be given the `latest` tag.
set +x set +x
@ -56,24 +56,24 @@ elif [[ "$triggeredBy" == "tags" ]]; then
TAG=$(echo $GITHUB_REF | cut -d / -f 3) TAG=$(echo $GITHUB_REF | cut -d / -f 3)
fi fi
if [[ "$BRANCH" == "master" ]]; then if [[ "$BRANCH" == "main" ]]; then
VERSION="$BRANCH" VERSION="$BRANCH"
elif [[ ! -z "$TAG" ]]; then elif [[ ! -z "$TAG" ]]; then
# Explicitly checkout tags when building from a git tag. # Explicitly checkout tags when building from a git tag.
# This is not needed when building from master # This is not needed when building from main
git fetch --tags git fetch --tags
# Calculate the latest release if there's a tag. # Calculate the latest release if there's a tag.
highest_release highest_release
VERSION="$TAG" VERSION="$TAG"
else else
echo "We're not on master and we're not building a tag, exit early." echo "We're not on main and we're not building a tag, exit early."
exit 0 exit 0
fi fi
# Assume we're not tagging `latest` by default, and never on master. # Assume we're not tagging `latest` by default, and never on main.
TAG_LATEST=false TAG_LATEST=false
if [[ "$BRANCH" == "master" ]]; then if [[ "$BRANCH" == "main" ]]; then
echo "Building master, not tagging latest." echo "Building main, not tagging latest."
elif [[ "$TAG" == "$HIGHEST" ]]; then elif [[ "$TAG" == "$HIGHEST" ]]; then
TAG_LATEST=true TAG_LATEST=true
fi fi

View File

@ -38,14 +38,14 @@ fi
echo "Creating copy of docs directory site/docs/$PREVIOUS_DOCS_VERSION in site/docs/$NEW_DOCS_VERSION" echo "Creating copy of docs directory site/docs/$PREVIOUS_DOCS_VERSION in site/docs/$NEW_DOCS_VERSION"
cp -r site/docs/${PREVIOUS_DOCS_VERSION}/ site/docs/${NEW_DOCS_VERSION}/ cp -r site/docs/${PREVIOUS_DOCS_VERSION}/ site/docs/${NEW_DOCS_VERSION}/
# 'git add' the previous version's docs as-is so we get a useful diff when we copy the master docs in # 'git add' the previous version's docs as-is so we get a useful diff when we copy the main docs in
echo "Running 'git add' for previous version's doc contents to use as a base for diff" echo "Running 'git add' for previous version's doc contents to use as a base for diff"
git add site/docs/${NEW_DOCS_VERSION} git add site/docs/${NEW_DOCS_VERSION}
# now copy the contents of site/docs/master into the same directory so we can get a nice # now copy the contents of site/docs/main into the same directory so we can get a nice
# git diff of what changed since previous version # git diff of what changed since previous version
echo "Copying site/docs/master/ to site/docs/${NEW_DOCS_VERSION}/" echo "Copying site/docs/main/ to site/docs/${NEW_DOCS_VERSION}/"
rm -rf site/docs/${NEW_DOCS_VERSION}/ && cp -r site/docs/master/ site/docs/${NEW_DOCS_VERSION}/ rm -rf site/docs/${NEW_DOCS_VERSION}/ && cp -r site/docs/main/ site/docs/${NEW_DOCS_VERSION}/
# make a copy of the previous versioned ToC # make a copy of the previous versioned ToC
NEW_DOCS_TOC="$(echo ${NEW_DOCS_VERSION} | tr . -)-toc" NEW_DOCS_TOC="$(echo ${NEW_DOCS_VERSION} | tr . -)-toc"
@ -54,20 +54,20 @@ PREVIOUS_DOCS_TOC="$(echo ${PREVIOUS_DOCS_VERSION} | tr . -)-toc"
echo "Creating copy of site/_data/$PREVIOUS_DOCS_TOC.yml at site/_data/$NEW_DOCS_TOC.yml" echo "Creating copy of site/_data/$PREVIOUS_DOCS_TOC.yml at site/_data/$NEW_DOCS_TOC.yml"
cp site/_data/$PREVIOUS_DOCS_TOC.yml site/_data/$NEW_DOCS_TOC.yml cp site/_data/$PREVIOUS_DOCS_TOC.yml site/_data/$NEW_DOCS_TOC.yml
# 'git add' the previous version's ToC content as-is so we get a useful diff when we copy the master ToC in # 'git add' the previous version's ToC content as-is so we get a useful diff when we copy the main ToC in
echo "Running 'git add' for previous version's ToC to use as a base for diff" echo "Running 'git add' for previous version's ToC to use as a base for diff"
git add site/_data/$NEW_DOCS_TOC.yml git add site/_data/$NEW_DOCS_TOC.yml
# now copy the master ToC so we can get a nice git diff of what changed since previous version # now copy the main ToC so we can get a nice git diff of what changed since previous version
echo "Copying site/_data/master-toc.yml to site/_data/$NEW_DOCS_TOC.yml" echo "Copying site/_data/main-toc.yml to site/_data/$NEW_DOCS_TOC.yml"
rm site/_data/$NEW_DOCS_TOC.yml && cp site/_data/master-toc.yml site/_data/$NEW_DOCS_TOC.yml rm site/_data/$NEW_DOCS_TOC.yml && cp site/_data/main-toc.yml site/_data/$NEW_DOCS_TOC.yml
# replace known version-specific links -- the sed syntax is slightly different in OS X and Linux, # replace known version-specific links -- the sed syntax is slightly different in OS X and Linux,
# so check which OS we're running on. # so check which OS we're running on.
if [[ $(uname) == "Darwin" ]]; then if [[ $(uname) == "Darwin" ]]; then
echo "[OS X] updating version-specific links" echo "[OS X] updating version-specific links"
find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://velero.io/docs/master|https://velero.io/docs/$VELERO_VERSION|g" find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://velero.io/docs/main|https://velero.io/docs/$VELERO_VERSION|g"
find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://github.com/vmware-tanzu/velero/blob/master|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g" find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i '' "s|https://github.com/vmware-tanzu/velero/blob/main|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g"
echo "[OS X] Updating latest version in _config.yml" echo "[OS X] Updating latest version in _config.yml"
sed -i '' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" site/_config.yml sed -i '' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" site/_config.yml
@ -75,28 +75,28 @@ if [[ $(uname) == "Darwin" ]]; then
# newlines and lack of indentation are requirements for this sed syntax # newlines and lack of indentation are requirements for this sed syntax
# which is doing an append # which is doing an append
echo "[OS X] Adding latest version to versions list in _config.yml" echo "[OS X] Adding latest version to versions list in _config.yml"
sed -i '' "/- master/a\\ sed -i '' "/- main/a\\
- ${NEW_DOCS_VERSION} - ${NEW_DOCS_VERSION}
" site/_config.yml " site/_config.yml
echo "[OS X] Adding ToC mapping entry" echo "[OS X] Adding ToC mapping entry"
sed -i '' "/master: master-toc/a\\ sed -i '' "/main: main-toc/a\\
${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC} ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}
" site/_data/toc-mapping.yml " site/_data/toc-mapping.yml
else else
echo "[Linux] updating version-specific links" echo "[Linux] updating version-specific links"
find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://velero.io/docs/master|https://velero.io/docs/$VELERO_VERSION|g" find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://velero.io/docs/main|https://velero.io/docs/$VELERO_VERSION|g"
find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://github.com/vmware-tanzu/velero/blob/master|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g" find site/docs/${NEW_DOCS_VERSION} -type f -name "*.md" | xargs sed -i'' "s|https://github.com/vmware-tanzu/velero/blob/main|https://github.com/vmware-tanzu/velero/blob/$VELERO_VERSION|g"
echo "[Linux] Updating latest version in _config.yml" echo "[Linux] Updating latest version in _config.yml"
sed -i'' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" site/_config.yml sed -i'' "s/latest: ${PREVIOUS_DOCS_VERSION}/latest: ${NEW_DOCS_VERSION}/" site/_config.yml
echo "[Linux] Adding latest version to versions list in _config.yml" echo "[Linux] Adding latest version to versions list in _config.yml"
sed -i'' "/- master/a - ${NEW_DOCS_VERSION}" site/_config.yml sed -i'' "/- main/a - ${NEW_DOCS_VERSION}" site/_config.yml
echo "[Linux] Adding ToC mapping entry" echo "[Linux] Adding ToC mapping entry"
sed -i'' "/master: master-toc/a ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}" site/_data/toc-mapping.yml sed -i'' "/main: main-toc/a ${NEW_DOCS_VERSION}: ${NEW_DOCS_TOC}" site/_data/toc-mapping.yml
fi fi
echo "Success! site/docs/$NEW_DOCS_VERSION has been created." echo "Success! site/docs/$NEW_DOCS_VERSION has been created."

View File

@ -104,8 +104,8 @@ if [[ "$VELERO_PATCH" > 0 ]]; then
tag_and_push tag_and_push
else else
echo "Checking out upstream/master." echo "Checking out upstream/main."
git checkout upstream/master git checkout upstream/main
tag_and_push tag_and_push
fi fi

View File

@ -2,3 +2,9 @@
base = "site/" base = "site/"
command = "jekyll build" command = "jekyll build"
publish = "site/_site" publish = "site/_site"
# Using the * -> :splat rule should redirect anything under master to the matching file under main
[[redirects]]
from = "/docs/master/*"
to = "/docs/main/:splat"

View File

@ -54,7 +54,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/client"
) )
// nonRestorableResources is a blacklist for the restoration process. Any resources // nonRestorableResources is an exclusion list for the restoration process. Any resources
// included here are explicitly excluded from the restoration process. // included here are explicitly excluded from the restoration process.
var nonRestorableResources = []string{ var nonRestorableResources = []string{
"nodes", "nodes",

View File

@ -335,7 +335,7 @@ func getOrderedResources(resourcePriorities []string, backupResources map[string
} }
sort.Strings(orderedBackupResources) sort.Strings(orderedBackupResources)
// master list: everything in resource priorities, followed by what's in the backup (alphabetized) // main list: everything in resource priorities, followed by what's in the backup (alphabetized)
return append(resourcePriorities, orderedBackupResources...) return append(resourcePriorities, orderedBackupResources...)
} }

View File

@ -44,6 +44,6 @@ To add a new set of versioned docs to go with a new Velero release:
NEW_DOCS_VERSION=vX.Y VELERO_VERSION=vX.Y.Z make gen-docs NEW_DOCS_VERSION=vX.Y VELERO_VERSION=vX.Y.Z make gen-docs
``` ```
1. In `site/_config.yml`, under the `defaults` field, add an entry for the new version just under `master` by copying the most recent version's entry and updating the version numbers. 1. In `site/_config.yml`, under the `defaults` field, add an entry for the new version just under `main` by copying the most recent version's entry and updating the version numbers.
1. [Pre-release only] In `site/_config.yml`, revert the change to the `latest` field, so the pre-release docs do not become the default. 1. [Pre-release only] In `site/_config.yml`, revert the change to the `latest` field, so the pre-release docs do not become the default.

View File

@ -50,10 +50,10 @@ defaults:
values: values:
layout: "default" layout: "default"
- scope: - scope:
path: docs/master path: docs/main
values: values:
version: master version: main
gh: https://github.com/vmware-tanzu/velero/tree/master gh: https://github.com/vmware-tanzu/velero/tree/main
layout: "docs" layout: "docs"
- scope: - scope:
path: docs/v1.4 path: docs/v1.4
@ -178,7 +178,7 @@ collections:
versioning: true versioning: true
latest: v1.4 latest: v1.4
versions: versions:
- master - main
- v1.4 - v1.4
- v1.3.2 - v1.3.2
- v1.3.1 - v1.3.1
@ -230,4 +230,4 @@ exclude:
- LICENSE - LICENSE
- CNAME - CNAME
- Runbook.docx - Runbook.docx
- '*.sh' - '*.sh'

View File

@ -2,7 +2,7 @@
# (TOC). You'll want to use this after any revamps to information architecture, to ensure # (TOC). You'll want to use this after any revamps to information architecture, to ensure
# that the navigation for older versions still work. # that the navigation for older versions still work.
master: master-toc main: main-toc
v1.4: v1-4-toc v1.4: v1-4-toc
v1.3.2: v1-3-2-toc v1.3.2: v1-3-2-toc
v1.3.1: v1-3-1-toc v1.3.1: v1-3-1-toc

View File

@ -18,4 +18,4 @@
</article> </article>
</div> </div>
</div> </div>
</div> </div>

View File

@ -10,4 +10,4 @@
<div class="row mt-4"> <div class="row mt-4">
{% endif %} {% endif %}
{% endfor %} {% endfor %}
</div> </div>

View File

@ -10,4 +10,4 @@
<div class="row mt-4"> <div class="row mt-4">
{% endif %} {% endif %}
{% endfor %} {% endfor %}
</div> </div>

View File

@ -18,4 +18,4 @@
{% break %} {% break %}
{% endif %} {% endif %}
{% endfor %} {% endfor %}
</div> </div>

View File

@ -7,7 +7,7 @@
<div class="col"> <div class="col">
<p>{{ site.title }} is released as open source software and provides community support through our GitHub project page. <p>{{ site.title }} is released as open source software and provides community support through our GitHub project page.
If you encounter an issue or have a question, feel free to reach out on the <strong><a href="{{ site.gh_repo }}/issues" class="light">GitHub issues page for {{ site.title }}</a></strong>.</p> If you encounter an issue or have a question, feel free to reach out on the <strong><a href="{{ site.gh_repo }}/issues" class="light">GitHub issues page for {{ site.title }}</a></strong>.</p>
<p>The Velero project team welcomes contributions from the community, please see our <strong><a href="https://velero.io/docs/master/start-contributing/" class="light">contributing documentation</a></strong>. <p>The Velero project team welcomes contributions from the community, please see our <strong><a href="https://velero.io/docs/main/start-contributing/" class="light">contributing documentation</a></strong>.
</p> </p>
</div> </div>
</div> </div>
@ -23,4 +23,4 @@
</div> </div>
</div> </div>
{% endfor %} {% endfor %}
</div> </div>

View File

@ -7,4 +7,4 @@
<link rel="stylesheet" href="/css/styles.css?{{site.time | date: '%s%N'}}"> <link rel="stylesheet" href="/css/styles.css?{{site.time | date: '%s%N'}}">
<title>{{ site.title }} {{page.title}}</title> <title>{{ site.title }} {{page.title}}</title>
{% seo %} {% seo %}
</head> </head>

View File

@ -7,4 +7,4 @@
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}
</div> </div>

View File

@ -1,6 +1,6 @@
{% if page.version != site.latest %} {% if page.version != site.latest %}
<div class="alert alert-primary" role="alert"> <div class="alert alert-primary" role="alert">
{% if page.version == 'master' %} {% if page.version == 'main' %}
<p> <p>
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> <i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
This is the documentation for the latest development version of Velero. Both code and docs may be This is the documentation for the latest development version of Velero. Both code and docs may be

View File

@ -18,4 +18,4 @@
<span>{{ site.latest }}</span> <span>{{ site.latest }}</span>
{% endif %} {% endif %}
</div> </div>
</div> </div>

View File

@ -12,4 +12,4 @@
</div> </div>
</body> </body>
</html> </html>

View File

@ -1,7 +1,7 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
{% include head-docs.html %} {% include head-docs.html %}
{% if page.version != "master" %} {% if page.version != "main" %}
<!-- Block google from indexing versioned docs --> <!-- Block google from indexing versioned docs -->
<meta name="robots" content="noindex"> <meta name="robots" content="noindex">
{% endif %} {% endif %}

View File

@ -25,4 +25,4 @@
</div> </div>
</body> </body>
</html> </html>

View File

@ -52,4 +52,4 @@
</div> </div>
</body> </body>
</html> </html>

View File

@ -41,6 +41,6 @@ As always, we welcome feedback and participation in the development of Velero. A
[1]: https://github.com/vmware-tanzu [1]: https://github.com/vmware-tanzu
[2]: https://blogs.vmware.com/cloudnative/2019/10/01/open-source-in-vmware-tanzu/ [2]: https://blogs.vmware.com/cloudnative/2019/10/01/open-source-in-vmware-tanzu/
[3]: ../docs/master/supported-providers [3]: ../docs/main/supported-providers
[4]: https://velero.io/docs/master/ [4]: https://velero.io/docs/main/
[5]: https://github.com/vmware-tanzu/velero/issues#workspaces/velero-5c59c15e39d47b774b5864e3/board?milestones=v1.2%232019-10-31&filterLogic=any&repos=99143276&showPipelineDescriptions=false [5]: https://github.com/vmware-tanzu/velero/issues#workspaces/velero-5c59c15e39d47b774b5864e3/board?milestones=v1.2%232019-10-31&filterLogic=any&repos=99143276&showPipelineDescriptions=false

View File

@ -45,7 +45,7 @@ In Kubernetes 1.16, custom resource definitions (CRDs) reached general availabil
## And More ## And More
There are too many new features and improvements to cover in this short blog post. For full details on all of the changes, see the [full changelog](https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.2.md). There are too many new features and improvements to cover in this short blog post. For full details on all of the changes, see the [full changelog](https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.2.md).
## Community Contributors ## Community Contributors

View File

@ -42,7 +42,7 @@ We fixed a large number of bugs and made some smaller usability improvements in
- Allow restores from schedules in other clusters ([PR #2218](https://github.com/vmware-tanzu/velero/pull/2218), [@cpanato](https://github.com/cpanato)) - Allow restores from schedules in other clusters ([PR #2218](https://github.com/vmware-tanzu/velero/pull/2218), [@cpanato](https://github.com/cpanato))
- Fix memory leak & race condition in restore code ([PR #2201](https://github.com/vmware-tanzu/velero/pull/2201), [@skriss](https://github.com/skriss)) - Fix memory leak & race condition in restore code ([PR #2201](https://github.com/vmware-tanzu/velero/pull/2201), [@skriss](https://github.com/skriss))
For a full list of all changes in this release, see [the changelog](https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.3.md). For a full list of all changes in this release, see [the changelog](https://github.com/vmware-tanzu/velero/blob/main/changelogs/CHANGELOG-1.3.md).
## An Update on CSI Snapshot Support ## An Update on CSI Snapshot Support

View File

@ -8,9 +8,9 @@ id: community
If youre 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 youre 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.
Read how [we're using ZenHub](https://velero.io/docs/master/zenhub) for project and roadmap planning. Read how [we're using ZenHub](https://velero.io/docs/main/zenhub) for project and roadmap planning.
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/master/start-contributing/) documentation for guidance on how to setup Velero for development. 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 [ZenHub board](https://app.zenhub.com/workspace/o/vmware-tanzu/velero/boards?filterLogic=all&repos=99143276). You can follow the work we do, see our milestones, and our backlog on our [ZenHub board](https://app.zenhub.com/workspace/o/vmware-tanzu/velero/boards?filterLogic=all&repos=99143276).

View File

@ -27,14 +27,14 @@ If you encounter issues, review the [troubleshooting docs][30], [file an issue][
## Contributing ## Contributing
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/master/start-contributing/) documentation for guidance on how to setup Velero for development. 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.
## Changelog ## Changelog
See [the list of releases][6] to find out about feature changes. See [the list of releases][6] to find out about feature changes.
[1]: https://github.com/vmware-tanzu/velero/workflows/Master%20CI/badge.svg [1]: https://github.com/vmware-tanzu/velero/workflows/Main%20CI/badge.svg
[2]: https://github.com/vmware-tanzu/velero/actions?query=workflow%3A"Master+CI" [2]: https://github.com/vmware-tanzu/velero/actions?query=workflow%3A"Main+CI"
[4]: https://github.com/vmware-tanzu/velero/issues [4]: https://github.com/vmware-tanzu/velero/issues
[6]: https://github.com/vmware-tanzu/velero/releases [6]: https://github.com/vmware-tanzu/velero/releases
@ -42,7 +42,7 @@ See [the list of releases][6] to find out about feature changes.
[9]: https://kubernetes.io/docs/setup/ [9]: https://kubernetes.io/docs/setup/
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos [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 [11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
[12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md [12]: https://github.com/kubernetes/kubernetes/blob/main/cluster/addons/dns/README.md
[14]: https://github.com/kubernetes/kubernetes [14]: https://github.com/kubernetes/kubernetes
[24]: https://groups.google.com/forum/#!forum/projectvelero [24]: https://groups.google.com/forum/#!forum/projectvelero
[25]: https://kubernetes.slack.com/messages/velero [25]: https://kubernetes.slack.com/messages/velero

View File

@ -76,7 +76,7 @@ If after installing Velero you would like to change the image used by its deploy
kubectl -n velero set image deploy/velero velero=myimagerepo/velero:$VERSION kubectl -n velero set image deploy/velero velero=myimagerepo/velero:$VERSION
``` ```
To build a Velero container image, first set the `$REGISTRY` environment variable. For example, if you want to build the `gcr.io/my-registry/velero-amd64:master` image, set `$REGISTRY` to `gcr.io/my-registry`. If this variable is not set, the default is `velero`. To build a Velero container image, first set the `$REGISTRY` environment variable. For example, if you want to build the `gcr.io/my-registry/velero-amd64:main` image, set `$REGISTRY` to `gcr.io/my-registry`. If this variable is not set, the default is `velero`.
Optionally, set the `$VERSION` environment variable to change the image tag. Then, run: Optionally, set the `$VERSION` environment variable to change the image tag. Then, run:
@ -93,7 +93,7 @@ ARCH=linux-ppc64le make container
``` ```
_Note: By default, ARCH is set to linux-amd64_ _Note: By default, ARCH is set to linux-amd64_
To push your image to the registry. For example, if you want to push the `gcr.io/my-registry/velero-amd64:master` image, run: To push your image to the registry. For example, if you want to push the `gcr.io/my-registry/velero-amd64:main` image, run:
```bash ```bash
make push make push
@ -108,7 +108,7 @@ ARCH=linux-ppc64le make push
``` ```
_Note: By default, ARCH is set to linux-amd64_ _Note: By default, ARCH is set to linux-amd64_
To create and push your manifest to the registry. For example, if you want to create and push the `gcr.io/my-registry/velero:master` manifest, run: To create and push your manifest to the registry. For example, if you want to create and push the `gcr.io/my-registry/velero:main` manifest, run:
```bash ```bash
make manifest make manifest

View File

@ -62,7 +62,7 @@ Example:
We use a package to generate mocks for our interfaces. 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/master/pkg/restic/mocks/restorer.go Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/main/pkg/restic/mocks/restorer.go
Run: Run:

View File

@ -14,7 +14,7 @@ To set up IBM Cloud Object Storage (COS) as Velero's destination, you:
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/vmware-tanzu/velero/releases) tarball for your client platform.
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of _We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
Velero. The tarballs for each release contain the `velero` command-line client. The code in the master branch 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!_ of the Velero repository is under active development and is not guaranteed to be stable!_
1. Extract the tarball: 1. Extract the tarball:

View File

@ -22,7 +22,7 @@ If you encounter issues with installing or configuring, see [Debugging Installat
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/vmware-tanzu/velero/releases) tarball for your client platform.
_We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of _We strongly recommend that you use an [official release](https://github.com/vmware-tanzu/velero/releases) of
Velero. The tarballs for each release contain the `velero` command-line client. The code in the master branch 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!_ of the Velero repository is under active development and is not guaranteed to be stable!_
1. Extract the tarball: 1. Extract the tarball:

View File

@ -20,7 +20,7 @@
wget https://github.com/vmware-tanzu/velero/releases/download/v1.0.0/velero-v1.0.0-linux-amd64.tar.gz wget https://github.com/vmware-tanzu/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 master branch of the Velero repository is under active development and is not guaranteed to be stable!* *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!*
2. Untar the release in your `/usr/bin` directory: `tar -xzvf <RELEASE-TARBALL-NAME>.tar.gz` 2. Untar the release in your `/usr/bin` directory: `tar -xzvf <RELEASE-TARBALL-NAME>.tar.gz`
@ -241,5 +241,5 @@ After creating the Velero server in your cluster, try this example:
## Additional Reading ## Additional Reading
* [Official Velero Documentation](https://velero.io/docs/master/) * [Official Velero Documentation](https://velero.io/docs/main/)
* [Oracle Cloud Infrastructure Documentation](https://docs.cloud.oracle.com/) * [Oracle Cloud Infrastructure Documentation](https://docs.cloud.oracle.com/)

View File

@ -87,5 +87,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. 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 [1]: https://github.com/vmware-tanzu/velero-plugin-example
[2]: https://github.com/vmware-tanzu/velero/blob/master/pkg/plugin/logger.go [2]: https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/logger.go
[3]: https://github.com/vmware-tanzu/velero/blob/master/pkg/restore/restic_restore_action.go [3]: https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restic_restore_action.go

View File

@ -304,4 +304,4 @@ If you get an error like `complete:13: command not found: compdef`, then add the
[8]: https://github.com/vmware-tanzu/velero/issues/2311 [8]: https://github.com/vmware-tanzu/velero/issues/2311
[9]: self-signed-certificates.md [9]: self-signed-certificates.md
[10]: csi.md [10]: csi.md
[11]: https://github.com/vmware-tanzu/velero/blob/master/pkg/apis/velero/v1/constants.go [11]: https://github.com/vmware-tanzu/velero/blob/main/pkg/apis/velero/v1/constants.go

View File

@ -38,4 +38,4 @@ If you periodically back up your cluster's resources, you are able to return to
--patch '{"spec":{"accessMode":"ReadWrite"}}' --patch '{"spec":{"accessMode":"ReadWrite"}}'
``` ```
[1]: how-velero-works.md#set-a-backup-to-expire [1]: how-velero-works.md#set-a-backup-to-expire

View File

@ -60,4 +60,4 @@ After you set up the Velero server, try these examples:
velero restore create --from-backup nginx-backup velero restore create --from-backup nginx-backup
``` ```
[1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming [1]: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming

View File

@ -22,7 +22,7 @@ Examples of cases where Velero is useful:
Yes, with some exceptions. For example, when Velero restores pods it deletes the `nodeName` from the 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 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/master/pkg/restore/pod_action.go) in [pod_action.go](https://github.com/vmware-tanzu/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? ## I'm using Velero in multiple clusters. Should I use the same bucket to store all of my backups?

View File

@ -85,5 +85,5 @@ To use multiple commands, wrap your target command in a shell and separate them
[1]: api-types/backup.md [1]: api-types/backup.md
[2]: https://github.com/vmware-tanzu/velero/blob/master/examples/nginx-app/with-pv.yaml [2]: https://github.com/vmware-tanzu/velero/blob/main/examples/nginx-app/with-pv.yaml
[3]: cloud-common.md [3]: cloud-common.md

View File

@ -16,6 +16,6 @@ The `latest` tag follows the most recently released version of Velero.
## Development ## Development
`velero/velero:master` `velero/velero:main`
The `master` tag follows the latest commit to land on the `master` branch. The `main` tag follows the latest commit to land on the `main` branch.

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

@ -160,5 +160,5 @@ velero backup create full-cluster-backup
[1]: api-types/backupstoragelocation.md [1]: api-types/backupstoragelocation.md
[2]: api-types/volumesnapshotlocation.md [2]: api-types/volumesnapshotlocation.md
[3]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/master/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/master/backupstoragelocation.md [4]: https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure/blob/main/backupstoragelocation.md

View File

@ -84,4 +84,4 @@ To make sure it's the most up-to-date:
### Post-release - Windows Chocolatey version update ### Post-release - Windows Chocolatey version update
From a Windows computer, follow the step-by-step instructions to [create the Windows Chocolatey package for Velero CLI](https://github.com/adamrushuk/velero-choco/blob/master/README.md) From a Windows computer, follow the step-by-step instructions to [create the Windows Chocolatey package for Velero CLI](https://github.com/adamrushuk/velero-choco/blob/main/README.md)

View File

@ -19,7 +19,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`. 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/master/CODE_OF_CONDUCT.md [1]: https://github.com/vmware-tanzu/velero/blob/main/CODE_OF_CONDUCT.md
[2]: https://github.com/vmware-tanzu/velero/blob/master/CONTRIBUTING.md [2]: https://github.com/vmware-tanzu/velero/blob/main/CONTRIBUTING.md
[3]: https://github.com/vmware-tanzu/velero/blob/master/.github/ISSUE_TEMPLATE/feature-enhancement-request.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/master/.github/ISSUE_TEMPLATE/bug_report.md [4]: https://github.com/vmware-tanzu/velero/blob/main/.github/ISSUE_TEMPLATE/bug_report.md

View File

@ -52,7 +52,7 @@ In the case you want to take volume snapshots but didn't find a plugin for your
[3]: contributions/minio.md [3]: contributions/minio.md
[4]: https://github.com/StackPointCloud/ark-plugin-digitalocean [4]: https://github.com/StackPointCloud/ark-plugin-digitalocean
[5]: http://www.noobaa.com/ [5]: http://www.noobaa.com/
[6]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/master/backupstoragelocation.md [6]: https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/main/backupstoragelocation.md
[7]: https://aws.amazon.com [7]: https://aws.amazon.com
[8]: https://github.com/vmware-tanzu/velero-plugin-for-aws [8]: https://github.com/vmware-tanzu/velero-plugin-for-aws
[9]: https://azure.com [9]: https://azure.com

View File

@ -116,8 +116,8 @@ Now, visiting http://localhost:8085/metrics on a browser should show the metrics
[2]: debugging-install.md [2]: debugging-install.md
[4]: https://github.com/vmware-tanzu/velero/issues [4]: https://github.com/vmware-tanzu/velero/issues
[5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
[6]: https://github.com/vmware-tanzu/helm-charts/blob/master/charts/velero [6]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero
[7]: https://github.com/vmware-tanzu/helm-charts/blob/master/charts/velero/values.yaml#L44 [7]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L44
[8]: https://github.com/vmware-tanzu/helm-charts/blob/master/charts/velero/values.yaml#L49-L52 [8]: https://github.com/vmware-tanzu/helm-charts/blob/main/charts/velero/values.yaml#L49-L52
[9]: https://kubectl.docs.kubernetes.io/pages/container_debugging/port_forward_to_pods.html [9]: https://kubectl.docs.kubernetes.io/pages/container_debugging/port_forward_to_pods.html
[25]: https://kubernetes.slack.com/messages/velero [25]: https://kubernetes.slack.com/messages/velero

View File

@ -5,4 +5,4 @@ If you would like to completely uninstall Velero from your cluster, the followin
```bash ```bash
kubectl delete namespace/velero clusterrolebinding/velero kubectl delete namespace/velero clusterrolebinding/velero
kubectl delete crds -l component=velero kubectl delete crds -l component=velero
``` ```

View File

@ -18,7 +18,7 @@ Alternatively, for quickly loading the website, under the `velero/site/` directo
bundle exec jekyll serve --livereload --future bundle exec jekyll serve --livereload --future
``` ```
For more information on how to run the website locally, please see our [jekyll documentation](https://github.com/vmware-tanzu/velero/blob/master/site/README-JEKYLL.md). For more information on how to run the website locally, please see our [jekyll documentation](https://github.com/vmware-tanzu/velero/blob/main/site/README-JEKYLL.md).
## Adding a blog post ## Adding a blog post

View File

@ -52,24 +52,24 @@ Feedback and discussion are available on [the mailing list][24].
See [the list of releases][6] to find out about feature changes. See [the list of releases][6] to find out about feature changes.
[0]: https://github.com/heptio [0]: https://github.com/heptio
[1]: https://travis-ci.org/heptio/ark.svg?branch=master [1]: https://travis-ci.org/heptio/ark.svg?branch=main
[2]: https://travis-ci.org/heptio/ark [2]: https://travis-ci.org/heptio/ark
[4]: https://github.com/heptio/ark/issues [4]: https://github.com/heptio/ark/issues
[5]: https://github.com/heptio/ark/blob/master/CONTRIBUTING.md [5]: https://github.com/heptio/ark/blob/main/CONTRIBUTING.md
[6]: https://github.com/heptio/ark/releases [6]: https://github.com/heptio/ark/releases
[8]: https://github.com/heptio/ark/blob/master/CODE_OF_CONDUCT.md [8]: https://github.com/heptio/ark/blob/main/CODE_OF_CONDUCT.md
[9]: https://kubernetes.io/docs/setup/ [9]: https://kubernetes.io/docs/setup/
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos [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 [11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
[12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md [12]: https://github.com/kubernetes/kubernetes/blob/main/cluster/addons/dns/README.md
[14]: https://github.com/kubernetes/kubernetes [14]: https://github.com/kubernetes/kubernetes
[24]: http://j.hept.io/ark-list [24]: http://j.hept.io/ark-list
[25]: https://kubernetes.slack.com/messages/ark-dr [25]: https://kubernetes.slack.com/messages/ark-dr
[26]: https://github.com/heptio/ark/blob/master/docs/zenhub.md [26]: https://github.com/heptio/ark/blob/main/docs/zenhub.md
[29]: https://velero.io/docs/v0.10.0/ [29]: https://velero.io/docs/v0.10.0/

View File

@ -208,13 +208,13 @@ If you need to add or update the vendored dependencies, see [Vendoring dependenc
[3]: #build [3]: #build
[4]: https://blog.golang.org/organizing-go-code [4]: https://blog.golang.org/organizing-go-code
[5]: https://golang.org/doc/install [5]: https://golang.org/doc/install
[6]: https://github.com/heptio/ark/tree/master/examples [6]: https://github.com/heptio/ark/tree/main/examples
[7]: #run [7]: #run
[8]: config-definition.md [8]: config-definition.md
[10]: #vendoring-dependencies [10]: #vendoring-dependencies
[11]: vendoring-dependencies.md [11]: vendoring-dependencies.md
[12]: #test [12]: #test
[13]: https://github.com/heptio/ark/blob/master/hack/generate-proto.sh [13]: https://github.com/heptio/ark/blob/main/hack/generate-proto.sh
[14]: https://grpc.io/docs/quickstart/go.html#install-protocol-buffers-v3 [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 [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 [16]: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable

View File

@ -56,4 +56,4 @@ into the Ark server pod. Ensure the following:
* The `cloud-credentials` secret is defined as a volume for the Ark deployment * The `cloud-credentials` secret is defined as a volume for the Ark deployment
* The `cloud-credentials` secret is being mounted into the Ark server pod at `/credentials` * The `cloud-credentials` secret is being mounted into the Ark server pod at `/credentials`
[0]: azure-config#credentials-and-configuration [0]: azure-config#credentials-and-configuration

View File

@ -22,7 +22,7 @@ Examples of cases where Ark is useful:
Yes, with some exceptions. For example, when Ark restores pods it deletes the `nodeName` from the Yes, with some exceptions. For example, when Ark restores pods it deletes the `nodeName` from the
pod so that it can be scheduled onto a new node. You can see some more examples of the differences pod so that it can be scheduled onto a new node. You can see some more examples of the differences
in [pod_action.go](https://github.com/heptio/ark/blob/master/pkg/restore/pod_action.go) in [pod_action.go](https://github.com/heptio/ark/blob/main/pkg/restore/pod_action.go)
## I'm using Ark in multiple clusters. Should I use the same bucket to store all of my backups? ## I'm using Ark in multiple clusters. Should I use the same bucket to store all of my backups?

View File

@ -16,6 +16,6 @@ The `latest` tag follows the most recently released version of Ark.
## Development ## Development
`gcr.io/heptio-images/ark:master` `gcr.io/heptio-images/ark:main`
The `master` tag follows the latest commit to land on the `master` branch. The `main` tag follows the latest commit to land on the `main` branch.

View File

@ -45,4 +45,4 @@ Check that the second cluster is behaving as expected:
ark restore describe <RESTORE-NAME-FROM-GET-COMMAND> ark restore describe <RESTORE-NAME-FROM-GET-COMMAND>
``` ```
If you encounter issues, make sure that Ark is running in the same namespace in both clusters. If you encounter issues, make sure that Ark is running in the same namespace in both clusters.

View File

@ -28,4 +28,4 @@ within your plugin.
[1]: https://github.com/heptio/ark-plugin-example [1]: https://github.com/heptio/ark-plugin-example
[2]: https://github.com/heptio/ark/blob/master/pkg/plugin/logger.go [2]: https://github.com/heptio/ark/blob/main/pkg/plugin/logger.go

View File

@ -44,4 +44,4 @@ roleRef:
[1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ [1]: https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/
[2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/ [2]: https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/
[3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ [3]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
[4]: namespace.md [4]: namespace.md

Some files were not shown because too many files have changed in this diff Show More