Chapter 10. Installing the OpenShift Serverless Logic Knative Workflow plugin

Procedure

1. Download the latest tar archive suitable for your environment, from the Serverless Logic download mirror page.

2. Extract the Knative Workflow plugin binary file by running the following command:

   $ tar xvzf <tar_archive>

3. Rename the extracted Knative Workflow plugin binary file to kn-workflow by running the following command:

   $ mv <filename> kn-workflow

4. Install the kn-workflow command as the Knative CLI plugin:

   1. Make the binary file executable by running the following command:

      $ chmod +x /usr/local/bin/kn-workflow

   2. Copy the kn-workflow binary file to a directory in the /usr/local/bin path by running the following command:

      $ cp <path/to/downloaded/kn-workflow> /usr/local/bin/kn-workflow

Procedure

1. Download the latest tar archive suitable for your environment, from the Serverless Logic download mirror page.

2. Extract the Knative Workflow plugin binary file by running the following command:

   $ tar xvzf <tar_archive>

3. Rename the extracted Knative Workflow plugin binary file to kn-workflow by running the following command:

   $ mv <filename> kn-workflow

4. Install the kn-workflow command as the Knative CLI plugin:

   1. Make the binary file executable by running the following command:

      $ chmod +x /usr/local/bin/kn-workflow

   2. Copy the kn-workflow binary file to a directory in the /usr/local/bin path by running the following command:

      $ cp <path/to/downloaded/kn-workflow> /usr/local/bin/kn-workflow

Procedure

1. Download the latest zip archive suitable for your environment, from the Serverless Logic download mirror page.

2. Extract the Knative Workflow plugin binary file using PowerShell by running the following command:

   $ Expand-Archive -Path <filename>.zip -DestinationPath <destination>

3. Rename the extracted Knative Workflow plugin binary file to kn-workflow by running the following command:

   $ Rename-Item -Path <destination>\<filename>.exe -NewName kn-workflow.exe

4. Install the kn-workflow command as the Knative CLI plugin:

   On Windows, files with a .exe extension are treated as executable by default, so you do not need to change permissions.

   1. Move the kn-workflow.exe file to a directory in your PATH by running the following command:

      $ move C:\path\to\kn-workflow.exe "C:\Program Files"

   2. Copy the kn-workflow binary file to a directory in your PATH by running the following command:

      $ Copy-Item -Path <destination>\kn-workflow.exe -Destination "C:\Program Files\kn-workflow.exe"

Procedure

1. Download the Knative Workflow plugin using the logic-kn-workflow-cli-artifacts-rhel8 image by running the following commands:

   1. Log in to the Red Hat Registry by running the following command:

      $ podman login registry.redhat.io

      You can use your Red Hat Customer Portal account or a registry service account.

   2. Set a variable for KN_IMAGE to start the logic-kn-workflow-cli-artifacts-rhel8 image by running the following command:

      $ export KN_IMAGE=registry.redhat.io/openshift-serverless-1/logic-kn-workflow-cli-artifacts-rhel8:1.33.0

   3. Set a variable for KN_CONTAINER_ID by running the following command:

      $ export KN_CONTAINER_ID=$(podman run -di $KN_IMAGE)

   4. Copy the Knative Workflow plugin binary file by running the following command:

      $ podman cp $KN_CONTAINER_ID:<path_to_binary> .

      where <path_to_binary> is the path to the file for your environment:

      Environment	Path to binary file
      Linux amd64 architecture	/usr/share/kn/linux_amd64/kn-workflow-linux-amd64.tar.gz
      Linux arm64 architecture	/usr/share/kn/linux_arm64/kn-workflow-linux-arm64.tar.gz
      macOS amd64 architecture	/usr/share/kn/macos_amd64/kn-workflow-macos-amd64.tar.gz
      macOS arm64 architecture	/usr/share/kn/macos_arm64/kn-workflow-macos-arm64.tar.gz
      Windows amd64 architecture	/usr/share/kn/windows/kn-workflow-windows-amd64.zip

   5. Stop the container by running the following command:

      $ podman stop $KN_CONTAINER_ID

   6. Delete the container by running the following command:

      $ podman rm $KN_CONTAINER_ID

   7. Extract the selected Knative Workflow plugin binary file by running the following command:

      $ tar xvzf kn-workflow-linux-amd64.tar.gz

   8. Rename the Knative Workflow plugin binary file to kn-workflow by running the following command:

      $ mv kn kn-workflow

2. Install the kn-workflow command as a plugin of the Knative CLI by running the following commands:

   1. Copy the kn-workflow binary file to a directory in your PATH, such as /usr/local/bin, and ensure the file name is kn-workflow:

      $ cp path/to/downloaded/kn-workflow /usr/local/bin/kn-workflow

   2. Make the binary file executable:

      $ chmod +x /usr/local/bin/kn-workflow

Verification

1. Run the following command to verify that the kn-workflow plugin is installed successfully:

   $ kn plugin list

2. After installing the plugin, you can use kn-workflow to run the related subcommands.

   Aliases to use workflow subcommand

   kn-workflow

   Example output of kn-workflow help command

   Manage OpenShift Serverless Logic Workflow 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 OpenShift Serverless Logic Workflow project
     deploy      Deploy an OpenShift Serverless Logic Workflow project on Kubernetes via SonataFlow Operator
     help        Help about any command
     quarkus     Manage OpenShift Serverless Logic Workflow projects built in Quarkus
     run         Run an OpenShift Serverless Logic Workflow project in development mode
     undeploy    Undeploy an OpenShift Serverless Logic Workflow project on Kubernetes via SonataFlow Operator
     version     Show the version
   
   Flags:
     -h, --help      help for kn
     -v, --version   version for kn
   
   Use "kn [command] --help" for more information about a command.