Kubernetes용 Apigee APIM Operator 리소스 참조

이 페이지는 Apigee에 적용되지만 Apigee Hybrid에는 적용되지 않습니다.

Apigee Edge 문서 보기

이 페이지는 Kubernetes용 Apigee APIM Operator(프리뷰)에서 지원하는 각 Kubernetes 리소스에 관한 참조 페이지입니다. 선택사항으로 명시되지 않는 한 모든 필드를 작성해야 합니다.

APIProduct

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

APIProduct
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: APIProductSpec

spec은 APIProductSet에 대해 원하는 상태를 정의합니다.

APIProductSpec

필드 설명
name

유형: string

API 제품의 이름입니다.
approvalType

유형: string

API 제품에서 정의된 API에 액세스하도록 API 키가 승인되는 방식을 지정하는 플래그입니다. manual로 설정하면 고객 키가 생성되어 pending으로 반환됩니다. 이 경우 API 키가 명시적으로 승인될 때까지 작동하지 않습니다.

auto로 설정하면 소비자 키가 생성되어 approved로 반환되며 즉시 사용할 수 있습니다.

description

유형: string

API 제품에 대한 설명입니다.
displayName

유형: string

API 액세스를 등록하는 개발자에게 UI 또는 개발자 포털에 표시되는 이름입니다.
analytics

유형: Analytics

이 제품과 연결된 작업에 대해 분석을 수집해야 하는지 여부를 정의합니다.
enforcementRefs

유형: Array

API 제품에 적용할 EnforcementRef 리소스 배열입니다.
attributes

유형: Array

고객별 메타데이터로 기본 API 제품 프로필을 확장하는 데 사용할 수 있는 속성의 배열입니다.

EnforcementRef

필드 설명
name

유형: string

대상 리소스의 이름입니다.
kind

유형: string

APIMExtensionPolicy
group

유형: string

Apigee APIM Operator의 APIGroup(apim.googleapis.com)입니다.
namespace

유형: string

(선택사항) 참조 대상의 네임스페이스입니다. 지정하지 않으면 로컬 네임스페이스가 추론됩니다.

속성

필드 설명
name

유형: string

속성의 키입니다.
value

유형: string

속성의 값입니다.

APIOperationSet

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

APIOperationSet
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: APIOperationSetSpec

APIOperationSet에 대해 원하는 상태를 정의합니다.

APIOperationSetSpec

필드 설명
quota

유형: Quota

할당량 정의입니다.
restOperations

유형: Array

RESTOperation 정의 배열입니다.
apiProductRefs

유형: Array

APIProductRef 리소스 배열 또는 RESTOperation이 적용되어야 하는 API 제품 참조입니다.

할당량

필드 설명
limit

유형: integer

지정된 interval 및 timeUnit에 대해 API 제품에서 앱별로 허용하는 요청 메시지 수입니다.
interval

유형: integer

요청 메시지 수가 계산되는 시간 간격입니다.
timeUnit

유형: string

간격에 정의된 시간 단위입니다. 유효한 값은 minute, hour, day 또는 month입니다.

RESTOperation

필드 설명
name

유형: string

REST 작업의 이름입니다.
path

유형: string

methods와 함께 사용되는 path는 할당량 또는 API 제품과 일치하는 HTTP 경로입니다.
methods

유형: array

path와 함께 사용되는 methods는 할당량 또는 API 제품과 일치하는 관련 HTTP 메서드의 목록(strings)입니다.

APIProductRef

필드 설명
name

유형: string

대상 리소스의 이름입니다.
kind

유형: string

APIProduct
group

유형: string

Apigee APIM Operator의 APIGroup(apim.googleapis.com)입니다.
namespace

유형: string

(선택사항) 참조 대상의 네임스페이스입니다. 지정하지 않으면 로컬 네임스페이스가 추론됩니다.

APIMExtensionPolicy

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

APIMExtensionPolicy
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: APIMExtensionPolicySpec

APIMExtensionPolicy에 대해 원하는 상태를 정의합니다.

APIMExtensionPolicySpec

필드 설명
apigeeEnv (선택사항) Apigee 환경입니다.

제공되지 않으면 새 환경이 생성되어 사용 가능한 모든 인스턴스에 연결됩니다.

제공된 경우 외부 전역 부하 분산기를 사용하는 동안 이 환경을 사용 가능한 모든 인스턴스에 연결해야 합니다.

failOpen

유형: boolean

Apigee 런타임에 연결할 수 없는 경우 장애 허용 여부를 지정합니다. true로 설정하면 런타임에 연결할 수 없더라도 Apigee 런타임 호출이 성공한 것으로 간주됩니다.
timeout

유형: string

Apigee 런타임 호출이 실패하기 전까지의 제한 시간(초 또는 밀리초)을 지정합니다. 예를 들면 10s입니다.
targetRef

유형: ExtensionServerRef

확장 프로그램이 설치되어야 하는 Google Kubernetes Engine 게이트웨이를 식별합니다.
location

유형: string

APIMExtensionPolicy가 적용되는 Google Cloud 위치를 식별합니다.

ExtensionServerRef

필드 설명
name

유형: string

대상 리소스의 이름입니다.
kind

유형: string

대상 리소스의 kind(예: Gateway 또는 Service)를 지정합니다.
group

유형: string

Apigee APIM Operator의 APIGroup(apim.googleapis.com)입니다.
namespace

유형: string

(선택사항) 참조 대상의 네임스페이스입니다. 지정하지 않으면 로컬 네임스페이스가 추론됩니다.

ApigeeGatewayPolicy

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

ApigeeGatewayPolicy
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: ApigeeGatewayPolicySpec

ApigeeGatewayPolicy에 대해 원하는 상태를 정의합니다.

ApigeeGatewayPolicySpec

필드 설명
ref

유형: ExtensionServerRef

GKE 게이트웨이에 적용된 정책을 제어하기 위해 만든 APIM 템플릿을 참조합니다.
targetRef

유형: ExtensionServerRef

이 특정 게이트웨이 정책을 적용해야 하는 APIM 확장 프로그램 정책을 참조합니다. GKE 게이트웨이를 간접적으로 참조합니다.
serviceAccount (선택사항) Apigee ProApigee 프록시에서 Google 승인 토큰을 생성하는 데 사용되는 서비스 계정을 지정합니다.

ApimTemplate

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

ApimTemplate
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: ApimTemplateSpec

ApimTemplate에 대해 원하는 상태를 정의합니다.

ApimTemplateSpec

필드 설명
templates

유형: list

요청 흐름에서 실행할 정책을 지정하는 ApimTemplateFlow 리소스 목록입니다.
apimTemplateRule

유형: ExtensionServerRef

적용된 정책을 검증하는 데 사용해야 하는 APIM 템플릿 규칙을 지정합니다.

ApimTemplateFlow

필드 설명
policies

유형: list ConditionalParameterReference

요청 흐름의 일부로 실행할 정책의 순서가 지정된 목록을 지정하는 ConditionalParameterReference 리소스 목록입니다.
condition

유형: string

 이 리소스를 실행하기 위한 조건을 지정합니다.

ConditionalParameterReference

필드 설명
condition

Type: string

 이 리소스를 실행하기 위한 조건을 지정합니다.

ApimTemplateRule

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

ApimTemplateRule
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: ApimTemplateRuleSpec

ApimTemplateRule에 대해 원하는 상태를 정의합니다.

ApimTemplateRuleSpec

필드 설명
requiredList ApimTemplate에 있어야 하는 정책 목록(strings)입니다.
denyList ApimTemplate에 있어서는 안 되는 정책 목록(strings)입니다.
allowList ApimTemplate에 있을 수 있지만 필수는 아닌 정책 목록(strings)입니다.
override

유형: boolean

 규칙을 사용하는 APIM 템플릿이 있는 경우 APIM 템플릿 규칙의 업데이트를 재정의합니다. 유효한 값은 true 또는 false입니다.

자바스크립트

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

JavaScript
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: JavascriptBean

JavaScript 정책에 대해 원하는 상태를 정의합니다.

JavascriptBean

필드 설명
mode

유형: array

ProxyRequest 또는 ProxyResponse를 지정하는 strings 배열입니다. 정책이 요청 흐름에 연결되어 있는지 또는 응답 흐름에 연결되어 있는지 결정합니다.
source

유형: string

인라인 JavaScript 코드입니다.
timeLimit

유형: integer

JavaScript 코드 실행의 제한 시간을 지정합니다.

SpikeArrest

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

SpikeArrest
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: SpikeArrestBean

SpikeArrest 정책에 대해 원하는 상태를 정의합니다.

SpikeArrestBean

필드 설명
mode

유형: array

ProxyRequest 또는 ProxyResponse를 지정하는 strings 배열입니다. 정책이 요청 흐름에 연결되어 있는지 또는 응답 흐름에 연결되어 있는지 결정합니다.
peakMessageRate

유형: peakMessageRate

SpikeArrest의 메시지 비율을 지정합니다.
useEffectiveCount

유형: boolean

true로 설정하면 SpikeArrest가 리전에 배포되며 리전의 Apigee 메시지 프로세서(MP) 간에 요청 수가 동기화됩니다.

false로 설정하면 SpikeArrest가 로컬에서 토큰 버킷 알고리즘을 사용합니다. 자세한 내용은 UseEffectiveCount를 참조하세요.

peakMessageRate

필드 설명
ref

유형: string

rate 값을 참조하는 변수입니다.
value

유형: string

참조를 사용할 수 없는 경우 실제 rate 값입니다.

AssignMessage(Google 토큰 삽입)

필드 설명
apiVersion

유형: string

apim.googleapis.com/v1alpha1
kind

유형: string

AssignMessage
metadata

유형: Kubernetes meta/v1.ObjectMeta

metadata에서 사용할 수 있는 필드는 Kubernetes API 문서를 참조하세요.
spec

유형: AssignMessageBean

AssignMessage 정책에 대해 원하는 상태를 정의합니다.

AssignMessageBean

필드 설명
setActions

유형: array

SetActionsBean 객체의 배열입니다. AssignTo 요소로 지정된 요청 또는 응답에서 기존 속성 값을 대체합니다.

헤더 또는 파라미터가 원본 메시지에 이미 있는 경우 setActions는 값을 덮어씁니다. 그 밖의 경우 setActions에서 지정된 대로 새 헤더 또는 파라미터를 추가합니다.

AssignTo

유형: AssignToBean

AssignMessage 정책이 작동하는 메시지를 지정합니다. 옵션에는 요청, 응답 또는 새 커스텀 메시지가 포함됩니다.

SetActionsBean

필드 설명
Authentication

유형: AuthenticationBean

Google OAuth 2.0 또는 OpenID Connect 토큰을 생성하여 Cloud Run Functions 및 Cloud Run과 같은 특정 Google Cloud 제품에서 실행되는 Google 서비스 또는 커스텀 서비스에 인증된 호출을 수행합니다.

AuthenticationBean

필드 설명
GoogleAccessToken

유형: GoogleAccessTokenBean

Google OAuth 2.0 토큰을 생성하여 Google 서비스에 인증된 호출을 수행합니다.
GoogleIDToken

유형: GoogleIDTokenBean

대상 요청을 인증하기 위해 OpenID Connect 토큰을 생성하는 구성입니다.
headerName

유형: string

기본적으로 인증 구성이 있는 경우 Apigee는 Bearer 토큰을 생성하고 대상 시스템으로 전송되는 메시지의 승인 헤더에 이를 삽입합니다. headerName 요소를 사용하면 해당 Bearer 토큰을 보유할 다른 헤더의 이름을 지정할 수 있습니다.

GoogleAccessTokenBean

필드 설명
scopes

유형: array

유효한 Google API 범위를 지정하는 strings 배열입니다. 자세한 내용은 Google API의 OAuth 2.0 범위를 참조하세요.
LifetimeInSeconds

유형: integer

액세스 토큰의 전체 기간을 초 단위로 지정합니다.

GoogleIDTokenBean

필드 설명
Audience

유형: AudienceBean

토큰에서 액세스 권한을 부여받은 API 또는 서비스 계정과 같은 생성된 인증 토큰의 대상입니다.
IncludeEmail

유형: boolean

true로 설정하면 생성된 인증 토큰에 서비스 계정 email 및 email_verified 클레임이 포함됩니다.

AudienceBean

필드 설명
useTargetHost

유형: string

Audience 값이 비어 있거나 ref 변수가 유효한 값으로 확인되지 않고 useTargetUrl이 true인 경우 대상의 URL(쿼리 매개변수 제외)이 대상으로 사용됩니다.
useTargetUrl

유형: boolean

useTargetUrl의 기본값은 false입니다.

AssignToBean

필드 설명
createNew

유형: boolean

값을 할당할 때 이 정책이 새 메시지를 만들지 여부를 결정합니다. true로 설정하면 정책에서 새 메시지를 만듭니다.
type

유형: string

CreateNew가 true로 설정된 경우 새 메시지의 유형을 지정합니다. 유효한 값은 request 또는 response입니다.