visualbuilder.oracle.com/v1beta1¶
APIVersion: visualbuilder.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 visualbuilder.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| VbInstance | Namespaced | Sample | - |
VbInstance¶
Manage OCI Visual Builder instances.
Plural:vbinstancesScope:NamespacedAPIVersion:visualbuilder.oracle.com/v1beta1Sample: Sample (config/samples/visualbuilder_v1beta1_vbinstance.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
VbInstanceSpec defines the desired state of VbInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alternateCustomEndpoints |
A list of alternate custom endpoints to be used for the vb instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance). | list[object] |
No | - | - |
compartmentId |
Compartment Identifier. | string |
Yes | - | - |
consumptionModel |
Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement. | string |
No | - | - |
customEndpoint |
VbInstanceCustomEndpoint defines nested fields for VbInstance.CustomEndpoint. | object |
No | - | - |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
Vb Instance Identifier. | 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 | - | - |
idcsOpenId |
Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter | string |
No | - | - |
isVisualBuilderEnabled |
Visual Builder is enabled or not. | boolean |
No | - | - |
networkEndpointDetails |
VbInstanceNetworkEndpointDetails defines nested fields for VbInstance.NetworkEndpointDetails. | object |
No | - | - |
nodeCount |
The number of Nodes | integer |
Yes | - | - |
Spec.alternateCustomEndpoints[]¶
VbInstanceAlternateCustomEndpoint defines nested fields for VbInstance.AlternateCustomEndpoint.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
certificateSecretId |
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. | string |
No | - | - |
hostname |
A custom hostname to be used for the vb instance URL, in FQDN format. | string |
Yes | - | - |
Spec.customEndpoint¶
VbInstanceCustomEndpoint defines nested fields for VbInstance.CustomEndpoint.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
certificateSecretId |
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. | string |
No | - | - |
hostname |
A custom hostname to be used for the vb instance URL, in FQDN format. | string |
Yes | - | - |
Spec.networkEndpointDetails¶
VbInstanceNetworkEndpointDetails defines nested fields for VbInstance.NetworkEndpointDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowlistedHttpIps |
Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. | list[string] |
No | - | - |
allowlistedHttpVcns |
Virtual Cloud Networks allowed to access this network endpoint. | list[object] |
No | - | - |
jsonData |
- | string |
No | - | - |
networkEndpointType |
- | string |
No | - | - |
networkSecurityGroupIds |
Network Security Group OCIDs for the Private Endpoint. | list[string] |
No | - | - |
privateEndpointIp |
The IP address to be assigned to Private Endpoint | string |
No | - | - |
subnetId |
The subnet OCID for the private endpoint. | string |
No | - | - |
Spec.networkEndpointDetails.allowlistedHttpVcns[]¶
VbInstanceNetworkEndpointDetailsAllowlistedHttpVcn defines nested fields for VbInstance.NetworkEndpointDetails.AllowlistedHttpVcn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowlistedIpCidrs |
Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. | list[string] |
No | - | - |
id |
The Virtual Cloud Network OCID. | string |
Yes | - | - |
Status¶
VbInstanceStatus defines the observed state of VbInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alternateCustomEndpoints |
A list of alternate custom endpoints used for the vb instance URL. | list[object] |
No | - | - |
compartmentId |
Compartment Identifier. | string |
No | - | - |
consumptionModel |
The entitlement used for billing purposes. | string |
No | - | - |
customEndpoint |
VbInstanceCustomEndpoint defines nested fields for VbInstance.CustomEndpoint. | object |
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 | - | - |
displayName |
Vb Instance Identifier, can be renamed. | 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 |
Unique identifier that is immutable on creation. | string |
No | - | - |
instanceUrl |
The Vb Instance URL. | string |
No | - | - |
isVisualBuilderEnabled |
Visual Builder is enabled or not. | boolean |
No | - | - |
lifecycleState |
The current state of the vb instance. | string |
No | - | - |
managementNatGatewayIp |
The NAT gateway IP address for the VB management VCN | string |
No | - | - |
managementVcnId |
The Oracle Cloud ID (OCID) of the Visual Builder management VCN | string |
No | - | - |
networkEndpointDetails |
VbInstanceNetworkEndpointDetails defines nested fields for VbInstance.NetworkEndpointDetails. | object |
No | - | - |
nodeCount |
The number of Nodes | integer |
No | - | - |
serviceNatGatewayIp |
The NAT gateway IP address for the VB service VCN | string |
No | - | - |
serviceVcnId |
The Oracle Cloud ID (OCID) of the Visual Builder service VCN | string |
No | - | - |
stateMessage |
An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. | 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 | - | - |
timeCreated |
The time the the VbInstance was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time the VbInstance was updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.alternateCustomEndpoints[]¶
VbInstanceAlternateCustomEndpoint defines nested fields for VbInstance.AlternateCustomEndpoint.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
certificateSecretId |
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. | string |
No | - | - |
hostname |
A custom hostname to be used for the vb instance URL, in FQDN format. | string |
Yes | - | - |
Status.customEndpoint¶
VbInstanceCustomEndpoint defines nested fields for VbInstance.CustomEndpoint.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
certificateSecretId |
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. | string |
No | - | - |
hostname |
A custom hostname to be used for the vb instance URL, in FQDN format. | string |
Yes | - | - |
Status.networkEndpointDetails¶
VbInstanceNetworkEndpointDetails defines nested fields for VbInstance.NetworkEndpointDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowlistedHttpIps |
Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. | list[string] |
No | - | - |
allowlistedHttpVcns |
Virtual Cloud Networks allowed to access this network endpoint. | list[object] |
No | - | - |
jsonData |
- | string |
No | - | - |
networkEndpointType |
- | string |
No | - | - |
networkSecurityGroupIds |
Network Security Group OCIDs for the Private Endpoint. | list[string] |
No | - | - |
privateEndpointIp |
The IP address to be assigned to Private Endpoint | string |
No | - | - |
subnetId |
The subnet OCID for the private endpoint. | string |
No | - | - |
Status.networkEndpointDetails.allowlistedHttpVcns[]¶
VbInstanceNetworkEndpointDetailsAllowlistedHttpVcn defines nested fields for VbInstance.NetworkEndpointDetails.AllowlistedHttpVcn.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
allowlistedIpCidrs |
Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. | list[string] |
No | - | - |
id |
The Virtual Cloud Network OCID. | string |
Yes | - | - |
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 | - | - |