Skip to content

Commit

Permalink
Merge pull request #1778 from skriss/v1.1.0-release
Browse files Browse the repository at this point in the history
v1.1.0 docs & changelog
  • Loading branch information
skriss committed Aug 22, 2019
2 parents b1b6a79 + dfb2258 commit a357f21
Show file tree
Hide file tree
Showing 83 changed files with 68 additions and 76 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
## Current release:
* [CHANGELOG-1.0.md][10]
* [CHANGELOG-1.1.md][11]

## Development release:
* [Unreleased Changes][0]

## Older releases:
* [CHANGELOG-1.0.md][10]
* [CHANGELOG-0.11.md][9]
* [CHANGELOG-0.10.md][8]
* [CHANGELOG-0.9.md][7]
Expand All @@ -16,6 +17,7 @@
* [CHANGELOG-0.3.md][1]


[11]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-1.1.md
[10]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-1.0.md
[9]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.11.md
[8]: https://github.com/heptio/velero/blob/master/changelogs/CHANGELOG-0.10.md
Expand Down
71 changes: 50 additions & 21 deletions changelogs/CHANGELOG-1.1.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,69 @@
## v1.1.0-beta.2
#### 2019-08-13
## v1.1.0
#### 2019-08-22

### Download
- https://github.com/heptio/velero/releases/tag/v1.1.0-beta.2
- https://github.com/heptio/velero/releases/tag/v1.1.0

### Container Image
`gcr.io/heptio-images/velero:v1.1.0-beta.2`
`gcr.io/heptio-images/velero:v1.1.0`

### Documentation
https://velero.io/docs/v1.1.0-beta.2/
https://velero.io/docs/v1.1.0/

### Bug Fixes
### Upgrading

* Use VELERO_NAMESPACE to determine what namespace Velero server is running in. For any v1.0 installations using a different namespace, the VELERO_NAMESPACE environment variable will need to be set to the correct namespace. (#1748, @nrb)
* Use backup's namespace when syncing pod volume backups into cluster from object storage (#1760, @skriss)
* support setting CPU/memory requests with unbounded limits using velero install (#1745, @prydonius)
* sort output of resource list in `velero backup describe --details` (#1741, @prydonius)
* upload pod volume backups from *all* pods to object storage (#1739, @skriss)
**If you are running Velero in a non-default namespace**, i.e. any namespace other than `velero`, manual intervention is required when upgrading to v1.1. See [upgrading to v1.1](https://velero.io/docs/v1.1.0/upgrade-to-1.1/) for details.

### Highlights

## v1.1.0-beta.1
#### 2019-08-07
#### Improved Restic Support

### Download
- https://github.com/heptio/velero/releases/tag/v1.1.0-beta.1
A big focus of our work this cycle was continuing to improve support for restic. To that end, we’ve fixed the following bugs:

### Container Image
`gcr.io/heptio-images/velero:v1.1.0-beta.1`

### Documentation
https://velero.io/docs/v1.1.0-beta.1/
- Prior to version 1.1, restic backups could be delayed or failed due to long-lived locks on the repository. Now, Velero removes stale locks from restic repositories every 5 minutes, ensuring they do not interrupt normal operations.
- Previously, the PodVolumeBackup custom resources that represented a restic backup within a cluster were not synchronized between clusters, making it unclear what restic volumes were available to restore into a new cluster. In version 1.1, these resources are synced into clusters, so they are more visible to you when you are trying to restore volumes.
- Originally, Velero would not validate the host path in which volumes were mounted on a given node. If a node did not expose the filesystem correctly, you wouldn’t know about it until a backup failed. Now, Velero’s restic server will validate that the directory structure is correct on startup, providing earlier feedback when it’s not.
- Velero’s restic support is intended to work on a broad range of volume types. With the general release of the [Container Storage Interface API](https://kubernetes.io/blog/2019/01/15/container-storage-interface-ga/), Velero can now use restic to back up CSI volumes.

Along with our bug fixes, we’ve provided an easier way to move restic backups between storage providers. Different providers often have different StorageClasses, requiring user intervention to make restores successfully complete.

### All Changes
To make cross-provider moves simpler, we’ve introduced a StorageClass remapping plug-in. It allows you to automatically translate one StorageClass on PersistentVolumeClaims and PersistentVolumes to another. You can read more about it in our [documentation](https://velero.io/docs/v1.1.0/restore-reference/#changing-pv-pvc-storage-classes).

#### Quality-of-Life Improvements

We’ve also made several other enhancements to Velero that should benefit all users.

Users sometimes ask about recommendations for Velero’s resource allocation within their cluster. To help with this concern, we’ve added default resource requirements to the Velero Deployment and restic init containers, along with configurable requests and limits for the restic DaemonSet. All these values can be adjusted if your environment requires it.

We’ve also taken some time to improve Velero for the future by updating the Deployment and DaemonSet to use the apps/v1 API group, which will be the [default in Kubernetes 1.16](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.16.md#action-required-3). This change means that `velero install` and the `velero plugin` commands will require Kubernetes 1.9 or later to work. Existing Velero installs will continue to work without needing changes, however.

In order to help you better understand what resources have been backed up, we’ve added a list of resources in the `velero backup describe --details` command. This change makes it easier to inspect a backup without having to download and extract it.

In the same vein, we’ve added the ability to put custom tags on cloud-provider snapshots. This approach should provide a better way to keep track of the resources being created in your cloud account. To add a label to a snapshot at backup time, use the `--labels` argument in the `velero backup create` command.

* adds the ability to define custom tags to be added to snapshots by specifying custom labels on the Backup CR with the `velero backup create --labels` flag (#1729, @prydonius)
Our final change for increasing visibility into your Velero installation is the `velero plugin get` command. This command will report all the plug-ins within the Velero deployment..

Velero has previously used a restore-only flag on the server to control whether a cluster could write backups to object storage. With Velero 1.1, we’ve now moved the restore-only behavior into read-only BackupStorageLocations. This move means that the Velero server can use a BackupStorageLocation as a source to restore from, but not for backups, while still retaining the ability to back up to other configured locations. In the future, the `--restore-only` flag will be removed in favor of configuring read-only BackupStorageLocations.

#### Community Contributions

We appreciate all community contributions, whether they be pull requests, bug reports, feature requests, or just questions. With this release, we wanted to draw attention to a few contributions in particular:

For users of node-based IAM authentication systems such as kube2iam, `velero install` now supports the `--pod-annotations` argument for applying necessary annotations at install time. This support should make `velero install` more flexible for scenarios that do not use Secrets for access to their cloud buckets and volumes. You can read more about how to use this new argument in our [AWS documentation](https://velero.io/docs/v1.1.0/aws-config/#alternative-setup-permissions-using-kube2iam). Huge thanks to [Traci Kamp](https://github.com/tlkamp) for this contribution.

Structured logging is important for any application, and Velero is no different. Starting with version 1.1, the Velero server can now output its logs in a JSON format, allowing easier parsing and ingestion. Thank you to [Donovan Carthew](https://github.com/carthewd) for this feature.

AWS supports multiple profiles for accessing object storage, but in the past Velero only used the default. With v.1.1, you can set the `profile` key on yourBackupStorageLocation to specify an alternate profile. If no profile is set, the default one is used, making this change backward compatible. Thanks [Pranav Gaikwad](https://github.com/pranavgaikwad) for this change.

Finally, thanks to testing by [Dylan Murray](https://github.com/dymurray) and [Scott Seago](https://github.com/sseago), an issue with running Velero in non-default namespaces was found in our beta version for this release. If you’re running Velero in a namespace other than `velero`, please follow the [upgrade instructions](https://velero.io/docs/v1.1.0/upgrade-to-1.1/).

### All Changes
* Add the prefix to BSL config map so that object stores can use it when initializing (#1767, @betta1)
* Use `VELERO_NAMESPACE` to determine what namespace Velero server is running in. For any v1.0 installations using a different namespace, the `VELERO_NAMESPACE` environment variable will need to be set to the correct namespace. (#1748, @nrb)
* support setting CPU/memory requests with unbounded limits using velero install (#1745, @prydonius)
* sort output of resource list in `velero backup describe --details` (#1741, @prydonius)
* adds the ability to define custom tags to be added to snapshots by specifying custom labels on the Backup CR with the velero backup create --labels flag (#1729, @prydonius)
* Restore restic volumes from PodVolumeBackups CRs (#1723, @carlisia)
* properly restore PVs backed up with restic and a reclaim policy of "Retain" (#1713, @skriss)
* Make `--secret-file` flag on `velero install` optional, add `--no-secret` flag for explicit confirmation (#1699, @nrb)
Expand Down
1 change: 0 additions & 1 deletion changelogs/unreleased/1428-guilhem

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1480-carlisia.md

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1522-coonsd

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1548-pranavgaikwad

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1556-prydonius

This file was deleted.

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

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1561-prydonius

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1587-prydonius

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1588-prydonius

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1601-prydonius

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1605-prajyot-parab

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1609-prydonius

This file was deleted.

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

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1616-prydonius

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1626-tlkamp

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1630-jwmatthews

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1654-carthewd

This file was deleted.

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

This file was deleted.

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

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1678-prydonius

This file was deleted.

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

This file was deleted.

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

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1710-prydonius

This file was deleted.

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

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1729-prydonius

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1741-prydonius

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1745-prydonius

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion changelogs/unreleased/1767-betta1

This file was deleted.

10 changes: 5 additions & 5 deletions site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ defaults:
gh: https://github.com/heptio/velero/tree/master
layout: "docs"
- scope:
path: docs/v1.1.0-beta.2
path: docs/v1.1.0
values:
version: v1.1.0-beta.2
gh: https://github.com/heptio/velero/tree/v1.1.0-beta.2
version: v1.1.0
gh: https://github.com/heptio/velero/tree/v1.1.0
layout: "docs"
- scope:
path: docs/v1.0.0
Expand Down Expand Up @@ -145,10 +145,10 @@ collections:
- casestudies

versioning: true
latest: v1.0.0
latest: v1.1.0
versions:
- master
- v1.1.0-beta.2
- v1.1.0
- v1.0.0
- v0.11.0
- v0.10.0
Expand Down
2 changes: 1 addition & 1 deletion site/_data/toc-mapping.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# that the navigation for older versions still work.

master: master-toc
v1.1.0-beta.2: v1-1-0-beta-2-toc
v1.1.0: v1-1-0-toc
v1.0.0: v1-0-0-toc
v0.11.0: v011-toc
v0.10.0: v010-toc
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ See [the list of releases][6] to find out about feature changes.
[2]: https://travis-ci.org/heptio/velero

[4]: https://github.com/heptio/velero/issues
[5]: https://github.com/heptio/velero/blob/v1.1.0-beta.2/CONTRIBUTING.md
[5]: https://github.com/heptio/velero/blob/v1.1.0/CONTRIBUTING.md
[6]: https://github.com/heptio/velero/releases

[8]: https://github.com/heptio/velero/blob/v1.1.0-beta.2/CODE_OF_CONDUCT.md
[8]: https://github.com/heptio/velero/blob/v1.1.0/CODE_OF_CONDUCT.md
[9]: https://kubernetes.io/docs/setup/
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
[11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
Expand All @@ -74,7 +74,7 @@ See [the list of releases][6] to find out about feature changes.


[28]: install-overview.md
[29]: https://velero.io/docs/v1.1.0-beta.2/
[29]: https://velero.io/docs/v1.1.0/
[30]: troubleshooting.md

[99]: support-matrix.md
Expand Down
File renamed without changes.
File renamed without changes.
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 @@ -238,7 +238,7 @@ If you need to add or update the vendored dependencies, see [Vendoring dependenc
[10]: #vendoring-dependencies
[11]: vendoring-dependencies.md
[12]: #test
[13]: https://github.com/heptio/velero/blob/v1.1.0-beta.2/hack/generate-proto.sh
[13]: https://github.com/heptio/velero/blob/v1.1.0/hack/generate-proto.sh
[14]: https://grpc.io/docs/quickstart/go.html#install-protocol-buffers-v3
[15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file
[16]: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion site/docs/v1.1.0-beta.2/faq.md → site/docs/v1.1.0/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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/velero/blob/v1.1.0-beta.2/pkg/restore/pod_action.go)
in [pod_action.go](https://github.com/heptio/velero/blob/v1.1.0/pkg/restore/pod_action.go)

## I'm using Velero in multiple clusters. Should I use the same bucket to store all of my backups?

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,5 @@ velero backup logs nginx-hook-test | grep hookCommand


[1]: api-types/backup.md
[2]: https://github.com/heptio/velero/blob/v1.1.0-beta.2/examples/nginx-app/with-pv.yaml
[2]: https://github.com/heptio/velero/blob/v1.1.0/examples/nginx-app/with-pv.yaml
[3]: cloud-common.md
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.
Original file line number Diff line number Diff line change
Expand Up @@ -241,5 +241,5 @@ After creating the Velero server in your cluster, try this example:

## Additional Reading

* [Official Velero Documentation](https://velero.io/docs/v1.1.0-beta.2/)
* [Official Velero Documentation](https://velero.io/docs/v1.1.0/)
* [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 @@ -78,5 +78,5 @@ for an example of this -- in particular, the `getPluginConfig(...)` function.


[1]: https://github.com/heptio/velero-plugin-example
[2]: https://github.com/heptio/velero/blob/v1.1.0-beta.2/pkg/plugin/logger.go
[3]: https://github.com/heptio/velero/blob/v1.1.0-beta.2/pkg/restore/restic_restore_action.go
[2]: https://github.com/heptio/velero/blob/v1.1.0/pkg/plugin/logger.go
[3]: https://github.com/heptio/velero/blob/v1.1.0/pkg/restore/restic_restore_action.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.

0 comments on commit a357f21

Please sign in to comment.