Skip to content

Bug 1957889: Improves documentation of GatherClusterOperatorPodsAndEvents #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions pkg/gather/clusterconfig/operators_pods_and_events.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,19 @@ type CompactedEventList struct {
Items []CompactedEvent `json:"items"`
}

// GatherClusterOperatorPodsAndEvents collects all the ClusterOperators degraded Pods
// for degraded cluster operators or that lives at the Cluster Operator's namespace, to collect:
// GatherClusterOperatorPodsAndEvents collects information about all pods
// and events from namespaces of degraded cluster operators. The collected
// information includes:
//
// - Pod definitions
// - Previous and current Pod Container logs (when available)
// - Namespace Events
// - Previous and current logs of pod containers (when available)
// - Namespace events
//
// * Location of pods in archive: config/pod/
// * Location of pod definitions: config/pod/{namespace}/{pod}.json
// * Location of pod container current logs:
// config/pod/{namespace}/logs/{pod}/{container}_current.log
// * Location of pod container previous logs:
// config/pod/{namespace}/logs/{pod}/{container}_previous.log
// * Location of events in archive: events/
// * Id in config: operators_pods_and_events
func GatherClusterOperatorPodsAndEvents(g *Gatherer, c chan<- gatherResult) {
Expand Down