서버리스 논리

프로세스

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

   프로젝트가 준비되면 localhost:8080/q/dev-ui 의 브라우저에서 Development 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

   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

   & lt;workflow_name >을 워크플로우 이름으로 바꾸고 < 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

   &lt ;your_file >을 워크플로우 파일의 이름으로 바꾸고 < your_namespace >를 네임스페이스로 바꿉니다.

프로세스

1. OpenAPI 기능을 정의하려면 다음을 수행합니다.

   1. 호출하려는 서비스의 OpenAPI 사양 파일을 식별하고 액세스합니다.

   2. OpenAPI 사양 파일을 src/main/resources/specs 와 같은 워크플로우 서비스 디렉터리에 복사합니다.

      다음 예제에서는 곱셈 REST 서비스에 대한 OpenAPI 사양을 보여줍니다.

      곱셈 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. 함수 정의가 src/main/resources/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. application.properties 파일에 구성 키와 URL 대체를 추가합니다.

   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. OpenShift Serverless Logic은 HTTP 요청 및 응답을 추적하기 위해 다음 속성을 설정하여 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 Client에 대한 디버깅을 켭니다.

   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