diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc index 2f685cd3e..a9f1365c5 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc @@ -47,7 +47,7 @@ minikube config set container-runtime docker minikube start --cpus 4 --memory 4096 --addons registry --addons metrics-server --insecure-registry "10.0.0.0/24" --insecure-registry "localhost:5000" # Set the active profile -minikube profile minikube +minikube profile knative ---- -- Minikube with Podman:: @@ -65,7 +65,7 @@ minikube config set container-runtime podman minikube start --cpus 4 --memory 4096 --addons registry --addons metrics-server --insecure-registry "10.0.0.0/24" --insecure-registry "localhost:5000" # Set the active profile -minikube profile minikube +minikube profile knative ---- -- Kind:: diff --git a/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc b/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc index cc5279cfd..6ae6fe2ec 100644 --- a/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc +++ b/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/kn-plugin-workflow-overview.adoc @@ -22,23 +22,21 @@ You can use the {product_name} plug-in to set up your local workflow project qui * (Optional) link:{docker_install_url}[Docker] is installed. * (Optional) link:{podman_install_url}[Podman] is installed. * link:{kubectl_install_url}[Kubernetes CLI] is installed. +* link:{kn_cli_install_url}[Knative CLI] is installed. .Procedure -. Download the latest binaries from the link:{kie_tools_releases_page_url}[KIE Tooling Releases] page. -. Run the `kn workflow` command using one of the following methods: +. Download the latest binary file from the link:{kie_tools_releases_page_url}[KIE Tooling Releases] page. +. Install the `kn workflow` command as a plug-in of the Knative CLI using the following steps: + -- -* Add `kn workflow` command in your system path and ensure that it is executable. -* Install `kn workflow` command as a plug-in of the Knative CLI using the following steps: -.. Install the Knative CLI. For installation instructions, see link:{kn_cli_install_url}[Installing kn] documentation. -.. Copy the `kn-workflow` binary to a directory in your `PATH`, such as `/usr/local/bin` and ensure that the file name is `kn-workflow`. -.. On Mac, add execution permission as follows: +.. Copy the `kn-workflow` binary file to a directory in your `PATH`, such as `/usr/local/bin` and ensure that the file name is `kn-workflow`. +.. Make the binary file executable as follows: + `chmod +x /usr/local/bin/kn-workflow` + [WARNING] ==== -Some systems might block the application to run due to Apple enforcing policies. To fix this problem, check the *Security & Privacy* section in the *System Preferences* -> *General* tab to approve the application to run. For more information, see link:{apple_support_url}[Apple support article: Open a Mac app from an unidentified developer]. +On Mac, some systems might block the application to run due to Apple enforcing policies. To fix this problem, check the *Security & Privacy* section in the *System Preferences* -> *General* tab to approve the application to run. For more information, see link:{apple_support_url}[Apple support article: Open a Mac app from an unidentified developer]. ==== .. Run the following command to verify that `kn-workflow` plug-in is installed successfully: + @@ -50,7 +48,7 @@ After installing the plug-in, you can use `kn workflow` to run the related subco . Use the `workflow` subcommand in Knative CLI as follows: + -- -.Methods to use workflow subcommand +.Aliases to use workflow subcommand [source,shell] ---- kn workflow @@ -65,6 +63,9 @@ Manage SonataFlow projects Usage: kn workflow [command] +Aliases: + kn workflow, kn-workflow + Available Commands: completion Generate the autocompletion script for the specified shell create Creates a new SonataFlow project