budget.oracle.com/v1beta1¶
APIVersion: budget.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes budget.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Budget | Namespaced | Sample | - |
Budget¶
Manage OCI Budgets.
Plural:budgetsScope:NamespacedAPIVersion:budget.oracle.com/v1beta1Sample: Sample (config/samples/budget_v1beta1_budget.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
BudgetSpec defines the desired state of Budget.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
amount |
The amount of the budget expressed as a whole number in the currency of the customer's rate card. | number |
Yes | - | - |
budgetProcessingPeriodStartOffset |
The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. | integer |
No | - | - |
compartmentId |
The OCID of the compartment. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
The description of the budget. | string |
No | - | - |
displayName |
The displayName of the budget. Avoid entering confidential information. | string |
No | - | - |
endDate |
The date when the one-time budget concludes. For example, 2023-08-12T16:01:19.847222+05:30. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. |
string |
No | - | - |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
processingPeriodType |
The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE. | string |
No | - | - |
resetPeriod |
The reset period for the budget. | string |
Yes | - | - |
startDate |
The date when the one-time budget begins. For example, 2023-07-12T16:01:19.847222+05:30. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. |
string |
No | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
targetCompartmentId |
This is DEPRECATED. Set the target compartment ID in targets instead. | string |
No | - | - |
targetType |
The type of target on which the budget is applied. | string |
No | - | - |
targets |
The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item. | list[string] |
No | - | - |
Status¶
BudgetStatus defines the observed state of Budget.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actualSpend |
The actual spend in currency for the current budget cycle. | number |
No | - | - |
alertRuleCount |
The total number of alert rules in the budget. | integer |
No | - | - |
amount |
The amount of the budget expressed in the currency of the customer's rate card. | number |
No | - | - |
budgetProcessingPeriodStartOffset |
The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. | integer |
No | - | - |
compartmentId |
The OCID of the compartment. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
The description of the budget. | string |
No | - | - |
displayName |
The display name of the budget. Avoid entering confidential information. | string |
No | - | - |
endDate |
The time when the one-time budget concludes. For example, 2023-08-12T16:01:19.847222+05:30. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. |
string |
No | - | - |
forecastedSpend |
The forecasted spend in currency by the end of the current budget cycle. | number |
No | - | - |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID of the budget. | string |
No | - | - |
lifecycleState |
The current state of the budget. | string |
No | - | - |
processingPeriodType |
The budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE. | string |
No | - | - |
resetPeriod |
The reset period for the budget. | string |
No | - | - |
startDate |
The date when the one-time budget begins. For example, 2023-07-12T16:01:19.847222+05:30. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. |
string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
targetCompartmentId |
This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty. | string |
No | - | - |
targetType |
The type of target on which the budget is applied. | string |
No | - | - |
targets |
The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". | list[string] |
No | - | - |
timeCreated |
The time that the budget was created. | string |
No | - | - |
timeSpendComputed |
The time that the budget spend was last computed. | string |
No | - | - |
timeUpdated |
The time that the budget was updated. | string |
No | - | - |
version |
The version of the budget. Starts from 1 and increments by 1. | integer |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |