Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update docs/arch.md documentation to mention the new gatherers #542

Merged
merged 6 commits into from
Nov 13, 2021
Merged

Update docs/arch.md documentation to mention the new gatherers #542

merged 6 commits into from
Nov 13, 2021

Conversation

tremes
Copy link
Contributor

@tremes tremes commented Nov 10, 2021

Categories

  • Bugfix
  • Enhancement
  • Backporting
  • Others (CI, Infrastructure, Documentation)

Sample Archive

No new data

Documentation

  • docs/arch.md updated

Unit Tests

No new test

Privacy

Yes. There are no sensitive data in the newly collected information.

Changelog

Breaking Changes

No

References

https://issues.redhat.com/browse/CCXDEV-6176
https://bugzilla.redhat.com/show_bug.cgi?id=???
https://access.redhat.com/solutions/???

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 10, 2021
xJustin
xJustin reviewed Nov 10, 2021
View reviewed changes
Copy link
Contributor

@xJustin xJustin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tremes just some minor grammar suggestions. If you feel like it changes the meaning too much, you can ignore.

docs/arch.md Outdated Show resolved Hide resolved
docs/arch.md Outdated Show resolved Hide resolved
docs/arch.md Outdated Show resolved Hide resolved
docs/arch.md Outdated Show resolved Hide resolved
docs/arch.md Outdated Show resolved Hide resolved
docs/arch.md Outdated Show resolved Hide resolved
docs/arch.md Outdated Show resolved Hide resolved
tremes and others added 4 commits November 10, 2021 16:22
@tremes @xJustin
Update docs/arch.md
0f85c54 
Co-authored-by: Justin Nixon <junixon@redhat.com>
@tremes @xJustin
Update docs/arch.md
789e852 
Co-authored-by: Justin Nixon <junixon@redhat.com>
@tremes @xJustin
Update docs/arch.md
0c2818c 
Co-authored-by: Justin Nixon <junixon@redhat.com>
@tremes
Updates
5fdbba3
natiiix
natiiix approved these changes Nov 11, 2021
View reviewed changes
Copy link
Contributor

@natiiix natiiix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems alright to me. Definitely better than the outdated information we had. Thanks!
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 11, 2021
@openshift-bot
Copy link
Contributor

/retest-required

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

6 similar comments
@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

xJustin
xJustin reviewed Nov 12, 2021
View reviewed changes
docs/arch.md Outdated Show resolved Hide resolved
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 12, 2021
natiiix
natiiix approved these changes Nov 12, 2021
View reviewed changes
Copy link
Contributor

@natiiix natiiix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see no significant issues with the new text.
/lgtm

docs/arch.md
- `important` meaning if that gather-function has an error we will notify `periodic.go` about it, which will handle it accordingly.
- `failable` meaning if that gather-function has an error we will just log it and add it to our metadata.
This is necessary as we are expanding into gathering data about resources that are not guaranteed to be present on the cluster. By default if a resource is not present we shouldn't see an error, but it's better to be safe.
Insights operator defines three types of gatherers (see below). Each of them must implement the [Interface](https://github.com/openshift/insights-operator/blob/master/pkg/gatherers/interface.go#L11) and they are initialized by calling [gather.CreateAllGatherers](https://github.com/openshift/insights-operator/blob/master/pkg/controller/operator.go#L124) in `operator.go`. The actual gathering is triggered in [periodic.go](https://github.com/openshift/insights-operator/blob/master/pkg/controller/periodic/periodic.go#L93), but not every gatherer is triggered every time ( for example, see the [CustomPeriodGatherer type](https://github.com/openshift/insights-operator/blob/master/pkg/gatherers/interface.go#L21)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing I could find is the extra space after an opening parenthesis.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 12, 2021
@openshift-ci
Copy link

openshift-ci bot commented Nov 12, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: natiiix, tremes

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@sferich888
Copy link

/label px-approved

@openshift-ci openshift-ci bot added the px-approved Signifies that Product Support has signed off on this PR label Nov 12, 2021
@tremes
Copy link
Contributor Author

tremes commented Nov 12, 2021

Applying remaining labels myself since it's minor documentation change.
/label qe-approved
/label docs-approved

@openshift-ci openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Nov 12, 2021
@openshift-ci openshift-ci bot added the docs-approved Signifies that Docs has signed off on this PR label Nov 12, 2021
@openshift-bot
Copy link
Contributor

/retest-required

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

6 similar comments
@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-bot
Copy link
Contributor

/retest-required

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

@openshift-merge-robot openshift-merge-robot merged commit 018938f into openshift:master Nov 13, 2021
@tremes tremes deleted the arch_doc_updated branch May 6, 2022 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xJustin xJustin xJustin left review comments

@natiiix natiiix natiiix approved these changes

@derekwaynecarr derekwaynecarr Awaiting requested review from derekwaynecarr

@smarterclayton smarterclayton Awaiting requested review from smarterclayton

Assignees

@natiiix natiiix

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. docs-approved Signifies that Docs has signed off on this PR lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR qe-approved Signifies that QE has signed off on this PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@tremes @openshift-bot @sferich888 @natiiix @xJustin @openshift-merge-robot