Subscription

Subscription¶

Subscription is the Schema for the subscriptions API

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
SubscriptionSpec

`subscriptionStatus` string
`organization` string
`api` API
`ratelimitRef` RatelimitRef

status
SubscriptionStatus

SubscriptionSpec ¶

(Appears on: Subscription)

SubscriptionSpec defines the desired state of Subscription

Field	Description
`subscriptionStatus` string
`organization` string
`api` API

SubscriptionStatus ¶

(Appears on: Subscription)

SubscriptionStatus defines the observed state of Subscription

API ¶

(Appears on: SubscriptionSpec)

API defines the API associated with the subscription

Field	Description
`name` string	Name of the API associated with the subscription
`version` string	Version of the API associated with the subscription

API ¶

(Appears on: SubscriptionSpec)

RatelimitRef defines the RatelimitPolicy or AIRatelimitpolicy associated with the subscription

Field	Description
`name` string	Name of the RatelimitPolicy\|AIRatelimitPolicy associated with the subscription
`level` string	Whether the policy should be applied to application or subscription level(NOT SUPPORTED YET. Currently subscription level is the default.)

Generated with gen-crd-api-reference-docs.

Subscription Sample¶

The following is a sample Subscription CR.

apiVersion: cp.wso2.com/v1alpha2
kind: Subscription
metadata:
  name: sample-subscription
spec:
  subscriptionStatus: ACTIVE
  organization: carbon.super
  api:
    name: AppSubTestAPI
    version: ^1.*|^v1$
  ratelimitRef:
    name : llm-backend-rl-subs
    level: subscription