8.9. 기능과 관련된 제품 사용자 정의 리소스

• applicationPlans map 키 이름이 system_name 으로 사용됩니다. 아래 예제에서는 plan01 및 plan02 입니다.

절차

• 다음 예와 같이 새 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

• 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

• 에서 ,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

• issuerType:RH-SSO(Red Hat Single Sign-On) 및 타사 IdP와 통합할 때 나머지 값을 사용할 때의 키cloak 값입니다.
• issuerEndpoint: 필요한 인증 정보가 있는 URL입니다.

사전 요구 사항

• RH-SSO를 구성해야 합니다. Red Hat Single Sign-On 구성을 참조하십시오.
• 타사 ID 공급자와 HTTP 통합을 구성해야 합니다.

추가 리소스

• 제품 CRD 참조.

• 메트릭 맵 키 이름은 system_name 으로 사용됩니다. 아래 예에서 metric01 을 입력하고 에 도달합니다.
• 지표 맵 키 이름은 모든 메트릭 및 방법 간에 고유해야 합니다.
• 단위 및 friendlyName 은 필수 필드입니다.
• hits 지표를 추가하지 않으면 Operator가 생성합니다.

절차

• 다음 예와 같이 새 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"

• 방법 맵 키 이름은 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

• httpMethod,패턴,increment 및 metricMethodRef 는 필수 필드입니다.
• metricMethodRef 에는 기존 지표 또는 메서드 맵 키 이름 system_name 에 대한 참조가 있습니다. 아래 예제에서 를 누릅니다.

절차

• 다음 예와 같이 새 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

• 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

• ProductID: 3scale 제품의 내부 식별자입니다.

• conditions: status.Conditions Kubernetes 일반적인 패턴을 나타냅니다. 이러한 유형 또는 상태:

  • 실패: 동기화 중 오류가 발생했습니다. 작업이 다시 시도합니다.
  • synced: 제품이 성공적으로 동기화되었습니다.
  • 유효하지 않음: 잘못된 오브젝트. 이는 일시적인 오류가 아니지만 잘못된 사양에 대해 보고하므로 변경해야 합니다. Operator는 재시도하지 않습니다.
  • orphan: 사양은 존재하지 않는 리소스를 참조합니다. Operator가 다시 시도합니다.
• observedGeneration: 최신 리소스 사양으로 상태 정보가 업데이트되었는지 확인합니다.
• State: 3scale API에서 읽은 3scale 제품 내부 상태입니다.
• providerAccountHost: 백엔드가 동기화되는 3scale 공급자 계정 URL입니다.

사전 요구 사항

• 3scale 관리자 권한 또는 삭제하려는 사용자 정의 리소스가 포함된 네임스페이스에서 삭제 권한이 있는 OpenShift 역할. 특정 제품 사용자 정의 리소스를 삭제할 수 있는 사용자를 확인하려면 oc policy who-can delete 명령을 실행합니다. 예를 들어 CR의 이름이 myproduct 인 경우 다음 명령을 실행합니다.

  oc policy who-can delete product.capabilities.3scale.net/myproduct

• 유효한 테넌트에 대한 링크를 삭제할 Product CR입니다.

절차

• oc delete 명령을 실행하여 Product 사용자 정의 리소스를 삭제합니다. 예를 들어 myproduct.yaml 파일에 정의된 제품을 배포한 경우 다음 명령을 실행합니다.

  oc delete -f myproduct.yaml

  또는 oc delete 명령을 실행하고 정의에 지정된 대로 제품의 이름을 지정할 수 있습니다. 예를 들어 다음과 같습니다.

  oc delete product.capabilities.3scale.net/myproduct