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.

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

CFE-473: Add information about profiling data lifetime #52213

Merged
merged 1 commit into from
Nov 7, 2022

Conversation

xenolinux
Copy link
Contributor

@xenolinux xenolinux commented Oct 27, 2022

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 27, 2022
@xenolinux xenolinux force-pushed the nob-data-profiling branch 2 times, most recently from ab8449d to 1a8060f Compare October 27, 2022 09:19
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Oct 27, 2022

🤖 Updated build preview is available at:
https://52213--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/3093

@alebedev87
Copy link
Contributor

Thanks for the PR, @xenolinux !

Just a small proposal. emptyDir change is just a little technical detail which doesn't change a lot for the end user. I think it doesn't really deserve to be at the very beginning of the NodeObservability Operator's page. I was thinking of Running the profiling query chapter more. This phrase can be a good candidate for mentioning emptyDir:

After the profiling query is complete, you must retrieve the profiling data inside the container file system /run/node-observability directory.

@@ -6,7 +6,7 @@
[id="running-profiling-query_{context}"]
= Running the profiling query

To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory.
To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data in the `emptyDir` volume. You can access the profiling data as long as a pod is in the `running` status.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data in the `emptyDir` volume. You can access the profiling data as long as a pod is in the `running` status.
To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory. The data's life time is bound to the agent pod via the `emptyDir` volume, so you can access the profiling data as long as a pod is in the `running` status.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed

@alebedev87
Copy link
Contributor

/lgtm

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

sunilcio commented Nov 7, 2022

/lgtm

@xenolinux xenolinux changed the title Add information about profiling data lifetime CFE-473: Add information about profiling data lifetime Nov 7, 2022
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 7, 2022
@openshift-ci
Copy link

openshift-ci bot commented Nov 7, 2022

New changes are detected. LGTM label has been removed.

@xenolinux
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Nov 7, 2022
@abhatt-rh
Copy link
Contributor

/label peer-review-in-progress

@openshift-ci openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Nov 7, 2022
Copy link
Contributor

@abhatt-rh abhatt-rh left a comment

Choose a reason for hiding this comment

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

LGTM, except a minor comment!

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

@@ -6,7 +6,7 @@
[id="running-profiling-query_{context}"]
= Running the profiling query

To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory.
To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory. The lifetime of data is bound to the agent pod through the `emptyDir` volume, so you can access the profiling data as long as the agent pod is in the `running` status.
Copy link
Contributor

Choose a reason for hiding this comment

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

Refer to ISG > Word Usage for as long as

Suggested change
To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory. The lifetime of data is bound to the agent pod through the `emptyDir` volume, so you can access the profiling data as long as the agent pod is in the `running` status.
To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory. The lifetime of data is bound to the agent pod through the `emptyDir` volume, so you can access the profiling data while the agent pod is in the `running` status.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Nov 7, 2022
@xenolinux
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Nov 7, 2022
@mjpytlak mjpytlak added merge-review-in-progress Signifies that the merge review team is reviewing this PR branch/enterprise-4.12 and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Nov 7, 2022
@mjpytlak mjpytlak added this to the Planned for 4.12 GA milestone Nov 7, 2022
@mjpytlak mjpytlak merged commit eaae123 into openshift:main Nov 7, 2022
@mjpytlak
Copy link
Contributor

mjpytlak commented Nov 7, 2022

/cherrypick enterprise-4.12

1 similar comment
@mjpytlak
Copy link
Contributor

mjpytlak commented Nov 7, 2022

/cherrypick enterprise-4.12

@openshift-cherrypick-robot

@mjpytlak: new pull request created: #52556

In response to this:

/cherrypick enterprise-4.12

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.

@bergerhoffer bergerhoffer removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.12 peer-review-done Signifies that the peer review team has reviewed this PR size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants