From d07d1f9327149de5811cb7e04f1b5de5ca75b10f Mon Sep 17 00:00:00 2001 From: Dominik Hanak Date: Tue, 12 Mar 2024 17:15:51 +0100 Subject: [PATCH] 574 - improve memory for minikube, add prereq to learning --- ...our-first-workflow-service-with-kn-cli-and-vscode.adoc | 8 ++++---- .../ROOT/pages/getting-started/learning-environment.adoc | 4 ++++ .../ROOT/pages/getting-started/preparing-environment.adoc | 5 ++++- 3 files changed, 12 insertions(+), 5 deletions(-) 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 index 711c4f4e6..51f8e0a44 100644 --- 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 @@ -50,22 +50,22 @@ Use the `deploy` command with kn workflow to deploy the {product_name} project i * Deploy to cluster [source,bash] ---- -kn workflow deploy --namespace my-sonataflow-application +kn workflow deploy --namespace my-sf-application ---- * Using k9s cli you can examine your deployment. * In a different bash instance, create a port mapping: [source,bash] ---- -minikube service hello --namespace my-sonataflow-application --url +minikube service hello --namespace my-sf-application --url ---- * Use this URL to access your workflow instances using the Developer UI -** {sonataflow_devmode_devui_url}{workflow_instances} +** {sonataflow_devmode_devui_url}/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 --namespace my-sonataflow-application +kn worklow undeploy --namespace my-sf-application ---- * You can validate your pod is terminating using k9s cli. diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc index 01b68d7c9..f4e193d06 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc @@ -1,5 +1,9 @@ = Learning environment +.Prerequisites +* Basic knowledge of cloud environments, containers, docker and Kubernetes +* You are familiar with https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md[CNCF Serverless Workflow Specification 0.8] + If you are new to {product_name} we recommend a few starting points to get up to speed with the technology and what it has to offer. * Read the link:xref:core/cncf-serverless-workflow-specification-support.adoc[serverless workflow specification and what is supported]. diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc index 7850df966..882aebc1e 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc @@ -25,7 +25,7 @@ If you have used https://knative.dev/docs/install/quickstart-install/[Knative us Please note, that if the knative quickstart procedure is not used, you need to install Knative Serving and Eventing manually. See <>. -+ + .To startup the selected cluster without quickstart, use the following command: [tabs] ==== @@ -40,6 +40,7 @@ minikube config set driver docker/podman minikube config set container-runtime docker/podman # Set cpu and memory +# 4096 is minimal baseline, increase to 6144 or 8192 if possible minikube config set cpus 4 minikube config set memory 4096 @@ -75,6 +76,8 @@ If you are interested in our Java and Quarkus development path, consider complet [[proc-additional-options-for-local-environment]] == Additional options for local environment setup +Points listed in this section provide extra posibilties when working with our guides and are considered optional. + * Install https://www.graalvm.org/[GraalVM] {graalvm_min_version}. This will allow you to create https://www.graalvm.org/22.0/reference-manual/native-image/[native image] of your {product_name} application. * Install https://knative.dev/docs/install/yaml-install/serving/install-serving-with-yaml/[Knative Serving using YAML files] for advanced customizations or in cases where the quickstart procedure fails. * Install https://knative.dev/docs/install/yaml-install/eventing/install-eventing-with-yaml/[Knative Eventing using YAML files] for advanced customizations or in cases where the quickstart procedure fails.