Serverless Logic

流程

1. 运行以下命令，创建一个新的 OpenShift Serverless Logic 工作流项目：

   $ kn workflow create

   Copy to Clipboard Toggle word wrap

   默认情况下，生成的项目名称是 new-project。您可以使用 [-n|--name] 标志来更改项目名称，如下所示：

   示例命令

   $ kn workflow create --name my-project

   Copy to Clipboard Toggle word wrap

流程

1. 运行以下命令来构建并运行 OpenShift Serverless Logic 工作流项目：

   $ kn workflow run

   Copy to Clipboard Toggle word wrap

   当项目就绪时，Dev Development UI 会在 localhost:8080/q/dev-ui 的浏览器中自动打开，您将找到可用的 Serverless Workflow Tools 标题。另外，您可以使用 http://localhost:8080/q/dev-ui/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflows 直接访问该工具。

流程

1. 创建工作流配置 YAML 文件。

   workflow-dev.yaml 文件示例

   apiVersion: sonataflow.org/v1alpha08
   kind: SonataFlow
   metadata:
     name: greeting 

   1

   
     annotations:
       sonataflow.org/description: Greeting example on k8s!
       sonataflow.org/version: 0.0.1
       sonataflow.org/profile: dev 

   2

   
   spec:
     flow:
       start: ChooseOnLanguage
       functions:
         - name: greetFunction
           type: custom
           operation: sysout
       states:
         - name: ChooseOnLanguage
           type: switch
           dataConditions:
             - condition: "${ .language == \"English\" }"
               transition: GreetInEnglish
             - condition: "${ .language == \"Spanish\" }"
               transition: GreetInSpanish
           defaultCondition: GreetInEnglish
         - name: GreetInEnglish
           type: inject
           data:
             greeting: "Hello from JSON Workflow, "
           transition: GreetPerson
         - name: GreetInSpanish
           type: inject
           data:
             greeting: "Saludos desde JSON Workflow, "
           transition: GreetPerson
         - name: GreetPerson
           type: operation
           actions:
             - name: greetAction
               functionRef:
                 refName: greetFunction
                 arguments:
                   message:  ".greeting + .name"
           end: true

   Copy to Clipboard Toggle word wrap

   1

   is a workflow_name

   2

   表示您必须在 Dev 模式中部署工作流

2. 要部署应用程序，请输入以下命令应用 YAML 文件：

   $ oc apply -f <filename> -n <your_namespace>

   Copy to Clipboard Toggle word wrap

3. 输入以下命令验证部署并检查部署工作流的状态：

   $ oc get workflow -n <your_namespace> -w

   Copy to Clipboard Toggle word wrap

   确定列出了您的工作流，其状态为 Running 或 Completed。

4. 输入以下命令直接在集群中编辑工作流：

   $ oc edit sonataflow <workflow_name> -n <your_namespace>

   Copy to Clipboard Toggle word wrap
5. 编辑后，保存更改。OpenShift Serverless Logic Operator 会检测更改并相应地更新工作流。

验证

1. 要确保正确应用更改，请输入以下命令验证工作流的状态和日志：

   1. 运行以下命令，查看工作流的状态：

      $ oc get sonataflows -n <your_namespace>

      Copy to Clipboard Toggle word wrap

   2. 运行以下命令来查看工作流日志：

      $ oc logs <workflow_pod_name> -n <your_namespace>

      Copy to Clipboard Toggle word wrap

后续步骤

1. 完成测试后，运行以下命令来删除资源以避免不必要的用法：

   $ oc delete sonataflow <workflow_name> -n <your_namespace>

   Copy to Clipboard Toggle word wrap

流程

1. 运行以下命令打开并编辑 ConfigMap ：

   $ oc edit cm <workflow_name>-props -n <namespace>

   Copy to Clipboard Toggle word wrap

   将 <workflow_name > 替换为工作流的名称，将 &lt;namespace> 替换为部署工作流的命名空间。

2. 在 application.properties 部分中添加属性。

   存储在 ConfigMap 中的工作流属性示例：

   apiVersion: v1
   kind: ConfigMap
   metadata:
     labels:
       app: greeting
     name: greeting-props
     namespace: default
   data:
     application.properties: |
       my.properties.key = any-value

   Copy to Clipboard Toggle word wrap

   确保正确格式化属性，以防止 Operator 将配置替换为默认配置。

3. 进行必要的更改后，保存文件并退出编辑器。

流程

1. 运行以下命令，为命名空间中的指定服务创建路由：

   $ oc expose svc <service_name> -n <namespace>

   Copy to Clipboard Toggle word wrap

2. 运行以下命令，获取新公开的服务的 URL：

   $ WORKFLOW_SVC=$(oc get route/<service_name> --template='{{.spec.host}}')

   Copy to Clipboard Toggle word wrap

3. 运行以下命令，执行测试 HTTP 调用并发送 POST 请求：

   $ curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '<request_body>' http://$WORKFLOW_SVC/<endpoint>

   Copy to Clipboard Toggle word wrap
4. 验证响应，以确保工作流按预期工作。

流程

1. 运行以下命令检查工作流状态：

   $ oc get workflow <name> -o jsonpath={.status.conditions} | jq .

   Copy to Clipboard Toggle word wrap

2. 要从工作流的部署中获取和分析日志，请运行以下命令：

   $ oc logs deployment/<workflow_name> -f

   Copy to Clipboard Toggle word wrap

流程

1. 验证您具有定义您要删除的工作流的正确文件。例如，workflow.yaml。

2. 运行 oc delete 命令从指定的命名空间中删除工作流：

   $ oc delete -f <your_file> -n <your_namespace>

   Copy to Clipboard Toggle word wrap

   将 <your_file > 替换为工作流文件的名称，将 &lt ;your_namespace& gt; 替换为您的命名空间。

流程

1. 定义 OpenAPI 功能：

   1. 识别并访问您要调用的服务的 OpenAPI 规格文件。

   2. 将 OpenAPI 规格文件复制到工作流服务目录中，如 < project_application_dir>/specs。

      以下示例显示了 multiplication REST 服务的 OpenAPI 规格：

      multiplication REST 服务 OpenAPI 规格示例

      openapi: 3.0.3
      info:
        title: Generated API
        version: "1.0"
      paths:
        /:
          post:
            operationId: doOperation
            parameters:
              - in: header
                name: notUsed
                schema:
                  type: string
                required: false
            requestBody:
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/MultiplicationOperation'
            responses:
              "200":
                description: OK
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        product:
                          format: float
                          type: number
      components:
        schemas:
          MultiplicationOperation:
            type: object
            properties:
              leftElement:
                format: float
                type: number
              rightElement:
                format: float
                type: number

      Copy to Clipboard Toggle word wrap

   3. 要在工作流中定义功能，请使用 OpenAPI 规格中的 operationId 来引用功能定义中的所需操作。

      温度转换应用中的函数定义示例

      {
         "functions": [
           {
             "name": "multiplication",
             "operation": "specs/multiplication.yaml#doOperation"
           },
           {
             "name": "subtraction",
             "operation": "specs/subtraction.yaml#doOperation"
           }
         ]
      }

      Copy to Clipboard Toggle word wrap

   4. 确保您的功能定义引用存储在 < project_application_dir>/specs 目录中的 OpenAPI 文件的正确路径。

2. 访问工作流状态中定义的功能：

   1. 定义工作流操作来调用您添加的功能定义。确保每个操作引用之前定义的函数。

   2. 使用 functionRef 属性根据其名称引用特定功能。使用 OpenAPI 规格中定义的参数来映射 functionRef 中的参数。

      以下示例演示了在请求路径而不是请求正文中映射参数，您可以参考以下 PetStore API 示例：

      工作流中的映射功能参数示例

      {
         "states": [
          {
            "name": "SetConstants",
            "type": "inject",
            "data": {
              "subtractValue": 32.0,
              "multiplyValue": 0.5556
            },
            "transition": "Computation"
          },
          {
            "name": "Computation",
            "actionMode": "sequential",
            "type": "operation",
            "actions": [
              {
                "name": "subtract",
                "functionRef": {
                  "refName": "subtraction",
                  "arguments": {
                    "leftElement": ".fahrenheit",
                    "rightElement": ".subtractValue"
                  }
                }
              },
              {
                "name": "multiply",
                "functionRef": {
                  "refName": "multiplication",
                  "arguments": {
                     "leftElement": ".difference",
                     "rightElement": ".multiplyValue"
                  }
                }
              }
            ],
            "end": {
              "terminate": true
            }
          }
        ]
      }

      Copy to Clipboard Toggle word wrap

   3. 检查 OpenAPI 规格的 Operation Object 部分，以了解如何在请求中结构参数。
   4. 使用 jq 表达式从有效负载中提取数据并将其映射到所需参数。确保引擎根据 OpenAPI 规格映射参数名称。

   5. 对于在请求路径而不是正文中需要参数的操作，请参阅 OpenAPI 规格中的参数定义。

      有关请求路径而不是请求正文中映射参数的更多信息，您可以参阅以下 PetStore API 示例：

      映射路径参数示例

      {
        "/pet/{petId}": {
          "get": {
            "tags": ["pet"],
            "summary": "Find pet by ID",
            "description": "Returns a single pet",
            "operationId": "getPetById",
            "parameters": [
              {
                "name": "petId",
                "in": "path",
                "description": "ID of pet to return",
                "required": true,
                "schema": {
                  "type": "integer",
                  "format": "int64"
                }
              }
            ]
          }
        }
      }

      Copy to Clipboard Toggle word wrap

      以下是调用函数的示例，在请求路径中只添加了一个名为 petId 的参数：

      调用 PetStore 功能的示例

      {
        "name": "CallPetStore", 

      1

      
        "actionMode": "sequential",
        "type": "operation",
        "actions": [
          {
            "name": "getPet",
            "functionRef": {
              "refName": "getPetById", 

      2

      
              "arguments": { 

      3

      
                "petId": ".petId"
              }
            }
          }
        ]
      }

      Copy to Clipboard Toggle word wrap

      1

      状态定义，如 CallPetStore。

      2

      功能定义参考。在上例中，函数定义 getPetById 用于 PetStore OpenAPI 规格。

      3

      参数定义。OpenShift Serverless Logic 在发送请求前将参数 petId 添加到请求路径中。

流程

1. 找到您要配置的 OpenAPI 规格文件。例如，substraction.yaml。
2. 通过将特殊字符（如 . ）替换为下划线并将字母转换为小写，将文件名转换为有效的配置键。例如，将 substraction.yaml 更改为 substraction_yaml。

3. 要定义配置密钥，请使用转换的文件名作为 REST 客户端配置密钥。将此键设置为环境变量，如下例所示：

   quarkus.rest-client.subtraction_yaml.url=http://myserver.com

   Copy to Clipboard Toggle word wrap

4. 要防止 application.properties 文件中的硬编码 URL，请使用环境变量替换，如下例所示：

   quarkus.rest-client.subtraction_yaml.url=${SUBTRACTION_URL:http://myserver.com}

   Copy to Clipboard Toggle word wrap

   在本例中：

   • 配置密钥： quarkus.rest-client.subtraction_yaml.url
   • 环境变量：SUBTRACTION_URL
   • 回退 URL: http://myserver.com
5. 确保在系统或部署环境中设置了 (SUBTRACTION_URL) 环境变量。如果没有找到变量，应用程序将使用回退 URL (http://myserver.com)。

6. 将配置键和 URL 替换添加到 application.properties 文件中：

   quarkus.rest-client.subtraction_yaml.url=${SUBTRACTION_URL:http://myserver.com}

   Copy to Clipboard Toggle word wrap
7. 部署或重启您的应用程序以应用新的配置设置。

流程

1. 在您的工作流中添加 workflow-uri-definitions 扩展。在此扩展中，为您的 URI 创建别名。

   工作流示例

   {
     "extensions": [
       {
         "extensionid": "workflow-uri-definitions", 

   1

   
         "definitions": {
           "remoteCatalog": "https://my.remote.host/apicatalog/apis/123/document" 

   2

   
         }
       }
     ],
     "functions": [ 

   3

   
       {
         "name": "operation1",
         "operation": "remoteCatalog#operation1"
       },
       {
         "name": "operation2",
         "operation": "remoteCatalog#operation2"
       }
     ]
   }

   Copy to Clipboard Toggle word wrap

流程

1. 要跟踪 HTTP 请求和响应，OpenShift Serverless Logic 通过设置以下属性来使用 Apache HTTP 客户端：

   # Turning HTTP tracing on
   quarkus.log.category."org.apache.http".level=DEBUG

   Copy to Clipboard Toggle word wrap

2. 在应用程序的 application.properties 文件中添加以下配置，以打开 Apache HTTP 客户端的调试：

   quarkus.log.category."org.apache.http".level=DEBUG

   Copy to Clipboard Toggle word wrap
3. 重启应用程序以传播日志配置更改。

4. 重启后，检查 HTTP 请求追踪的日志。

   追踪的 HTTP 请求的日志示例

   2023-09-25 19:00:55,242 DEBUG Executing request POST /v2/models/yolo-model/infer HTTP/1.1
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> POST /v2/models/yolo-model/infer HTTP/1.1
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> Accept: application/json
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> Content-Type: application/json
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> kogitoprocid: inferencepipeline
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> kogitoprocinstanceid: 85114b2d-9f64-496a-bf1d-d3a0760cde8e
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> kogitoprocist: Active
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> kogitoproctype: SW
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> kogitoprocversion: 1.0
   2023-09-25 19:00:55,243 DEBUG http-outgoing-0 >> Content-Length: 23177723
   2023-09-25 19:00:55,244 DEBUG http-outgoing-0 >> Host: yolo-model-opendatahub-model.apps.trustyai.dzzt.p1.openshiftapps.com

   Copy to Clipboard Toggle word wrap

5. 在请求日志后检查 HTTP 响应追踪的日志。

   追踪的 HTTP 响应的日志示例

   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "HTTP/1.1 500 Internal Server Error[\r][\n]"
   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "content-type: application/json[\r][\n]"
   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "date: Mon, 25 Sep 2023 19:01:00 GMT[\r][\n]"
   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "content-length: 186[\r][\n]"
   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "set-cookie: 276e4597d7fcb3b2cba7b5f037eeacf5=5427fafade21f8e7a4ee1fa6c221cf40; path=/; HttpOnly; Secure; SameSite=None[\r][\n]"
   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "[\r][\n]"
   2023-09-25 19:01:00,738 DEBUG http-outgoing-0 << "{"code":13, "message":"Failed to load Model due to adapter error: Error calling stat on model file: stat /models/yolo-model__isvc-1295fd6ba9/yolov5s-seg.onnx: no such file or directory"}"

   Copy to Clipboard Toggle word wrap