-
Notifications
You must be signed in to change notification settings - Fork 215
/
billingbudgets_v1beta1_billingbudgetsbudget.yaml
471 lines (468 loc) · 22.9 KB
/
billingbudgets_v1beta1_billingbudgetsbudget.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
cnrm.cloud.google.com/version: 1.122.0
creationTimestamp: null
labels:
cnrm.cloud.google.com/dcl2crd: "true"
cnrm.cloud.google.com/managed-by-kcc: "true"
cnrm.cloud.google.com/stability-level: stable
cnrm.cloud.google.com/system: "true"
name: billingbudgetsbudgets.billingbudgets.cnrm.cloud.google.com
spec:
group: billingbudgets.cnrm.cloud.google.com
names:
categories:
- gcp
kind: BillingBudgetsBudget
plural: billingbudgetsbudgets
shortNames:
- gcpbillingbudgetsbudget
- gcpbillingbudgetsbudgets
singular: billingbudgetsbudget
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- description: When 'True', the most recent reconcile of the resource succeeded
jsonPath: .status.conditions[?(@.type=='Ready')].status
name: Ready
type: string
- description: The reason for the value in 'Ready'
jsonPath: .status.conditions[?(@.type=='Ready')].reason
name: Status
type: string
- description: The last transition time for the value in 'Status'
jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
name: Status Age
type: date
name: v1beta1
schema:
openAPIV3Schema:
properties:
apiVersion:
description: 'apiVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
type: string
kind:
description: 'kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
properties:
allUpdatesRule:
description: Optional. Rules to apply to notifications sent based
on budget spend and thresholds.
properties:
disableDefaultIamRecipients:
description: Optional. When set to true, disables default notifications
sent when a threshold is exceeded. Default notifications are
sent to those with Billing Account Administrator and Billing
Account User IAM roles for the target account.
type: boolean
monitoringNotificationChannels:
items:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The Google Cloud resource name
of a `MonitoringNotificationChannel` resource (format:
`projects/{{project}}/notificationChannels/{{name}}`).'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
type: array
pubsubTopicRef:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: |-
Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have `pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.
Allowed value: The Google Cloud resource name of a `PubSubTopic` resource (format: `projects/{{project}}/topics/{{name}}`).
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
schemaVersion:
description: Optional. Required when NotificationsRule.pubsub_topic
is set. The schema version of the notification sent to NotificationsRule.pubsub_topic.
Only "1.0" is accepted. It represents the JSON schema as defined
in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
type: string
type: object
amount:
description: Required. Budgeted amount.
properties:
lastPeriodAmount:
description: Use the last period's actual spend as the budget
for the present period. LastPeriodAmount can only be set when
the budget's time period is a .
type: object
x-kubernetes-preserve-unknown-fields: true
specifiedAmount:
description: A specified amount to use as the budget. `currency_code`
is optional. If specified when creating a budget, it must match
the currency of the billing account. If specified when updating
a budget, it must match the currency_code of the existing budget.
The `currency_code` is provided on output.
properties:
currencyCode:
description: Immutable. The three-letter currency code defined
in ISO 4217.
type: string
nanos:
description: Number of nano (10^-9) units of the amount. The
value must be between -999,999,999 and +999,999,999 inclusive.
If `units` is positive, `nanos` must be positive or zero.
If `units` is zero, `nanos` can be positive, zero, or negative.
If `units` is negative, `nanos` must be negative or zero.
For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
format: int64
type: integer
units:
description: The whole units of the amount. For example if
`currencyCode` is `"USD"`, then 1 unit is one US dollar.
format: int64
type: integer
type: object
type: object
billingAccountRef:
description: Immutable.
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: |-
The billing account of the resource
Allowed value: The Google Cloud resource name of a Google Cloud Billing Account (format: `billingAccounts/{{name}}`).
type: string
name:
description: |-
[WARNING] BillingAccount not yet supported in Config Connector, use 'external' field to reference existing resources.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
budgetFilter:
description: Optional. Filters that define which resources are used
to compute the actual spend against the budget amount, such as projects,
services, and the budget's time period, as well as other filters.
properties:
calendarPeriod:
description: 'Optional. Specifies to track usage for recurring
calendar period. For example, assume that CalendarPeriod.QUARTER
is set. The budget will track usage from April 1 to June 30,
when the current calendar month is April, May, June. After that,
it will track usage from July 1 to September 30 when the current
calendar month is July, August, September, so on. Possible values:
CALENDAR_PERIOD_UNSPECIFIED, MONTH, QUARTER, YEAR'
type: string
creditTypes:
description: Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS,
this is a list of credit types to be subtracted from gross cost
to determine the spend for threshold calculations. See a list
of acceptable credit type values. If Filter.credit_types_treatment
is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.
items:
type: string
type: array
creditTypesTreatment:
description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
type: string
customPeriod:
description: Optional. Specifies to track usage from any start
date (required) to any end date (optional). This time period
is static, it does not recur.
properties:
endDate:
description: Immutable. Optional. The end date of the time
period. Budgets with elapsed end date won't be processed.
If unset, specifies to track all usage incurred since the
start_date.
properties:
day:
description: Immutable. Day of a month. Must be from 1
to 31 and valid for the year and month, or 0 to specify
a year by itself or a year and month where the day isn't
significant.
format: int64
type: integer
month:
description: Immutable. Month of a year. Must be from
1 to 12, or 0 to specify a year without a month and
day.
format: int64
type: integer
year:
description: Immutable. Year of the date. Must be from
1 to 9999, or 0 to specify a date without a year.
format: int64
type: integer
type: object
startDate:
description: Immutable. Required. The start date must be after
January 1, 2017.
properties:
day:
description: Immutable. Day of a month. Must be from 1
to 31 and valid for the year and month, or 0 to specify
a year by itself or a year and month where the day isn't
significant.
format: int64
type: integer
month:
description: Immutable. Month of a year. Must be from
1 to 12, or 0 to specify a year without a month and
day.
format: int64
type: integer
year:
description: Immutable. Year of the date. Must be from
1 to 9999, or 0 to specify a date without a year.
format: int64
type: integer
type: object
required:
- startDate
type: object
labels:
additionalProperties:
properties:
values:
description: Immutable. The values of the label
items:
type: string
type: array
type: object
description: Optional. A single label and value pair specifying
that usage from only this set of labeled resources should be
included in the budget. Currently, multiple entries or multiple
values per entry are not allowed. If omitted, the report will
include all labeled and unlabeled usage.
type: object
projects:
items:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
description: 'Allowed value: The Google Cloud resource name
of a `Project` resource (format: `projects/{{name}}`).'
type: string
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
type: array
services:
description: 'Optional. A set of services of the form `services/{service_id}`,
specifying that usage from only this set of services should
be included in the budget. If omitted, the report will include
usage for all the services. The service names are available
through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.'
items:
type: string
type: array
subaccounts:
items:
oneOf:
- not:
required:
- external
required:
- name
- not:
anyOf:
- required:
- name
- required:
- namespace
required:
- external
properties:
external:
type: string
name:
description: |-
[WARNING] CloudBillingBillingAccount not yet supported in Config Connector, use 'external' field to reference existing resources.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
type: string
namespace:
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type: string
type: object
type: array
type: object
displayName:
description: User data for display name in UI. The name must be less
than or equal to 60 characters.
type: string
resourceID:
description: Immutable. Optional. The service-generated name of the
resource. Used for acquisition only. Leave unset to create a new
resource.
type: string
thresholdRules:
description: Optional. Rules that trigger alerts (notifications of
thresholds being crossed) when spend exceeds the specified percentages
of the budget.
items:
properties:
spendBasis:
description: 'Optional. The type of basis used to determine
if spend has passed the threshold. Behavior defaults to CURRENT_SPEND
if not set. Possible values: BASIS_UNSPECIFIED, CURRENT_SPEND,
FORECASTED_SPEND'
type: string
thresholdPercent:
description: 'Required. Send an alert when this threshold is
exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation:
non-negative number.'
format: double
type: number
required:
- thresholdPercent
type: object
type: array
required:
- amount
- billingAccountRef
type: object
status:
properties:
conditions:
description: Conditions represent the latest available observation
of the resource's current state.
items:
properties:
lastTransitionTime:
description: Last time the condition transitioned from one status
to another.
type: string
message:
description: Human-readable message indicating details about
last transition.
type: string
reason:
description: Unique, one-word, CamelCase reason for the condition's
last transition.
type: string
status:
description: Status is the status of the condition. Can be True,
False, Unknown.
type: string
type:
description: Type is the type of the condition.
type: string
type: object
type: array
etag:
description: Optional. Etag to validate that the object is unchanged
for a read-modify-write operation. An empty etag will cause an update
to overwrite other changes.
type: string
observedGeneration:
description: ObservedGeneration is the generation of the resource
that was most recently observed by the Config Connector controller.
If this is equal to metadata.generation, then that means that the
current reported status reflects the most recent desired state of
the resource.
type: integer
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []