Skip to content

Commit

Permalink
Add changelog and docs for v1.5 release (vmware-tanzu#2941)
Browse files Browse the repository at this point in the history
* Add changelog and docs for v1.5 release

Signed-off-by: Nolan Brubaker <[email protected]>

* Fix markdown indentation

Signed-off-by: Nolan Brubaker <[email protected]>

* Fix URLs with patch version

Signed-off-by: Nolan Brubaker <[email protected]>

* Fix example link

Signed-off-by: Nolan Brubaker <[email protected]>
  • Loading branch information
nrb authored and georgettica committed Dec 23, 2020
1 parent 33b6c2b commit 68f89ae
Show file tree
Hide file tree
Showing 116 changed files with 91 additions and 158 deletions.
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
62 changes: 31 additions & 31 deletions changelogs/CHANGELOG-1.5.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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)
Expand All @@ -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 change: 0 additions & 1 deletion changelogs/unreleased/2550-skriss

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2561-carlisia

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2569-cblecker

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2595-skriss

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2602-skriss

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2610-nrb

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2611-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2613-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2615-tbatard

This file was deleted.

6 changes: 0 additions & 6 deletions changelogs/unreleased/2620-mauilion

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2621-jaygridley

This file was deleted.

3 changes: 0 additions & 3 deletions changelogs/unreleased/2625-tbatard

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2629-adamrushuk

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2635-jessicagreben

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2636-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2638-adamrushuk

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2651-laverya

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2660-carlisia

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2674-carlisia

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2676-dthrasher

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2712-fvsqr

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2714-kathpeony

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2719-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2720-tbatard

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2724-phuong

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2734-nrb

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/unreleased/2748-thejasbabu

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2750-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2754-robreus

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2755-areed

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2761-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2762-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2764-runzexia

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2776-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2778-jenting

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/unreleased/2787-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2792-doughepi

This file was deleted.

2 changes: 0 additions & 2 deletions changelogs/unreleased/2793-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2796-bgagnon

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2802-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2804-areed

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2805-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2808-nrb

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2814-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2815-nrb

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2830-bgagnon

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2835-pawanpraka1

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2838-carlisia

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2853-ashish-amarnath

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2863-dymurray

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2882-jenting

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2901-jenting

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/2911-ashish-amarnath

This file was deleted.

4 changes: 2 additions & 2 deletions site/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/main/release-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
11 changes: 6 additions & 5 deletions site/content/docs/main/upgrade-to-1.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
```

Expand All @@ -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
```

Expand All @@ -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
Expand All @@ -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

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
toc: "false"
cascade:
version: v1.5.0-rc.1
version: v1.5
toc: "true"
---
![100]
Expand Down Expand Up @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
Loading

0 comments on commit 68f89ae

Please sign in to comment.