Add changelog and docs for v1.5 release (#2941)
* Add changelog and docs for v1.5 release Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Fix markdown indentation Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Fix URLs with patch version Signed-off-by: Nolan Brubaker <brubakern@vmware.com> * Fix example link Signed-off-by: Nolan Brubaker <brubakern@vmware.com>pull/2947/head v1.5.1
Nolan Brubaker
GitHub
parent
6e20eaaba8
commit
87d86a45a6
|
|
@ -1,10 +1,8 @@
|
|||
## Current release:
|
||||
* [CHANGELOG-1.4.md][14]
|
||||
|
||||
## Development release:
|
||||
* [Unreleased Changes][15]
|
||||
* [CHANGELOG-1.5.md][15]
|
||||
|
||||
## Older releases:
|
||||
* [CHANGELOG-1.4.md][14]
|
||||
* [CHANGELOG-1.3.md][13]
|
||||
* [CHANGELOG-1.2.md][12]
|
||||
* [CHANGELOG-1.1.md][11]
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
## v1.5.0-rc.1
|
||||
### 2020-09-09
|
||||
## v1.5.1
|
||||
### 2020-09-16
|
||||
|
||||
### Download
|
||||
https://github.com/vmware-tanzu/velero/releases/tag/v1.5.0-rc.1
|
||||
https://github.com/vmware-tanzu/velero/releases/tag/v1.5.1
|
||||
|
||||
### Container Image
|
||||
`velero/velero:v1.5.0-rc.1`
|
||||
`velero/velero:v1.5.1`
|
||||
|
||||
### Documentation
|
||||
https://velero.io/docs/v1.5-pre/
|
||||
https://velero.io/docs/v1.5/
|
||||
|
||||
### Upgrading
|
||||
https://velero.io/docs/v1.5-pre/upgrade-to-1.5/
|
||||
https://velero.io/docs/v1.5/upgrade-to-1.5/
|
||||
|
||||
### Highlights
|
||||
|
||||
|
|
@ -22,25 +22,26 @@ https://velero.io/docs/v1.5-pre/upgrade-to-1.5/
|
|||
|
||||
### All Changes
|
||||
|
||||
* 🏃♂️ add shortnames for CRDs (#2911, @ashish-amarnath)
|
||||
* Use format version instead of version on `velero backup describe` since version has been deprecated (#2901, @jenting)
|
||||
* Implement post-restore exec hooks in pod containers (#2804, @areed)
|
||||
* rename the PV if VolumeSnapshotter has modified the PV name (#2835, @pawanpraka1)
|
||||
* fix EnableAPIGroupersions output log format (#2882, @jenting)
|
||||
* Convert ServerStatusRequest controller to kubebuilder (#2838, @carlisia)
|
||||
* rename the PV if VolumeSnapshotter has modified the PV name (#2835, @pawanpraka1)
|
||||
* Implement post-restore exec hooks in pod containers (#2804, @areed)
|
||||
* Check for errors on restic backup command (#2863, @dymurray)
|
||||
* 🐛 fix passing LDFLAGS across build stages (#2853, @ashish-amarnath)
|
||||
* Feature: Invoke DeleteItemAction plugins based on backup contents when a backup is deleted. (#2815, @nrb)
|
||||
* When JSON logging format is enabled, place error message at "error.message" instead of "error" for compatibility with Elasticsearch/ELK and the Elastic Common Schema (#2830, @bgagnon)
|
||||
* Add the DeleteItemAction plugin type (#2808, @nrb)
|
||||
* discovery Helper support get GroupVersionResource and an APIResource from GroupVersionKind (#2764, @runzexia)
|
||||
* 🐛 Manually patch the generated yaml for restore CRD as a hacky workaround (#2814, @ashish-amarnath)
|
||||
* Pass default-volumes-to-restic flag from create schedule to backup (#2776, @ashish-amarnath)
|
||||
* Enhance Backup to support backing up resources in specific orders and add --ordered-resources option to support this feature. (#2724, @phuong)
|
||||
* Migrate site from Jekyll to Hugo (#2720, @tbatard)
|
||||
* Add the DeleteItemAction plugin type (#2808, @nrb)
|
||||
* 🐛 Manually patch the generated yaml for restore CRD as a hacky workaround (#2814, @ashish-amarnath)
|
||||
* Setup crd validation github action on k8s versions (#2805, @ashish-amarnath)
|
||||
* 🐛 Supply command to run restic-wait init container (#2802, @ashish-amarnath)
|
||||
* Make init and exec restore hooks as optional in restore hookSpec (#2793, @ashish-amarnath)
|
||||
* Implement restore hooks injecting init containers into pod spec (#2787, @ashish-amarnath)
|
||||
* Pass default-volumes-to-restic flag from create schedule to backup (#2776, @ashish-amarnath)
|
||||
* Enhance Backup to support backing up resources in specific orders and add --ordered-resources option to support this feature. (#2724, @phuong)
|
||||
* Fix inconsistent type for the "resource" structured logging field (#2796, @bgagnon)
|
||||
* Add the ability to set the allowPrivilegeEscalation flag in the securityContext for the Restic restore helper. (#2792, @doughepi)
|
||||
* Add cacert flag for velero backup-location create (#2778, @jenting)
|
||||
|
|
@ -55,28 +56,27 @@ Displays the Timestamps when issued a print or describe (#2748, @thejasbabu)
|
|||
* add metrics for restic back up operation (#2719, @ashish-amarnath)
|
||||
* StorageGrid compatibility by removing explicit gzip accept header setting (#2712, @fvsqr)
|
||||
* restic: add support for setting SecurityContext (runAsUser, runAsGroup) for restore (#2621, @jaygridley)
|
||||
* Convert manifests + BSL api client to kubebuilder (#2561, @carlisia)
|
||||
* Add linter checks to Makefile (#2615, @tbatard)
|
||||
* improve builder image handling so that we don't rebuild each `make shell`
|
||||
first check if there are pending changed on the build-image dockerfile if so build it.
|
||||
then check if there is an image in the registry if so pull it.
|
||||
then build an image cause we don't have a cached image. (this handles the backward compat case.)
|
||||
fix make clean to clear go mod cache before removing dirs (for containerized builds) (#2620, @mauilion)
|
||||
* Add backupValidationFailureTotal to metrics (#2714, @kathpeony)
|
||||
* bump Kubernetes module dependencies to v0.18.4 to fix https://github.com/vmware-tanzu/velero/issues/2540 by adding code compatibility with kubernetes v1.18 (#2651, @laverya)
|
||||
* Add a BSL controller to handle validation + update BSL status phase (validation removed from the server and no longer blocks when there's any invalid BSL) (#2674, @carlisia)
|
||||
* updated acceptable values on cron schedule from 0-7 to 0-6 (#2676, @dthrasher)
|
||||
* Add backupValidationFailureTotal to metrics (#2714, @kathpeony)
|
||||
* move CSI plugin out of prototype into beta (#2636, @ashish-amarnath)
|
||||
* Improve velero download doc (#2660, @carlisia)
|
||||
* log a warning instead of erroring if an additional item returned from a plugin can't be found in the Kubernetes API (#2595, @skriss)
|
||||
* Azure: support using `aad-pod-identity` auth when using restic (#2602, @skriss)
|
||||
* When a timeout string can't be parsed, log the error as a warning instead of silently consuming the error. (#2610, @nrb)
|
||||
* implement option to back up all volumes by default with restic (#2611, @ashish-amarnath)
|
||||
* add a CI check for a changelog file (#2613, @ashish-amarnath)
|
||||
* Documentation: Update Jekyll to 4.1.0
|
||||
* Switch from redcarpet to kramdown for Markdown renderer (#2625, @tbatard)
|
||||
* Update basic-install.md documentation: Add windows cli installation option via chocolatey (#2629, @adamrushuk)
|
||||
* Add a new supported provider for an object storage plugin for Storj (#2635, @jessicagreben)
|
||||
* Update basic-install and release-instructions documentation for Windows Chocolatey package (#2638, @adamrushuk)
|
||||
* backup/restore: reinstantiate backup store just before uploading artifacts to ensure credentials are up-to-date (#2550, @skriss)
|
||||
* move CSI plugin out of prototype into beta (#2636, @ashish-amarnath)
|
||||
* Add a new supported provider for an object storage plugin for Storj (#2635, @jessicagreben)
|
||||
* Update basic-install.md documentation: Add windows cli installation option via chocolatey (#2629, @adamrushuk)
|
||||
* Documentation: Update Jekyll to 4.1.0. Switch from redcarpet to kramdown for Markdown renderer (#2625, @tbatard)
|
||||
* improve builder image handling so that we don't rebuild each `make shell` (#2620, @mauilion)
|
||||
* first check if there are pending changed on the build-image dockerfile if so build it.
|
||||
* then check if there is an image in the registry if so pull it.
|
||||
* then build an image cause we don't have a cached image. (this handles the backward compat case.)
|
||||
* fix make clean to clear go mod cache before removing dirs (for containerized builds)
|
||||
* Add linter checks to Makefile (#2615, @tbatard)
|
||||
* add a CI check for a changelog file (#2613, @ashish-amarnath)
|
||||
* implement option to back up all volumes by default with restic (#2611, @ashish-amarnath)
|
||||
* When a timeout string can't be parsed, log the error as a warning instead of silently consuming the error. (#2610, @nrb)
|
||||
* Azure: support using `aad-pod-identity` auth when using restic (#2602, @skriss)
|
||||
* log a warning instead of erroring if an additional item returned from a plugin can't be found in the Kubernetes API (#2595, @skriss)
|
||||
* when creating new backup from schedule from cli, allow backup name to be automatically generated (#2569, @cblecker)
|
||||
* Convert manifests + BSL api client to kubebuilder (#2561, @carlisia)
|
||||
* backup/restore: reinstantiate backup store just before uploading artifacts to ensure credentials are up-to-date (#2550, @skriss)
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
backup/restore: reinstantiate backup store just before uploading artifacts to ensure credentials are up-to-date
|
||||
|
|
@ -1 +0,0 @@
|
|||
Convert manifests + BSL api client to kubebuilder
|
||||
|
|
@ -1 +0,0 @@
|
|||
when creating new backup from schedule from cli, allow backup name to be automatically generated
|
||||
|
|
@ -1 +0,0 @@
|
|||
log a warning instead of erroring if an additional item returned from a plugin can't be found in the Kubernetes API
|
||||
|
|
@ -1 +0,0 @@
|
|||
Azure: support using `aad-pod-identity` auth when using restic
|
||||
|
|
@ -1 +0,0 @@
|
|||
When a timeout string can't be parsed, log the error as a warning instead of silently consuming the error.
|
||||
|
|
@ -1 +0,0 @@
|
|||
implement option to back up all volumes by default with restic
|
||||
|
|
@ -1 +0,0 @@
|
|||
add a CI check for a changelog file
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add linter checks to Makefile
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
improve builder image handling so that we don't rebuild each `make shell`
|
||||
first check if there are pending changed on the build-image dockerfile if so build it.
|
||||
then check if there is an image in the registry if so pull it.
|
||||
then build an image cause we don't have a cached image. (this handles the backward compat case.)
|
||||
fix make clean to clear go mod cache before removing dirs (for containerized builds)
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
restic: add support for setting SecurityContext (runAsUser, runAsGroup) for restore
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
Documentation: Update Jekyll to 4.1.0
|
||||
|
||||
Switch from redcarpet to kramdown for Markdown renderer
|
||||
|
|
@ -1 +0,0 @@
|
|||
Update basic-install.md documentation: Add windows cli installation option via chocolatey
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add a new supported provider for an object storage plugin for Storj
|
||||
|
|
@ -1 +0,0 @@
|
|||
move CSI plugin out of prototype into beta
|
||||
|
|
@ -1 +0,0 @@
|
|||
Update basic-install and release-instructions documentation for Windows Chocolatey package
|
||||
|
|
@ -1 +0,0 @@
|
|||
bump Kubernetes module dependencies to v0.18.4 to fix https://github.com/vmware-tanzu/velero/issues/2540 by adding code compatibility with kubernetes v1.18
|
||||
|
|
@ -1 +0,0 @@
|
|||
Improve velero download doc
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add a BSL controller to handle validation + update BSL status phase (validation removed from the server and no longer blocks when there's any invalid BSL)
|
||||
|
|
@ -1 +0,0 @@
|
|||
updated acceptable values on cron schedule from 0-7 to 0-6
|
||||
|
|
@ -1 +0,0 @@
|
|||
StorageGrid compatibility by removing explicit gzip accept header setting
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add backupValidationFailureTotal to metrics
|
||||
|
|
@ -1 +0,0 @@
|
|||
add metrics for restic back up operation
|
||||
|
|
@ -1 +0,0 @@
|
|||
Migrate site from Jekyll to Hugo
|
||||
|
|
@ -1 +0,0 @@
|
|||
Enhance Backup to support backing up resources in specific orders and add --ordered-resources option to support this feature.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Move pkg/backup/item_hook_handlers.go to internal/hook
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
Adds Start and CompletionTimestamp to RestoreStatus
|
||||
Displays the Timestamps when issued a print or describe
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add annotation key constants for restore hooks
|
||||
|
|
@ -1 +0,0 @@
|
|||
Refactor image builds to use buildx for multi arch image building
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add wait group and error channel for restore hooks to restore context.
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add types to implement restore hooks
|
||||
|
|
@ -1 +0,0 @@
|
|||
Exclude volumes mounting secrets and configmaps from defaulting volume backups to restic
|
||||
|
|
@ -1 +0,0 @@
|
|||
discovery Helper support get GroupVersionResource and an APIResource from GroupVersionKind
|
||||
|
|
@ -1 +0,0 @@
|
|||
Pass default-volumes-to-restic flag from create schedule to backup
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add cacert flag for velero backup-location create
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
Implement restore hooks injecting init containers into pod spec
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add the ability to set the allowPrivilegeEscalation flag in the securityContext for the Restic restore helper.
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
Make init and exec restore hooks as optional in restore hookSpec
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
Fix inconsistent type for the "resource" structured logging field
|
||||
|
|
@ -1 +0,0 @@
|
|||
🐛 Supply command to run restic-wait init container
|
||||
|
|
@ -1 +0,0 @@
|
|||
Implement post-restore exec hooks in pod containers
|
||||
|
|
@ -1 +0,0 @@
|
|||
Setup crd validation github action on k8s versions
|
||||
|
|
@ -1 +0,0 @@
|
|||
Add the DeleteItemAction plugin type
|
||||
|
|
@ -1 +0,0 @@
|
|||
🐛 Manually patch the generated yaml for restore CRD as a hacky workaround
|
||||
|
|
@ -1 +0,0 @@
|
|||
Feature: Invoke DeleteItemAction plugins based on backup contents when a backup is deleted.
|
||||
|
|
@ -1 +0,0 @@
|
|||
When JSON logging format is enabled, place error message at "error.message" instead of "error" for compatibility with Elasticsearch/ELK and the Elastic Common Schema
|
||||
|
|
@ -1 +0,0 @@
|
|||
rename the PV if VolumeSnapshotter has modified the PV name
|
||||
|
|
@ -1 +0,0 @@
|
|||
Convert ServerStatusRequest controller to kubebuilder
|
||||
|
|
@ -1 +0,0 @@
|
|||
🐛 fix passing LDFLAGS across build stages
|
||||
|
|
@ -1 +0,0 @@
|
|||
Check for errors on restic backup command
|
||||
|
|
@ -1 +0,0 @@
|
|||
fix EnableAPIGroupersions output log format
|
||||
|
|
@ -1 +0,0 @@
|
|||
Use format version instead of version on `velero backup describe` since version has been deprecated
|
||||
|
|
@ -1 +0,0 @@
|
|||
🏃♂️ add shortnames for CRDs
|
||||
|
|
@ -12,10 +12,10 @@ params:
|
|||
hero:
|
||||
backgroundColor: med-blue
|
||||
versioning: true
|
||||
latest: v1.4
|
||||
latest: v1.5
|
||||
versions:
|
||||
- main
|
||||
- v1.5.0-rc.1
|
||||
- v1.5
|
||||
- v1.4
|
||||
- v1.3.2
|
||||
- v1.3.1
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ For each major or minor release, create and publish a blog post to let folks kno
|
|||
- Delete the pre-release docs table of contents file, i.e. `site/data/<pre-release-version>-toc.yml`.
|
||||
- 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/update the "Upgrade to $major.minor" page (Example: https://velero.io/docs/main/upgrade-to-1.5/). This needs to be done in both the versioned and the `main` folders.
|
||||
1. Create/update the "Upgrade to $major.minor" page (Example: https://velero.io/docs/v1.5/upgrade-to-1.5/ ). 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.
|
||||
- Do a review of the diffs, and/or run `make serve-docs` and review the site.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ If you're not yet running at least Velero v1.4, see the following:
|
|||
|
||||
```bash
|
||||
Client:
|
||||
Version: v1.5.0-rc.1
|
||||
Version: v1.5.1
|
||||
Git commit: <git SHA>
|
||||
```
|
||||
|
||||
|
|
@ -42,12 +42,12 @@ If you're not yet running at least Velero v1.4, see the following:
|
|||
|
||||
```bash
|
||||
kubectl set image deployment/velero \
|
||||
velero=velero/velero:v1.5.0-rc.1 \
|
||||
velero=velero/velero:v1.5.1 \
|
||||
--namespace velero
|
||||
|
||||
# optional, if using the restic daemon set
|
||||
kubectl set image daemonset/restic \
|
||||
restic=velero/velero:v1.5.0-rc.1 \
|
||||
restic=velero/velero:v1.5.1 \
|
||||
--namespace velero
|
||||
```
|
||||
|
||||
|
|
@ -61,11 +61,11 @@ If you're not yet running at least Velero v1.4, see the following:
|
|||
|
||||
```bash
|
||||
Client:
|
||||
Version: v1.5.0-rc.1
|
||||
Version: v1.5.1
|
||||
Git commit: <git SHA>
|
||||
|
||||
Server:
|
||||
Version: v1.4.0-rc.1
|
||||
Version: v1.5.1
|
||||
```
|
||||
|
||||
[0]: basic-install.md#install-the-cli
|
||||
|
|
@ -74,3 +74,4 @@ If you're not yet running at least Velero v1.4, see the following:
|
|||
[3]: https://velero.io/docs/v1.3.2/upgrade-to-1.3/
|
||||
[4]: https://velero.io/docs/v1.4/upgrade-to-1.4/
|
||||
[5]: https://github.com/vmware-tanzu/velero/releases/tag/v1.4.2
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
toc: "false"
|
||||
cascade:
|
||||
version: v1.5.0-rc.1
|
||||
version: v1.5
|
||||
toc: "true"
|
||||
---
|
||||
![100]
|
||||
|
|
@ -33,7 +33,7 @@ If you encounter issues, review the [troubleshooting docs][30], [file an issue][
|
|||
|
||||
## 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/v1.5.0-rc.1/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/v1.5/start-contributing/) documentation for guidance on how to setup Velero for development.
|
||||
|
||||
## Changelog
|
||||
|
||||
|
|
@ -88,5 +88,5 @@ To use multiple commands, wrap your target command in a shell and separate them
|
|||
|
||||
|
||||
[1]: api-types/backup.md
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.5.0-rc.1/examples/nginx-app/with-pv.yaml
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.5.1/examples/nginx-app/with-pv.yaml
|
||||
[3]: cloud-common.md
|
||||
|
|
@ -80,7 +80,7 @@ Example:
|
|||
|
||||
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.5.0-rc.1/pkg/restic/mocks/restorer.go
|
||||
Example: if you want to change this mock: https://github.com/vmware-tanzu/velero/blob/v1.5.1/pkg/restic/mocks/restorer.go
|
||||
|
||||
Run:
|
||||
|
||||
|
|
@ -244,5 +244,5 @@ After creating the Velero server in your cluster, try this example:
|
|||
|
||||
## Additional Reading
|
||||
|
||||
* [Official Velero Documentation](https://velero.io/docs/v1.5.0-rc.1/)
|
||||
* [Official Velero Documentation](https://velero.io/docs/v1.5/)
|
||||
* [Oracle Cloud Infrastructure Documentation](https://docs.cloud.oracle.com/)
|
||||
|
|
@ -91,5 +91,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.5.0-rc.1/pkg/plugin/logger.go
|
||||
[3]: https://github.com/vmware-tanzu/velero/blob/v1.5.0-rc.1/pkg/restore/restic_restore_action.go
|
||||
[2]: https://github.com/vmware-tanzu/velero/blob/v1.5.1/pkg/plugin/logger.go
|
||||
[3]: https://github.com/vmware-tanzu/velero/blob/v1.5.1/pkg/restore/restic_restore_action.go
|
||||
|
|
@ -348,4 +348,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
|
||||
[9]: self-signed-certificates.md
|
||||
[10]: csi.md
|
||||
[11]: https://github.com/vmware-tanzu/velero/blob/v1.5.0-rc.1/pkg/apis/velero/v1/constants.go
|
||||
[11]: https://github.com/vmware-tanzu/velero/blob/v1.5.1/pkg/apis/velero/v1/constants.go
|
||||
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
|
@ -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/vmware-tanzu/velero/blob/v1.5.1/GOVERNANCE.md#code-repositories).
|
||||
|
||||
Please be sure to also go through the guidance under the entire [Contribute](start-contributing/) section.
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ 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/vmware-tanzu/velero/blob/v1.5.1/GOVERNANCE.md#lazy-consensus) policy for the project.
|
||||
|
||||
## Creating a release
|
||||
Maintainers are expected to create releases for the project. We have parts of the process automated, and full [instructions](release-instructions).
|
||||
|
|
@ -26,4 +26,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/vmware-tanzu/velero/blob/v1.5.1/GOVERNANCE.md#maintainers) is decided.
|
||||
|
|
@ -6,8 +6,8 @@ toc: "true"
|
|||
This page covers the steps to perform when releasing a new version of Velero.
|
||||
|
||||
## General notes
|
||||
- Please read the documented variables in each scrip to understand what they are for and how to properly format their values.
|
||||
- You will need to have a remote named `origin` pointing to the Velero repository so the scripts can work properly.
|
||||
- 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 a remote named `upstream` pointing to the Velero repository so the scripts can work properly.
|
||||
- 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.
|
||||
|
|
@ -15,48 +15,48 @@ This page covers the steps to perform when releasing a new version of Velero.
|
|||
## Preparing
|
||||
|
||||
### Create release blog post (GA only)
|
||||
For each major or minor release, create and publish a blog post to let folks know what's new. Please follow these [instructions](Instructions-to-write-and-release-a-blog-post).
|
||||
For each major or minor release, create and publish a blog post to let folks know what's new. Please follow these [instructions](how-to-write-and-release-a-blog-post).
|
||||
|
||||
### Changelog and Docs PR
|
||||
#### Troubleshooting
|
||||
- `You don't have enough free space in /var/cache/apt/archives/` when running `make serve-docs`: run `docker system prune`.
|
||||
- If you encounter the error `You don't have enough free space in /var/cache/apt/archives/` when running `make serve-docs`: run `docker system prune`.
|
||||
|
||||
#### Steps
|
||||
1. If it doesn't already exist: in a branch, create the file `changelogs/CHANGELOG-<major>.<minor>.md` by copying the most recent one.
|
||||
2. Update the file `changelogs/CHANGELOG-<major>.<minor>.md`
|
||||
1. Update the file `changelogs/CHANGELOG-<major>.<minor>.md`
|
||||
- Run `make changelog` to generate a list of all unreleased changes.
|
||||
- Copy/paste the output into `CHANGELOG-<major>.<minor>.md`, under the "All Changes" section for the release.
|
||||
- You *may* choose to tweak formatting on the list of changes by adding code blocks, etc.
|
||||
- Update links at the top of the file to point to the new release version
|
||||
3. Update the main `CHANGELOG.md` file to properly reference the release-specific changelog file
|
||||
1. Update the main `CHANGELOG.md` file to properly reference the release-specific changelog file
|
||||
- Under "Current release":
|
||||
- Should contain only the current GA release.
|
||||
- Under "Development release":
|
||||
- Should contain only the latest pre-release
|
||||
- Move any prior pre-release into "Older releases"
|
||||
4. GA Only: Remove all changelog files from `changelogs/unreleased`.
|
||||
5. Generate new docs
|
||||
1. GA Only: Remove all changelog files from `changelogs/unreleased`.
|
||||
1. Generate new docs
|
||||
- Run `make gen-docs`, passing the appropriate variables. Examples:
|
||||
a) `VELERO_VERSION=v1.5.0-rc.1 NEW_DOCS_VERSION=v1.5.0-rc.1 make gen-docs`.
|
||||
b) `VELERO_VERSION=v1.5.0 NEW_DOCS_VERSION=v1.5 make gen-docs`).
|
||||
- Note: `PREVIOUS_DOCS_VERSION=<doc-version-to-copy-from>` is optional; when not set, it will default to the latest doc version.
|
||||
6. Clean up when there is an existing set of pre-release versioned docs for the version you are releasing
|
||||
1. Clean up when there is an existing set of pre-release versioned docs for the version you are releasing
|
||||
- Example: `site/content/docs/v1.5.0-beta.1` exists, and you're releasing `v1.5.0-rc.1` or `v1.5`
|
||||
- Remove the directory containing the pre-release docs, i.e. `site/content/docs/<pre-release-version>`.
|
||||
- Delete the pre-release docs table of contents file, i.e. `site/data/<pre-release-version>-toc.yml`.
|
||||
- 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`.
|
||||
7. Create/update the "Upgrade to $major.minor" page.
|
||||
8. Review and submit PR
|
||||
1. Create/update the "Upgrade to $major.minor" page (Example: https://velero.io/docs/v1.5/upgrade-to-1.5/ ). 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.
|
||||
- Do a review of the diffs, and/or run `make serve-docs` and review the site.
|
||||
- Submit a PR containing the changelog and the version-tagged docs.
|
||||
|
||||
## Velero release
|
||||
#### Notes
|
||||
- Pre-requisite: PR with the changelog and docs is merged, so that it's included in the release tag.
|
||||
- This process is the same for both pre-release and GA.
|
||||
- Refer to the [General notes](general-notes) above for instructions.
|
||||
### Notes
|
||||
- Pre-requisite: PR with the changelog and docs is merged, so that it's included in the release tag.
|
||||
- This process is the same for both pre-release and GA.
|
||||
- Refer to the [General notes](general-notes) above for instructions.
|
||||
|
||||
#### Troubleshooting
|
||||
- If the dry-run fails with random errors, try running it again.
|
||||
|
|
@ -66,9 +66,9 @@ For each major or minor release, create and publish a blog post to let folks kno
|
|||
- This won't push anything to GitHub.
|
||||
- Run `VELERO_VERSION=v1.0.0-rc.1 GITHUB_TOKEN=REDACTED ./hack/release-tools/tag-release.sh`.
|
||||
- Fix any issue.
|
||||
2. Create a tagged release and push it to GitHub
|
||||
1. Create a tagged release and push it to GitHub
|
||||
- Run `VELERO_VERSION=v1.0.0-rc.1 GITHUB_TOKEN=REDACTED ./hack/release-tools/tag-release.sh publish`.
|
||||
3. Publish the release
|
||||
1. Publish the release
|
||||
- Navigate to the draft GitHub release at https://github.com/vmware-tanzu/velero/releases and edit the release.
|
||||
- If this is a patch release (e.g. `v1.4.1`), note that the full `CHANGELOG-1.4.md` contents will be included in the body of the GitHub release. You need to delete the previous releases' content (e.g. `v1.2.0`'s changelog) so that only the latest patch release's changelog shows.
|
||||
- Do a quick review for formatting.
|
||||
|
|
@ -77,7 +77,7 @@ For each major or minor release, create and publish a blog post to let folks kno
|
|||
- 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.
|
||||
4. Test the release
|
||||
1. Test the release
|
||||
- By now, the Docker images should have been published.
|
||||
- Perform a smoke-test - for example:
|
||||
- Download the CLI from the GitHub release
|
||||
|
|
@ -85,17 +85,14 @@ For each major or minor release, create and publish a blog post to let folks kno
|
|||
- Verify that `velero version` shows the expected output
|
||||
- Run a backup/restore and ensure it works
|
||||
|
||||
## Homebrew release
|
||||
## Homebrew release (GA only)
|
||||
These are the steps to update the Velero Homebrew version.
|
||||
|
||||
#### Note
|
||||
- Only for GA releases. Homebrew does not allow pre-releases.
|
||||
|
||||
#### Steps
|
||||
- If you don't already have one, create a [GitHub access token for Homebrew](https://github.com/settings/tokens/new?scopes=gist,public_repo&description=Homebrew)
|
||||
- Run `export HOMEBREW_GITHUB_API_TOKEN=your_token_here` on your command line to make sure that `brew` can work on GitHub on your behalf.
|
||||
- Run `hack/release-tools/brew-update.sh`. This script will download the necessary files, do the checks, and invoke the brew helper to submit the PR, which will open in your browser.
|
||||
- Update Windows Chocolatey version. 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)
|
||||
### Steps
|
||||
- If you don't already have one, create a [GitHub access token for Homebrew](https://github.com/settings/tokens/new?scopes=gist,public_repo&description=Homebrew)
|
||||
- Run `export HOMEBREW_GITHUB_API_TOKEN=your_token_here` on your command line to make sure that `brew` can work on GitHub on your behalf.
|
||||
- Run `hack/release-tools/brew-update.sh`. This script will download the necessary files, do the checks, and invoke the brew helper to submit the PR, which will open in your browser.
|
||||
- Update Windows Chocolatey version. 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)
|
||||
|
||||
## How to write and release a blog post
|
||||
What to include in a release blog:
|
||||
|
|
@ -112,12 +109,11 @@ Release blog post PR:
|
|||
* Plan to publish the blog post the same day as the release.
|
||||
|
||||
## Announce a release
|
||||
|
||||
Once you are finished doing the release, let the rest of the world know it's available by posting messages in the following places.
|
||||
1. GA Only: Merge the blog post PR.
|
||||
2. Velero's Twitter account. Maintainers are encouraged to help spread the word by posting or reposting on social media.
|
||||
3. Community Slack channel.
|
||||
4. Google group message.
|
||||
1. Velero's Twitter account. Maintainers are encouraged to help spread the word by posting or reposting on social media.
|
||||
1. Community Slack channel.
|
||||
1. Google group message.
|
||||
|
||||
What to include:
|
||||
* Thank all contributors
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue