{"id":28451759,"url":"https://github.com/vmware-tanzu/velero-plugin-example","last_synced_at":"2026-03-12T03:33:05.082Z","repository":{"id":27135198,"uuid":"112385197","full_name":"vmware-tanzu/velero-plugin-example","owner":"vmware-tanzu","description":"Example project for plugins for Velero, a Kubernetes disaster recovery utility","archived":false,"fork":false,"pushed_at":"2025-04-29T06:49:14.000Z","size":8801,"stargazers_count":56,"open_issues_count":5,"forks_count":44,"subscribers_count":13,"default_branch":"main","last_synced_at":"2026-02-28T00:37:34.646Z","etag":null,"topics":["backup","disaster-recovery","example","kubernetes","plugin","plugins","sample","velero","velero-plugin"],"latest_commit_sha":null,"homepage":"https://velero.io","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vmware-tanzu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-11-28T20:25:03.000Z","updated_at":"2026-01-26T00:50:59.000Z","dependencies_parsed_at":"2023-01-14T06:03:48.869Z","dependency_job_id":"10e67af3-2a85-489a-a3b2-9ef4ab4b7660","html_url":"https://github.com/vmware-tanzu/velero-plugin-example","commit_stats":null,"previous_names":["heptio/velero-plugin-example"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vmware-tanzu/velero-plugin-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-tanzu%2Fvelero-plugin-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-tanzu%2Fvelero-plugin-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-tanzu%2Fvelero-plugin-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-tanzu%2Fvelero-plugin-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vmware-tanzu","download_url":"https://codeload.github.com/vmware-tanzu/velero-plugin-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-tanzu%2Fvelero-plugin-example/sbom","scorecard":{"id":461775,"data":{"date":"2025-08-04","repo":{"name":"github.com/vmware-tanzu/velero-plugin-example","commit":"db1d1d1a74cc9889fcf1dbde77dc120930825bc1"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":4.4,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":6,"reason":"Found 12/20 approved changesets -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/auto_assign_prs.yml:1","Warn: no topLevel permission defined: .github/workflows/continuous-integration.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto_assign_prs.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/vmware-tanzu/velero-plugin-example/auto_assign_prs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/continuous-integration.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/vmware-tanzu/velero-plugin-example/continuous-integration.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/continuous-integration.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/vmware-tanzu/velero-plugin-example/continuous-integration.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/continuous-integration.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/vmware-tanzu/velero-plugin-example/continuous-integration.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:15","Warn: containerImage not pinned by hash: Dockerfile:21","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T11:18:33.548Z","repository_id":27135198,"created_at":"2025-08-19T11:18:33.548Z","updated_at":"2025-08-19T11:18:33.548Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30414332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-12T00:40:14.898Z","status":"online","status_checked_at":"2026-03-12T02:00:07.260Z","response_time":114,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","disaster-recovery","example","kubernetes","plugin","plugins","sample","velero","velero-plugin"],"created_at":"2025-06-06T17:08:55.401Z","updated_at":"2026-03-12T03:33:05.064Z","avatar_url":"https://github.com/vmware-tanzu.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Velero Example Plugins\n\n![Build Status][1]\n\nThis repository contains example plugins for Velero.\n\n## Kinds of Plugins\n\nVelero currently supports the following kinds of plugins:\n\n- **Object Store** - persists and retrieves backups, backup log files, restore warning/error files, restore logs.\n- **Volume Snapshotter** - creates snapshots from volumes (during a backup) and volumes from snapshots (during a restore).\n- **Backup Item Action** - performs arbitrary logic on individual items prior to storing them in the backup file.\n- **Restore Item Action** - performs arbitrary logic on individual items prior to restoring them in the Kubernetes cluster.\n- **Delete Item Action** - performs arbitrary logic on individual items prior to deleting them from the backup file.\n\nVelero can host multiple plugins inside of a single, resumable process. The plugins can be of any supported type. See `main.go`.\n\nFor more information, please see the full [plugin documentation](https://velero.io/docs/main/overview-plugins/).\n\n## Building the plugins\n\nTo build the plugins, run\n\n```bash\n$ make\n```\n\nTo build the image, run\n\n```bash\n$ make container\n```\n\nThis builds an image tagged as `velero/velero-plugin-example:main`. If you want to specify a different name or version/tag, run:\n\n```bash\n$ IMAGE=your-repo/your-name VERSION=your-version-tag make container \n```\n\n## Deploying the plugins\n\nTo deploy your plugin image to an Velero server:\n\n1. Make sure your image is pushed to a registry that is accessible to your cluster's nodes.\n2. Run `velero plugin add \u003cregistry/image:version\u003e`. Example with a dockerhub image: `velero plugin add velero/velero-plugin-example`.\n\n## Using the plugins\n\nWhen the plugin is deployed, it is only made available to use. To make the plugin effective, you must modify your configuration:\n\nBackup storage:\n\n1. Run `kubectl edit backupstoragelocation \u003clocation-name\u003e -n \u003cvelero-namespace\u003e` e.g. `kubectl edit backupstoragelocation default -n velero` OR `velero backup-location create \u003clocation-name\u003e --provider \u003cprovider-name\u003e`\n2. Change the value of `spec.provider` to enable an **Object Store** plugin\n3. Save and quit. The plugin will be used for the next `backup/restore`\n\nVolume snapshot storage:\n\n1. Run `kubectl edit volumesnapshotlocation \u003clocation-name\u003e -n \u003cvelero-namespace\u003e` e.g. `kubectl edit volumesnapshotlocation default -n velero` OR `velero snapshot-location create \u003clocation-name\u003e --provider \u003cprovider-name\u003e`\n2. Change the value of `spec.provider` to enable a **Volume Snapshotter** plugin\n3. Save and quit. The plugin will be used for the next `backup/restore`\n\nBackup/Restore actions:\n\n1. Add the plugin to Velero as described in the Deploying the plugins section.\n2. The plugin will be used for the next `backup/restore`.\n\n## Examples\n\nTo run with the example plugins, do the following:\n\n1. Run `velero backup-location create  default --provider file` Optional: `--config bucket:\u003cyour-bucket\u003e,prefix:\u003cyour-prefix\u003e` to configure a bucket and/or prefix directories.\n2. Run `velero snapshot-location create example-default --provider example-volume-snapshotter`\n3. Run `kubectl edit deployment/velero -n \u003cvelero-namespace\u003e`\n4. Change the value of `spec.template.spec.args` to look like the following:\n\n```yaml\n      - args:\n        - server\n        - --default-volume-snapshot-locations\n        - example-volume-snapshotter:example-default\n```\n\n5. Run `kubectl create -f examples/with-pv.yaml` to apply a sample nginx application that uses the example block store plugin. ***Note***: This example works best on a virtual machine, as it uses the host's `/tmp` directory for data storage.\n6. Save and quit. The plugins will be used for the next `backup/restore`\n\n## Creating your own plugin project\n\n1. Create a new directory in your `$GOPATH`, e.g. `$GOPATH/src/github.com/someuser/velero-plugins`\n2. Copy everything from this project into your new project\n\n```bash\n$ cp -a $GOPATH/src/github.com/vmware-tanzu/velero-plugin-example/* $GOPATH/src/github.com/someuser/velero-plugins/.\n```\n\n3. Remove the git history\n\n```bash\n$ cd $GOPATH/src/github.com/someuser/velero-plugins\n$ rm -rf .git\n```\n\n4. Adjust the existing plugin directories and source code as needed.\n\nThe `Makefile` is configured to automatically build all directories starting with the prefix `velero-`.\nYou most likely won't need to edit this file, as long as you follow this convention.\n\nIf you need to pull in additional dependencies to your vendor directory, just run\n\n```bash\n$ make modules\n```\n\n[1]: https://github.com/vmware-tanzu/velero-plugin-example/workflows/Continuous%20Integration/badge.svg\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-tanzu%2Fvelero-plugin-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvmware-tanzu%2Fvelero-plugin-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-tanzu%2Fvelero-plugin-example/lists"}