Merge pull request #2247 from ashish-amarnath/update-helm-chart-repo-docs

📖 Update helm chart repo docs
pull/2252/head
Ashish Amarnath 2020-02-05 13:16:55 -08:00 committed by GitHub
commit 079c0e10d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 37 additions and 24 deletions

View File

@ -6,6 +6,7 @@
- [Option 1: macOS - Homebrew](#option-1-macos---homebrew)
- [Option 2: GitHub release](#option-2-github-release)
- [Install and configure the server components](#install-and-configure-the-server-components)
- [Command line Autocompletion](#command-line-autocompletion)
Use this doc to get a basic installation of Velero.
Refer [this document](customize-installation.md) to customize your installation.
@ -45,7 +46,7 @@ brew install velero
There are two supported methods for installing the Velero server components:
- the `velero install` CLI command
- the [Helm chart](https://github.com/vmware-tanzu/helm-charts)
- the [Helm chart](https://vmware-tanzu.github.io/helm-charts/)
Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. The steps to install and configure the Velero server components along with the appropriate plugins are specific to your chosen storage provider. To find installation instructions for your chosen storage provider, follow the documentation link for your provider at our [supported storage providers][0] page

View File

@ -12,6 +12,14 @@
- [Generate YAML only](#generate-yaml-only)
- [Additional options](#additional-options)
- [Optional Velero CLI configurations](#optional-velero-cli-configurations)
- [Enabling shell autocompletion](#enabling-shell-autocompletion)
- [Bash on Linux](#bash-on-linux)
- [Install bash-completion](#install-bash-completion)
- [Enable Velero CLI autocompletion for Bash on Linux](#enable-velero-cli-autocompletion-for-bash-on-linux)
- [Bash on macOS](#bash-on-macos)
- [Install bash-completion](#install-bash-completion-1)
- [Enable Velero CLI autocompletion for Bash on macOS](#enable-velero-cli-autocompletion-for-bash-on-macos)
- [Autocompletion on Zsh](#autocompletion-on-zsh)
## Plugins
@ -88,7 +96,7 @@ If you are installing Velero in Kubernetes 1.13.x or earlier, you need to use `k
## Additional options
Run `velero install --help` or see the [Helm chart documentation](https://github.com/vmware-tanzu/helm-charts) for the full set of installation options.
Run `velero install --help` or see the [Helm chart documentation](https://vmware-tanzu.github.io/helm-charts/) for the full set of installation options.
## Optional Velero CLI configurations
@ -98,13 +106,13 @@ Run `velero install --help` or see the [Helm chart documentation](https://github
Below are the procedures to set up autocompletion for `Bash` (including the difference between `Linux` and `macOS`) and `Zsh`.
## Bash on Linux
#### Bash on Linux
The **Velero CLI** completion script for `Bash` can be generated with the command `velero completion bash`. Sourcing the completion script in your shell enables velero autocompletion.
However, the completion script depends on [**bash-completion**](https://github.com/scop/bash-completion), which means that you have to install this software first (you can test if you have bash-completion already installed by running `type _init_completion`).
### Install bash-completion
##### Install bash-completion
`bash-completion` is provided by many package managers (see [here](https://github.com/scop/bash-completion#installation)). You can install it with `apt-get install bash-completion` or `yum install bash-completion`, etc.
@ -118,7 +126,7 @@ source /usr/share/bash-completion/bash_completion
Reload your shell and verify that bash-completion is correctly installed by typing `type _init_completion`.
### Enable Velero CLI autocompletion for Bash on Linux
##### Enable Velero CLI autocompletion for Bash on Linux
You now need to ensure that the **Velero CLI** completion script gets sourced in all your shell sessions. There are two ways in which you can do this:
@ -145,7 +153,7 @@ You now need to ensure that the **Velero CLI** completion script gets sourced in
Both approaches are equivalent. After reloading your shell, velero autocompletion should be working.
## Bash on macOS
#### Bash on macOS
The **Velero CLI** completion script for Bash can be generated with `velero completion bash`. Sourcing this script in your shell enables velero completion.
@ -155,7 +163,7 @@ However, the velero completion script depends on [**bash-completion**](https://g
> There are two versions of bash-completion, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. The velero completion script **doesn't work** correctly with bash-completion v1 and Bash 3.2. It requires **bash-completion v2** and **Bash 4.1+**. Thus, to be able to correctly use velero completion on macOS, you have to install and use Bash 4.1+ ([*instructions*](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba)). The following instructions assume that you use Bash 4.1+ (that is, any Bash version of 4.1 or newer).
### Install bash-completion
##### Install bash-completion
> As mentioned, these instructions assume you use Bash 4.1+, which means you will install bash-completion v2 (in contrast to Bash 3.2 and bash-completion v1, in which case kubectl completion won't work).
@ -174,7 +182,7 @@ As stated in the output of this command, add the following to your `~/.bashrc` f
Reload your shell and verify that bash-completion v2 is correctly installed with `type _init_completion`.
### Enable Velero CLI autocompletion for Bash on macOS
##### Enable Velero CLI autocompletion for Bash on macOS
You now have to ensure that the velero completion script gets sourced in all your shell sessions. There are multiple ways to achieve this:
@ -204,8 +212,7 @@ You now have to ensure that the velero completion script gets sourced in all you
In any case, after reloading your shell, velero completion should be working.
## Autocompletion on Zsh
#### Autocompletion on Zsh
The velero completion script for Zsh can be generated with the command `velero completion zsh`. Sourcing the completion script in your shell enables velero autocompletion.
@ -231,7 +238,6 @@ If you get an error like `complete:13: command not found: compdef`, then add the
compinit
```
[1]: https://github.com/vmware-tanzu/velero/releases/latest
[2]: namespace.md
[3]: restic.md

View File

@ -6,6 +6,7 @@
- [Option 1: macOS - Homebrew](#option-1-macos---homebrew)
- [Option 2: GitHub release](#option-2-github-release)
- [Install and configure the server components](#install-and-configure-the-server-components)
- [Command line Autocompletion](#command-line-autocompletion)
Use this doc to get a basic installation of Velero.
Refer [this document](customize-installation.md) to customize your installation.
@ -45,7 +46,7 @@ brew install velero
There are two supported methods for installing the Velero server components:
- the `velero install` CLI command
- the [Helm chart](https://github.com/helm/charts/tree/master/stable/velero)
- the [Helm chart](https://vmware-tanzu.github.io/helm-charts/)
Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. The steps to install and configure the Velero server components along with the appropriate plugins are specific to your chosen storage provider. To find installation instructions for your chosen storage provider, follow the documentation link for your provider at our [supported storage providers][0] page

View File

@ -12,6 +12,14 @@
- [Generate YAML only](#generate-yaml-only)
- [Additional options](#additional-options)
- [Optional Velero CLI configurations](#optional-velero-cli-configurations)
- [Enabling shell autocompletion](#enabling-shell-autocompletion)
- [Bash on Linux](#bash-on-linux)
- [Install bash-completion](#install-bash-completion)
- [Enable Velero CLI autocompletion for Bash on Linux](#enable-velero-cli-autocompletion-for-bash-on-linux)
- [Bash on macOS](#bash-on-macos)
- [Install bash-completion](#install-bash-completion-1)
- [Enable Velero CLI autocompletion for Bash on macOS](#enable-velero-cli-autocompletion-for-bash-on-macos)
- [Autocompletion on Zsh](#autocompletion-on-zsh)
## Plugins
@ -29,7 +37,7 @@ If you are using an alternate identity mechanism, such as kube2iam/kiam on AWS,
## Enable restic integration
By default, `velero install` does not install Velero's [restic integration][3]. To enable it, specify the `--use-restic` flag.
By default, `velero install` does not install Velero's [restic integration][3]. To enable it, specify the `--use-restic` flag.
If you've already run `velero install` without the `--use-restic` flag, you can run the same command again, including the `--use-restic` flag, to add the restic integration to your existing install.
@ -88,7 +96,7 @@ If you are installing Velero in Kubernetes 1.13.x or earlier, you need to use `k
## Additional options
Run `velero install --help` or see the [Helm chart documentation](https://github.com/helm/charts/tree/master/stable/velero) for the full set of installation options.
Run `velero install --help` or see the [Helm chart documentation](https://vmware-tanzu.github.io/helm-charts/) for the full set of installation options.
## Optional Velero CLI configurations
@ -98,13 +106,13 @@ Run `velero install --help` or see the [Helm chart documentation](https://github
Below are the procedures to set up autocompletion for `Bash` (including the difference between `Linux` and `macOS`) and `Zsh`.
## Bash on Linux
#### Bash on Linux
The **Velero CLI** completion script for `Bash` can be generated with the command `velero completion bash`. Sourcing the completion script in your shell enables velero autocompletion.
However, the completion script depends on [**bash-completion**](https://github.com/scop/bash-completion), which means that you have to install this software first (you can test if you have bash-completion already installed by running `type _init_completion`).
### Install bash-completion
##### Install bash-completion
`bash-completion` is provided by many package managers (see [here](https://github.com/scop/bash-completion#installation)). You can install it with `apt-get install bash-completion` or `yum install bash-completion`, etc.
@ -118,7 +126,7 @@ source /usr/share/bash-completion/bash_completion
Reload your shell and verify that bash-completion is correctly installed by typing `type _init_completion`.
### Enable Velero CLI autocompletion for Bash on Linux
##### Enable Velero CLI autocompletion for Bash on Linux
You now need to ensure that the **Velero CLI** completion script gets sourced in all your shell sessions. There are two ways in which you can do this:
@ -145,7 +153,7 @@ You now need to ensure that the **Velero CLI** completion script gets sourced in
Both approaches are equivalent. After reloading your shell, velero autocompletion should be working.
## Bash on macOS
#### Bash on macOS
The **Velero CLI** completion script for Bash can be generated with `velero completion bash`. Sourcing this script in your shell enables velero completion.
@ -155,7 +163,7 @@ However, the velero completion script depends on [**bash-completion**](https://g
> There are two versions of bash-completion, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. The velero completion script **doesn't work** correctly with bash-completion v1 and Bash 3.2. It requires **bash-completion v2** and **Bash 4.1+**. Thus, to be able to correctly use velero completion on macOS, you have to install and use Bash 4.1+ ([*instructions*](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba)). The following instructions assume that you use Bash 4.1+ (that is, any Bash version of 4.1 or newer).
### Install bash-completion
##### Install bash-completion
> As mentioned, these instructions assume you use Bash 4.1+, which means you will install bash-completion v2 (in contrast to Bash 3.2 and bash-completion v1, in which case kubectl completion won't work).
@ -174,7 +182,7 @@ As stated in the output of this command, add the following to your `~/.bashrc` f
Reload your shell and verify that bash-completion v2 is correctly installed with `type _init_completion`.
### Enable Velero CLI autocompletion for Bash on macOS
##### Enable Velero CLI autocompletion for Bash on macOS
You now have to ensure that the velero completion script gets sourced in all your shell sessions. There are multiple ways to achieve this:
@ -204,8 +212,7 @@ You now have to ensure that the velero completion script gets sourced in all you
In any case, after reloading your shell, velero completion should be working.
## Autocompletion on Zsh
#### Autocompletion on Zsh
The velero completion script for Zsh can be generated with the command `velero completion zsh`. Sourcing the completion script in your shell enables velero autocompletion.
@ -231,11 +238,9 @@ If you get an error like `complete:13: command not found: compdef`, then add the
compinit
```
[1]: https://github.com/vmware-tanzu/velero/releases/latest
[2]: namespace.md
[3]: restic.md
[4]: on-premises.md
[6]: velero-install.md#usage
[7]: https://github.com/vmware-tanzu/velero/issues/2077