governancerulescontrolplane.oracle.com/v1beta1¶
APIVersion: governancerulescontrolplane.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 governancerulescontrolplane.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| GovernanceRule | Namespaced | Sample | - |
| InclusionCriterion | Namespaced | Sample | - |
GovernanceRule¶
GovernanceRule is the Schema for the governancerules API.
Plural:governancerulesScope:NamespacedAPIVersion:governancerulescontrolplane.oracle.com/v1beta1Sample: Sample (config/samples/governancerulescontrolplane_v1beta1_governancerule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
GovernanceRuleSpec defines the desired state of GovernanceRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the root compartment containing the governance rule. | string |
Yes | - | - |
creationOption |
The type of option used to create the governance rule, could be one of TEMPLATE or CLONE. Example: TEMPLATE |
string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
Description of the governance rule. | string |
No | - | - |
displayName |
Display name of the governance rule. | string |
Yes | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
relatedResourceId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the resource, which was used as a template to create this governance rule. | string |
No | - | - |
template |
GovernanceRuleTemplate defines nested fields for GovernanceRule.Template. | object |
Yes | - | - |
type |
Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS. Example: QUOTA |
string |
Yes | - | - |
Spec.template¶
GovernanceRuleTemplate defines nested fields for GovernanceRule.Template.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description of the tag namespace. | string |
No | - | - |
displayName |
Display name of the quota resource. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed. | string |
No | - | - |
regions |
List of allowed regions. | list[string] |
No | - | - |
statements |
List of quota statements. | list[string] |
No | - | - |
tagDefaults |
- | list[object] |
No | - | - |
tags |
Represents an array of tags for tag namespace. | list[object] |
No | - | - |
type |
- | string |
No | - | - |
Spec.template.tagDefaults[]¶
GovernanceRuleTemplateTagDefault defines nested fields for GovernanceRule.Template.TagDefault.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag default). If no value is set, resource creation is blocked. * If the isRequired flag is set to "true", the value is set during resource creation. * If the isRequired flag is set to "false", the value you enter is set during resource creation. Example: false |
boolean |
Yes | - | - |
tagName |
The name of the tag. The tag default will always assign a default value for this tag name. | string |
Yes | - | - |
value |
The default value for the tag name. This will be applied to all new resources created in the compartment. | string |
Yes | - | - |
Spec.template.tags[]¶
GovernanceRuleTemplateTag defines nested fields for GovernanceRule.Template.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description assigned to the tag during creation. | string |
No | - | - |
isCostTracking |
Indicates whether the tag is enabled for cost tracking. | boolean |
No | - | - |
name |
The name you assign to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed. | string |
Yes | - | - |
validator |
GovernanceRuleTemplateTagValidator defines nested fields for GovernanceRule.Template.Tag.Validator. | object |
No | - | - |
Spec.template.tags[].validator¶
GovernanceRuleTemplateTagValidator defines nested fields for GovernanceRule.Template.Tag.Validator.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
validatorType |
- | string |
No | - | - |
values |
The list of allowed values for a definedTag value. | list[string] |
No | - | - |
Status¶
GovernanceRuleStatus defines the observed state of GovernanceRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the root compartment containing the governance rule. | string |
No | - | - |
creationOption |
The type of option used to create the governance rule, could be one of TEMPLATE or CLONE. Example: TEMPLATE |
string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
Description of the governance rule. | string |
No | - | - |
displayName |
Display name of the governance rule. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
id |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the governance rule. | string |
No | - | - |
lifecycleState |
The current state of the governance rule. | string |
No | - | - |
relatedResourceId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the resource, which was used as a template to create this governance rule. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
template |
GovernanceRuleTemplate defines nested fields for GovernanceRule.Template. | object |
No | - | - |
timeCreated |
Date and time the governance rule was created. An RFC3339 formatted datetime string. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
Date and time the governance rule was updated. An RFC3339 formatted datetime string. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
type |
Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS. Example: QUOTA |
string |
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 | - | - |
Status.template¶
GovernanceRuleTemplate defines nested fields for GovernanceRule.Template.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description of the tag namespace. | string |
No | - | - |
displayName |
Display name of the quota resource. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
name |
The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed. | string |
No | - | - |
regions |
List of allowed regions. | list[string] |
No | - | - |
statements |
List of quota statements. | list[string] |
No | - | - |
tagDefaults |
- | list[object] |
No | - | - |
tags |
Represents an array of tags for tag namespace. | list[object] |
No | - | - |
type |
- | string |
No | - | - |
Status.template.tagDefaults[]¶
GovernanceRuleTemplateTagDefault defines nested fields for GovernanceRule.Template.TagDefault.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isRequired |
If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag default). If no value is set, resource creation is blocked. * If the isRequired flag is set to "true", the value is set during resource creation. * If the isRequired flag is set to "false", the value you enter is set during resource creation. Example: false |
boolean |
Yes | - | - |
tagName |
The name of the tag. The tag default will always assign a default value for this tag name. | string |
Yes | - | - |
value |
The default value for the tag name. This will be applied to all new resources created in the compartment. | string |
Yes | - | - |
Status.template.tags[]¶
GovernanceRuleTemplateTag defines nested fields for GovernanceRule.Template.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
The description assigned to the tag during creation. | string |
No | - | - |
isCostTracking |
Indicates whether the tag is enabled for cost tracking. | boolean |
No | - | - |
name |
The name you assign to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed. | string |
Yes | - | - |
validator |
GovernanceRuleTemplateTagValidator defines nested fields for GovernanceRule.Template.Tag.Validator. | object |
No | - | - |
Status.template.tags[].validator¶
GovernanceRuleTemplateTagValidator defines nested fields for GovernanceRule.Template.Tag.Validator.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
validatorType |
- | string |
No | - | - |
values |
The list of allowed values for a definedTag value. | list[string] |
No | - | - |
InclusionCriterion¶
InclusionCriterion is the Schema for the inclusioncriterions API.
Plural:inclusioncriteriaScope:NamespacedAPIVersion:governancerulescontrolplane.oracle.com/v1beta1Sample: Sample (config/samples/governancerulescontrolplane_v1beta1_inclusioncriterion.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
InclusionCriterionSpec defines the desired state of InclusionCriterion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
association |
InclusionCriterionAssociation defines nested fields for InclusionCriterion.Association. | object |
No | - | - |
governanceRuleId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the governance rule. Every inclusion criterion is associated with a governance rule. | string |
Yes | - | - |
type |
Type of inclusion criterion - TENANCY, ALL or TAG. We support TENANCY and ALL for now. | string |
Yes | - | - |
Spec.association¶
Back to InclusionCriterion spec
InclusionCriterionAssociation defines nested fields for InclusionCriterion.Association.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
tenancyId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the tenancy to which the governance rule will be applied as part of this tenancy inclusion criterion. | string |
No | - | - |
type |
- | string |
No | - | - |
Status¶
InclusionCriterionStatus defines the observed state of InclusionCriterion.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
association |
InclusionCriterionAssociation defines nested fields for InclusionCriterion.Association. | object |
No | - | - |
governanceRuleId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the governance rule. Every inclusion criterion is associated with a governance rule. | string |
No | - | - |
id |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the inclusion criterion. | string |
No | - | - |
lifecycleState |
The current state of the inclusion criterion. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
Date and time the inclusion criterion was created. An RFC3339 formatted datetime string. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
Date and time the inclusion criterion was updated. An RFC3339 formatted datetime string. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
type |
Type of inclusion criterion - TENANCY, ALL or TAG. We support TENANCY and ALL for now. | string |
No | - | - |
Status.association¶
Back to InclusionCriterion status
InclusionCriterionAssociation defines nested fields for InclusionCriterion.Association.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
jsonData |
- | string |
No | - | - |
tenancyId |
The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the tenancy to which the governance rule will be applied as part of this tenancy inclusion criterion. | string |
No | - | - |
type |
- | string |
No | - | - |
Status.status¶
Back to InclusionCriterion 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¶
Back to InclusionCriterion status
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¶
Back to InclusionCriterion status
| 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[]¶
Back to InclusionCriterion status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |