{"id":19236847,"url":"https://github.com/crunchydata/postgres-operator-client","last_synced_at":"2025-10-03T22:18:45.347Z","repository":{"id":59911244,"uuid":"416428126","full_name":"CrunchyData/postgres-operator-client","owner":"CrunchyData","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-01T21:22:36.000Z","size":677,"stargazers_count":16,"open_issues_count":4,"forks_count":12,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-10-01T22:05:46.985Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"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/CrunchyData.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-10-12T17:10:00.000Z","updated_at":"2025-10-01T21:20:43.000Z","dependencies_parsed_at":"2023-02-09T16:30:51.704Z","dependency_job_id":"17cc13b1-5ec9-44b0-a09f-9e686baffd68","html_url":"https://github.com/CrunchyData/postgres-operator-client","commit_stats":{"total_commits":135,"total_committers":16,"mean_commits":8.4375,"dds":0.7333333333333334,"last_synced_commit":"0c7a778410dc73960f707d303410f17fc929b261"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/CrunchyData/postgres-operator-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fpostgres-operator-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fpostgres-operator-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fpostgres-operator-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fpostgres-operator-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrunchyData","download_url":"https://codeload.github.com/CrunchyData/postgres-operator-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fpostgres-operator-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278235466,"owners_count":25953352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-03T02:00:06.070Z","response_time":53,"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":[],"created_at":"2024-11-09T16:23:41.728Z","updated_at":"2025-10-03T22:18:45.342Z","avatar_url":"https://github.com/CrunchyData.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003ccode\u003epgo\u003c/code\u003e, the Postgres Operator CLI from Crunchy Data\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"150\" src=\"./docs/static/logos/pgo.svg\" alt=\"pgo: The CLI for the Postgres Operator from Crunchy Data\"/\u003e\n\u003c/p\u003e\n\nWelcome to the repository for `pgo`, the Command Line Interface (CLI) for\nthe [Crunchy Postgres Operator](https://github.com/CrunchyData/postgres-operator)!\nBuilt as a `kubectl` plugin, the `pgo` CLI facilitates the creation and management of PostgreSQL\nclusters created using the Crunchy Postgres Operator. For more information about using the CLI and\nthe various commands available, please see the\n[`pgo` CLI documentation](https://access.crunchydata.com/documentation/postgres-operator-client/latest).\n\n## Install `pgo`\n\nThe following steps will allow you to download and install the `pgo`\n[kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)\nin your local environment.\n\n### Prerequisites\n\nDepending on your deployment type, Kubernetes or OpenShift, `kubectl` or `oc`\nmust be installed and configured in your environment. For the purposes of these\ninstructions we will be using the `kubectl` client. The `pgo`\n[kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)\nwill use the role-based access controls (RBAC) that are configured for your\n`kubectl` client.\n\n### Download the binary\n\nThe `kubectl-pgo` binary is available either through the Crunchy Data\n[Access Portal](https://access.crunchydata.com/downloads/browse/containers/postgres-operator/cli/) or via\n[GitHub](https://github.com/CrunchyData/postgres-operator-client/releases).\n\n### Installing the Client\n\nOnce downloaded, move the `kubectl-pgo` binary to `/usr/local/bin` and make it\nexecutable by running the following commands:\n\n```\nsudo mv /PATH/TO/kubectl-pgo /usr/local/bin/kubectl-pgo\nsudo chmod +x /usr/local/bin/kubectl-pgo\n```\n\n### Checking the plugin install\n\nNow that the `kubectl-pgo` binary is installed on your `PATH`, it can be used as\na [kubectl plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/).\nRun the following command to ensure that the plugin is working:\n\n```\nkubectl pgo version\n```\n\nor if running in OpenShift:\n```\noc pgo version\n```\n\n## Compatibility\n\nThe `pgo` CLI supports all actively maintained versions of PGO v5+.\n\n## More Information\n\nFor more about PGO, please see the\n[PGO Documentation](https://access.crunchydata.com/documentation/postgres-operator/).\n\n## Testing the Client\n\nThe PGO client has several KUTTL tests that run through some common scenarios.\nIn order to run these tests, we need a PGO operator or the equivalent running, i.e., `make deploy-dev`.\n\nNote: the `support export` test requires a PGO operator running in the `postgres-operator` namespace.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrunchydata%2Fpostgres-operator-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrunchydata%2Fpostgres-operator-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrunchydata%2Fpostgres-operator-client/lists"}