This is an automated email from the ASF dual-hosted git repository.
ricardozanini pushed a commit to branch 1.42.x
in repository https://gitbox.apache.org/repos/asf/incubator-kie-kogito-docs.git
The following commit(s) were added to refs/heads/1.42.x by this push:
new f8e0773ef [1.42.x] KOGITO-9455: Create the getting started guide to
describe how to run … (#474)
f8e0773ef is described below
commit f8e0773eff05ac43123b70cb6a9d0b8a2ad005ea
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Thu Oct 5 08:12:36 2023 -0300
[1.42.x] KOGITO-9455: Create the getting started guide to describe how to
run … (#474)
KOGITO-9455: Create the getting started guide to describe how to run …
(#421)
* KOGITO-9455: Create the getting started guide to describe how to run
workflow projects
Adds new file with guide containing create, run and deploy showcases to
begin development
of SonataFlow project using operator first approach.
* KOGITO-9455: Update the initial chapter texts to make it sound bette
* Fix typos, use empty brackets for referrences
* Reference our guide for operator install
* KOGITO-9455: Improve Testing your application section
Expplains basics fo accesing the project via REST using
CURL.
* KOGITO-9455: Fix typos, invalid page refs and improve text
* Fix typo in
serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
* KOGITO-9455: Add guide to nav.adoc and index.adoc
---------
Co-authored-by: Dominik Hanák <[email protected]>
Co-authored-by: Marián Macik <[email protected]>
---
serverlessworkflow/modules/ROOT/nav.adoc | 3 +-
...st-workflow-service-with-kn-cli-and-vscode.adoc | 120 +++++++++++++++++++++
serverlessworkflow/modules/ROOT/pages/index.adoc | 8 ++
3 files changed, 129 insertions(+), 2 deletions(-)
diff --git a/serverlessworkflow/modules/ROOT/nav.adoc
b/serverlessworkflow/modules/ROOT/nav.adoc
index ebb76485c..36e97c4f2 100644
--- a/serverlessworkflow/modules/ROOT/nav.adoc
+++ b/serverlessworkflow/modules/ROOT/nav.adoc
@@ -1,7 +1,6 @@
* xref:release_notes.adoc[Release notes]
* Getting Started
-// TODO: https://issues.redhat.com/browse/KOGITO-9455
-//** Creating a Workflow Project
+**
xref:getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc[]
** xref:getting-started/create-your-first-workflow-service.adoc[]
// We will refactor this section here:
https://issues.redhat.com/browse/KOGITO-9451
//** xref:getting-started/getting-familiar-with-our-tooling.adoc[Getting
familiar with tooling]
diff --git
a/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
b/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
new file mode 100644
index 000000000..c45f3bf2a
--- /dev/null
+++
b/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc
@@ -0,0 +1,120 @@
+= Creating and running workflow projects using KN CLI and Visual Studio Code
+
+This guide showcases using the Knative Workflow CLI plugin and Visual Studio
code to create & run {product_name} projects.
+
+.Prerequisites
+* xref:testing-and-troubleshooting/kn-plugin-workflow-overview.adoc[Knative
Workflow CLI] {kn_cli_version} is installed.
+* Visual Studio Code with
https://marketplace.visualstudio.com/items?itemName=redhat.vscode-extension-serverless-workflow-editor[Red
Hat Serverless Workflow Editor] is installed to edit your workflows.
+
+.Preparing your environment
+* Install https://docs.docker.com/engine/install/[Docker] or
https://podman.io/docs/installation[Podman].
+* Install https://minikube.sigs.k8s.io/docs/start/[minikube].
+* Install https://kubernetes.io/docs/tasks/tools/[kubectl].
+* Start minikube. Depending on your environment, set `--driver` flag to
`podman` or `docker`
+[source,bash]
+----
+minikube start --cpus 4 --memory 8096 --addons registry --addons
metrics-server --insecure-registry "10.0.0.0/24" --insecure-registry
"localhost:5000" --driver=docker
+----
+* (optional) Install https://k9scli.io/[k9scli.io]
+* xref:cloud/operator/install-serverless-operator.adoc[]
+* Install https://github.com/kiegroup/kie-tools/releases/tag/0.30.3[KN
Workflow CLI] by downloading the correct distribution for your development
environment and adding it to the PATH.
+
+[[proc-creating-app-with-kn-cli]]
+== Creating a workflow project with Visual Studio Code and KN CLI
+
+Use the `create` command with kn workflow to scaffold a new SonataFlow project.
+
+* Navigate to you development directory and create your project.
+[source,bash]
+----
+kn workflow create -n my-sonataflow-project
+----
+* This will create a folder with name `my-sonataflow-project` and a sample
workflow `workflow.sw.json`
+[source,bash]
+----
+cd ./my-sonataflow-project
+----
+* Open the folder in Visual Studo Code and examine the created
`workflow.sw.json` using our extension.
+
+Now you can run the project and execute the workflow.
+
+[[proc-running-app-with-kn-cli]]
+== Running a Workflow project with Visual Studio Code and KN CLI
+
+Use the `run` command with kn workflow to build and run the {product_name}
project in local development mode.
+
+* Run the project.
+[source,bash]
+----
+kn workflow run
+----
+* The Development UI wil be accesible at `localhost:8080/q/dev`
+* You can now work on your project. Any changes will be picked up by the hot
reload feature.
+* See
xref:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc[Workflow
instances] guide on how to run workflows via Development UI.
+* Once you are done developing your project navigate to the terminal that is
running the `kn workflow run` command and hit `Ctlr+C` to stop the development
environment.
+
+To deploy the finished project to a local cluster, proceed to the next section.
+
+[[proc-deploying-app-with-kn-cli]]
+== Deploying a workflow project with Visual Studio Code and KN CLI
+
+Use the `deploy` command with kn workflow to deploy the {product_name} project
into your local cluster.
+
+* Deploy to minikube
+[source,bash]
+----
+kn workflow deploy
+----
+* (Optional) Using k9scli you can examine your deployment.
+* In a different bash instance, create a port mapping:
+[source,bash]
+----
+minikube service hello --namespace default --url
+----
+* Use this URL to access your workflow instances using the Developer UI
+**
<RETURNED_URL>/q/dev/org.kie.kogito.kogito-quarkus-serverless-workflow-devui/workflowInstances
+* To update the image run the `deploy` again, note that this may take some
time.
+
+* To stop the deployment, use the `undeploy` command:
+[source,bash]
+----
+kn worklow undeploy
+----
+* You can validate your pod is terminating using k9s cli.
+
+[[proc-testing-application]]
+== Testing your workflow application
+
+To test your workflow application you can use any capable REST client out
there. All that is needeed is the URL of your deployed worklow project.
+
+.Prerequisites
+* You have your workflow project deployed using
<<proc-deploying-app-with-kn-cli>> and you have the URL where it is deployed
handy.
+
+.Testing your workflow application
+* To test your workflow project, access the Swagger UI on `<URL>/q/swagger-ui`
to examine available endpoints.
+* In order to execute the workflow once, run:
+[source,bash]
+----
+curl -X 'POST' \
+ '<URL>/hello' \
+ -H 'accept: */*' \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "workflowdata": {}
+}'
+----
+* To examine executed instance you can use the GraphQL UI by navigating to
+`<URL>/q/graphl-ui`.
+
+
+== Additional resources
+
+*
xref:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc[]
+* xref:getting-started/getting-familiar-with-our-tooling.adoc[]
+* xref:service-orchestration/orchestration-of-openapi-based-services.adoc[]
+
+include::../../pages/_common-content/report-issue.adoc[]
+
+ifeval::["{kogito_version_redhat}" != ""]
+include::../../pages/_common-content/downstream-project-setup-instructions.adoc[]
+endif::[]
\ No newline at end of file
diff --git a/serverlessworkflow/modules/ROOT/pages/index.adoc
b/serverlessworkflow/modules/ROOT/pages/index.adoc
index ee7e28d6e..0b3470c0d 100644
--- a/serverlessworkflow/modules/ROOT/pages/index.adoc
+++ b/serverlessworkflow/modules/ROOT/pages/index.adoc
@@ -19,6 +19,14 @@
xref:getting-started/create-your-first-workflow-service.adoc[]
Learn how to create your first Quarkus Workflow Project
--
+[.card]
+--
+[.card-title]
+xref:getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc[]
+[.card-description]
+Learn how to create & run your first {Kogito Serverless Workflow} project.
+--
+
// We will refactor this section here:
https://issues.redhat.com/browse/KOGITO-9451
//[.card]
//--
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
