tenantmanagercontrolplane.oracle.com/v1beta1¶
APIVersion: tenantmanagercontrolplane.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 tenantmanagercontrolplane.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Domain | Namespaced | Sample | - |
| DomainGovernance | Namespaced | Sample | - |
| Organization | Namespaced | Sample | - |
Domain¶
Manage OCI domains with workrequest-aware create behavior and confirmed OCI delete semantics.
Plural:domainsScope:NamespacedAPIVersion:tenantmanagercontrolplane.oracle.com/v1beta1Sample: Sample (config/samples/tenantmanagercontrolplane_v1beta1_domain.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DomainSpec defines the desired state of Domain.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the tenancy. | 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 | - | - |
domainName |
The domain name. | 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 | - | - |
isGovernanceEnabled |
Indicates whether governance should be enabled for this domain. Defaults to false. | boolean |
No | - | - |
lifecycleState |
Optional exact-match filter used to narrow list-based binding and delete confirmation reads. Supported values include CREATING, ACTIVE, INACTIVE, UPDATING, FAILED, and TERMINATED. |
string |
No | - | - |
status |
Optional exact-match filter used to narrow list-based binding and delete confirmation reads. Supported values include PENDING, RELEASING, RELEASED, EXPIRING, REVOKING, REVOKED, ACTIVE, and FAILED. |
string |
No | - | - |
subscriptionEmail |
Email address to be used to notify the user, and that the ONS subscription will be created with. | string |
No | - | - |
Status¶
DomainStatus defines the observed state of Domain.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The tenancy OCID recorded for list identity matching and replacement-only drift checks. | 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 | - | - |
domainName |
The domain name. | 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 OCID of the domain. | string |
No | - | - |
isGovernanceEnabled |
Whether governance was requested for the bound domain; tracked from the spec because the SDK does not echo it on reads. | boolean |
No | - | - |
lifecycleState |
Lifecycle state of the domain. | string |
No | - | - |
ownerId |
The OCID of the tenancy that has started the registration process for this domain. | string |
No | - | - |
sdkStatus |
The raw domain status returned by Tenant Manager Control Plane. | string |
No | - | - |
status |
- | object |
Yes | - | - |
subscriptionEmail |
The accepted subscription email tracked from the spec because the SDK does not echo it on reads. | string |
No | - | - |
timeCreated |
Date-time when this domain was created. An RFC 3339-formatted date and time string. | string |
No | - | - |
timeUpdated |
Date-time when this domain was last updated. An RFC 3339-formatted date and time string. | string |
No | - | - |
txtRecord |
The code that the owner of the domain will need to add as a TXT record to their domain. | 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 | - | - |
DomainGovernance¶
Manage OCI domain governance resources with lifecycle-based generatedruntime semantics.
Plural:domaingovernancesScope:NamespacedAPIVersion:tenantmanagercontrolplane.oracle.com/v1beta1Sample: Sample (config/samples/tenantmanagercontrolplane_v1beta1_domaingovernance.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DomainGovernanceSpec defines the desired state of DomainGovernance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the tenancy. | 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 | - | - |
domainId |
OCID of the domain. | 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 | - | - |
isGovernanceEnabled |
Indicates whether governance is enabled for this domain. | boolean |
No | - | - |
onsSubscriptionId |
The ONS subscription associated with this domain governance entity. | string |
Yes | - | - |
onsTopicId |
The ONS topic associated with this domain governance entity. | string |
Yes | - | - |
subscriptionEmail |
Email address to be used to notify the user, and that the ONS subscription will be created with. | string |
Yes | - | - |
Status¶
DomainGovernanceStatus defines the observed state of DomainGovernance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
domainId |
The OCID of the domain associated with this domain governance entity. | 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 OCID of the domain governance entity. | string |
No | - | - |
isGovernanceEnabled |
Indicates whether governance is enabled for this domain. | boolean |
No | - | - |
lifecycleState |
Lifecycle state of the domain governance entity. | string |
No | - | - |
onsSubscriptionId |
The ONS subscription associated with this domain governance entity. | string |
No | - | - |
onsTopicId |
The ONS topic associated with this domain governance entity. | string |
No | - | - |
ownerId |
The OCID of the tenancy that owns this domain governance entity. | string |
No | - | - |
status |
- | object |
Yes | - | - |
subscriptionEmail |
Email address to be used to notify the user, and that the ONS subscription will be created with. | 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 | - | - |
timeCreated |
Date-time when this domain governance was created. An RFC 3339-formatted date and time string. | string |
No | - | - |
timeUpdated |
Date-time when this domain governance was last updated. An RFC 3339-formatted date and time string. | string |
No | - | - |
Status.status¶
Back to DomainGovernance 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 DomainGovernance 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 DomainGovernance 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 DomainGovernance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Organization¶
Manage existing OCI organizations with an update-only default subscription contract.
Plural:organizationsScope:NamespacedAPIVersion:tenantmanagercontrolplane.oracle.com/v1beta1Sample: Sample (config/samples/tenantmanagercontrolplane_v1beta1_organization.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
OrganizationSpec defines the desired state of Organization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The tenancy OCID containing the existing organization when binding by list lookup. Provide this when organizationId is not set; reconcile requires ListOrganizations to return a unique match. |
string |
No | - | - |
defaultUcmSubscriptionId |
Desired default Universal Credits Model subscription for the bound organization. Omit this field to leave the current OCI value unchanged. | string |
No | - | - |
organizationId |
The OCI identifier of the existing organization to bind directly. | string |
No | - | - |
Status¶
OrganizationStatus defines the observed state of Organization.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
OCID of the compartment containing the organization. Always a tenancy OCID. | string |
No | - | - |
defaultUcmSubscriptionId |
OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned. | string |
No | - | - |
displayName |
A display name for the organization. Avoid entering confidential information. | string |
No | - | - |
id |
OCID of the organization. | string |
No | - | - |
lifecycleState |
Lifecycle state of the organization. | string |
No | - | - |
parentName |
The name of the tenancy that is the organization parent. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
Date and time when the organization was created. | string |
No | - | - |
timeUpdated |
Date and time when the organization was last updated. | 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 | - | - |