Skip to main content

velero configure-gcp

Configures snapshots to use a Google Cloud Platform Object Storage Bucket as a storage destination. This command supports auth via Serivce Account Credentials or Workload Identity.

Valid Subcommands:

  • service-account
  • workload-identity

Usage

kubectl kots velero configure-gcp [subcommand]
FlagTypeDescription
-h, --helphelp for configure-aws-s3

service-account

kubectl kots velero configure-gcp service-account [flags]
  • Provide [flags] according to the table below
FlagTypeDescription
-h, --helphelp for access-key
-n, --namespacestringthe namespace of the Admin Console (required)
--bucketstringname of the object storage bucket where backups should be stored (required)
--json-filestringpath to JSON credntials file for veloro (required)
--path stringpath to a subdirectory in the object store bucket
--skip-validationboolskip the validation of the GCP Bucket (default false)

Example

kubectl kots velero configure-gcp service-account --namespace default --bucket velero-backups --json-file sa-creds.json

workload-identity

kubectl kots velero configure-gcp workload-identity [flags]
  • Provide [flags] according to the table below
FlagTypeDescription
-h, --helphelp for access-key
-n, --namespacestringthe namespace of the Admin Console (required)
--bucketstringname of the object storage bucket where backups should be stored (required)
--path stringpath to a subdirectory in the object store bucket
--service-accountstringthe service account to use if using Google Cloud instance role (required)
--skip-validationboolskip the validation of the GCP Bucket (default false)

Example

kubectl kots velero configure-gcp workload-identity --namespace default --bucket velero-backups --service-account ss-velero@gcp-project.iam.gserviceaccount.com