openshift-docs
openshift-docs copied to clipboard
openshift
WIP PR for SRVLOGIC-300, SRVLOGIC-190, SRVLOGIC-188, SRVLOGIC-192: Document "Serverless Logic" parent directory for Openshift Serverless Logic docs.
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
Notes for the reviewers:
- {ServerlessLogicOperatorName} will reflect because I have added this attribute in the (https://github.com/openshift/openshift-docs/pull/76488). Once we merge that PR this attribute will reflect correctly.
- I am currently creating the new guides and new content for OpenShift Serverless Logic.
- This is a new component of Serverless, and the new content needs to be included for the specific release happening on July 8th. Due to the nature of the update, I cannot add the content in pieces. Instead, I need to include all sections under the "Serverless Logic" parent directory in one go.
- I have commented out the following sections in the PR, as we have discussed with the Dev team to add this post-release (No need to review). include::modules/serverless-logic-asyncAPI-consuming-event.adoc[leveloffset=+1] include::modules/serverless-logic-asyncAPI-publishing-event.adoc[leveloffset=+1] include::modules/serverless-logic-event-correlation.adoc[leveloffset=+1] serverless-logic-openAPI-callback.adoc
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
In response to this:
Tracking JIRA: https://issues.redhat.com/browse/SRVLOGIC-300
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 openshift-eng/jira-lifecycle-plugin repository.
🤖 Mon Jul 15 14:12:56 - Prow CI generated the docs preview: https://76490--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt
@kaldesai: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.
In response to this:
Tracking JIRA: https://issues.redhat.com/browse/SRVLOGIC-300
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-190 which is a valid jira issue.
In response to this:
Tracking JIRA:
- https://issues.redhat.com/browse/SRVLOGIC-300
- https://issues.redhat.com/browse/SRVLOGIC-190
- https://issues.redhat.com/browse/SRVLOGIC-188
Doc previews:
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-190 which is a valid jira issue.
In response to this:
Tracking JIRA:
- https://issues.redhat.com/browse/SRVLOGIC-300
- https://issues.redhat.com/browse/SRVLOGIC-190
- https://issues.redhat.com/browse/SRVLOGIC-188
Doc previews:
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Deploying workflows
Managing services
- Configuring OpenAPI services
- Configuring OpenAPI services endpoints
- Understanding OpenAPI callback and callback state
- Troubleshooting services
Managing events
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
- Configuring OpenAPI services
- Configuring OpenAPI services endpoints
- Understanding OpenAPI callback and callback state
- Troubleshooting services
Managing events
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai Thanks for the hard work I see you kind of merge the information of these two guides: https://sonataflow.org/serverlessworkflow/latest/eventing/orchestration-of-asyncapi-based-services.html and https://sonataflow.org/serverlessworkflow/latest/eventing/event-correlation-with-workflows.html into one, but you skip https://sonataflow.org/serverlessworkflow/latest/core/handling-events-on-workflows.html, https://sonataflow.org/serverlessworkflow/latest/eventing/consume-produce-events-with-knative-eventing.html and https://sonataflow.org/serverlessworkflow/latest/eventing/consume-producing-events-with-kafka.html Im sorry to say the result lacks consistency. Please take a look to the skipped guides and lets see how can we create a doc that makes sense.
@kaldesai: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
- Configuring OpenAPI services
- Configuring OpenAPI services endpoints
- Understanding OpenAPI callback and callback state
- Troubleshooting services
Managing events
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-191 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
- Configuring OpenAPI services
- Configuring OpenAPI services endpoints
- Understanding OpenAPI callback and callback state
- Troubleshooting services
Managing events
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai Following up my comment https://github.com/openshift/openshift-docs/pull/76490#issuecomment-2200276727, I think you should rewrite the whole event part, just merging these two docs https://sonataflow.org/serverlessworkflow/latest/core/handling-events-on-workflows.html as main driver, where events in Sonataflow are explained And then include how to configure them in Knative using this other guide https://sonataflow.org/serverlessworkflow/main/cloud/operator/configuring-knative-eventing-resources.html That will be enough, you might optionally include the asyncapi content (skipping the smallrye part), but the correlation one is considered advanced and it is better to skip it (also because will be heavily changed in upcoming versions of the spec)
@kaldesai Following up my comment #76490 (comment), I think you should rewrite the whole event part, just merging these two docs https://sonataflow.org/serverlessworkflow/latest/core/handling-events-on-workflows.html as main driver, where events in Sonataflow are explained And then include how to configure them in Knative using this other guide https://sonataflow.org/serverlessworkflow/main/cloud/operator/configuring-knative-eventing-resources.html That will be enough, you might optionally include the asyncapi content (skipping the smallrye part), but the correlation one is considered advanced and it is better to skip it (also because will be heavily changed in upcoming versions of the spec)
@fjtirado, I have already included the information about the events in the "OSL overview assembly.
Regarding OpenAPI and AsyncAPI, while planning the OSL content structure, I discussed this with the @ricardozanini @wmedvede @domhanak whether to include this in the doc or not and I received an ack and agreed to include it in the release. These two JIRAs are created https://issues.redhat.com/browse/SRVLOGIC-191 and https://issues.redhat.com/browse/SRVLOGIC-192 are targetted for 1.33 release and received an ack about the content.
@kaldesai Thanks for the hard work I see you kind of merge the information of these two guides: https://sonataflow.org/serverlessworkflow/latest/eventing/orchestration-of-asyncapi-based-services.html and https://sonataflow.org/serverlessworkflow/latest/eventing/event-correlation-with-workflows.html into one, but you skip https://sonataflow.org/serverlessworkflow/latest/core/handling-events-on-workflows.html, https://sonataflow.org/serverlessworkflow/latest/eventing/consume-produce-events-with-knative-eventing.html and https://sonataflow.org/serverlessworkflow/latest/eventing/consume-producing-events-with-kafka.html Im sorry to say the result lacks consistency. Please take a look to the skipped guides and lets see how can we create a doc that makes sense.
@fjtirado, After discussing with @ricardozanini @wmedvede @domhanak we are not going to include any quarkus related information in the OSL docs. (Not now but we may include it in the upcoming releases)
@kaldesai Thanks for the hard work I see you kind of merge the information of these two guides: https://sonataflow.org/serverlessworkflow/latest/eventing/orchestration-of-asyncapi-based-services.html and https://sonataflow.org/serverlessworkflow/latest/eventing/event-correlation-with-workflows.html into one, but you skip https://sonataflow.org/serverlessworkflow/latest/core/handling-events-on-workflows.html, https://sonataflow.org/serverlessworkflow/latest/eventing/consume-produce-events-with-knative-eventing.html and https://sonataflow.org/serverlessworkflow/latest/eventing/consume-producing-events-with-kafka.html Im sorry to say the result lacks consistency. Please take a look to the skipped guides and lets see how can we create a doc that makes sense.
@fjtirado, After discussing with @ricardozanini @wmedvede @domhanak we are not going to include any quarkus related information in the OSL docs. (Not now but we may include it in the upcoming releases)
This comment was superseeded by my latter comment. The document as it is written currently does not make any sense to me. If the implementor of the code (me) does not understand the documentation that was written, it is hard to expect that a new guy reading the doc will understand it. What we need to explain in the event section is how to use events and how to configure them in knative. Not talk about async api (wich mentionn smallrye channels that are quarkus related) and correlation (which mentions signalling by process instance id, which is not explained anywhere in the doc).
Maybe Im missing other existing docs, but in any case, at a minumun, async api and correlation should be in two separate entries, since they are not related; reference to smallrye should be removed from asyncapi doc (it is unclear to me how automatically generated configuration from asyncapi, which assumes the existance of a kafka broker can coexist with knative triggers) and correlation doc should refer to the document where event handling (signalling by process instance id) is explained.
I forgot to mention that asyncAPI I wont document at all, becuase it only works with knative if the protocol declared in the async api file is http. Or, at least, we need to mention that constraint.
@fjtirado, @ricardozanini, @wmedvede, @domhanak, we need to get consensus on what needs to be included in: https://76490--ocpdocs-pr.netlify.app/openshift-serverless/latest/serverless-logic/serverless-logic-managing-events/serverless-logic-configuring-asyncapi-services In order for us to unblock this PR from moving forward with peer reviews I am asking Kalyani to comment out this section and create a new Jira and a follow up to handle the SL manage events section. She will be setting up a call with you all today evening to find a way forward. Please note, tomorrow is a holiday in the US and Friday most folks would take off, leaving us a very short time for reviews for this huge PR.
@Preeticp I think we need to get consensus on what is included in https://76490--ocpdocs-pr.netlify.app/openshift-serverless/latest/serverless-logic/serverless-logic-managing-events/ In my opinion, this section should include just one single doc with a wise merge of these three guides https://sonataflow.org/serverlessworkflow/latest/core/handling-events-on-workflows.html, https://sonataflow.org/serverlessworkflow/latest/core/working-with-callbacks.html and https://sonataflow.org/serverlessworkflow/main/cloud/operator/configuring-knative-eventing-resources.html. AsyncAPI and correlation can be skipped, as we are skipping detailed explanation of jq and grpc.
Once you have done that, you can remove, https://76490--ocpdocs-pr.netlify.app/openshift-serverless/latest/serverless-logic/serverless-logic-managing-services/serverless-logic-openapi-callback. Callback and events are two heavily coupled features, it does not really make sense include callback together with OpenAPI. Appart from removing the callback part, https://76490--ocpdocs-pr.netlify.app/openshift-serverless/latest/serverless-logic/serverless-logic-managing-services is fine in my opinion
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-191 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-191 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
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 openshift-eng/jira-lifecycle-plugin repository.
@fjtirado @wmedvede @ricardozanini I have incorporated your suggestions in the PR.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
Note: {ServerlessLogicOperatorName} will reflect because I have added this attribute in the [#PR76488] (https://github.com/openshift/openshift-docs/pull/76488). Once we merge that PR this attribute will reflect correctly.
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
Note: {ServerlessLogicOperatorName} will reflect because I have added this attribute in the (https://github.com/openshift/openshift-docs/pull/76488). Once we merge that PR this attribute will reflect correctly.
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
Notes for the reviewers:
- {ServerlessLogicOperatorName} will reflect because I have added this attribute in the (https://github.com/openshift/openshift-docs/pull/76488). Once we merge that PR this attribute will reflect correctly.
- I am currently creating the new guides and new content for OpenShift Serverless Logic.
- This is a new component of Serverless, and the new content needs to be included for the specific release happening on July 8th. Due to the nature of the update, I cannot add the content in pieces. Instead, I need to include all sections under the "Serverless Logic" parent directory in one go.
- I have commented out a few sections in the PR, as we have discussed with the Dev team to add this post-release.
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 openshift-eng/jira-lifecycle-plugin repository.
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Tracking JIRA:
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
Notes for the reviewers:
- {ServerlessLogicOperatorName} will reflect because I have added this attribute in the (https://github.com/openshift/openshift-docs/pull/76488). Once we merge that PR this attribute will reflect correctly.
- I am currently creating the new guides and new content for OpenShift Serverless Logic.
- This is a new component of Serverless, and the new content needs to be included for the specific release happening on July 8th. Due to the nature of the update, I cannot add the content in pieces. Instead, I need to include all sections under the "Serverless Logic" parent directory in one go.
- I have commented out the following sections in the PR, as we have discussed with the Dev team to add this post-release (No need to review). include::modules/serverless-logic-asyncAPI-consuming-event.adoc[leveloffset=+1] include::modules/serverless-logic-asyncAPI-publishing-event.adoc[leveloffset=+1] include::modules/serverless-logic-event-correlation.adoc[leveloffset=+1] serverless-logic-openAPI-callback.adoc
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 openshift-eng/jira-lifecycle-plugin repository.
@dfitzmau, could you please check my review.
Nice work, @max-cx . Comments are very good.
@Srivaralakshmi, @mramendi @dfitzmau @max-cx Thank you so much for the extensive reviews. I have incorporated all of your suggestions and your support is highly appreciated. <3
@kaldesai: This pull request references SRVLOGIC-300 which is a valid jira issue.
This pull request references SRVLOGIC-190 which is a valid jira issue.
This pull request references SRVLOGIC-188 which is a valid jira issue.
This pull request references SRVLOGIC-192 which is a valid jira issue.
In response to this:
Affecting version:
serverless-docs-1.33Tracking JIRA: SRVLOGIC-300, SRVLOGIC-190, SRVLOGIC-188, SRVLOGIC-192
Doc previews:
Creating and managing workflows
Deploying workflows
Managing services
Notes for the reviewers:
- {ServerlessLogicOperatorName} will reflect because I have added this attribute in the (https://github.com/openshift/openshift-docs/pull/76488). Once we merge that PR this attribute will reflect correctly.
- I am currently creating the new guides and new content for OpenShift Serverless Logic.
- This is a new component of Serverless, and the new content needs to be included for the specific release happening on July 8th. Due to the nature of the update, I cannot add the content in pieces. Instead, I need to include all sections under the "Serverless Logic" parent directory in one go.
- I have commented out the following sections in the PR, as we have discussed with the Dev team to add this post-release (No need to review). include::modules/serverless-logic-asyncAPI-consuming-event.adoc[leveloffset=+1] include::modules/serverless-logic-asyncAPI-publishing-event.adoc[leveloffset=+1] include::modules/serverless-logic-event-correlation.adoc[leveloffset=+1] serverless-logic-openAPI-callback.adoc
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 openshift-eng/jira-lifecycle-plugin repository.
The Configuring OpenAI services and Creating and managing workflows books LGTM.