-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4517 from reasonerjt/1.8-doc
Update doc for v1.8
- Loading branch information
Showing
80 changed files
with
6,693 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Update doc for v1.8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| toc: "false" | ||
| cascade: | ||
| version: v1.8 | ||
| toc: "true" | ||
| --- | ||
| ![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.8.0/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://github.com/vmware-tanzu/velero/workflows/Main%20CI/badge.svg | ||
| [2]: https://github.com/vmware-tanzu/velero/actions?query=workflow%3A"Main+CI" | ||
|
|
||
| [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/main/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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: "Table of Contents" | ||
| layout: docs | ||
| --- | ||
|
|
||
| ## 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| layout: docs | ||
| title: API types | ||
| --- | ||
|
|
||
| Here's a 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| --- | ||
| title: "Backup API Type" | ||
| layout: docs | ||
| --- | ||
|
|
||
| ## Use | ||
|
|
||
| Use the `Backup` API type to request the Velero server to perform a backup. Once created, the | ||
| Velero Server immediately starts the backup process. | ||
|
|
||
| ## API GroupVersion | ||
|
|
||
| Backup belongs to the API group version `velero.io/v1`. | ||
|
|
||
| ## Definition | ||
|
|
||
| Here is a sample `Backup` object with each of the fields documented: | ||
|
|
||
| ```yaml | ||
| # Standard Kubernetes API Version declaration. Required. | ||
| apiVersion: velero.io/v1 | ||
| # Standard Kubernetes Kind declaration. Required. | ||
| kind: Backup | ||
| # Standard Kubernetes metadata. Required. | ||
| metadata: | ||
| # Backup name. May be any valid Kubernetes object name. Required. | ||
| name: a | ||
| # Backup namespace. Must be the namespace of the Velero server. Required. | ||
| namespace: velero | ||
| # Parameters about the backup. Required. | ||
| spec: | ||
| # Array of namespaces to include in the backup. If unspecified, all namespaces are included. | ||
| # Optional. | ||
| includedNamespaces: | ||
| - '*' | ||
| # Array of namespaces to exclude from the backup. Optional. | ||
| excludedNamespaces: | ||
| - some-namespace | ||
| # Array of resources to include in the backup. Resources may be shortcuts (for example 'po' for 'pods') | ||
| # or fully-qualified. If unspecified, all resources are included. Optional. | ||
| includedResources: | ||
| - '*' | ||
| # Array of resources to exclude from the backup. Resources may be shortcuts (for example 'po' for 'pods') | ||
| # or fully-qualified. Optional. | ||
| excludedResources: | ||
| - storageclasses.storage.k8s.io | ||
| # Whether or not to include cluster-scoped resources. Valid values are true, false, and | ||
| # null/unset. If true, all cluster-scoped resources are included (subject to included/excluded | ||
| # resources and the label selector). If false, no cluster-scoped resources are included. If unset, | ||
| # all cluster-scoped resources are included if and only if all namespaces are included and there are | ||
| # no excluded namespaces. Otherwise, if there is at least one namespace specified in either | ||
| # includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed | ||
| # up are those associated with namespace-scoped resources included in the backup. For example, if a | ||
| # PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is | ||
| # cluster-scoped) would also be backed up. | ||
| includeClusterResources: null | ||
| # Individual objects must match this label selector to be included in the backup. Optional. | ||
| labelSelector: | ||
| matchLabels: | ||
| app: velero | ||
| component: server | ||
| # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and | ||
| # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as | ||
| # a persistent volume provider is configured for Velero. | ||
| snapshotVolumes: null | ||
| # Where to store the tarball and logs. | ||
| storageLocation: aws-primary | ||
| # The list of locations in which to store volume snapshots created for this backup. | ||
| volumeSnapshotLocations: | ||
| - aws-primary | ||
| - gcp-primary | ||
| # The amount of time before this backup is eligible for garbage collection. If not specified, | ||
| # a default value of 30 days will be used. The default can be configured on the velero server | ||
| # by passing the flag --default-backup-ttl. | ||
| ttl: 24h0m0s | ||
| # Whether restic should be used to take a backup of all pod volumes by default. | ||
| defaultVolumesToRestic: true | ||
| # Actions to perform at different times during a backup. The only hook supported is | ||
| # executing a command in a container in a pod using the pod exec API. Optional. | ||
| hooks: | ||
| # Array of hooks that are applicable to specific resources. Optional. | ||
| resources: | ||
| - | ||
| # Name of the hook. Will be displayed in backup log. | ||
| name: my-hook | ||
| # Array of namespaces to which this hook applies. If unspecified, the hook applies to all | ||
| # namespaces. Optional. | ||
| includedNamespaces: | ||
| - '*' | ||
| # Array of namespaces to which this hook does not apply. Optional. | ||
| excludedNamespaces: | ||
| - some-namespace | ||
| # Array of resources to which this hook applies. The only resource supported at this time is | ||
| # pods. | ||
| includedResources: | ||
| - pods | ||
| # Array of resources to which this hook does not apply. Optional. | ||
| excludedResources: [] | ||
| # This hook only applies to objects matching this label selector. Optional. | ||
| labelSelector: | ||
| matchLabels: | ||
| app: velero | ||
| component: server | ||
| # An array of hooks to run before executing custom actions. Only "exec" hooks are supported. | ||
| pre: | ||
| - | ||
| # The type of hook. This must be "exec". | ||
| exec: | ||
| # The name of the container where the command will be executed. If unspecified, the | ||
| # first container in the pod will be used. Optional. | ||
| container: my-container | ||
| # The command to execute, specified as an array. Required. | ||
| command: | ||
| - /bin/uname | ||
| - -a | ||
| # How to handle an error executing the command. Valid values are Fail and Continue. | ||
| # Defaults to Fail. Optional. | ||
| onError: Fail | ||
| # How long to wait for the command to finish executing. Defaults to 30 seconds. Optional. | ||
| timeout: 10s | ||
| # An array of hooks to run after all custom actions and additional items have been | ||
| # processed. Only "exec" hooks are supported. | ||
| post: | ||
| # Same content as pre above. | ||
| # Status about the Backup. Users should not set any data here. | ||
| status: | ||
| # The version of this Backup. The only version supported is 1. | ||
| version: 1 | ||
| # The date and time when the Backup is eligible for garbage collection. | ||
| expiration: null | ||
| # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. | ||
| phase: "" | ||
| # An array of any validation errors encountered. | ||
| validationErrors: null | ||
| # Date/time when the backup started being processed. | ||
| startTimestamp: 2019-04-29T15:58:43Z | ||
| # Date/time when the backup finished being processed. | ||
| completionTimestamp: 2019-04-29T15:58:56Z | ||
| # Number of volume snapshots that Velero tried to create for this backup. | ||
| volumeSnapshotsAttempted: 2 | ||
| # Number of volume snapshots that Velero successfully created for this backup. | ||
| volumeSnapshotsCompleted: 1 | ||
| # Number of warnings that were logged by the backup. | ||
| warnings: 2 | ||
| # Number of errors that were logged by the backup. | ||
| errors: 0 | ||
|
|
||
| ``` |
Oops, something went wrong.