11.8. 3scale WebAssembly 모듈 구성
WasmPlugin
사용자 정의 리소스 사양은 Proxy-WASM
모듈에서 읽을 수 있는 구성을 제공합니다.
사양은 호스트에 포함되어 Proxy-WASM
모듈에서 읽습니다. 일반적으로 구성은 모듈이 구문 분석되도록 JSON 파일 형식입니다. 그러나 WasmPlugin
리소스는 사양 값을 YAML로 해석하고 모듈의 사용을 위해 JSON으로 변환할 수 있습니다.
독립 실행형 모드에서 Proxy-WASM
모듈을 사용하는 경우 JSON 형식을 사용하여 구성을 작성해야 합니다. JSON 형식을 사용하면 호스트
구성 파일(예: Envoy
) 내에서 이스케이프 및 인용을 사용하는 것을 의미합니다. WasmPlugin
리소스와 함께 WebAssembly 모듈을 사용하는 경우 구성은 YAML 형식으로 되어 있습니다. 이 경우 잘못된 구성은 모듈이 사이드카의 로깅 스트림에 대한 JSON 표현을 기반으로 진단을 표시하도록 강제 적용합니다.
EnvoyFilter
사용자 정의 리소스는 지원되는 API가 아니지만 일부 3scale Istio 어댑터 또는 Service Mesh 릴리스에서 사용할 수 있습니다. EnvoyFilter
사용자 정의 리소스를 사용하는 것은 권장되지 않습니다. EnvoyFilter
사용자 정의 리소스 대신 WasmPlugin
API를 사용합니다. EnvoyFilter
사용자 정의 리소스를 사용해야 하는 경우 사양을 JSON 형식으로 지정해야 합니다.
11.8.1. 3scale WebAssembly 모듈 구성
3scale WebAssembly 모듈 구성의 아키텍처는 3scale 계정 및 권한 부여 서비스 및 처리할 서비스 목록에 따라 다릅니다.
사전 요구 사항
사전 요구 사항은 모든 경우에서 최소 필수 필드 세트입니다.
-
3scale 계정 및 권한 부여 서비스의 경우
backend-listener
URL입니다. - 처리할 서비스 목록: 서비스 ID와 하나 이상의 인증 정보에서 방법 및 찾을 위치를 찾습니다.
-
userkey
,
및 OpenID Connect (OIDC) 패턴을 사용하는 예제를 찾을 수 있습니다.app
key -
WebAssembly 모듈은 정적 구성에 지정한 설정을 사용합니다. 예를 들어, 모듈에 매핑 규칙 구성을 추가하는 경우 3scale 관리 포털에 이러한 매핑 규칙이 없는 경우에도 항상 적용됩니다. 나머지
WasmPlugin
리소스는spec.pluginConfig
YAML 항목에 있습니다.
11.8.2. 3scale WebAssembly 모듈 api 오브젝트
3scale WebAssembly 모듈의 api
최상위 문자열은 모듈에서 사용할 구성 버전을 정의합니다.
api
오브젝트의 존재하지 않거나 지원되지 않는 버전은 3scale WebAssembly 모듈을 작동하지 않게 렌더링합니다.
api
최상위 수준 문자열 예
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> namespace: <info> spec: pluginConfig: api: v1 ...
api
항목은 구성에 대한 나머지 값을 정의합니다. 유일하게 허용되는 값은 v1
입니다. 현재 구성과의 호환성을 중단하거나 v1
을 사용하는 모듈에서 처리할 수 없는 논리가 필요한 새 설정에는 다른 값이 필요합니다.
11.8.3. 3scale WebAssembly 모듈 시스템 오브젝트
시스템
최상위 오브젝트는 특정 계정에 대한 3scale 계정 관리 API에 액세스하는 방법을 지정합니다. 업스트림
필드는 오브젝트에서 가장 중요한 부분입니다. 시스템
오브젝트는 선택 사항이지만 3scale WebAssembly 모듈에 대한 완전히 정적 구성을 제공하지 않는 것이 좋습니다. 3scale의 시스템 구성 요소에 대한 연결을 제공하지 않으려면 나중에는 옵션입니다.
시스템
오브젝트 외에 정적 구성 오브젝트를 제공하는 경우 정적 개체가 항상 우선합니다.
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> spec: pluginConfig: system: name: <saas_porta> upstream: <object> token: <my_account_token> ttl: 300 ...
이름 | 설명 | 필수 항목 |
---|---|---|
| 현재 다른 위치에서 참조되지 않은 3scale 서비스의 식별자입니다. | 선택 사항 |
|
연결할 네트워크 호스트에 대한 세부 정보입니다. | 제공됨 |
| 읽기 권한이 있는 3scale 개인 액세스 토큰입니다. | 제공됨 |
| 새 변경 사항을 가져오기 전에 이 호스트에서 검색된 구성을 유효한 것으로 간주하는 최소 시간(초)입니다. 기본값은 600초(10분)입니다. 참고: 최대 크기는 없지만 모듈은 이 TTL이 경과한 후 적절한 시간 내에 구성을 가져옵니다. | 선택 사항 |
11.8.4. 3scale WebAssembly 모듈 업스트림 오브젝트
업스트림
오브젝트는 프록시가 호출을 수행할 수 있는 외부 호스트를 설명합니다.
apiVersion: maistra.io/v1 upstream: name: outbound|443||multitenant.3scale.net url: "https://myaccount-admin.3scale.net/" timeout: 5000 ...
이름 | 설명 | 필수 항목 |
---|---|---|
|
| 제공됨 |
| 설명된 서비스에 액세스하기 위한 전체 URL입니다. 스키마에 의해 제한되지 않는 한 TCP 포트를 포함해야 합니다. | 제공됨 |
| 응답 시간을 초과하여 이 서비스에 대한 연결이 오류로 간주되도록 시간 제한 시간(밀리초)입니다. 기본값은 1000초입니다. | 선택 사항 |
11.8.5. 3scale WebAssembly 모듈 백엔드 오브젝트
backend
최상위 오브젝트는 HTTP 요청을 승인하고 보고하기 위해 3scale Service Management API에 액세스하는 방법을 지정합니다. 이 서비스는 3scale의 백엔드 구성 요소에서 제공합니다.
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> spec: pluginConfig: ... backend: name: backend upstream: <object> ...
이름 | 설명 | 필수 항목 |
---|---|---|
| 현재 다른 위치에서 참조되지 않은 3scale 백엔드의 식별자입니다. | 선택 사항 |
| 연결할 네트워크 호스트에 대한 세부 정보입니다. 이는 알려진 3scale 계정 관리 API 호스트, 시스템을 참조해야 합니다. | 제공됨 가장 중요하고 필요한 필드입니다. |
11.8.6. 3scale WebAssembly 모듈 서비스 오브젝트
services
최상위 오브젝트는 모듈의
이 특정 인스턴스에서 처리하는 서비스 ID를 지정합니다.
계정에 여러 서비스가 있으므로 처리되는 서비스를 지정해야 합니다. 나머지 구성에서는 서비스 구성 방법에 따라 달라집니다.
services
필드는 필수입니다. 유용한 서비스를 하나 이상 포함해야 하는 배열입니다.
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> spec: pluginConfig: ... services: - id: "2555417834789" token: service_token authorities: - "*.app" - 0.0.0.0 - "0.0.0.0:8443" credentials: <object> mapping_rules: <object> ...
services
배열의 각 요소는 3scale 서비스를 나타냅니다.
이름 | 설명 | 필수 항목 |
---|---|---|
| 현재 다른 위치에서 참조되지 않은 이 3scale 서비스의 식별자입니다. | 제공됨 |
|
이
| 선택 사항 |
| 일치하는 URL 의 권한을 나타내는 문자열 배열입니다. 이러한 문자열은 별표(*), 더하기 기호(+) 및 물음표(?)를 지원하는 글러 패턴을 허용합니다. | 제공됨 |
| 찾을 자격 증명 종류와 위치를 정의하는 오브젝트입니다. | 제공됨 |
| 매핑 규칙 및 3scale 메서드를 나타내는 오브젝트 배열입니다. | 선택 사항 |
11.8.7. 3scale WebAssembly 모듈 인증 정보 오브젝트
credentials
오브젝트는 서비스
오브젝트의 구성 요소입니다. credentials
는 조회할 인증 정보와 이 작업을 수행하는 단계를 지정합니다.
모든 필드는 선택 사항이지만 하나 이상의 user_key
또는 app_id
를 지정해야 합니다. 각 인증 정보를 지정하는 순서는 모듈에 의해 미리 설정되므로 관련이 없습니다. 각 인증 정보 인스턴스 하나만 지정합니다.
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> spec: pluginConfig: ... services: - credentials: user_key: <array_of_lookup_queries> app_id: <array_of_lookup_queries> app_key: <array_of_lookup_queries> ...
이름 | 설명 | 필수 항목 |
---|---|---|
| 3scale 사용자 키를 정의하는 조회 쿼리의 배열입니다. 사용자 키는 일반적으로 API 키라고 합니다. | 선택 사항 |
|
3scale 애플리케이션 ID를 정의하는 조회 쿼리의 배열입니다. 애플리케이션 ID는 3scale에서 제공하거나 Red Hat Single Sign-On(RH-SS0) 또는 OpenID Connect(OIDC)와 같은 ID 공급자를 사용하여 제공합니다. 여기에 지정된 조회 쿼리의 해상도가 성공하고 두 개의 값으로 확인되면 | 선택 사항 |
|
3scale 애플리케이션 키를 정의하는 조회 쿼리의 배열입니다. 확인된 | 선택 사항 |
11.8.8. 3scale WebAssembly 모듈 조회 쿼리
조회 쿼리
오브젝트는 credentials
오브젝트의 필드 중 하나에 포함됩니다. 지정된 인증 정보 필드를 찾아서 처리하는 방법을 지정합니다. 평가되면 성공적인 해결 방법은 하나 이상의 값이 발견되었음을 의미합니다. 실패한 해결 방법은 값을 찾을 수 없음을 의미합니다.
조회 쿼리
의 배열은 단락 또는 관계를 설명합니다. 쿼리 중 하나를 성공적으로 해결하면 나머지 쿼리의 평가를 중지하고 값 또는 값을 지정된 인증 정보 유형에 할당합니다. 배열의 각 쿼리는 서로 독립적입니다.
조회 쿼리
는 여러 소스 유형 중 하나일 수 있는 소스 오브젝트인 단일 필드로 구성됩니다. 다음 예제를 참조하십시오.
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> spec: pluginConfig: ... services: - credentials: user_key: - <source_type>: <object> - <source_type>: <object> ... app_id: - <source_type>: <object> ... app_key: - <source_type>: <object> ... ...
소스
오브젝트는 인증 정보
오브젝트 필드 내에 있는 소스 배열의 일부로 존재합니다. source
-type이라고 하는 오브젝트 필드 이름은 다음 중 하나입니다.
-
header
: 조회 쿼리는 HTTP 요청 헤더를 입력으로 수신합니다. -
QUERY_STRING
:조회 쿼리
는 URL 쿼리 문자열 매개변수를 입력으로 수신합니다. -
filter
:조회 쿼리
는 필터 메타데이터를 입력으로 수신합니다.
모든 source
-type 오브젝트에는 다음 두 필드가 있습니다.
이름 | 설명 | 필수 항목 |
---|---|---|
|
각 문자열 배열은 입력 데이터에 있는 항목을 참조하는 | 제공됨 |
|
| 선택 사항 |
|
데이터를 조회하는 데 사용되는 메타데이터의 경로를 표시합니다. 그러나 | 선택 사항 |
키가
입력 데이터와 일치하면 나머지 키가 평가되지 않고 소스 확인 알고리즘이 지정된 작업
(있는 경우)을 실행하도록 건너뜁니다.
ops
를 지정하지 않으면 일치하는 키
의 결과 값이 반환됩니다.
작업을 수행하면 첫 번째 단계가 키를
조회한 후 입력에 대한 특정 조건 및 변환을 지정할 수 있습니다. 속성을 변환, 디코딩 및 증명해야 할 때
작업을
사용하지만 모든 요구 사항과 Turing-completeness 가 부족한 성숙한 언어를 제공하지는 않습니다.
스택은 작업 출력을 저장했습니다
. 평가되면 인증 정보가 사용하는 값 수에 따라 스택 하단에 값 또는 값을 할당하여 조회 쿼리
가 완료됩니다.
11.8.9. 3scale WebAssembly 모듈 작업 오브젝트
특정 소스 유형에
속하는 ops
배열의 각 요소는 값에 변환을 적용하거나 테스트를 수행하는 작업
오브젝트입니다. 이러한 오브젝트에 사용할 필드 이름은 작업
자체의 이름이며 모든 값은 구조 오브젝트(예: 필드 및 값, 목록 또는 문자열로 맵)일 수 있는 매개 변수입니다.
대부분의 작업은
하나 이상의 입력에 참여하고 하나 이상의 출력을 생성합니다. 입력을 사용하거나 출력을 생성할 때 해당 스택은 값 스택에서 작동합니다. 작업에서 사용하는 각 값은 값 스택에서 채워지고 처음에 모든 소스
일치 항목으로 채워집니다. 해당 리소스에서 출력한 값은 스택으로 푸시됩니다. 다른 작업에서
는 특정 속성을 나타내는 것 이외의 출력을 사용하거나 생성하지 않지만 값 스택을 검사합니다.
확인이 완료되면 다음 단계에서 선택한 값(예: app_id
,app_key
또는 user_key
)은 스택의 하단 값에서 가져옵니다.
다음과 같은 몇 가지 작업
범주가 있습니다.
-
디코딩
: 이러한 변환은 다른 형식을 가져오도록 디코딩하여 입력 값을 변환합니다. -
string
: 문자열 값을 입력으로 사용하고 변환 및 검사를 수행합니다. -
스택
: 입력에서 값 집합을 가져와서 스택의 특정 위치를 여러 스택 변환 및 선택합니다. -
확인
: 이러한 어설션 속성은 부작용없는 방식으로 작업 세트에 대한 속성입니다. -
Control
: 평가 흐름을 수정할 수 있는 작업을 수행합니다. -
형식
: 입력 값의 형식별 구조를 구문 분석하고 해당 값의 값을 조회합니다.
모든 작업은 이름 식별자에 의해 문자열로 지정됩니다.
추가 리소스
11.8.10. 3scale WebAssembly 모듈 mapping_rules 오브젝트
mapping_rules
오브젝트는 서비스
오브젝트의 일부입니다. REST 경로 패턴 및 관련 3scale 메트릭 세트를 지정하고 패턴이 일치할 때 사용할 증가 수를 지정합니다.
시스템
최상위 오브젝트에 동적 구성이 제공되지 않은 경우 값이 필요합니다. 오브젝트가 시스템
최상위 항목 외에 제공되는 경우 mapping_rules
오브젝트가 먼저 평가됩니다.
mapping_rules
는 배열 오브젝트입니다. 해당 배열의 각 요소는 mapping_rule
개체입니다. 들어오는 요청에 대한 평가 일치 매핑 규칙은 APIManager 에게 권한 부여 및 보고를 위한 3scale 메서드
세트를 제공합니다. 여러 일치 규칙이 동일한 메서드
를 참조하는 경우 3scale로 호출할 때 deltas
의 합계가 요약됩니다. 예를 들어, 두 개의 규칙이 1과 3의
를 사용하여 Hits 메서드를 두 번 늘리면 3scale에 보고하는 Hits의 단일 메서드 항목에 4가 있습니다.
delta
s
11.8.11. 3scale WebAssembly 모듈 mapping_rule 오브젝트
mapping_rule
오브젝트는 mapping_rules
오브젝트의 배열의 일부입니다.
mapping_rule
오브젝트 필드는 다음 정보를 지정합니다.
- 일치시킬 HTTP 요청 방법입니다.
- 경로와 일치하는 패턴입니다.
- 보고할 양과 함께 보고하는 3scale 방법입니다. 필드를 지정하는 순서에 따라 평가 순서가 결정됩니다.
이름 | 설명 | 필수 항목 |
---|---|---|
| 동사라고도 하는 HTTP 요청 메서드를 나타내는 문자열을 지정합니다. 허용되는 값은 허용되는 HTTP 메서드 이름 중 하나와 대소문자를 구분하지 않습니다. 특수 값은 모든 메서드와 일치합니다. | 제공됨 |
|
HTTP 요청의 URI 경로 구성 요소와 일치하는 패턴입니다. 이 패턴은 3scale에서 설명한 것과 동일한 구문을 따릅니다. | 제공됨 |
|
다음 필수 필드를 사용하여
| 제공됨 |
| 이 규칙의 성공적인 일치 여부를 통해 더 많은 매핑 규칙 평가를 중지해야 하는지 여부입니다. |
선택적 부울입니다. 기본값은 |
다음 예제는 3scale의 메서드 간 기존 계층 구조와 독립적입니다. 즉 3scale 측에서 실행되는 모든 것은 이에 영향을 미치지 않습니다. 예를 들어 Hits 지표는 모두 상위일 수 있으므로 권한 있는 요청에서 보고된 모든 메서드 합계로 인해 4 조회를 저장하고 3scale Authrep
API 엔드포인트를 호출합니다.
아래 예제에서는 모든 규칙과 일치하는 경로 /products/1/sold
에 대한 GET
요청을 사용합니다.
mapping_rules
GET
요청 예
apiVersion: extensions.istio.io/v1alpha1 kind: WasmPlugin metadata: name: <threescale_wasm_plugin_name> spec: pluginConfig: ... mapping_rules: - method: GET pattern: / usages: - name: hits delta: 1 - method: GET pattern: /products/ usages: - name: products delta: 1 - method: ANY pattern: /products/{id}/sold usages: - name: sales delta: 1 - name: products delta: 1 ...
모든 사용량은
다음과 같이 사용 데이터를 사용하여 모듈이 3scale에 수행하는 요청에 추가됩니다.
- 히트: 1
- 제품: 2
- 영업: 1