[SRVLOGIC-469]: Deploying workflows chapter does not use kn worklow plugin #85916

domhanak · 2024-12-06T13:58:34Z

Now it uses the kn workflow plugin

Version(s):

serverless-docs-1.34
serverless-docs-1.35

Issue:

SRVLOGIC-269

Link to docs preview:

Preview

QE review:

QE has approved this change.

Additional information:

@kaldesai @wmedvede @ricardozanini PTAL

Now it uses the kn workflow plugin

openshift-ci · 2024-12-06T14:00:43Z

Hi @domhanak. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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-sigs/prow repository.

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

modules/serverless-logic-deploying-workflows-dev-mode.adoc

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

domhanak · 2024-12-11T14:16:41Z

Need to also fix the devmode and the other referenced guide. Ty for review, so far will ping you when I push the changes

kaldesai · 2025-01-09T06:05:53Z

/ok-to-test

ocpdocs-previewbot · 2025-01-09T06:22:34Z

🤖 Thu Jan 16 15:24:14 - Prow CI generated the docs preview:

https://85916--ocpdocs-pr.netlify.app/openshift-serverless/latest/serverless-logic/serverless-logic-getting-started/serverless-logic-deploying-workflows.html

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

…ode.adoc

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

…ode.adoc

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

modules/serverless-logic-deploying-workflows-dev-mode.adoc

kaldesai

A minor suggestions. Otherwise, LGTM!

kaldesai · 2025-01-15T06:05:30Z

@domhanak Once you have drafted the content, you can assign this PR for the peer review process by adding a /label peer-review-needed label to it.

Note: Make sure you have squashed down the commit to only 1.

The OpenShift peer review squad will then peer review this PR, and you can proceed with the merge review process.

Review from Kalyani Co-authored-by: Kalyani Desai <[email protected]>

Reorder docs to make more sense and follow the precedures from basic (what user should do 1st, to more complex ones )

Removes the example workflow from the module and replaces it with prerequsites that user should have the WF deployed. Adds steps to query all services.

kaldesai · 2025-01-16T10:32:20Z

@domhanak You want me to put this on the peer review as well?

Unify namespace usage. Use shorthand -n where possible. Add Testing section to deploying-workflows-dev-mode

domhanak · 2025-01-16T14:34:39Z

@kaldesai not yet I still feel like some parts can be enhanced. I ll ping you :)

openshift-ci · 2025-01-16T15:26:03Z

@domhanak: all tests passed!

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

kaldesai · 2025-01-20T06:27:50Z

@domhanak Do you want me to put this on the peer review as well?

domhanak · 2025-01-21T16:26:53Z

@kaldesai if you think it is ok please do

kaldesai · 2025-01-22T11:23:22Z

/label peer-review-needed

adellape · 2025-01-22T21:24:35Z

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

 ----
 +
-.Example command for the `greetings-workflow.yaml` file:
+.Example command for a workflow that has ID attribute with value `greeting`:


No colons for titles:

Suggested change

.Example command for a workflow that has ID attribute with value `greeting`:

.Example command for a workflow that has an ID attribute with value `greeting`

adellape · 2025-01-22T21:30:27Z

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

+$ oc logs pod/<pod-name> -n <namespace>
+----
+
+.Cleanup


Technically .Cleanup is a non-standard heading for a procedure module (per modular docs guide). FWIW, I see only 1 other instance in the repo (though, that one has it as .Clean up two-words; the single-word here is correctly what IBM Style Guide suggests).

Could this instead just be the last step in the normal .Procedure? Or maybe the last step in .Verification? Alternatively, could be split out into its own procedure module "Cleaning up a workflow deployment" but that seems like overkill.

adellape · 2025-01-22T21:31:56Z

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc

+----
+
+.Cleanup
+. To cleanup the deployment, delete the projects resources running the following command:


Either way though, if this stays as a single-step procedure, use an unordered list (per guidelines) and use "by running":

Suggested change

. To cleanup the deployment, delete the projects resources running the following command:

* To cleanup the deployment, delete the projects resources by running the following command:

adellape · 2025-01-22T21:32:53Z

modules/serverless-logic-deploying-workflows-dev-mode.adoc

-. To deploy the application, apply the YAML file by entering the following command:
+. In your terminal, navigate to the root directory of your {ServerlessLogicProductName} project.
+
+. Deploy the application, by running the following command:


Suggested change

. Deploy the application, by running the following command:

. Deploy the application by running the following command:

adellape · 2025-01-22T21:34:03Z

modules/serverless-logic-deploying-workflows-dev-mode.adoc

 ----

+.Testing


Same thought re: non-standard heading for this .Testing one. This one, however, feels like splitting it out as its own procedure would be worthwhile (versus including it within some other procedure module).

Edit: I see now there already is a "Testing a deployment" procedure later in the assembly. Is that basically the same procedure that's being shown here? If so, could there just be an "Additional resources" link to that procedure from this one instead of duplicating?

adellape · 2025-01-22T21:37:08Z

modules/serverless-logic-deploying-workflows-dev-mode.adoc

+
+Note the value of `HOST/PORT` from the result of tis command, referenced as `<WORKFLOW_URL>` in next step.
+
+.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available. 


Re: previous comment, match lowercase here as well, if you change the other:

Suggested change

.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available.

.. Navigate to the `<workflow_url>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available.

adellape · 2025-01-22T21:37:48Z

modules/serverless-logic-deploying-workflows-dev-mode.adoc

+
+Note the value of `HOST/PORT` from the result of tis command, referenced as `<WORKFLOW_URL>` in next step.
+
+.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available. 


Don't need "please", or maybe even "note".

"might" instead of "may" (better for translation).

Suggested change

.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available.

.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. It might take some time until the management console is available.

adellape · 2025-01-22T21:40:18Z

modules/serverless-logic-deploying-workflows-dev-mode.adoc

+
+.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available. 
+
+
 .Next steps


This single-step .Next steps procedure could probably just be absorbed into wherever the .Testing procedure above it ends up.

adellape · 2025-01-22T21:43:36Z

modules/serverless-logic-verifying-workflow-deployment-preview-mode.adoc

@@ -13,62 +13,22 @@ You can verify that your {ServerlessLogicProductName} workflow is running by per
 * You have an {ServerlessLogicOperatorName} installed on your cluster.
 * You have access to an {ServerlessLogicProductName} project with the appropriate roles and permissions to create applications and other workloads in {ocp-product-title}.
 * You have installed the OpenShift CLI `(oc)`.
+* You have deployed your workflow in preview mode in the {ocp-product-title}.


Drop "the":

Suggested change

* You have deployed your workflow in preview mode in the {ocp-product-title}.

* You have deployed your workflow in preview mode in {ocp-product-title}.

adellape · 2025-01-22T21:44:37Z

modules/serverless-logic-verifying-workflow-deployment-preview-mode.adoc


 .Procedure

-. Create a workflow `YAML` file similar to the following:
+. Retrieve the list of service and identify the one matching `name` of your workflow:


Should this be plural?

Suggested change

. Retrieve the list of service and identify the one matching `name` of your workflow:

. Retrieve the list of services and identify the one matching the `name` of your workflow:

domhanak · 2025-02-12T13:39:00Z

@adellape You made me think hard about the guide and how it looks as whole. I am trying to improve it

openshift-bot · 2025-05-14T01:01:13Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 6, 2024

SRVLOGIC-469: Deploying workflows chapter does not use kn worklow plugin

0537eaa

Now it uses the kn workflow plugin

domhanak force-pushed the SRVLOGIC-469 branch from 50a1b1d to 0537eaa Compare December 6, 2024 14:00

openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 6, 2024

ricardozanini approved these changes Dec 6, 2024

View reviewed changes

gmunozfe reviewed Dec 9, 2024

View reviewed changes

Fix incorrect flag used mode -> preview

bf355e5

openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 9, 2025

domhanak commented Jan 14, 2025

View reviewed changes

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc Outdated Show resolved Hide resolved

Update modules/serverless-logic-building-deploying-workflow-preview-m…

c35c75b

…ode.adoc

domhanak commented Jan 14, 2025

View reviewed changes

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc Outdated Show resolved Hide resolved

Update modules/serverless-logic-building-deploying-workflow-preview-m…

dd7ad30

…ode.adoc

kaldesai reviewed Jan 15, 2025

View reviewed changes

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc Outdated Show resolved Hide resolved

kaldesai reviewed Jan 15, 2025

View reviewed changes

modules/serverless-logic-building-deploying-workflow-preview-mode.adoc Outdated Show resolved Hide resolved

kaldesai reviewed Jan 15, 2025

View reviewed changes

modules/serverless-logic-deploying-workflows-dev-mode.adoc Outdated Show resolved Hide resolved

kaldesai approved these changes Jan 15, 2025

View reviewed changes

domhanak and others added 6 commits January 15, 2025 08:24

Apply suggestions from code review

f3fe3b7

Review from Kalyani Co-authored-by: Kalyani Desai <[email protected]>

SRVLOGC-469: Reorganize Deploying Workflow doc

e85b0b2

Reorder docs to make more sense and follow the precedures from basic (what user should do 1st, to more complex ones )

SRVLOGIC-469: Improve verifying-workflow-deployment-preview-mode

e62ba73

Removes the example workflow from the module and replaces it with prerequsites that user should have the WF deployed. Adds steps to query all services.

SRVLOGIC-469: Fix typos and rebase

1230083

SRVLOGIC-469: Fix typos introducing formating issues

de488c5

SRVLOGIC-469: Fix additonal typos, use <namespace> instead of workflows

edddd29

SRVLOGIC-469: Improve deploying dev and preview mode docs

9670f45

Unify namespace usage. Use shorthand -n where possible. Add Testing section to deploying-workflows-dev-mode

SRVLOGIC-469: Improve deploying-workflows-dev-mode Testing section

b0c912c

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

adellape self-assigned this Jan 22, 2025

adellape added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jan 22, 2025

adellape reviewed Jan 22, 2025

View reviewed changes

adellape 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 Jan 22, 2025

adellape added this to the Continuous Release milestone Jan 22, 2025

adellape added the serverless Label for all Serverless PRs label Jan 22, 2025

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SRVLOGIC-469]: Deploying workflows chapter does not use kn worklow plugin #85916

[SRVLOGIC-469]: Deploying workflows chapter does not use kn worklow plugin #85916

domhanak commented Dec 6, 2024 •

edited

Loading

openshift-ci bot commented Dec 6, 2024

domhanak commented Dec 11, 2024

kaldesai commented Jan 9, 2025

ocpdocs-previewbot commented Jan 9, 2025 •

edited

Loading

kaldesai left a comment

kaldesai commented Jan 15, 2025 •

edited

Loading

kaldesai commented Jan 16, 2025

domhanak commented Jan 16, 2025

openshift-ci bot commented Jan 16, 2025

kaldesai commented Jan 20, 2025

domhanak commented Jan 21, 2025

kaldesai commented Jan 22, 2025

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025

adellape Jan 22, 2025

adellape Jan 22, 2025

adellape Jan 22, 2025

adellape Jan 22, 2025

domhanak commented Feb 12, 2025 •

edited

Loading

openshift-bot commented May 14, 2025

	.Example command for a workflow that has ID attribute with value `greeting`:
	.Example command for a workflow that has an ID attribute with value `greeting`

	. To cleanup the deployment, delete the projects resources running the following command:
	* To cleanup the deployment, delete the projects resources by running the following command:

	. Deploy the application, by running the following command:
	. Deploy the application by running the following command:

	.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available.
	.. Navigate to the `<workflow_url>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available.


		.. Navigate to the `<WORKFLOW_URL>/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows` in your browser. Please note that it may take some time until the management console is available.


		.Next steps

	* You have deployed your workflow in preview mode in the {ocp-product-title}.
	* You have deployed your workflow in preview mode in {ocp-product-title}.

	. Retrieve the list of service and identify the one matching `name` of your workflow:
	. Retrieve the list of services and identify the one matching the `name` of your workflow:

		----

		.Testing

[SRVLOGIC-469]: Deploying workflows chapter does not use kn worklow plugin #85916

Are you sure you want to change the base?

[SRVLOGIC-469]: Deploying workflows chapter does not use kn worklow plugin #85916

Conversation

domhanak commented Dec 6, 2024 • edited Loading

openshift-ci bot commented Dec 6, 2024

domhanak commented Dec 11, 2024

kaldesai commented Jan 9, 2025

ocpdocs-previewbot commented Jan 9, 2025 • edited Loading

kaldesai left a comment

Choose a reason for hiding this comment

kaldesai commented Jan 15, 2025 • edited Loading

kaldesai commented Jan 16, 2025

domhanak commented Jan 16, 2025

openshift-ci bot commented Jan 16, 2025

kaldesai commented Jan 20, 2025

domhanak commented Jan 21, 2025

kaldesai commented Jan 22, 2025

adellape Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

adellape Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

adellape Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

adellape Jan 22, 2025

Choose a reason for hiding this comment

adellape Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

adellape Jan 22, 2025

Choose a reason for hiding this comment

adellape Jan 22, 2025

Choose a reason for hiding this comment

adellape Jan 22, 2025

Choose a reason for hiding this comment

adellape Jan 22, 2025

Choose a reason for hiding this comment

adellape Jan 22, 2025

Choose a reason for hiding this comment

domhanak commented Feb 12, 2025 • edited Loading

openshift-bot commented May 14, 2025

domhanak commented Dec 6, 2024 •

edited

Loading

ocpdocs-previewbot commented Jan 9, 2025 •

edited

Loading

kaldesai commented Jan 15, 2025 •

edited

Loading

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025 •

edited

Loading

adellape Jan 22, 2025 •

edited

Loading

domhanak commented Feb 12, 2025 •

edited

Loading