Skip to content

blockchain.oracle.com/v1beta1

Back to API Reference

APIVersion: blockchain.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 blockchain.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
BlockchainPlatform Namespaced Sample -
Osn Namespaced Sample -
Peer Namespaced Sample -

BlockchainPlatform

BlockchainPlatform is the Schema for the blockchainplatforms API.

  • Plural: blockchainplatforms
  • Scope: Namespaced
  • APIVersion: blockchain.oracle.com/v1beta1
  • Sample: Sample (config/samples/blockchain_v1beta1_blockchainplatform.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

BlockchainPlatformSpec defines the desired state of BlockchainPlatform.

Field Description Type Required Default Enum
caCertArchiveText Base64 encoded text in ASCII character set of a Thirdparty CA Certificates archive file. The Archive file is a zip file containing third part CA Certificates, the ca key and certificate files used when issuing enrollment certificates (ECerts) and transaction certificates (TCerts). The chainfile (if it exists) contains the certificate chain which should be trusted for this CA, where the 1st in the chain is always the root CA certificate. File list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)]. string No - -
compartmentId Compartment Identifier string Yes - -
computeShape Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE 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 Platform Instance Description string No - -
displayName Platform Instance Display name, can be renamed string Yes - -
federatedUserId Identifier for a federated user 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 - -
idcsAccessToken IDCS access token with Identity Domain Administrator role string Yes - -
isByol Bring your own license boolean No - -
loadBalancerShape Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. string No - -
platformRole Role of platform - founder or participant string Yes - -
platformVersion Platform version string No - -
replicas BlockchainPlatformReplicas defines nested fields for BlockchainPlatform.Replicas. object No - -
storageSizeInTBs Storage size in TBs number No - -
totalOcpuCapacity Number of total OCPUs to allocate integer No - -

Spec.replicas

Back to BlockchainPlatform spec

BlockchainPlatformReplicas defines nested fields for BlockchainPlatform.Replicas.

Field Description Type Required Default Enum
caCount Number of CA replicas integer No - -
consoleCount Number of console replicas integer No - -
proxyCount Number of REST proxy replicas integer No - -

Status

BlockchainPlatformStatus defines the observed state of BlockchainPlatform.

Field Description Type Required Default Enum
compartmentId Compartment Identifier string No - -
componentDetails BlockchainPlatformComponentDetails defines nested fields for BlockchainPlatform.ComponentDetails. object No - -
computeShape Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM or DIGITAL_ASSETS_MEDIUM or DIGITAL_ASSETS_LARGE or DIGITAL_ASSETS_EXTRA_LARGE 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 Platform Instance Description string No - -
displayName Platform Instance Display name, 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 - -
hostOcpuUtilizationInfo List of OcpuUtilization for all hosts list[object] No - -
id unique identifier that is immutable on creation string No - -
isByol Bring your own license boolean No - -
isMultiAD True for multi-AD blockchain plaforms, false for single-AD boolean No - -
lifecycleDetails 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 - -
lifecycleState The current state of the Platform Instance. string No - -
loadBalancerShape Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. string No - -
platformRole Role of platform - FOUNDER or PARTICIPANT string No - -
platformShapeType Type of Platform shape - DEFAULT or CUSTOM string No - -
platformVersion Platform Version string No - -
replicas BlockchainPlatformReplicas defines nested fields for BlockchainPlatform.Replicas. object No - -
serviceEndpoint Service endpoint URL, valid post-provisioning string No - -
serviceVersion The version of the Platform Instance. string No - -
status - object Yes - -
storageSizeInTBs Storage size in TBs number No - -
storageUsedInTBs Storage used in TBs number No - -
timeCreated The time the the Platform Instance was created. An RFC3339 formatted datetime string string No - -
timeUpdated The time the Platform Instance was updated. An RFC3339 formatted datetime string string No - -
totalOcpuCapacity Number of total OCPUs allocated to the platform cluster integer No - -

Status.componentDetails

Back to BlockchainPlatform status

BlockchainPlatformComponentDetails defines nested fields for BlockchainPlatform.ComponentDetails.

Field Description Type Required Default Enum
osns List of OSNs list[object] No - -
peers List of Peers list[object] No - -

Status.componentDetails.osns[]

Back to BlockchainPlatform status

BlockchainPlatformComponentDetailsOsn defines nested fields for BlockchainPlatform.ComponentDetails.Osn.

Field Description Type Required Default Enum
ad Availability Domain of OSN string No - -
lifecycleState The current state of the OSN. string No - -
ocpuAllocationParam BlockchainPlatformComponentDetailsOsnOcpuAllocationParam defines nested fields for BlockchainPlatform.ComponentDetails.Osn.OcpuAllocationParam. object No - -
osnKey OSN identifier string No - -

Status.componentDetails.osns[].ocpuAllocationParam

Back to BlockchainPlatform status

BlockchainPlatformComponentDetailsOsnOcpuAllocationParam defines nested fields for BlockchainPlatform.ComponentDetails.Osn.OcpuAllocationParam.

Field Description Type Required Default Enum
ocpuAllocationNumber Number of OCPU allocation number No - -

Status.componentDetails.peers[]

Back to BlockchainPlatform status

BlockchainPlatformComponentDetailsPeer defines nested fields for BlockchainPlatform.ComponentDetails.Peer.

Field Description Type Required Default Enum
ad Availability Domain of peer string No - -
alias peer alias string No - -
host Host on which the Peer exists string No - -
lifecycleState The current state of the peer. string No - -
ocpuAllocationParam BlockchainPlatformComponentDetailsPeerOcpuAllocationParam defines nested fields for BlockchainPlatform.ComponentDetails.Peer.OcpuAllocationParam. object No - -
peerKey peer identifier string No - -
role Peer role string No - -

Status.componentDetails.peers[].ocpuAllocationParam

Back to BlockchainPlatform status

BlockchainPlatformComponentDetailsPeerOcpuAllocationParam defines nested fields for BlockchainPlatform.ComponentDetails.Peer.OcpuAllocationParam.

Field Description Type Required Default Enum
ocpuAllocationNumber Number of OCPU allocation number No - -

Status.hostOcpuUtilizationInfo[]

Back to BlockchainPlatform status

BlockchainPlatformHostOcpuUtilizationInfo defines nested fields for BlockchainPlatform.HostOcpuUtilizationInfo.

Field Description Type Required Default Enum
host Host name of VM string No - -
ocpuCapacityNumber Number of total OCPU capacity on the host number No - -
ocpuUtilizationNumber Number of OCPU utilized number No - -

Status.replicas

Back to BlockchainPlatform status

BlockchainPlatformReplicas defines nested fields for BlockchainPlatform.Replicas.

Field Description Type Required Default Enum
caCount Number of CA replicas integer No - -
consoleCount Number of console replicas integer No - -
proxyCount Number of REST proxy replicas integer No - -

Status.status

Back to BlockchainPlatform 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 BlockchainPlatform 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 BlockchainPlatform 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 BlockchainPlatform status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Osn

Osn is the Schema for the osns API.

  • Plural: osns
  • Scope: Namespaced
  • APIVersion: blockchain.oracle.com/v1beta1
  • Sample: Sample (config/samples/blockchain_v1beta1_osn.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OsnSpec defines the desired state of Osn.

Field Description Type Required Default Enum
ad Availability Domain to place new OSN string Yes - -
ocpuAllocationParam OsnOcpuAllocationParam defines nested fields for Osn.OcpuAllocationParam. object No - -

Spec.ocpuAllocationParam

Back to Osn spec

OsnOcpuAllocationParam defines nested fields for Osn.OcpuAllocationParam.

Field Description Type Required Default Enum
ocpuAllocationNumber Number of OCPU allocation number Yes - -

Status

OsnStatus defines the observed state of Osn.

Field Description Type Required Default Enum
ad Availability Domain of OSN string No - -
lifecycleState The current state of the OSN. string No - -
ocpuAllocationParam OsnOcpuAllocationParam defines nested fields for Osn.OcpuAllocationParam. object No - -
osnKey OSN identifier string No - -
status - object Yes - -

Status.ocpuAllocationParam

Back to Osn status

OsnOcpuAllocationParam defines nested fields for Osn.OcpuAllocationParam.

Field Description Type Required Default Enum
ocpuAllocationNumber Number of OCPU allocation number Yes - -

Status.status

Back to Osn 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 Osn 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 Osn 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 Osn status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Peer

Peer is the Schema for the peers API.

  • Plural: peers
  • Scope: Namespaced
  • APIVersion: blockchain.oracle.com/v1beta1
  • Sample: Sample (config/samples/blockchain_v1beta1_peer.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

PeerSpec defines the desired state of Peer.

Field Description Type Required Default Enum
ad Availability Domain to place new peer string Yes - -
alias peer alias string No - -
ocpuAllocationParam PeerOcpuAllocationParam defines nested fields for Peer.OcpuAllocationParam. object Yes - -
role Peer role string Yes - -

Spec.ocpuAllocationParam

Back to Peer spec

PeerOcpuAllocationParam defines nested fields for Peer.OcpuAllocationParam.

Field Description Type Required Default Enum
ocpuAllocationNumber Number of OCPU allocation number Yes - -

Status

PeerStatus defines the observed state of Peer.

Field Description Type Required Default Enum
ad Availability Domain of peer string No - -
alias peer alias string No - -
host Host on which the Peer exists string No - -
lifecycleState The current state of the peer. string No - -
ocpuAllocationParam PeerOcpuAllocationParam defines nested fields for Peer.OcpuAllocationParam. object No - -
peerKey peer identifier string No - -
role Peer role string No - -
status - object Yes - -

Status.ocpuAllocationParam

Back to Peer status

PeerOcpuAllocationParam defines nested fields for Peer.OcpuAllocationParam.

Field Description Type Required Default Enum
ocpuAllocationNumber Number of OCPU allocation number Yes - -

Status.status

Back to Peer 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 Peer 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 Peer 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 Peer status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -