Bug 1825831: Refactoring collector, add Doc and doc generator by martinkunc · Pull Request #95 · openshift/insights-operator

martinkunc · 2020-04-17T13:57:37Z

The goal here is to

Refactor the clusterconfig.Gather and extract the methods out for better separation and testing
Document the individual methods in code, add description, and location in the archive
Generate documentation from the methods. It collects Gather... methods and if exists complementary Example... methods to collect the anonymized output example.
Resulting documentation is placed in docs/gathered-data.md

martinkunc · 2020-04-17T16:51:03Z

/retest

martinkunc · 2020-04-17T18:35:03Z

/retest

alexandrevicenzi · 2020-04-20T09:28:44Z

@martinkunc is there any BZ or Jira related to this PR?

alexandrevicenzi

I see some inconsistency in godoc in some function, some include more info some not.

There's a need to document somewhere that samples and everything else are autogen, otherwise, someone might update manually.

alexandrevicenzi · 2020-04-20T09:35:45Z

-				if isHealthyOperator(&item) {
+// GatherMostRecentMetrics gathers cluster Federated Monitoring metrics
+//
+// The GET REST query to URL /federate


Sounds a bit better:

Same data as GET /federate

alexandrevicenzi · 2020-04-20T09:36:53Z

+// The Kubernetes api https://github.com/openshift/client-go/blob/master/config/clientset/versioned/typed/config/v1/clusteroperator.go#L62
+// Response see https://docs.openshift.com/container-platform/4.3/rest_api/index.html#clusteroperatorlist-v1config-openshift-io
+//
+// Location of operators in archive: config/clusteroperator/


One function creates two archives? Should we split this function?

alexandrevicenzi · 2020-04-20T09:37:04Z

+//
+// Location of operators in archive: config/clusteroperator/
+// see: docs/insights-archive-sample/config/clusteroperator
+// Location of pods in archive: config/pod/


No example for pods?

I would like to add more samples later. I just have few samples ready and it takes some time to get each prepared with the test.

alexandrevicenzi · 2020-04-20T09:37:36Z

+// The Kubernetes api https://github.com/kubernetes/client-go/blob/master/kubernetes/typed/core/v1/node.go#L78
+// Response see https://docs.openshift.com/container-platform/4.3/rest_api/index.html#nodelist-v1core
+//
+// Location in archive: config/node/


martinkunc · 2020-04-22T04:56:03Z

/retest

martinkunc · 2020-04-22T05:18:49Z

/retitle Bug 1825831: Refactoring collector, add Doc and doc generator

martinkunc · 2020-04-22T05:19:37Z

/bugzilla refresh

openshift-ci-robot · 2020-04-22T05:19:43Z

@martinkunc: This pull request references Bugzilla bug 1825831, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.5.0) matches configured target release for branch (4.5.0)
bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Details

In response to this:

/bugzilla refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci-robot · 2020-04-22T05:19:44Z

@martinkunc: An error was encountered searching for bug 1825831 on the Bugzilla server at https://bugzilla.redhat.com:

Get https://bugzilla.redhat.com/rest/bug/1825831?api_key=CENSORED: dial tcp 209.132.183.69:443: i/o timeout
Please contact an administrator to resolve this issue, then request a bug refresh with /bugzilla refresh.

Details

In response to this:

Bug 1825831: Refactoring collector, add Doc and doc generator

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

martinkunc · 2020-04-22T05:20:52Z

/bugzilla refresh

openshift-ci-robot · 2020-04-22T05:21:23Z

@martinkunc: An error was encountered searching for bug 1825831 on the Bugzilla server at https://bugzilla.redhat.com:

Get https://bugzilla.redhat.com/rest/bug/1825831?api_key=CENSORED: dial tcp 209.132.183.69:443: i/o timeout
Please contact an administrator to resolve this issue, then request a bug refresh with /bugzilla refresh.

Details

In response to this:

/bugzilla refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

alexandrevicenzi · 2020-04-27T09:30:10Z

/lgtm

openshift-ci-robot · 2020-04-27T09:30:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alexandrevicenzi, dpensi, martinkunc, tremes

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [alexandrevicenzi,martinkunc]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-bot · 2020-04-27T11:36:12Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-04-27T13:32:13Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-ci-robot · 2020-04-27T14:43:51Z

@martinkunc: All pull requests linked via external trackers have merged: openshift/insights-operator#95. Bugzilla bug 1825831 has been moved to the MODIFIED state.

Details

In response to this:

Bug 1825831: Refactoring collector, add Doc and doc generator

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci-robot requested review from derekwaynecarr and iNecas April 17, 2020 13:58

alexandrevicenzi suggested changes Apr 20, 2020

View reviewed changes

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 20, 2020

openshift-ci-robot assigned alexandrevicenzi Apr 20, 2020

martinkunc force-pushed the refactoring-collector-add-doc branch from f8eec5c to ba24d8b Compare April 21, 2020 08:33

openshift-ci-robot changed the title ~~Refactoring collector, add Doc and doc generator~~ Bug 1825831: Refactoring collector, add Doc and doc generator Apr 22, 2020

openshift-ci-robot added the bugzilla/medium label Apr 22, 2020

openshift-ci-robot added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Apr 22, 2020

dpensi approved these changes Apr 23, 2020

View reviewed changes

tremes reviewed Apr 23, 2020

View reviewed changes

Comment thread README.md Outdated

tremes reviewed Apr 23, 2020

View reviewed changes

Comment thread docs/gathered-data.md Outdated

tremes approved these changes Apr 23, 2020

View reviewed changes

martinkunc force-pushed the refactoring-collector-add-doc branch from ba24d8b to 1be9355 Compare April 24, 2020 10:00

Refactoring collector, add Doc and doc generator

fc6889b

martinkunc force-pushed the refactoring-collector-add-doc branch from 1be9355 to fc6889b Compare April 24, 2020 10:07

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 27, 2020

openshift-merge-robot merged commit f730f2b into openshift:master Apr 27, 2020

Conversation

martinkunc commented Apr 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

martinkunc commented Apr 17, 2020

Uh oh!

martinkunc commented Apr 17, 2020

Uh oh!

alexandrevicenzi commented Apr 20, 2020

Uh oh!

alexandrevicenzi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alexandrevicenzi Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

alexandrevicenzi Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

alexandrevicenzi Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

martinkunc Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

alexandrevicenzi Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

martinkunc commented Apr 22, 2020

Uh oh!

martinkunc commented Apr 22, 2020

Uh oh!

martinkunc commented Apr 22, 2020

Uh oh!

openshift-ci-robot commented Apr 22, 2020

Uh oh!

openshift-ci-robot commented Apr 22, 2020

Uh oh!

martinkunc commented Apr 22, 2020

Uh oh!

openshift-ci-robot commented Apr 22, 2020

Uh oh!

Uh oh!

Uh oh!

alexandrevicenzi commented Apr 27, 2020

Uh oh!

openshift-ci-robot commented Apr 27, 2020

Uh oh!

openshift-bot commented Apr 27, 2020

Uh oh!

openshift-bot commented Apr 27, 2020

Uh oh!

openshift-ci-robot commented Apr 27, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

martinkunc commented Apr 17, 2020 •

edited

Loading