8.8. 기능과 관련된 백엔드 사용자 정의 리소스
새로 생성된 테넌트에 Openshift Container Platform을 사용하면 백엔드, 해당 메트릭, 방법 및 매핑 규칙을 구성합니다. 백엔드 사용자 지정 리소스의 상태와 백엔드가 테넌트 계정에 연결되는 방법도 알아봅니다.
사전 요구 사항
일반 사전 요구 사항에 나열된 것과 동일한 설치 요구 사항은 다음과 같습니다.
- 3scale 계정의 최소 필수 매개변수는 Admin Portal URL 주소 및 액세스 토큰입니다.
8.8.1. 기능과 관련된 백엔드 사용자 정의 리소스 배포 링크 복사링크가 클립보드에 복사되었습니다!
새로 생성된 테넌트에 Openshift Container Platform을 사용하면 새 백엔드를 구성합니다.
절차
- OpenShift 계정에서 Installed operator 로 이동합니다.
- 3scale Operator를 클릭합니다.
- 3scale 백엔드에서 인스턴스 생성을 클릭합니다.
- YAML 보기를 선택합니다.
특정 3scale 관리자 URL 주소를 가리키는 3scale 백엔드를 생성합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: <your_backend_OpenShift_name> spec: name: "<your_backend_name>" privateBaseURL: "<your_admin_portal_URL>"
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: <your_backend_OpenShift_name> spec: name: "<your_backend_name>" privateBaseURL: "<your_admin_portal_URL>"Copy to Clipboard Copied! Toggle word wrap Toggle overflow 예를 들어 다음과 같습니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com"
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com"Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 변경 사항을 저장하려면 만들기를 클릭합니다.
OpenShift에서 백엔드와 3scale 계정으로 백엔드를 생성할 수 있도록 몇 초 정도 기다립니다. 다음 검증을 수행할 수 있습니다.
-
3scale 백엔드 개요 페이지에서 Synced 조건이
True로 표시되어 있는지 확인하여 OpenShift에서 백엔드 가 생성되었는지 확인합니다. -
3scale 계정으로 이동하여 백엔드가 생성된 것을 확인할 수 있습니다. 위의 예에서는
내 백엔드 이름이라는 새 백엔드가 표시됩니다.
-
3scale 백엔드 개요 페이지에서 Synced 조건이
8.8.2. 백엔드 지표 정의 링크 복사링크가 클립보드에 복사되었습니다!
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 백엔드 사용자 정의 리소스에 원하는 백엔드 지표를 정의합니다.
이러한 관찰을 고려하십시오.
-
지표맵 키 이름은system_name으로 사용됩니다. 아래 예에서 metrics01,metric02및hits. -
지표맵 키 이름은 모든 메트릭 및 방법 중에서 고유해야 합니다. -
unit및friendlyName은 필수 필드입니다. -
적중메트릭을 추가하지 않으면 이 메트릭이 Operator에 의해 생성됩니다.
절차
다음 예제와 같이 새 3scale 백엔드에 백엔드 지표를 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" metrics: metric01: friendlyName: Metric01 unit: "1" metric02: friendlyName: Metric02 unit: "1" hits: description: Number of API hits friendlyName: Hits unit: "hitapiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" metrics: metric01: friendlyName: Metric01 unit: "1" metric02: friendlyName: Metric02 unit: "1" hits: description: Number of API hits friendlyName: Hits unit: "hitCopy to Clipboard Copied! Toggle word wrap Toggle overflow
8.8.3. 백엔드 메서드 정의 링크 복사링크가 클립보드에 복사되었습니다!
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 백엔드 사용자 정의 리소스에서 원하는 백엔드 방법을 정의합니다.
이러한 관찰을 고려하십시오.
-
메서드맵 키 이름은system_name으로 사용됩니다. 아래 예에서Method01및Method02. -
메서드매핑 키 이름은 모든 메트릭 및 메서드 간에 고유해야 합니다. -
FriendlyName은 필수 필드입니다.
절차
다음 예제와 같이 새 3scale 백엔드에 백엔드 메서드를 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" methods: method01: friendlyName: Method01 method02: friendlyName: Method02apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" methods: method01: friendlyName: Method01 method02: friendlyName: Method02Copy to Clipboard Copied! Toggle word wrap Toggle overflow
8.8.4. 백엔드 매핑 규칙 정의 링크 복사링크가 클립보드에 복사되었습니다!
새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 백엔드 사용자 정의 리소스에서 원하는 백엔드 매핑 규칙을 정의합니다.
이러한 관찰을 고려하십시오.
-
httpMethod,pattern,increment및metricMethodRef는 필수 필드입니다. -
metricMethodRef에는 기존 메트릭 또는 메서드 맵 키 이름system_name에 대한 참조가 있습니다. 아래 예제에서hits.
절차
다음 예제와 같이 새 3scale 백엔드에 백엔드 매핑 규칙을 추가합니다.
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" mappingRules: - httpMethod: GET pattern: "/pets" increment: 1 metricMethodRef: hits - httpMethod: GET pattern: "/pets/id" increment: 1 metricMethodRef: hits metrics: hits: description: Number of API hits friendlyName: Hits unit: "hit"apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" mappingRules: - httpMethod: GET pattern: "/pets" increment: 1 metricMethodRef: hits - httpMethod: GET pattern: "/pets/id" increment: 1 metricMethodRef: hits metrics: hits: description: Number of API hits friendlyName: Hits unit: "hit"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
8.8.5. 백엔드 사용자 정의 리소스의 상태 링크 복사링크가 클립보드에 복사되었습니다!
status 필드에는 최종 사용자에게 유용한 리소스 정보가 표시됩니다. 이는 수동으로 업데이트할 수 없으며 모든 리소스 변경 시 동기화됩니다.
이는 status 필드의 속성입니다.
-
backendId: 3scale 백엔드의 내부 식별자입니다. conditions:status.ConditionsKubernetes 공통 패턴을 나타냅니다. 다음과 같은 유형 또는 상태가 있습니다.-
invalid:
BackendSpec의 구성 조합은 지원되지 않습니다. 이는 일시적인 오류는 아니지만 진행을 수행하기 전에 수정해야 하는 상태를 나타냅니다. - synced: 백엔드가 성공적으로 동기화되었습니다.
- Failed: 동기화하는 동안 오류가 발생했습니다.
-
invalid:
-
observedGener: 상태 정보가 최신 리소스 사양으로 업데이트되었는지 확인하는 도우미 필드입니다.
동기화 리소스의 예:
status:
backendId: 59978
conditions:
- lastTransitionTime: "2020-06-22T10:50:33Z"
status: "False"
type: Failed
- lastTransitionTime: "2020-06-22T10:50:33Z"
status: "False"
type: Invalid
- lastTransitionTime: "2020-06-22T10:50:33Z"
status: "True"
type: Synced
observedGeneration: 2
status:
backendId: 59978
conditions:
- lastTransitionTime: "2020-06-22T10:50:33Z"
status: "False"
type: Failed
- lastTransitionTime: "2020-06-22T10:50:33Z"
status: "False"
type: Invalid
- lastTransitionTime: "2020-06-22T10:50:33Z"
status: "True"
type: Synced
observedGeneration: 2
8.8.6. 테넌트 계정에 연결된 백엔드 사용자 정의 리소스 링크 복사링크가 클립보드에 복사되었습니다!
3scale Operator에서 새 3scale 리소스를 찾으면 lookupProviderAccount 프로세스는 리소스를 소유하는 테넌트를 식별하는 목적으로 시작됩니다.
이 프로세스에서는 테넌트 인증 정보 소스를 확인합니다. 찾을 수 없는 경우 오류가 발생합니다.
다음 단계에서는 프로세스에서 테넌트 인증 정보 소스를 확인하는 방법을 설명합니다.
providerAccountRef 리소스 속성에서 인증 정보를 확인합니다. 시크릿 로컬 참조입니다. 예를 들면 mytenant:
apiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" providerAccountRef: name: mytenantapiVersion: capabilities.3scale.net/v1beta1 kind: Backend metadata: name: backend-1 spec: name: "My Backend Name" privateBaseURL: "https://api.example.com" providerAccountRef: name: mytenantCopy to Clipboard Copied! Toggle word wrap Toggle overflow mytenant 시크릿에는 테넌트 자격 증명으로 채워진 adminURL 및 토큰 필드가 있어야 합니다. 예를 들어 다음과 같습니다.
apiVersion: v1 kind: Secret metadata: name: mytenant type: Opaque stringData: adminURL: https://my3scale-admin.example.com:443 token: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
apiVersion: v1 kind: Secret metadata: name: mytenant type: Opaque stringData: adminURL: https://my3scale-admin.example.com:443 token: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"Copy to Clipboard Copied! Toggle word wrap Toggle overflow 기본 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
oc create secret generic threescale-provider-account --from-literal=adminURL=https://3scale-admin.example.com --from-literal=token=123456Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 3scale 배포의 동일한 네임스페이스에서 기본 공급자 계정을 확인합니다. Operator는 3scale 설치가 사용자 정의 리소스와 동일한 네임스페이스에 있는 경우 기본 3scale 테넌트(provider 계정)에 필요한 인증 정보를 자동으로 수집합니다.
8.8.7. 백엔드 사용자 정의 리소스 삭제 링크 복사링크가 클립보드에 복사되었습니다!
백엔드 엔터티를 관리하는 CR(사용자 정의 리소스) 을 삭제하여 백엔드 엔터티를 삭제할 수 있습니다. 백엔드 CR을 삭제하면 3scale Operator에서 삭제된 백엔드를 참조하는 배포된 Product CR을 업데이트합니다. 업데이트는 다음 특성에 있습니다.
-
backendUsages -
applicationPlans
이러한 속성은 더 이상 삭제된 백엔드를 참조하지 않습니다.
백엔드 CR에서 정의한 API 백엔드를 삭제하는 유일한 방법은 여기에 설명된 절차를 따르는 것입니다. Admin Portal 또는 3scale API를 사용하여 사용자 정의 리소스로 배포된 백엔드를 삭제하지 마십시오.
사전 요구 사항
3scale 관리자 권한 또는 삭제하려는
백엔드CR이 포함된 네임스페이스에서 권한을 삭제하는 OpenShift 역할입니다. 특정백엔드사용자 정의 리소스를 삭제할 수 있는 사람을 확인하려면oc policy who-can delete명령을 실행합니다. 예를 들어 CR의 이름이mybackend인 경우 다음 명령을 실행합니다.oc policy who-can delete product.capabilities.3scale.net/mybackend
oc policy who-can delete product.capabilities.3scale.net/mybackendCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
삭제할
백엔드CR은 유효한 테넌트에 대한 링크입니다.
절차
oc delete명령을 실행하여백엔드 사용자 정의리소스를 삭제합니다. 예를 들어mybackend.yaml파일에 정의된 백엔드를 배포한 경우 다음 명령을 실행합니다.oc delete -f mybackend.yaml
oc delete -f mybackend.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 또는
oc delete명령을 실행하고 정의에 지정된 대로 백엔드 이름을 지정할 수 있습니다. 예를 들어 다음과 같습니다.oc delete backend.capabilities.3scale.net/mybackend
oc delete backend.capabilities.3scale.net/mybackendCopy to Clipboard Copied! Toggle word wrap Toggle overflow