{"id":36577481,"url":"https://github.com/clevyr/kubedb","last_synced_at":"2026-01-12T07:37:45.051Z","repository":{"id":41128143,"uuid":"369894863","full_name":"clevyr/kubedb","owner":"clevyr","description":"Painlessly work with databases in Kubernetes.","archived":false,"fork":false,"pushed_at":"2026-01-02T22:43:02.000Z","size":2065,"stargazers_count":21,"open_issues_count":29,"forks_count":1,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-01-05T04:30:26.461Z","etag":null,"topics":["database","kubernetes","mariadb","mongodb","postgresql"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clevyr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-05-22T19:55:41.000Z","updated_at":"2025-12-18T06:56:19.000Z","dependencies_parsed_at":"2023-02-18T10:00:59.958Z","dependency_job_id":"a07e62f5-8ef3-484f-b7a0-3a18c36b2c10","html_url":"https://github.com/clevyr/kubedb","commit_stats":null,"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"purl":"pkg:github/clevyr/kubedb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clevyr%2Fkubedb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clevyr%2Fkubedb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clevyr%2Fkubedb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clevyr%2Fkubedb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clevyr","download_url":"https://codeload.github.com/clevyr/kubedb/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clevyr%2Fkubedb/sbom","scorecard":{"id":291434,"data":{"date":"2025-08-11","repo":{"name":"github.com/clevyr/kubedb","commit":"6a5f92061cf8ed3c17c6341a6aef83b88b6b33f7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.1,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/5 approved changesets -- score normalized to 0","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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/build.yml:14","Info: jobLevel 'contents' permission set to 'read': .github/workflows/build.yml:33","Warn: no topLevel permission defined: .github/workflows/build.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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Warn: containerImage not pinned by hash: Dockerfile:3","Warn: containerImage not pinned by hash: Dockerfile:5","Warn: containerImage not pinned by hash: Dockerfile:21: pin your Docker image by updating alpine:3.22.1 to alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1","Warn: containerImage not pinned by hash: goreleaser.Dockerfile:1: pin your Docker image by updating alpine:3.22.1 to alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1","Info:   8 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   5 out of   5 third-party GitHubAction dependencies pinned","Info:   0 out of   4 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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":3,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: branch 'main' does not require approvers","Warn: codeowners review is not required on branch 'main'","Info: status check found to merge onto on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.18.1 not signed: https://api.github.com/repos/clevyr/kubedb/releases/238366358","Warn: release artifact v1.18.0 not signed: https://api.github.com/repos/clevyr/kubedb/releases/237110469","Warn: release artifact v1.17.4 not signed: https://api.github.com/repos/clevyr/kubedb/releases/210686132","Warn: release artifact v1.17.3 not signed: https://api.github.com/repos/clevyr/kubedb/releases/210280705","Warn: release artifact v1.17.2 not signed: https://api.github.com/repos/clevyr/kubedb/releases/209468334","Warn: release artifact v1.18.1 does not have provenance: https://api.github.com/repos/clevyr/kubedb/releases/238366358","Warn: release artifact v1.18.0 does not have provenance: https://api.github.com/repos/clevyr/kubedb/releases/237110469","Warn: release artifact v1.17.4 does not have provenance: https://api.github.com/repos/clevyr/kubedb/releases/210686132","Warn: release artifact v1.17.3 does not have provenance: https://api.github.com/repos/clevyr/kubedb/releases/210280705","Warn: release artifact v1.17.2 does not have provenance: https://api.github.com/repos/clevyr/kubedb/releases/209468334"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/build.yml:44"],"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: all commits (25) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T18:19:49.102Z","repository_id":41128143,"created_at":"2025-08-17T18:19:49.102Z","updated_at":"2025-08-17T18:19:49.102Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28336604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["database","kubernetes","mariadb","mongodb","postgresql"],"created_at":"2026-01-12T07:37:44.517Z","updated_at":"2026-01-12T07:37:45.046Z","avatar_url":"https://github.com/clevyr.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003e\n  \u003cimg src=\"./assets/icon.svg\" width=\"92\" align=\"left\"\u003e\n  KubeDB\n\u003c/h1\u003e\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/clevyr/kubedb)](https://github.com/clevyr/kubedb/releases)\n[![Build](https://github.com/clevyr/kubedb/actions/workflows/build.yml/badge.svg)](https://github.com/clevyr/kubedb/actions/workflows/build.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/clevyr/kubedb)](https://goreportcard.com/report/github.com/clevyr/kubedb)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=clevyr_kubedb\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=clevyr_kubedb)\n\n\u003cbr\u003e\n\u003c/div\u003e\n\nKubeDB is a command to interact with databases running in Kubernetes.\nIt supports dumping, restoring, and dropping into a database shell.\nOptional flags are available to set running database parameters\n(see each command's help entry for more details).\nIf no flags are given, KubeDB will inspect the pod configuration and attempt\nto configure itself via the Kubernetes EnvVar API.\n\n## Supported Databases\n- PostgreSQL\n  - [bitnami/postgresql](https://artifacthub.io/packages/helm/bitnami/postgresql)\n  - [bitnami/postgresql-ha](https://artifacthub.io/packages/helm/bitnami/postgresql-ha)\n  - [CloudNativePG](https://cloudnative-pg.io)\n  - [Zalando Operator](https://github.com/zalando/postgres-operator)\n- MariaDB/MySQL\n  - [bitnami/mariadb](https://artifacthub.io/packages/helm/bitnami/mariadb)\n  - [bitnami/mariadb-galera](https://artifacthub.io/packages/helm/bitnami/mariadb-galera)\n  - [bitnami/mysql](https://artifacthub.io/packages/helm/bitnami/mysql)\n- MongoDB\n  - [bitnami/mongodb](https://artifacthub.io/packages/helm/bitnami/mongodb)\n- Redis\n  - [bitnami/redis](https://artifacthub.io/packages/helm/bitnami/redis)\n  - [bitnami/valkey](https://artifacthub.io/packages/helm/bitnami/valkey)\n- Meilisearch [beta]\n  - [meilisearch/meilisearch](https://github.com/meilisearch/meilisearch-kubernetes)\n\n## Installation\n\n### Homebrew (macOS, Linux)\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n\n  ```shell\n  brew install clevyr/tap/kubedb\n  ```\n\u003c/details\u003e\n\n### Docker\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n\nKubeDB has a Docker image available at [`ghcr.io/clevyr/kubedb`](https://ghcr.io/clevyr/kubedb)\n\n```shell\ndocker pull ghcr.io/clevyr/kubedb\n```\n\nTo use this image, you will need to volume bind a couple of directories into the Docker container:\n\n1. **Kubeconfig:** Typically, this will be at `~/.kube/config`, and the container expects it to be at `/.kube/config`.\n   - Example: `-v \"$HOME/.kube/config:/.kube/config\"`\n2. **Data dir:** A directory to hold the generated dump or that has a sql file to restore. The container expects this to be at `/data`.\n   - Example: `-v \"$PWD:/data\"`\n\n#### Example:\n```shell\ndocker run --rm -it -v \"$HOME/.kube:/.kube\" -v \"$PWD:/data\" ghcr.io/clevyr/kubedb dump\n```\n\u003c/details\u003e\n\n### APT Repository (Ubuntu, Debian)\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n\n1. If you don't have it already, install the `ca-certificates` package\n   ```shell\n   sudo apt install ca-certificates\n   ```\n\n2. Add Clevyr's apt repository\n   ```\n   echo 'deb [trusted=yes] https://apt.clevyr.com /' | sudo tee /etc/apt/sources.list.d/clevyr.list\n   ```\n\n3. Update apt repositories\n   ```shell\n   sudo apt update\n   ```\n\n4. Install KubeDB\n   ```shell\n   sudo apt install kubedb\n   ```\n\u003c/details\u003e\n\n### RPM Repository (CentOS, RHEL)\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n\n1. If you don't have it already, install the `ca-certificates` package\n   ```shell\n   sudo yum install ca-certificates\n   ```\n\n2. Add Clevyr's rpm repository to `/etc/yum.repos.d/clevyr.repo`\n   ```ini\n   [clevyr]\n   name=Clevyr\n   baseurl=https://rpm.clevyr.com\n   enabled=1\n   gpgcheck=0\n   ```\n\n3. Install KubeDB\n   ```shell\n   sudo yum install kubedb\n   ```\n\u003c/details\u003e\n\n### AUR (Arch Linux)\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n\nInstall [kubedb-bin](https://aur.archlinux.org/packages/kubedb-bin) with your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) of choice.\n\u003c/details\u003e\n\nKubeDB requires an existing Kubeconfig. See below for details.\n\n## Usage\n\nAll of the KubeDB subcommands and flags are documented in the [docs](./docs/kubedb.md) directory.\n\n### Examples\n\n- Verify cluster/database connection\n  ```shell\n  kubedb status\n  ```\n- Dump a database (filename will be generated)\n  ```shell\n  kubedb dump\n- Dump a database to a specific filename\n  ```shell\n  kubedb dump example.sql.gz\n  ```\n- Restore a SQL file to a database\n  ```shell\n  kubedb restore example.sql.gz\n  ```\n- Set up a local port-forward\n  ```shell\n  kubedb port-forward\n  ```\n- Open an interactive prompt\n  ```shell\n  kubedb exec\n  ```\n\n### Connecting to GKE\n\n1. To connect to a Kubernetes cluster running in GKE,\n   ensure you have the `gcloud` command installed. \n   If you have it then skip to step 2.  \n   Otherwise, you can either [take a look at GCP's install doc](https://cloud.google.com/sdk/docs/install), \n   or run:\n\n   ```shell\n   brew install google-cloud-sdk\n   gcloud init\n   ```\n2. Install the `gke-cloud-auth-plugin` per the GCP install doc or run:\n\n    ```shell\n    gcloud components install gke-gcloud-auth-plugin\n    ```\n\n3. Then to generate a Kubeconfig, run:\n\n   ```shell\n   gcloud container clusters get-credentials --project=PROJECT CLUSTER_NAME\n   ```\n   \n4. If you don’t encounter any errors then you should be connected and ready to work with databases!\n   To verify, type in the following command and press the tab key twice:\n\n   ```shell\n   kubedb exec -n \u003cTAB\u003e\u003cTAB\u003e\n   ```\n\n   All of your current namespaces should show up in your shell.\n   Many of the KubeDB flags support tab completion.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclevyr%2Fkubedb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclevyr%2Fkubedb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclevyr%2Fkubedb/lists"}