OCPBUGS#5149: Adding missing CurrentState API route info #54355

rohennes · 2023-01-09T14:12:25Z

OCPBUGS-5149: Adding missing CurrentState API route for PTP API

Version(s):
4.11+

Issue:
https://issues.redhat.com/browse/OCPBUGS-5149

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2023-01-09T14:20:49Z

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

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

openshift-ci-robot · 2023-01-10T14:51:51Z

@rohennes: This pull request references Jira Issue OCPBUGS-5149, which is invalid:

expected the bug to target only the "4.13.0" version, but multiple target versions were set
expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is MODIFIED instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Version(s):

Issue:

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

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 · 2023-01-10T14:51:59Z

@rohennes: This pull request references Jira Issue OCPBUGS-5149, which is invalid:

expected the bug to target only the "4.13.0" version, but multiple target versions were set
expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is MODIFIED instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

OCPBUGS#5149: Adding missing CurrentState API route for PTP API

Version(s):
4.11+

Issue:
https://issues.redhat.com/browse/OCPBUGS-5149

Link to docs preview:

https://54355--docspreview.netlify.app/openshift-enterprise/latest/networking/using-ptp.html#cnf-fast-event-notifications-api-refererence_using-ptp

https://54355--docspreview.netlify.app/openshift-enterprise/latest/networking/using-ptp.html#apicloudnotificationsv1resource_addresscurrentstate

QE review:

QE has approved this change.

Additional information:

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.

rohennes · 2023-01-10T14:52:09Z

/label telco

openshift-ci-robot · 2023-01-10T14:52:35Z

@rohennes: This pull request references Jira Issue OCPBUGS-5149, which is invalid:

expected the bug to target only the "4.13.0" version, but multiple target versions were set
expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is MODIFIED instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

OCPBUGS-5149: Adding missing CurrentState API route for PTP API

Version(s):
4.11+

Issue:
https://issues.redhat.com/browse/OCPBUGS-5149

Link to docs preview:

https://54355--docspreview.netlify.app/openshift-enterprise/latest/networking/using-ptp.html#cnf-fast-event-notifications-api-refererence_using-ptp

https://54355--docspreview.netlify.app/openshift-enterprise/latest/networking/using-ptp.html#apicloudnotificationsv1resource_addresscurrentstate

QE review:

QE has approved this change.

Additional information:

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.

rohennes · 2023-01-10T14:52:47Z

/jira refresh

openshift-ci-robot · 2023-01-10T14:52:50Z

@rohennes: This pull request references Jira Issue OCPBUGS-5149, which is invalid:

expected the bug to target only the "4.13.0" version, but multiple target versions were set
expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is MODIFIED instead

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

/jira 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 · 2023-01-10T14:53:39Z

@rohennes: No Jira bug is referenced in the title of this pull request.
To reference a bug, add 'OCPBUGS-XXX:' to the title of this pull request and request another bug refresh with /jira refresh.

In response to this:

OCPBUGS-5149: Adding missing CurrentState API route for PTP API

Version(s):
4.11+

Issue:
https://issues.redhat.com/browse/OCPBUGS-5149

Link to docs preview:

https://54355--docspreview.netlify.app/openshift-enterprise/latest/networking/using-ptp.html#cnf-fast-event-notifications-api-refererence_using-ptp

https://54355--docspreview.netlify.app/openshift-enterprise/latest/networking/using-ptp.html#apicloudnotificationsv1resource_addresscurrentstate

QE review:

QE has approved this change.

Additional information:

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.

rohennes · 2023-01-10T14:53:44Z

/jira refresh

openshift-ci-robot · 2023-01-10T14:53:47Z

@rohennes: No Jira bug is referenced in the title of this pull request.
To reference a bug, add 'OCPBUGS-XXX:' to the title of this pull request and request another bug refresh with /jira refresh.

In response to this:

/jira 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.

aneeshkp · 2023-01-10T16:49:56Z

modules/cnf-fast-event-notifications-api-refererence.adoc

@@ -29,6 +29,9 @@ Use the following API endpoints to subscribe the `cloud-event-consumer` DU appli
 * `api/cloudNotifications/v1/publishers`
 - `GET`: Returns an array of `os-clock-sync-state`, `ptp-clock-class-change`, and `lock-state` messages for the cluster node

+* `/api/cloudnotifications/v1/<resource_address>/CurrentState`
+-  `GET`: Returns the current state of `os-clock-sync-state`, `ptp-clock-class-change`, and `lock-state` for the cluster node


Supports three events
GET api/cloudNotifications/v1/<resource_address>/sync/ptp-status/lock-state/CurrentState
GET api/cloudNotifications/v1/<resource_address>/sync/sync-status/os-clock-sync-state/CurrentState
GET api/cloudNotifications/v1/<resource_address>/sync/ptp-status/ptp-clock-class-change/CurrentState

aneeshkp · 2023-01-10T16:54:57Z

modules/cnf-fast-event-notifications-api-refererence.adoc

+----
+{
+  "specversion": "0.3",
+  "id": "4f51fe99-feaa-4e66-9112-66c5c9b9afcb",


Here is the example for lock-state
{"id": "c1ac3aa5-1195-4786-84f8-da0ea4462921",
"type": "event.sync.ptp-status.ptp-state-change",
"source": "/cluster/node/compute-1.example.com/sync/ptp-status/lock-state",
"dataContentType": "application/json",
"time": "2023-01-10T02:41:57.094981478Z",
"data": {
"version": "v1",
"values": [
{ "resource": "/cluster/node/compute-1.example.com/ens5fx/master",
"dataType": "notification",
"valueType": "enumeration",
"value": "LOCKED"
},
{"resource": "/cluster/node/compute-1.example.com/ens5fx/master",
"dataType": "metric",
"valueType": "decimal64.3",
"value": "29"
}
]
}
}

and for clock class
{"id": "064c9e67-5ad4-4afb-98ff-189c6aa9c205",
"type": "event.sync.ptp-status.ptp-clock-class-change",
"source": "/cluster/node/compute-1.example.com/sync/ptp-status/ptp-clock-class-change",
"dataContentType": "application/json",
"time": "2023-01-10T02:41:56.785673989Z",
"data": {"version": "v1",
"values": [{"resource": "/cluster/node/compute-1.example.com/ens5fx/master",
"dataType": "metric",
"valueType": "decimal64.3",
"value": "165"
}]
}
}

rohennes · 2023-01-11T13:39:05Z

modules/cnf-fast-event-notifications-api-refererence.adoc

+`GET api/cloudNotifications/v1/cluster/node/<node_name>/sync/sync-status/os-clock-sync-state/CurrentState`
+
+`GET api/cloudNotifications/v1/cluster/node/<node_name>/sync/ptp-status/ptp-clock-class-change/CurrentState`
+


@aneeshkp - I added the Get request for each supported event here. Hope that this is understandable for the user?

we are missing consumer api docs . That is why we are leaving out the full url. I think its okay for now

It says <resource_address> in the section heading now. But in the GET request examples, I have expanded the route to show the format cluster/node/<node_name>. Let me know if I should change this to resource address too

openshift-ci · 2023-01-16T11:17:52Z

@obochan-rh: changing LGTM is restricted to collaborators

In response to this:

/LGTM

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.

rohennes · 2023-01-16T11:32:30Z

/label peer-review-needed

sheriff-rh · 2023-01-16T19:32:21Z

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

sheriff-rh

This makes sense to me, no suggestions from peer review.

sheriff-rh · 2023-01-16T19:36:11Z

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

rohennes · 2023-01-18T09:34:44Z

/label merge-review-needed

skrthomas

merge review lgtm.

skrthomas · 2023-01-18T17:17:14Z

/cherrypick enterprise-4.11

skrthomas · 2023-01-18T17:17:20Z

/cherrypick enterprise-4.12

skrthomas · 2023-01-18T17:17:51Z

/cherrypick enterprise-4.13

openshift-cherrypick-robot · 2023-01-18T17:18:02Z

@skrthomas: new pull request created: #54873

In response to this:

/cherrypick enterprise-4.11

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-cherrypick-robot · 2023-01-18T17:18:05Z

@skrthomas: new pull request created: #54874

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.

openshift-cherrypick-robot · 2023-01-18T17:18:37Z

@skrthomas: new pull request created: #54875

In response to this:

/cherrypick enterprise-4.13

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.

rohennes changed the title ~~Adding missing CurrentState API route info~~ Adding missing CurrentState API route info - WIP Jan 9, 2023

openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 9, 2023

rohennes force-pushed the OCPBUGS-5149-PTP-current-state-API branch from b81241d to 0c12365 Compare January 10, 2023 14:24

openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 10, 2023

rohennes force-pushed the OCPBUGS-5149-PTP-current-state-API branch 2 times, most recently from b4b2d29 to a80296e Compare January 10, 2023 14:49

rohennes changed the title ~~Adding missing CurrentState API route info - WIP~~ OCPBUGS-5149: Adding missing CurrentState API route info - WIP Jan 10, 2023

openshift-ci-robot added the jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. label Jan 10, 2023

openshift-ci bot added the telco Label for all Telco PRs label Jan 10, 2023

rohennes changed the title ~~OCPBUGS-5149: Adding missing CurrentState API route info - WIP~~ OCPBUGS#5149: Adding missing CurrentState API route info - WIP Jan 10, 2023

openshift-ci-robot removed the jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. label Jan 10, 2023

rohennes force-pushed the OCPBUGS-5149-PTP-current-state-API branch from a80296e to 15fad37 Compare January 10, 2023 15:33

aneeshkp reviewed Jan 10, 2023

View reviewed changes

rohennes force-pushed the OCPBUGS-5149-PTP-current-state-API branch from 15fad37 to 52210fe Compare January 10, 2023 17:49

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 10, 2023

rohennes force-pushed the OCPBUGS-5149-PTP-current-state-API branch from 52210fe to 559a147 Compare January 11, 2023 13:25

rohennes commented Jan 11, 2023

View reviewed changes

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 16, 2023

openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 16, 2023

sheriff-rh approved these changes Jan 16, 2023

View reviewed changes

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 labels Jan 16, 2023

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jan 18, 2023

skrthomas added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jan 18, 2023

skrthomas reviewed Jan 18, 2023

View reviewed changes

skrthomas merged commit bd718c1 into openshift:main Jan 18, 2023

skrthomas added this to the Continuous Release milestone Jan 18, 2023

skrthomas added branch/enterprise-4.11 branch/enterprise-4.12 branch/enterprise-4.13 labels Jan 18, 2023

openshift-cherrypick-robot mentioned this pull request Jan 18, 2023

[enterprise-4.11] OCPBUGS#5149: Adding missing CurrentState API route info - WIP #54873

Merged

openshift-cherrypick-robot mentioned this pull request Jan 18, 2023

[enterprise-4.12] OCPBUGS#5149: Adding missing CurrentState API route info - WIP #54874

Merged

openshift-cherrypick-robot mentioned this pull request Jan 18, 2023

[enterprise-4.13] OCPBUGS#5149: Adding missing CurrentState API route info - WIP #54875

Merged

rohennes changed the title ~~OCPBUGS#5149: Adding missing CurrentState API route info - WIP~~ OCPBUGS#5149: Adding missing CurrentState API route info Jan 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OCPBUGS#5149: Adding missing CurrentState API route info #54355

OCPBUGS#5149: Adding missing CurrentState API route info #54355

rohennes commented Jan 9, 2023 •

edited

ocpdocs-previewbot commented Jan 9, 2023 •

edited

openshift-ci-robot commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

rohennes commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

rohennes commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

rohennes commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

aneeshkp Jan 10, 2023

aneeshkp Jan 10, 2023 •

edited

aneeshkp Jan 10, 2023

rohennes Jan 11, 2023 •

edited

aneeshkp Jan 11, 2023

rohennes Jan 12, 2023

aneeshkp Jan 12, 2023

openshift-ci bot commented Jan 16, 2023

rohennes commented Jan 16, 2023

sheriff-rh commented Jan 16, 2023

sheriff-rh left a comment

sheriff-rh commented Jan 16, 2023

rohennes commented Jan 18, 2023

skrthomas left a comment

skrthomas commented Jan 18, 2023

skrthomas commented Jan 18, 2023

skrthomas commented Jan 18, 2023

openshift-cherrypick-robot commented Jan 18, 2023

openshift-cherrypick-robot commented Jan 18, 2023

openshift-cherrypick-robot commented Jan 18, 2023

		`GET api/cloudNotifications/v1/cluster/node/<node_name>/sync/sync-status/os-clock-sync-state/CurrentState`

		`GET api/cloudNotifications/v1/cluster/node/<node_name>/sync/ptp-status/ptp-clock-class-change/CurrentState`

OCPBUGS#5149: Adding missing CurrentState API route info #54355

OCPBUGS#5149: Adding missing CurrentState API route info #54355

Conversation

rohennes commented Jan 9, 2023 • edited

ocpdocs-previewbot commented Jan 9, 2023 • edited

openshift-ci-robot commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

rohennes commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

rohennes commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

rohennes commented Jan 10, 2023

openshift-ci-robot commented Jan 10, 2023

aneeshkp Jan 10, 2023

Choose a reason for hiding this comment

aneeshkp Jan 10, 2023 • edited

Choose a reason for hiding this comment

aneeshkp Jan 10, 2023

Choose a reason for hiding this comment

rohennes Jan 11, 2023 • edited

Choose a reason for hiding this comment

aneeshkp Jan 11, 2023

Choose a reason for hiding this comment

rohennes Jan 12, 2023

Choose a reason for hiding this comment

aneeshkp Jan 12, 2023

Choose a reason for hiding this comment

openshift-ci bot commented Jan 16, 2023

rohennes commented Jan 16, 2023

sheriff-rh commented Jan 16, 2023

sheriff-rh left a comment

Choose a reason for hiding this comment

sheriff-rh commented Jan 16, 2023

rohennes commented Jan 18, 2023

skrthomas left a comment

Choose a reason for hiding this comment

skrthomas commented Jan 18, 2023

skrthomas commented Jan 18, 2023

skrthomas commented Jan 18, 2023

openshift-cherrypick-robot commented Jan 18, 2023

openshift-cherrypick-robot commented Jan 18, 2023

openshift-cherrypick-robot commented Jan 18, 2023

rohennes commented Jan 9, 2023 •

edited

ocpdocs-previewbot commented Jan 9, 2023 •

edited

aneeshkp Jan 10, 2023 •

edited

rohennes Jan 11, 2023 •

edited