{"id":13451661,"url":"https://github.com/pulumi/kubespy","last_synced_at":"2025-04-11T01:33:01.065Z","repository":{"id":39617595,"uuid":"149165150","full_name":"pulumi/kubespy","owner":"pulumi","description":"Tools for observing Kubernetes resources in real time, powered by Pulumi.","archived":false,"fork":false,"pushed_at":"2024-04-19T12:47:44.000Z","size":3291,"stargazers_count":2915,"open_issues_count":11,"forks_count":92,"subscribers_count":60,"default_branch":"master","last_synced_at":"2025-04-03T13:14:31.570Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pulumi.com/","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/pulumi.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":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-17T17:49:56.000Z","updated_at":"2025-04-03T00:53:09.000Z","dependencies_parsed_at":"2023-12-05T22:23:49.002Z","dependency_job_id":"4db7cead-b4ff-4095-bffa-585d750af503","html_url":"https://github.com/pulumi/kubespy","commit_stats":{"total_commits":51,"total_committers":18,"mean_commits":"2.8333333333333335","dds":0.6470588235294117,"last_synced_commit":"b943461d8d7bf60eb1c4a71344da0b81481a50c3"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pulumi%2Fkubespy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pulumi%2Fkubespy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pulumi%2Fkubespy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pulumi%2Fkubespy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pulumi","download_url":"https://codeload.github.com/pulumi/kubespy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248325355,"owners_count":21084911,"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","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-07-31T07:00:58.190Z","updated_at":"2025-04-11T01:33:01.043Z","avatar_url":"https://github.com/pulumi.png","language":"Go","funding_links":[],"categories":["Monitoring Services","Go","others","Kubernetes","Troubleshooting","Diagnostics \u0026 Troubleshooting","Observability"],"sub_categories":["[Jenkins](#jenkins)","Kubernetes runtime security","Kubernetes // Dashboards, UI, Reporting and Validation"],"readme":"# kubespy: tools for observing Kubernetes resources in real time\n\nWhat happens when you boot up a `Pod`? What happens to a `Service` before it is allocated a public\nIP address? How often is a `Deployment`'s status changing?\n\n**`kubespy` is a small tool that makes it easy to observe how Kubernetes resources change in real\ntime,** derived from the work we did to make Kubernetes deployments predictable in [Pulumi's CLI](https://www.pulumi.com/kubernetes/). Run `kubespy` at any point in time, and it will watch and report information about a\nKubernetes resource continuously until you kill it.\n\n## Examples\n\n`kubespy trace deployment nginx` will \"trace\" the complex changes a complex Kubernetes resource\nmakes in the cluster (in this case, a `Deployment` called `nginx`), and aggregate them into a\nhigh-level summary, which is updated in real time.\n\n![Changes](images/trace-deployment/trace-deployment-rollout.gif \"Changes a Deployment rolls out a new change, in real time\")\n\n`kubespy status v1 Pod nginx` will wait for a `Pod` called `nginx` to be created, and then continuously emit changes made to its `.status` field, as syntax-highlighted JSON diffs:\n\n![Changes](images/status.gif \"Changes a Pod undergoes as it starts, in real time\")\n\n## Installation\n\nYou can install kubespy in the following ways:\n\n### Homebrew (Mac)\n\nPrerequisite: [homebrew](https://docs.brew.sh/Installation)\n\n```bash\nbrew install kubespy\n```\n\n### Binary\n\nGet the [latest release](https://github.com/pulumi/kubespy/releases),\nrename it to `kubespy`, run `chmod +x kubespy` to make it executable and move it in your path (can be /usr/local/bin).\n\n### Kubectl Plugin\n\nPrerequisite: kubectl v1.12.0 or later\n\nWith kubectl v1.12.0 introducing [easy pluggability](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) of external functions, kubespy can be invoked as `kubectl spy` just by renaming it to `kubectl-spy` and having it available in your path.\n\n### via Golang\n\nPrerequisite: [Go](https://golang.org/) version 1.19 or later\n\n```sh\ngo install github.com/pulumi/kubespy@latest\n```\n\n## Usage\n\n`kubespy` has four commands:\n\n-   `status \u003capiVersion\u003e \u003ckind\u003e [\u003cnamespace\u003e/]\u003cname\u003e`, which in real time emits all changes made to\n    the `.status` field of an arbitrary Kubernetes resource, as a JSON diff.\n-   `changes \u003capiVersion\u003e \u003ckind\u003e [\u003cnamespace\u003e/]\u003cname\u003e`, which in real time emits all changes to any\n    field in a Kubernetes resource, as a JSON diff.\n-   `trace \u003ckind\u003e [\u003cnamespace\u003e/]\u003cname\u003e`, which \"traces\" the changes a complex Kubernetes resource\n    makes throughout a cluster, and aggregates them into a high-level summary, which is updated in\n    real time.\n-   `record \u003capiVersion\u003e \u003ckind\u003e [\u003cnamespace\u003e/]\u003cname\u003e`, which in real time emits all changes to any\n    field in a Kubernetes resource, as a JSON array.\n\nSeveral more commands are planned as well.\n\n## Examples\n\nFor a concrete example you can run using either `Pulumi CLI` or `kubectl`, check out [examples/trivial-pulumi-example](https://github.com/pulumi/kubespy/tree/master/examples/trivial-pulumi-example).\n\n## Features\n\n-   [x] Supports any resources the API server knows about, including CRDs (_i.e._, uses the discovery\n        client to discover the available API resources, and allows users to query any of them).\n-   [x] Displays changes to API objects in real time.\n-   [ ] Supports case-insensitive aliases (_e.g._ `kubespy status v1 pod \u003cname\u003e` instead of\n        `kubespy status v1 Pod \u003cname\u003e`).\n-   [ ] Supports status updates from regex and/or fuzzy matching (_i.e._, make it easy to watch the\n        status of `Pod`s generated by `Deployment`s and `ReplicaSet`s).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpulumi%2Fkubespy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpulumi%2Fkubespy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpulumi%2Fkubespy/lists"}