8.9. 기능과 관련된 사용자 정의 리소스
새로 생성된 테넌트에서 Openshift Container Platform을 사용하면 제품 및 해당 메트릭, 메서드, 애플리케이션 계획 및 매핑 규칙을 구성하고 제품 백엔드 사용량을 정의하고 제품을 테넌트 계정에 연결합니다.
사전 요구 사항
일반 사전 요구 사항에 나열된 것과 동일한 설치 요구 사항 및 다음 사항을 고려합니다.
- 3scale 계정의 최소 필수 매개 변수는 제품 이름입니다.
8.9.1. 기능과 관련된 제품 사용자 정의 리소스 배포
새로 생성된 테넌트에서 Openshift Container Platform을 사용하여 신제품을 구성합니다.
8.9.1.1. 기본 제품 사용자 정의 리소스 배포
절차
- OpenShift 계정에서 설치된 운영자 로 이동합니다.
- 3scale 연산자를 클릭합니다.
- 3scale Product (제품)에서 Create Instance (인스턴스 만들기)를 클릭합니다.
- YAML View(YAML 보기)를 선택합니다.
3scale 제품을 만듭니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: <your_product_OpenShift_name> spec: name: "<your_product_name>"
예를 들면 다음과 같습니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1"
- 변경 사항을 저장하려면 Create(만들기 )를 클릭합니다.
OpenShift 및 3scale 계정에서 둘 다 만든 제품이 생성될 때까지 몇 초 동안 기다립니다. 그런 다음 다음 검증을 수행할 수 있습니다.
-
동기화 조건이
True
로 표시되는 3scale Product Overview (제품 개요) 페이지에서 확인하여 제품이 OpenShift에 생성되었는지 확인합니다. -
3scale 계정으로 이동하여 제품이 생성된 것을 확인할 수 있습니다. 위의 예에서
OperatedProduct 1
이라는 신제품이 나타납니다.
-
동기화 조건이
생성하는 각 제품에 대해 APIcast 배포 모드를 지정할 수도 있습니다. 두 가지 대안이 있습니다.
8.9.1.2. 호스팅된 APIcast로 제품 배포
호스팅된 APIcast로 제품을 구성합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" deployment: apicastHosted: {}
8.9.1.3. APIcast 자체 관리로 제품 배포
APIcast 셀프 관리로 제품 구성. 이 경우 stagingPublicBaseURL 및
을 지정합니다.
productionPublic
BaseURL
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" deployment: apicastSelfManaged: stagingPublicBaseURL: "https://staging.api.example.com" productionPublicBaseURL: "https://production.api.example.com"
8.9.2. 제품 애플리케이션 계획 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 application Plans 오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 애플리케이션
계획을 정의합니다.
다음 관찰을 고려하십시오.
-
ApplicationPlans
맵핑 키 이름은system_name
으로 사용됩니다. 아래 예에서plan01
및plan02
.
setupFee
및 costMonth
는 일반적인 3scale 개념입니다. 3scale 사용자 인터페이스에서 애플리케이션 계획을 생성할 때 이러한 세부 사항을 입력해야 합니다. 가격 규칙을 사용하여 애플리케이션 계획 구성을 참조하십시오.
절차
다음 예와 같이 새로운 3scale 제품에 애플리케이션 계획을 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" applicationPlans: plan01: name: "My Plan 01" setupFee: "14.56" plan02: name: "My Plan 02" trialPeriod: 3 costMonth: 3
8.9.3. 제품 애플리케이션 계획에 대한 제한 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 application Plans.limits 목록을 사용하여 제품 애플리케이션
계획에 필요한 제한을 정의합니다.
다음 관찰을 고려하십시오.
-
period
,value
및metricMethodRef
는 필수 필드입니다. -
metricMethodRef
참조는 제품 또는 백엔드 참조일 수 있습니다. 선택적backend
필드를 사용하여 백엔드 지표 소유자를 참조합니다.
절차
다음 예와 같이 3scale 제품의 애플리케이션 계획에 대한 제한을 정의합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" metrics: hits: description: Number of API hits friendlyName: Hits unit: "hit" applicationPlans: plan01: name: "My Plan 01" limits: - period: month value: 300 metricMethodRef: systemName: hits backend: backendA - period: week value: 100 metricMethodRef: systemName: hits
8.9.4. 제품 애플리케이션 계획에 대한 가격 결정 규칙 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 application Plans.pricingRules 목록을 사용하여 제품 애플리케이션
계획에 필요한 가격 규칙을 정의합니다.
다음 관찰을 고려하십시오.
-
에서
pricePerUnit
및metricMethodRef
는 필수 필드입니다. -
에서
및에 대한
유효성을 검사합니다. 모든 규칙에 대해 의 값은~
동일한 지표의 겹치는 범위는 허용되지 않습니다.보다
작으며 -
metricMethodRef
참조는 제품 또는 백엔드 참조일 수 있습니다. 선택적backend
필드를 사용하여 백엔드 지표 소유자를 참조합니다.
절차
다음 예와 같이 3scale 제품의 애플리케이션 계획에 대한 가격 규칙을 정의합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" metrics: hits: description: Number of API hits friendlyName: Hits unit: "hit" applicationPlans: plan01: name: "My Plan 01" pricingRules: - from: 1 to: 100 pricePerUnit: "15.45" metricMethodRef: systemName: hits - from: 1 to: 300 pricePerUnit: "15.45" metricMethodRef: systemName: hits backend: backendA
8.9.5. OpenID Connect를 사용하여 제품 인증 정의
OAuth 2.0 흐름에 대한 인증에 OIDC (OpenID Connect )를 사용하는 3scale 제품에 대한 제품
사용자 지정 리소스를 배포할 수 있습니다. 3scale은 OpenID Connect와 같은 타사 IdM(Identity Providers)과 통합되어 API 요청을 인증합니다. OpenID Connect에 대한 자세한 내용은 OpenID Connect 통합을 참조하십시오. 타사 IdP와 통합한 후 제품 사용자 정의 리소스에 포함할 두 가지 유형의 데이터를 보유하게 됩니다.
-
issuerType
: 타사 IdP와 통합할 때 Red Hat Single Sign-On(RH-SSO)과나머지
가치를 사용할 때keycloak
의 가치. -
issuerEndpoint
: 이 파일에 필요한 자격 증명이 있는 URL입니다.
사전 요구 사항
- RH-SSO를 구성해야 합니다. Red Hat Single Sign-On 구성을 참조하십시오.
- 타사 ID 공급자와 HTTP 통합을 구성해야 합니다.
issuerEndpoint
에 제공된 자격 증명 CLIENT_ID 및 CLIENT_CREDENTIALS 에는 영역에서 다른 클라이언트를 관리할 수 있는 충분한 권한이 있어야 합니다.
절차
OpenID 공급자의 위치를 정의하고 제품 사용자 정의 리소스에서 이 형식을 사용하는 끝점
issuerEndpoint
를 결정합니다.https://<client_id>:<client_secret>@<host>:<port_number>/auth/realms/<realm_name>`
OAuth 2.0 흐름에 대해 OIDC(OpenID Connect) 인증을 지정하는 3scale
제품
CR을 정의하거나 업데이트합니다. 예를 들면 다음과 같습니다.apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" deployment: <any>: authentication: oidc: issuerType: "keycloak" issuerEndpoint: "https://myclientid:myclientsecret@mykeycloack.example.com/auth/realms/myrealm" authenticationFlow: standardFlowEnabled: false implicitFlowEnabled: true serviceAccountsEnabled: true directAccessGrantsEnabled: true jwtClaimWithClientID: "azp" jwtClaimWithClientIDType: "plain"
방금 정의한 리소스를 생성합니다. 예를 들면 다음과 같습니다.
oc create -f product1.yaml
주어진 예에서 출력은 다음과 같습니다.
product.capabilities.3scale.net/product1 created
추가 리소스
8.9.6. 제품 지표 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 지표 오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 지표를
정의합니다.
다음 관찰을 고려하십시오.
-
지표
맵 키 이름은system_name
으로 사용됩니다. 아래 예에서는metric01
및hits
입니다. -
지표
맵의 키 이름은 모든 지표 및 방법에서 고유해야 합니다. -
단위
및friendlyName
은 필수 필드입니다. -
hits
지표를 추가하지 않으면 운영자가 생성합니다.
절차
다음 예와 같이 새로운 3scale 백엔드에 제품 지표를 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" metrics: metric01: friendlyName: Metric01 unit: "1" hits: description: Number of API hits friendlyName: Hits unit: "hit"
8.9.7. 제품 방법 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 메서드
오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 방법을 정의합니다.
다음 관찰을 고려하십시오.
-
메서드
맵 키 이름은system_name
으로 사용됩니다. 아래 예제에서는 다음을 수행합니다.Method01
및Method02
. -
메서드
는 모든 지표 및 방법에서 키 이름을 매핑해야 합니다. -
friendlyName
은 필수 필드입니다.
절차
다음 예와 같이 새로운 3scale 제품에 메서드를 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" methods: method01: friendlyName: Method01 method02: friendlyName: Method02
8.9.8. 제품 매핑 규칙 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 mappingRules
오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 매핑 규칙을 정의합니다.
다음 관찰을 고려하십시오.
-
httpMethod
,패턴
,increment
및metricMethodRef
는 필수 필드입니다. -
metricMethodRef
에는 기존 지표 또는 메서드 맵 키 이름system_name
에 대한 참조가 있습니다. 아래 예에서,hits
.
절차
다음 예와 같이 새로운 3scale 백엔드에 제품 매핑 규칙을 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" metrics: hits: description: Number of API hits friendlyName: Hits unit: "hit" methods: method01: friendlyName: Method01 mappingRules: - httpMethod: GET pattern: "/pets" increment: 1 metricMethodRef: hits - httpMethod: GET pattern: "/cars" increment: 1 metricMethodRef: method01
8.9.9. 제품 백엔드 사용 정의
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 backendUsages
오브젝트를 적용하여 제품 선언적으로 원하는 백엔드를 정의합니다.
다음 관찰을 고려하십시오.
-
path
는 필수 필드입니다. -
backendUsages
맵 키 이름은 백엔드의system_name
에 대한 참조입니다. 아래 예제에서는backendA
및backendB
입니다.
절차
다음 예와 같이 제품에 백엔드를 추가하여 사용을 선언적으로 정의합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" backendUsages: backendA: path: /A backendB: path: /B
8.9.10. 3scale 제품 사용자 정의 리소스에서 게이트웨이 응답 구성
3scale 관리자는 제품
사용자 지정 리소스를 구성하여 해당 API 제품에 대해 노출된 API 요청에 대한 게이트웨이 응답을 지정할 수 있습니다. CR을 배포한 후 3scale은 사용자가 지정한 응답 및 오류 메시지를 반환하도록 합니다.
Product
CR에서 gatewayResponse
오브젝트에는 게이트웨이가 반환할 응답이 포함되어 있습니다.
절차
새 제품 또는 배포된
제품
CR에서gatewayResponse
오브젝트에서 하나 이상의 응답을 구성합니다. 다음 예제에서는userKey
라는 인증 모드를 사용하여 Apicast 호스팅 배포에 대한 응답 구성을 보여줍니다.apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" deployment: apicastHosted: authentication: userkey: gatewayResponse: errorStatusAuthFailed: 500 errorHeadersAuthFailed: "text/plain; charset=mycharset" errorAuthFailed: "My custom reponse body" errorStatusAuthMissing: 500 errorHeadersAuthMissing: "text/plain; charset=mycharset" errorAuthMissing: "My custom reponse body" errorStatusNoMatch: 501 errorHeadersNoMatch: "text/plain; charset=mycharset" errorNoMatch: "My custom reponse body" errorStatusLimitsExceeded: 502 errorHeadersLimitsExceeded: "text/plain; charset=mycharset" errorLimitsExceeded: "My custom reponse body"
게이트웨이 응답이 포함된
Product
CR을 배포합니다. 예를 들어product1.yaml
파일을 업데이트한 경우 다음 명령을 실행합니다.oc create -f product1.yaml
주어진 예에서 출력은 다음과 같습니다.
product.capabilities.3scale.net/product1 created
8.9.11. 3scale 제품 사용자 정의 리소스에서 정책 체인 구성
3scale 관리자는 제품
사용자 지정 리소스를 구성하여 해당 API 제품에 적용할 정책 체인을 지정할 수 있습니다. CR을 배포한 후 3scale은 구성된 정책을 제품의 업스트림, 노출된 API에 적용합니다.
절차
신규 또는 배포된
제품
CR에서 정책 오브젝트에 하나 이상의정책을
구성합니다. 예를 들면 다음과 같습니다.apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" policies: - configuration: http_proxy: http://example.com https_proxy: https://example.com enabled: true name: camel version: builtin - configuration: {} enabled: true name: apicast version: builtin
각 정책에 대해 다음 필드를 지정합니다.
-
정책에 매개 변수가 없는 경우 구성은 빈 중괄호
쌍입니다
. 정책에 매개 변수가 있는 경우 여기에 지정합니다. 지정해야 하는 매개변수의 이름은 API Gateway, APIcast 표준 정책의 관련 정책에 대한 설명서를 참조하십시오. -
enabled
는 정책을 켜거나 끌 수 있는 부울 스위치입니다. -
name
은 정책을 식별합니다.Product
사용자 지정 리소스가 연결되는 테넌트 범위의 고유한 이름입니다. 정책 이름을 식별하려면 API Gateway, APIcast 표준 정책의 관련 정책에 대한 설명서를 참조하십시오. 버전은
표준 정책 또는 사용자 지정 정책에 대한 사용자 정의 문자열에기본
제공됩니다. 예를 들어 사용자 지정 정책 버전을1.0
으로 설정할 수 있습니다.Product
CR에서apicast
정책을 지정하지 않으면 Operator가 이를 추가합니다.정책 체인이 관리 포털에 이미 정의된 경우 3scale toolbox
export
명령을 실행하여 정책 체인을.yaml
형식으로 내보낼 수 있습니다.내보내기
출력을Product
CR에 붙여넣을 수 있습니다. 예를 들어api-provider-account-one
이 3scale 공급자 계정의 이름이고my-api-product-one
이 내보내기하려는 정책 체인이 있는 제품의 이름인 경우 다음 명령을 실행합니다.
3scale policies export api-provider-account-one my-api-product-one
-
정책에 매개 변수가 없는 경우 구성은 빈 중괄호
정책 체인이 포함된
Product
CR을 배포합니다. 예를 들어product1.yaml
파일을 업데이트한 경우 다음 명령을 실행합니다.oc create -f product1.yaml
주어진 예에서 출력은 다음과 같습니다.
product.capabilities.3scale.net/product1 created
8.9.12. 제품 사용자 정의 리소스의 상태
status 필드에는 최종 사용자에게 유용한 리소스 정보가 표시됩니다. 수동으로 업데이트하려는 것은 아니며 리소스 변경 시 동기화됩니다.
다음은 status 필드의 속성입니다.
-
productId
: 3scale 제품의 내부 식별자입니다. 조건
:status.Conditions
Kubernetes 공통 패턴을 나타냅니다. 다음과 같은 유형이 있습니다.- 실패: 동기화하는 동안 오류가 발생했습니다. 이 작업은 다시 시도합니다.
- 동기화됨: 제품이 성공적으로 동기화되었습니다.
- 잘못된: 올바르지 않은 객체입니다. 일시적인 오류는 아니지만 잘못된 사양에 대해 보고하고 변경해야 합니다. Operator는 다시 시도하지 않습니다.
- 고아: 사양은 존재하지 않는 리소스를 참조합니다. Operator가 다시 시도합니다.
-
observedGeneration
: 최신 리소스 사양을 사용하여 상태 정보가 업데이트되었는지 확인합니다. -
state
: 3scale 제품 내부 상태는 3scale API에서 읽습니다. -
providerAccountHost
: 백엔드가 동기화되는 3scale 공급자 계정 URL입니다.
동기화된 리소스의 예:
status: conditions: - lastTransitionTime: "2020-10-21T18:07:01Z" status: "False" type: Failed - lastTransitionTime: "2020-10-21T18:06:54Z" status: "False" type: Invalid - lastTransitionTime: "2020-10-21T18:07:01Z" status: "False" type: Orphan - lastTransitionTime: "2020-10-21T18:07:01Z" status: "True" type: Synced observedGeneration: 1 productId: 2555417872138 providerAccountHost: https://3scale-admin.example.com state: incomplete
8.9.13. 테넌트 계정에 연결된 제품 사용자 정의 리소스
3scale Operator가 새로운 3scale 리소스를 찾으면 LookupProviderAccount 프로세스는 리소스를 소유한 테넌트를 식별하기 위한 목적으로 시작됩니다.
이 프로세스는 테넌트 자격 증명 소스를 확인합니다. 찾을 수 없는 경우 오류가 발생합니다.
다음 단계에서는 프로세스가 테넌트 자격 증명 소스를 확인하는 방법을 설명합니다.
providerAccountRef 리소스 속성에서 자격 증명을 확인합니다. 이는 보안 로컬 참조입니다. 예를 들어 mytenant:
apiVersion: capabilities.3scale.net/v1beta1 kind: Product metadata: name: product1 spec: name: "OperatedProduct 1" providerAccountRef: name: mytenant
mytenant 시크릿에는 테넌트 자격 증명으로 채워진 adminURL 및 token 필드가 있어야 합니다. 예를 들면 다음과 같습니다.
apiVersion: v1 kind: Secret metadata: name: mytenant type: Opaque stringData: adminURL: https://my3scale-admin.example.com:443 token: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
기본 3scale-provider-account 시크릿을 확인합니다. 예:
adminURL=https://3scale-admin.example.com
및token=123456
:oc create secret generic threescale-provider-account --from-literal=adminURL=https://3scale-admin.example.com --from-literal=token=123456
- 3scale 배포의 동일한 네임스페이스에서 기본 공급자 계정을 확인합니다. 3scale 설치가 사용자 지정 리소스와 동일한 네임스페이스에 있는 경우 Operator는 기본 3scale 테넌트(공급자 계정)에 대해 필요한 자격 증명을 자동으로 수집합니다.