{"id":18637085,"url":"https://github.com/openshift/must-gather","last_synced_at":"2025-05-16T04:05:21.491Z","repository":{"id":37470761,"uuid":"164676389","full_name":"openshift/must-gather","owner":"openshift","description":"A client tool for gathering information about an operator managed component.","archived":false,"fork":false,"pushed_at":"2025-04-28T19:31:31.000Z","size":20079,"stargazers_count":114,"open_issues_count":9,"forks_count":199,"subscribers_count":151,"default_branch":"master","last_synced_at":"2025-04-28T20:34:00.995Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/openshift.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-01-08T15:20:20.000Z","updated_at":"2025-04-28T19:31:35.000Z","dependencies_parsed_at":"2023-02-16T19:30:44.747Z","dependency_job_id":"dae04523-fe88-4f9f-bb79-14391320459b","html_url":"https://github.com/openshift/must-gather","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Fmust-gather","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Fmust-gather/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Fmust-gather/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Fmust-gather/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openshift","download_url":"https://codeload.github.com/openshift/must-gather/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254464895,"owners_count":22075570,"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-11-07T05:33:11.155Z","updated_at":"2025-05-16T04:05:18.021Z","avatar_url":"https://github.com/openshift.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"must-gather\n===========\n\n`openshift-must-gather` is a tool for collecting cluster data.\nIt dumps `clusteroperator` data, and associated namespace data, into a specified `--base-dir` location.\nThe directory structure, as well as specific details behind this tool can be found [in this enhancement](https://github.com/openshift/enhancements/blob/master/enhancements/oc/must-gather.md).\n\n## Collection Scripts\nData collection scripts are kept in `./collection-scripts`.  The content of that folder is placed in `/usr/bin` in the image.\nThe data collection scripts should only include collection logic for components that are included as part of the OpenShift\nCVO payload.  Outside components are encouraged to produce a similar \"must-gather\" image, but this is not the spot to be\nincluded.\n\n## How to run\nYou can run `must-gather` on a cluster with `oc adm must-gather`. \nUse `-h` flag to see available options.\n\n## How to test\nBuild a new must-gather image with your changes using the Makefile. There are two options in the Makefile, `make` will use imagebuilder to build the image while `make BUILDER=podman` will use podman to build the image.\n\nIf using `make BUILDER=podman`, please set the `AUTH_FILE` parameter pointing to an authentication file that has credentials for the `registry.ci.openshift.org` registry. Ensure that you are connected to the VPN before building the image.\n```\nmake BUILDER=podman AUTH_FILE=/path/to/authfile\n```\n\nOnce the image is built, push it to a registry where it can be accessed from. \n```\npodman push [built-image] [registry/username/your-built-image]\n``` \n\nTo test your new changes with a cluster, run the following:\n```\noc adm must-gather --image=registry/username/your-built-image\n```\n\n## Obfuscate confidential information\nThere is a dedicated effort to obfuscate and omit confidential information. Head over to [openshift/must-gather-clean](https://github.com/openshift/must-gather-clean) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift%2Fmust-gather","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenshift%2Fmust-gather","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift%2Fmust-gather/lists"}