{"id":21511493,"url":"https://github.com/netobserv/must-gather","last_synced_at":"2025-04-09T18:08:52.448Z","repository":{"id":156325382,"uuid":"631995994","full_name":"netobserv/must-gather","owner":"netobserv","description":"A client tool for gathering information about an NetObserv operator managed component.","archived":false,"fork":false,"pushed_at":"2024-05-07T12:09:30.000Z","size":33,"stargazers_count":1,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-23T20:11:11.420Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/netobserv.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}},"created_at":"2023-04-24T13:49:38.000Z","updated_at":"2024-08-22T20:07:44.000Z","dependencies_parsed_at":"2024-04-12T20:31:06.167Z","dependency_job_id":"2cfb810b-3550-4e71-8200-38e3eeb1e077","html_url":"https://github.com/netobserv/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/netobserv%2Fmust-gather","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fmust-gather/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fmust-gather/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fmust-gather/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netobserv","download_url":"https://codeload.github.com/netobserv/must-gather/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085157,"owners_count":21045135,"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-23T22:14:27.114Z","updated_at":"2025-04-09T18:08:52.432Z","avatar_url":"https://github.com/netobserv.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NetObserv must-gather\n\n`must-gather` is a tool built on top of [OpenShift must-gather](https://github.com/openshift/must-gather)\nthat expands its capabilities to gather NetObserv information.\n\n## Usage\n```sh\noc adm must-gather --image=quay.io/netobserv/must-gather\n```\n\nThe command above will create a local directory with a dump of the NetObserv Operator state.\nNote that this command will only get data related to the NetObserv part of the OpenShift cluster.\n\nYou will get a dump of:\n- The NetObserv operator pod logs\n- The NetObserv FlowCollector CRD's definition\n- Dump of Loki as well as NetObserv agent pods logs\n\nIn order to get data about other parts of the cluster (not specific to NetObserv) you should\nrun `oc adm must-gather` (without passing a custom image). Run `oc adm must-gather -h` to see more options.\n\n### Flags\n\n`must-gather` provides a series of options to select which information to\ncollect from the cluster. The tool will always collect all control-plane logs and information.\nOptional collectors can be enabled with CLI options.\n\n\nTo run only the default collectors:\n```sh\noc adm must-gather --image=quay.io/netobserv/must-gather -- /usr/bin/gather\n```\n\n### Help Menu\n\nAt any time you can check the help menu for usage details of the NetObserv must-gather\n\n```sh\noc adm must-gather --image=quay.io/netobserv/must-gather -- /usr/bin/gather --help\n```\n\n```\nUsage: oc adm must-gather --image=quay.io/netobserv/must-gather -- /usr/bin/gather [params...]\n\n  A client tool for gathering NetObserv information in an OpenShift cluster\n\n  Available options:\n\n  \u003e To see this help menu and exit use\n  --help\n\n  \u003e The tool will always collect all control-plane logs and information.\n  \u003e This will include:\n  \u003e - crds\n  \u003e - resources\n  \u003e - webhooks\n\n```\n\n## Development\nYou can build the image locally using the Dockerfile included.\n\nA `makefile` is also provided. To use it, you must pass a repository via the command-line using the variable `MUST_GATHER_IMAGE`.\nYou can also specify the registry using the variable `IMAGE_REGISTRY` (default is [quay.io](https://quay.io)) and the tag via `IMAGE_TAG` (default is `latest`).\n\nThe targets for `make` are as follows:\n- `build`: builds the image with the supplied name and pushes it\n- `image-build`: builds the image but does not push it\n- `image-push`: pushes an already-built image\n\nFor example:\n```sh\nmake build MUST_GATHER_IMAGE=netobserv/must-gather\n```\nwould build the local repository as `quay.io/netobserv/must-gather:latest` and then push it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetobserv%2Fmust-gather","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetobserv%2Fmust-gather","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetobserv%2Fmust-gather/lists"}