Skip to content

Commit

Permalink
Add change log and docs site for v1.4.0-beta.1 (#2523)
Browse files Browse the repository at this point in the history
* Update site for v1.4.0-beta.1

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

* Add v1.4.0-beta.1 changelogs

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

* Update upgrade link to v1.4

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

* Correct docs links in changelog

Signed-off-by: Nolan Brubaker <[email protected]>
  • Loading branch information
nrb authored May 8, 2020
1 parent e400be9 commit 8bf75bd
Show file tree
Hide file tree
Showing 56 changed files with 4,323 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* [CHANGELOG-1.3.md][13]

## Development release:
* [CHANGELOG-1.4.md][14]
* [Unreleased Changes][0]

## Older releases:
Expand All @@ -19,6 +20,7 @@
* [CHANGELOG-0.3.md][1]


[14]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.4.md
[13]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.3.md
[12]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.2.md
[11]: https://github.com/vmware-tanzu/velero/blob/master/changelogs/CHANGELOG-1.1.md
Expand Down
53 changes: 53 additions & 0 deletions changelogs/CHANGELOG-1.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## v1.4.0-beta.1
### 2020-05-08

### Download
https://github.com/vmware-tanzu/velero/releases/tag/v1.4.0-beta.1

### Container Image
`velero/velero:v1.4.0-beta.1`

### Documentation
https://velero.io/docs/v1.4-pre/

### Upgrading
https://velero.io/docs/v1.4-pre/upgrade-to-1.4/

### Download
https://github.com/vmware-tanzu/velero/releases/tag/v1.4.0-beta.1

### Highlights

* Added beta-level CSI support
* Added custom CA certificate support
* Backup progress reporting

### All Changes
* Add details of CSI volumesnapshotcontents associated with a backup to `velero backup describe` when the `EnableCSI` feature flag is given on the velero client. (#2448, @nrb)
* report backup progress (number of items backed up so far out of an estimated total number of items) during backup in the logs and as status fields on the Backup custom resource (#2440, @skriss)
* allow feature flags to be passed from install CLI (#2503, @ashish)
* sync backups' CSI API objects into the cluster as part of the backup sync controller (#2496, @ashish)
* bug fix: in error location logging hook, if the item logged under the `error` key doesn't implement the `error` interface, don't return an error since this is a valid scenario (#2487, @skriss)
* bug fix: in CRD restore plugin, don't use runtime.DefaultUnstructuredConverter.FromUnstructured(...) to avoid conversion issues when float64 fields contain int values (#2484, @skriss)
* during backup deletion also delete CSI volumesnapshotcontents that were created as a part of the backup but the associated volumesnapshot object does not exist (#2480, @ashish)
* If plugins don't support the `--features` flag, don't pass it to them. Also, update the standard plugin server to ignore unknown flags. (#2479, @skriss)
* At backup time, if a CustomResourceDefinition appears to have been created via the v1beta1 endpoint, retrieve it from the v1beta1 endpoint instead of simply changing the APIVersion. (#2478, @nrb)
* update container base images from ubuntu:bionic to ubuntu:focal (#2471, @skriss)
* bug fix: when a resource includes/excludes list contains unresolvable items, don't remove them from the list, so that the list doesn't inadvertently end up matching *all* resources. (#2462, @skriss)
* Azure: add support for getting storage account key for restic directly from an environment variable (#2455, @jaygridley)
* Support to skip VSL validation for the backup having SnapshotVolumes set to false or created with `--snapshot-volumes=false` (#2450, @mynktl)
* during backup deletion also delete CSI volumesnapshots that were created as a part of the backup (#2411, @ashish)
* clarify the wording for restore describe for namespaces included Instead of showing it as "*" explicitly mention that all the namespaces from the backup object are included. (#1918, @raghavendrabhat)
* When the EnableCSI feature flag is provided, upload CSI VolumeSnapshots and VolumeSnapshotContents to object storage as gzipped JSON. (#2323, @nrb)
* bug fix: populate namespace in logs for backup errors (#2438, @skriss)
* bug fix: save PodVolumeBackup manifests to object storage even if the volume was empty, so that on restore, the PV is dynamically reprovisioned if applicable (#2390, @skriss)
* adding annotations on backup CRD for k8s major, minor and git versions (#2346, @brito)
* bump Kubernetes module dependencies to v0.17.4 to get fix for https://github.com/kubernetes/kubernetes/issues/86149 (#2407, @skriss)
* Adding new restoreItemAction for PVC to update the selected-node annotation (#2377, @mynktl)
* Added a --cacert flag to the install command to provide the CA bundle to use when verifying TLS connections to object storage (#2368, @mansam)
* Added a `--cacert` flag to the velero client describe, download, and logs commands to allow passing a path to a certificate to use when verifying TLS connections to object storage. Also added a corresponding client config option called `cacert` which takes a path to a certificate bundle to use as a default when `--cacert` is not specified. (#2364, @mansam)
* support setting a custom CA certificate on a BSL to use when verifying TLS connections (#2353, @mansam)
* add CSI snapshot API types into default restore priorities (#2318, @ashish)
* refactoring: wait for all informer caches to sync before running controllers (#2299, @skriss)
* refactor restore code to lazily resolve resources via discovery and eliminate second restore loop for instances of restored CRDs (#2248, @skriss)
* upgrade to go 1.14 and migrate from `dep` to go modules (#2214, @skriss)
7 changes: 7 additions & 0 deletions site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ defaults:
version: master
gh: https://github.com/vmware-tanzu/velero/tree/master
layout: "docs"
- scope:
path: docs/v1.4-pre
values:
version: v1.4-pre
gh: https://github.com/vmware-tanzu/velero/tree/v1.4.0-beta.1
layout: "docs"
- scope:
path: docs/v1.3.2
values:
Expand Down Expand Up @@ -173,6 +179,7 @@ versioning: true
latest: v1.3.2
versions:
- master
- v1.4-pre
- v1.3.2
- v1.3.1
- v1.3.0
Expand Down
1 change: 1 addition & 0 deletions site/_data/toc-mapping.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# that the navigation for older versions still work.

master: master-toc
v1.4-pre: v1-4-pre-toc
v1.3.2: v1-3-2-toc
v1.3.1: v1-3-1-toc
v1.3.0: v1-3-0-toc
Expand Down
87 changes: 87 additions & 0 deletions site/_data/v1-4-pre-toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
toc:
- title: Introduction
subfolderitems:
- page: About Velero
url: /index.html
- page: How Velero works
url: /how-velero-works
- page: About locations
url: /locations
- title: Install
subfolderitems:
- page: Basic Install
url: /basic-install
- page: Customize Installation
url: /customize-installation
- page: Upgrade to 1.4
url: /upgrade-to-1.4
- page: Supported providers
url: /supported-providers
- page: Evaluation install
url: /contributions/minio
- page: Restic integration
url: /restic
- page: Examples
url: /examples
- page: Uninstalling
url: /uninstalling
- title: Use
subfolderitems:
- page: Disaster recovery
url: /disaster-case
- page: Cluster migration
url: /migration-case
- page: Backup reference
url: /backup-reference
- page: Restore reference
url: /restore-reference
- page: Run in any namespace
url: /namespace
- page: Extend with hooks
url: /hooks
- page: CSI Support (beta)
url: /csi
- page: Verifying Self-signed Certificates
url: /self-signed-certificates
- title: Plugins
subfolderitems:
- page: Overview
url: /overview-plugins
- page: Custom plugins
url: /custom-plugins
- title: Troubleshoot
subfolderitems:
- page: Troubleshooting
url: /troubleshooting
- page: Troubleshoot an install or setup
url: /debugging-install
- page: Troubleshoot a restore
url: /debugging-restores
- page: Troubleshoot Restic
url: /restic#troubleshooting
- title: Contribute
subfolderitems:
- page: Start Contributing
url: /start-contributing
- page: Development
url: /development
- page: Build from source
url: /build-from-source
- page: Run locally
url: /run-locally
- page: Code standards
url: /code-standards
- page: Website guidelines
url: /website-guidelines
- title: More information
subfolderitems:
- page: Backup file format
url: /output-file-format
- page: API types
url: /api-types
- page: FAQ
url: /faq
- page: ZenHub
url: /zenhub
- page: Support Process
url: /support-process
52 changes: 52 additions & 0 deletions site/docs/v1.4-pre/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
![100]

[![Build Status][1]][2]

## Overview

Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. You can run Velero with a cloud provider or on-premises. Velero lets you:

* Take backups of your cluster and restore in case of loss.
* Migrate cluster resources to other clusters.
* Replicate your production cluster to development and testing clusters.

Velero consists of:

* A server that runs on your cluster
* A command-line client that runs locally

## Documentation

This site is our documentation home with installation instructions, plus information about customizing Velero for your needs, architecture, extending Velero, contributing to Velero and more.

Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of Velero.

## Troubleshooting

If you encounter issues, review the [troubleshooting docs][30], [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server.

## 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.4.0-beta.1/start-contributing/) documentation for guidance on how to setup Velero for development.

## Changelog

See [the list of releases][6] to find out about feature changes.

[1]: https://travis-ci.org/vmware-tanzu/velero.svg?branch=master
[2]: https://travis-ci.org/vmware-tanzu/velero

[4]: https://github.com/vmware-tanzu/velero/issues
[6]: https://github.com/vmware-tanzu/velero/releases

[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
[12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md
[14]: https://github.com/kubernetes/kubernetes
[24]: https://groups.google.com/forum/#!forum/projectvelero
[25]: https://kubernetes.slack.com/messages/velero

[30]: troubleshooting.md

[100]: img/velero.png
18 changes: 18 additions & 0 deletions site/docs/v1.4-pre/api-types/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Table of Contents

## API types

Here we list the API types that have some functionality that you can only configure via json/yaml vs the `velero` cli
(hooks)

* [Backup][1]
* [Restore][2]
* [Schedule][3]
* [BackupStorageLocation][4]
* [VolumeSnapshotLocation][5]

[1]: backup.md
[2]: restore.md
[3]: schedule.md
[4]: backupstoragelocation.md
[5]: volumesnapshotlocation.md
Loading

0 comments on commit 8bf75bd

Please sign in to comment.