1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: stable
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: pubsubsubscriptions.pubsub.cnrm.cloud.google.com
13spec:
14 group: pubsub.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: PubSubSubscription
19 plural: pubsubsubscriptions
20 shortNames:
21 - gcppubsubsubscription
22 - gcppubsubsubscriptions
23 singular: pubsubsubscription
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1beta1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 ackDeadlineSeconds:
62 description: |-
63 This value is the maximum time after a subscriber receives a message
64 before the subscriber should acknowledge the message. After message
65 delivery but before the ack deadline expires and before the message is
66 acknowledged, it is an outstanding message and will not be delivered
67 again during that time (on a best-effort basis).
68
69 For pull subscriptions, this value is used as the initial value for
70 the ack deadline. To override this value for a given message, call
71 subscriptions.modifyAckDeadline with the corresponding ackId if using
72 pull. The minimum custom deadline you can specify is 10 seconds. The
73 maximum custom deadline you can specify is 600 seconds (10 minutes).
74 If this parameter is 0, a default value of 10 seconds is used.
75
76 For push delivery, this value is also used to set the request timeout
77 for the call to the push endpoint.
78
79 If the subscriber never acknowledges the message, the Pub/Sub system
80 will eventually redeliver the message.
81 type: integer
82 bigqueryConfig:
83 description: |-
84 If delivery to BigQuery is used with this subscription, this field is used to configure it.
85 Either pushConfig or bigQueryConfig can be set, but not both.
86 If both are empty, then the subscriber will pull and ack messages using API methods.
87 properties:
88 dropUnknownFields:
89 description: |-
90 When true and useTopicSchema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery.
91 Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
92 type: boolean
93 tableRef:
94 description: The name of the table to which to write data.
95 oneOf:
96 - not:
97 required:
98 - external
99 required:
100 - name
101 - not:
102 anyOf:
103 - required:
104 - name
105 - required:
106 - namespace
107 required:
108 - external
109 properties:
110 external:
111 description: 'Allowed value: string of the format `{{project}}.{{dataset_id}}.{{value}}`,
112 where {{value}} is the `name` field of a `BigQueryTable`
113 resource.'
114 type: string
115 name:
116 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
117 type: string
118 namespace:
119 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
120 type: string
121 type: object
122 useTopicSchema:
123 description: When true, use the topic's schema as the columns
124 to write to in BigQuery, if it exists.
125 type: boolean
126 writeMetadata:
127 description: |-
128 When true, write the subscription name, messageId, publishTime, attributes, and orderingKey to additional columns in the table.
129 The subscription name, messageId, and publishTime fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
130 type: boolean
131 required:
132 - tableRef
133 type: object
134 deadLetterPolicy:
135 description: |-
136 A policy that specifies the conditions for dead lettering messages in
137 this subscription. If dead_letter_policy is not set, dead lettering
138 is disabled.
139
140 The Cloud Pub/Sub service account associated with this subscription's
141 parent project (i.e.,
142 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
143 permission to Acknowledge() messages on this subscription.
144 properties:
145 deadLetterTopicRef:
146 oneOf:
147 - not:
148 required:
149 - external
150 required:
151 - name
152 - not:
153 anyOf:
154 - required:
155 - name
156 - required:
157 - namespace
158 required:
159 - external
160 properties:
161 external:
162 description: 'Allowed value: string of the format `projects/{{project}}/topics/{{value}}`,
163 where {{value}} is the `name` field of a `PubSubTopic` resource.'
164 type: string
165 name:
166 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
167 type: string
168 namespace:
169 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
170 type: string
171 type: object
172 maxDeliveryAttempts:
173 description: |-
174 The maximum number of delivery attempts for any message. The value must be
175 between 5 and 100.
176
177 The number of delivery attempts is defined as 1 + (the sum of number of
178 NACKs and number of times the acknowledgement deadline has been exceeded for the message).
179
180 A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
181 client libraries may automatically extend ack_deadlines.
182
183 This field will be honored on a best effort basis.
184
185 If this parameter is 0, a default value of 5 is used.
186 type: integer
187 type: object
188 enableExactlyOnceDelivery:
189 description: |-
190 If 'true', Pub/Sub provides the following guarantees for the delivery
191 of a message with a given value of messageId on this Subscriptions':
192
193 - The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.
194
195 - An acknowledged message will not be resent to a subscriber.
196
197 Note that subscribers may still receive multiple copies of a message when 'enable_exactly_once_delivery'
198 is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values.
199 type: boolean
200 enableMessageOrdering:
201 description: |-
202 Immutable. If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to
203 the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they
204 may be delivered in any order.
205 type: boolean
206 expirationPolicy:
207 description: |-
208 A policy that specifies the conditions for this subscription's expiration.
209 A subscription is considered active as long as any connected subscriber
210 is successfully consuming messages from the subscription or is issuing
211 operations on the subscription. If expirationPolicy is not set, a default
212 policy with ttl of 31 days will be used. If it is set but ttl is "", the
213 resource never expires. The minimum allowed value for expirationPolicy.ttl
214 is 1 day.
215 properties:
216 ttl:
217 description: |-
218 Specifies the "time-to-live" duration for an associated resource. The
219 resource expires if it is not active for a period of ttl.
220 If ttl is set to "", the associated resource never expires.
221 A duration in seconds with up to nine fractional digits, terminated by 's'.
222 Example - "3.5s".
223 type: string
224 required:
225 - ttl
226 type: object
227 filter:
228 description: |-
229 Immutable. The subscription only delivers the messages that match the filter.
230 Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages
231 by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription,
232 you can't modify the filter.
233 type: string
234 messageRetentionDuration:
235 description: |-
236 How long to retain unacknowledged messages in the subscription's
237 backlog, from the moment a message is published. If
238 retain_acked_messages is true, then this also configures the retention
239 of acknowledged messages, and thus configures how far back in time a
240 subscriptions.seek can be done. Defaults to 7 days. Cannot be more
241 than 7 days ('"604800s"') or less than 10 minutes ('"600s"').
242
243 A duration in seconds with up to nine fractional digits, terminated
244 by 's'. Example: '"600.5s"'.
245 type: string
246 pushConfig:
247 description: |-
248 If push delivery is used with this subscription, this field is used to
249 configure it. An empty pushConfig signifies that the subscriber will
250 pull and ack messages using API methods.
251 properties:
252 attributes:
253 additionalProperties:
254 type: string
255 description: |-
256 Endpoint configuration attributes.
257
258 Every endpoint has a set of API supported attributes that can
259 be used to control different aspects of the message delivery.
260
261 The currently supported attribute is x-goog-version, which you
262 can use to change the format of the pushed message. This
263 attribute indicates the version of the data expected by
264 the endpoint. This controls the shape of the pushed message
265 (i.e., its fields and metadata). The endpoint version is
266 based on the version of the Pub/Sub API.
267
268 If not present during the subscriptions.create call,
269 it will default to the version of the API used to make
270 such call. If not present during a subscriptions.modifyPushConfig
271 call, its value will not be changed. subscriptions.get
272 calls will always return a valid version, even if the
273 subscription was created without this attribute.
274
275 The possible values for this attribute are:
276
277 - v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
278 - v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API.
279 type: object
280 oidcToken:
281 description: |-
282 If specified, Pub/Sub will generate and attach an OIDC JWT token as
283 an Authorization header in the HTTP request for every pushed message.
284 properties:
285 audience:
286 description: |-
287 Audience to be used when generating OIDC token. The audience claim
288 identifies the recipients that the JWT is intended for. The audience
289 value is a single case-sensitive string. Having multiple values (array)
290 for the audience field is not supported. More info about the OIDC JWT
291 token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
292 Note: if not specified, the Push endpoint URL will be used.
293 type: string
294 serviceAccountEmail:
295 description: |-
296 Service account email to be used for generating the OIDC token.
297 The caller (for subscriptions.create, subscriptions.patch, and
298 subscriptions.modifyPushConfig RPCs) must have the
299 iam.serviceAccounts.actAs permission for the service account.
300 type: string
301 required:
302 - serviceAccountEmail
303 type: object
304 pushEndpoint:
305 description: |-
306 A URL locating the endpoint to which messages should be pushed.
307 For example, a Webhook endpoint might use
308 "https://example.com/push".
309 type: string
310 required:
311 - pushEndpoint
312 type: object
313 resourceID:
314 description: Immutable. Optional. The name of the resource. Used for
315 creation and acquisition. When unset, the value of `metadata.name`
316 is used as the default.
317 type: string
318 retainAckedMessages:
319 description: |-
320 Indicates whether to retain acknowledged messages. If 'true', then
321 messages are not expunged from the subscription's backlog, even if
322 they are acknowledged, until they fall out of the
323 messageRetentionDuration window.
324 type: boolean
325 retryPolicy:
326 description: |-
327 A policy that specifies how Pub/Sub retries message delivery for this subscription.
328
329 If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers.
330 RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
331 properties:
332 maximumBackoff:
333 description: |-
334 The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
335 A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
336 type: string
337 minimumBackoff:
338 description: |-
339 The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
340 A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
341 type: string
342 type: object
343 topicRef:
344 description: Reference to a PubSubTopic.
345 oneOf:
346 - not:
347 required:
348 - external
349 required:
350 - name
351 - not:
352 anyOf:
353 - required:
354 - name
355 - required:
356 - namespace
357 required:
358 - external
359 properties:
360 external:
361 description: 'Allowed value: string of the format `projects/{{project}}/topics/{{value}}`,
362 where {{value}} is the `name` field of a `PubSubTopic` resource.'
363 type: string
364 name:
365 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
366 type: string
367 namespace:
368 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
369 type: string
370 type: object
371 required:
372 - topicRef
373 type: object
374 status:
375 properties:
376 conditions:
377 description: Conditions represent the latest available observation
378 of the resource's current state.
379 items:
380 properties:
381 lastTransitionTime:
382 description: Last time the condition transitioned from one status
383 to another.
384 type: string
385 message:
386 description: Human-readable message indicating details about
387 last transition.
388 type: string
389 reason:
390 description: Unique, one-word, CamelCase reason for the condition's
391 last transition.
392 type: string
393 status:
394 description: Status is the status of the condition. Can be True,
395 False, Unknown.
396 type: string
397 type:
398 description: Type is the type of the condition.
399 type: string
400 type: object
401 type: array
402 observedGeneration:
403 description: ObservedGeneration is the generation of the resource
404 that was most recently observed by the Config Connector controller.
405 If this is equal to metadata.generation, then that means that the
406 current reported status reflects the most recent desired state of
407 the resource.
408 type: integer
409 type: object
410 required:
411 - spec
412 type: object
413 served: true
414 storage: true
415 subresources:
416 status: {}
417status:
418 acceptedNames:
419 kind: ""
420 plural: ""
421 conditions: []
422 storedVersions: []
View as plain text