From 75fd5a187dd984bb9a86fc3e1c707c3cc68582a1 Mon Sep 17 00:00:00 2001 From: Madhav Jivrajani Date: Mon, 1 Feb 2021 20:22:04 +0530 Subject: [PATCH] Update docs for running velero locally (#3363) * add documentation for running velero locally, specifically for --plugin-dir flag requireing binary to be present locally Signed-off-by: Madhav Jivrajani * add changelog Signed-off-by: Madhav Jivrajani * remove changelog Signed-off-by: Madhav Jivrajani --- site/content/docs/main/run-locally.md | 1 + site/content/docs/v1.5/run-locally.md | 1 + 2 files changed, 2 insertions(+) diff --git a/site/content/docs/main/run-locally.md b/site/content/docs/main/run-locally.md index ffd735b4f..897ee1893 100644 --- a/site/content/docs/main/run-locally.md +++ b/site/content/docs/main/run-locally.md @@ -42,6 +42,7 @@ After you use the `velero install` command to install Velero into your cluster, * `--kubeconfig`: set the path to the kubeconfig file the Velero server uses to talk to the Kubernetes apiserver (default `$KUBECONFIG`) * `--namespace`: the set namespace where the Velero server should look for backups, schedules, restores (default `velero`) * `--plugin-dir`: set the directory where the Velero server looks for plugins (default `/plugins`) + * The `--plugin-dir` flag requires the plugin binary to be present locally, and should be set to the directory containing this built binary. * `--metrics-address`: set the bind address and port where Prometheus metrics are exposed (default `:8085`) [15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file diff --git a/site/content/docs/v1.5/run-locally.md b/site/content/docs/v1.5/run-locally.md index ffd735b4f..897ee1893 100644 --- a/site/content/docs/v1.5/run-locally.md +++ b/site/content/docs/v1.5/run-locally.md @@ -42,6 +42,7 @@ After you use the `velero install` command to install Velero into your cluster, * `--kubeconfig`: set the path to the kubeconfig file the Velero server uses to talk to the Kubernetes apiserver (default `$KUBECONFIG`) * `--namespace`: the set namespace where the Velero server should look for backups, schedules, restores (default `velero`) * `--plugin-dir`: set the directory where the Velero server looks for plugins (default `/plugins`) + * The `--plugin-dir` flag requires the plugin binary to be present locally, and should be set to the directory containing this built binary. * `--metrics-address`: set the bind address and port where Prometheus metrics are exposed (default `:8085`) [15]: https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#the-shared-credentials-file