{"id":27633389,"url":"https://github.com/universityofadelaide/shepherd-operator","last_synced_at":"2026-04-30T13:34:17.806Z","repository":{"id":38161596,"uuid":"195918206","full_name":"universityofadelaide/shepherd-operator","owner":"universityofadelaide","description":"Kubernetes operators which handle critical functions of Shepherd.","archived":false,"fork":false,"pushed_at":"2022-09-12T01:10:33.000Z","size":34415,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-01-20T15:47:39.781Z","etag":null,"topics":["kubebuilder","kubernetes","openshift","shepherd"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/universityofadelaide.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-09T02:31:35.000Z","updated_at":"2022-06-10T01:40:41.000Z","dependencies_parsed_at":"2022-08-08T23:15:59.996Z","dependency_job_id":null,"html_url":"https://github.com/universityofadelaide/shepherd-operator","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/universityofadelaide/shepherd-operator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/universityofadelaide%2Fshepherd-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/universityofadelaide%2Fshepherd-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/universityofadelaide%2Fshepherd-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/universityofadelaide%2Fshepherd-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/universityofadelaide","download_url":"https://codeload.github.com/universityofadelaide/shepherd-operator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/universityofadelaide%2Fshepherd-operator/sbom","scorecard":{"id":910455,"data":{"date":"2025-08-18","repo":{"name":"github.com/universityofadelaide/shepherd-operator","commit":"166451f56fa409a91c9c6a990b8086cac0bb6630"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":2.6,"checks":[{"name":"Code-Review","score":2,"reason":"Found 4/20 approved changesets -- score normalized to 2","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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"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/40576783fda6698350fcbbeaea760ff827433034/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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish.yml:16","Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/test.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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#packaging"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}},{"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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":4,"reason":"dependency not pinned by hash detected -- score normalized to 4","details":["Info: Possibly incomplete results: error parsing shell code: \"foo(\" must be followed by ): vendor/sigs.k8s.io/controller-runtime/Makefile:0","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/universityofadelaide/shepherd-operator/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/universityofadelaide/shepherd-operator/lint.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/universityofadelaide/shepherd-operator/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/universityofadelaide/shepherd-operator/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/universityofadelaide/shepherd-operator/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/universityofadelaide/shepherd-operator/test.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:2","Warn: containerImage not pinned by hash: Dockerfile:23: pin your Docker image by updating gcr.io/distroless/static:nonroot to gcr.io/distroless/static:nonroot@sha256:cdf4daaf154e3e27cfffc799c16f343a384228f38646928a1513d925f473cb46","Warn: goCommand not pinned by hash: vendor/github.com/json-iterator/go/build.sh:10","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   3 out of   4 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   2 out of   3 goCommand 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/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"22 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2022-0322 / GHSA-cg3q-j54f-5p7p","Warn: Project is vulnerable to: GO-2022-0968 / GHSA-gwc9-m7rh-j2ww","Warn: Project is vulnerable to: GO-2021-0356 / GHSA-8c26-wmh5-6g9v","Warn: Project is vulnerable to: GO-2024-2961","Warn: Project is vulnerable to: GO-2023-2402 / GHSA-45x7-px36-x8w8","Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GO-2022-0969 / GHSA-69cg-p879-7622","Warn: Project is vulnerable to: GO-2022-1144 / GHSA-xrjj-mj9h-534m","Warn: Project is vulnerable to: GO-2023-1571 / GHSA-vvpx-j8f3-3w6h","Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2025-3488 / GHSA-6v2p-p543-phr9","Warn: Project is vulnerable to: GO-2022-0493 / GHSA-p782-xgp4-8hr8","Warn: Project is vulnerable to: GO-2022-1059 / GHSA-69ch-w2m2-3vjp","Warn: Project is vulnerable to: GO-2024-2611 / GHSA-8r3f-844c-mc37","Warn: Project is vulnerable to: GO-2022-0603 / GHSA-hp87-p4gw-j4gq"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T18:55:40.852Z","repository_id":38161596,"created_at":"2025-08-24T18:55:40.852Z","updated_at":"2025-08-24T18:55:40.852Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32466333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"ssl_error","status_checked_at":"2026-04-30T13:12:06.837Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["kubebuilder","kubernetes","openshift","shepherd"],"created_at":"2025-04-23T18:15:47.532Z","updated_at":"2026-04-30T13:34:17.801Z","avatar_url":"https://github.com/universityofadelaide.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shepherd Operator\n\nThis project provides kubernetes operators which control backing up and restoring an environment.\n\nIt is written in Go using the [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) framework.\n\n_Note: Kubebuilder version 2 is not compatible with the version of OpenShift that Shepherd runs on_\n\n## Usage\n\n### Via Shepherd\n\nShepherd has integration with this operator. It allows administrators to create new `Backup` and `Restore` objects via the Drupal UI.\n\n### Via kube manifests\n\nBackup/Restores can be created by creating a new object with a manifest similar to the example below. In this example:\n\n* The `site` and `environment` labels allow Shepherd to query these objects for display in the UI.\n* `volumes` holds a unique name and `claimName` for each PVC that is going to be backed up.\n* `mysql` holds a unique name and `secret` for each database that is going to be backed up. The `secret.keys` property is used by the operator to mount environment variables into the containers running the sql dump/restores in order to connect to the database.\n\n```\napiVersion: extension.shepherd/v1\nkind: Backup\nmetadata:\n  name: node-123-backup-xyz\n  labels:\n    site: 456\n    environment: 123\nspec:\n  volumes:\n    shared:\n      claimName: node-123-shared\n  mysql:\n    default:\n      secret:\n        name: node-123\n        keys:\n          username: DATABASE_USER\n          password: DATABASE_PASSWORD\n          database: DATABASE_NAME\n          hostname: DATABASE_HOST\n          port: DATABASE_PORT\nstatus:\n  startTime: '2018-11-21T00:16:23Z'\n  completionTime: '2018-11-21T00:16:43Z'\n  resticId: abcd969xcz\n  phase: New|InProgress|Failed|Completed\n```\n\n## Containers\n\n```bash\n$ docker pull ghcr.io/universityofadelaide/shepherd-operator:latest\n```\n\n## Deploy\n\nThis approach can be used for both production deployments and local develop on [Shepherd](https://github.com/universityofadelaide/shepherd)\n\n1. Generate Github Token\n\nCreate new Github Personal Access Token with `read:packages` scope.\n\nhttps://github.com/settings/tokens/new\n\nUpdate the [secret manifest](config/manager/secret.yml) to contain a base64 string using the following command:\n\n```bash\necho -n \u003cyour-github-username\u003e:\u003cTOKEN\u003e | base64\n```\n\n2. Create Namespace\n\n```bash\noc apply -f config/manager/namespace.yml\n```\n\n4. Apply CustomerResourceDefinitions\n\n```bash\noc apply -f config/crd/bases/\n\n```\n\n5. Apply RBAC Policies\n\n```bash\noc apply -f config/rbac/\n```\n\n6. Apply Deployment Manifests\n\n```bash\noc apply -f config/manager/deployment.yml\n```\n\n## Local Development\n\n1. Setup Permissions\n\n```bash\noc apply -f config/manager/namespace.yml\noc apply -f config/crd/bases/\noc apply -f config/rbac/\n```\n\n2. Run the Operator\n\n```\nmake run\n```\n\n## Resources\n\nThe codebase is written in Go and uses the Kubebuilder framework.\n\n* [Getting Started with Go](https://github.com/alco/gostart)\n* [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)\n\nThe core logic of this operator is contained in:\n- [pkg/controller/backup/backup_controller.go](pkg/controller/backup/backup_controller.go) in the function `Reconcile()`.\n- [pkg/controller/restore/restore_controller.go](pkg/controller/backup/restore_controller.go) in the function `Reconcile()`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funiversityofadelaide%2Fshepherd-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funiversityofadelaide%2Fshepherd-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funiversityofadelaide%2Fshepherd-operator/lists"}