managedkafka.oracle.com/v1beta1¶
APIVersion: managedkafka.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 managedkafka.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| KafkaCluster | Namespaced | Sample | - |
| KafkaClusterConfig | Namespaced | Sample | - |
KafkaCluster¶
Manage OCI Managed Kafka clusters.
Plural:kafkaclustersScope:NamespacedAPIVersion:managedkafka.oracle.com/v1beta1Sample: Sample (config/samples/managedkafka_v1beta1_kafkacluster.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
KafkaClusterSpec defines the desired state of KafkaCluster.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessSubnets |
Subnets where broker/coordinator VNICs will be created. | list[object] |
Yes | - | - |
brokerShape |
KafkaClusterBrokerShape defines nested fields for KafkaCluster.BrokerShape. | object |
Yes | - | - |
clientCertificateBundle |
CA certificate bundle for mTLS broker authentication. | string |
No | - | - |
clusterConfigId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object | string |
Yes | - | - |
clusterConfigVersion |
The version of configuration object | integer |
Yes | - | - |
clusterType |
Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node PRODUCTION - Minimum allowed broker count is 3 | string |
Yes | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the KafkaCluster in. | string |
Yes | - | - |
coordinationType |
Kafka coordination type. Set of available types depends on Kafka version | 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 | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | 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 | - | - |
kafkaVersion |
Version of Kafka to use to spin up the cluster | string |
Yes | - | - |
Spec.accessSubnets[]¶
KafkaClusterAccessSubnet defines nested fields for KafkaCluster.AccessSubnet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
subnets |
Subnets OCIDs | list[string] |
Yes | - | - |
Spec.brokerShape¶
KafkaClusterBrokerShape defines nested fields for KafkaCluster.BrokerShape.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
nodeCount |
Number of Kafka broker nodes | integer |
Yes | - | - |
nodeShape |
Node shape for broker is passed as part of cluster creation, similar to VM.Standard.A1.Flex | string |
No | - | - |
ocpuCount |
Number of OCPUs per nodes | integer |
Yes | - | - |
storageSizeInGbs |
Size of the storage per nodes. | integer |
No | - | - |
Status¶
KafkaClusterStatus defines the observed state of KafkaCluster.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
accessSubnets |
Subnets where broker/coordinator VNICs will be created. | list[object] |
No | - | - |
brokerShape |
KafkaClusterBrokerShape defines nested fields for KafkaCluster.BrokerShape. | object |
No | - | - |
clientCertificateBundle |
CA certificate bundle for mTLS broker authentication. | string |
No | - | - |
clusterConfigId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object | string |
No | - | - |
clusterConfigVersion |
The version of configuration object | integer |
No | - | - |
clusterType |
Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on a single node PRODUCTION - Minimum allowed broker count is 3 | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. | string |
No | - | - |
coordinationType |
Kafka coordination type. Set of available types depends on Kafka version | 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 | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. | 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 | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. | string |
No | - | - |
kafkaBootstrapUrls |
Bootstrap URL that can be used to connect to Kafka | list[object] |
No | - | - |
kafkaVersion |
Version of Kafka to use to spin up the cluster | string |
No | - | - |
lifecycleDetails |
A message that describes the current state of the KafkaCluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state. | string |
No | - | - |
lifecycleState |
The current state of the KafkaCluster. | string |
No | - | - |
secretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret that contains superuser password. | 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 | - | - |
timeCreated |
The date and time the KafkaCluster was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the KafkaCluster was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.accessSubnets[]¶
KafkaClusterAccessSubnet defines nested fields for KafkaCluster.AccessSubnet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
subnets |
Subnets OCIDs | list[string] |
Yes | - | - |
Status.brokerShape¶
KafkaClusterBrokerShape defines nested fields for KafkaCluster.BrokerShape.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
nodeCount |
Number of Kafka broker nodes | integer |
Yes | - | - |
nodeShape |
Node shape for broker is passed as part of cluster creation, similar to VM.Standard.A1.Flex | string |
No | - | - |
ocpuCount |
Number of OCPUs per nodes | integer |
Yes | - | - |
storageSizeInGbs |
Size of the storage per nodes. | integer |
No | - | - |
Status.kafkaBootstrapUrls[]¶
KafkaClusterKafkaBootstrapUrl defines nested fields for KafkaCluster.KafkaBootstrapUrl.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of the Kafka listener providing this bootstrap URL | string |
No | - | - |
url |
Bootstrap URL | 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 | - | - |
KafkaClusterConfig¶
Manage OCI Managed Kafka cluster configurations.
Plural:kafkaclusterconfigsScope:NamespacedAPIVersion:managedkafka.oracle.com/v1beta1Sample: Sample (config/samples/managedkafka_v1beta1_kafkaclusterconfig.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
KafkaClusterConfigSpec defines the desired state of KafkaClusterConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the KafkaClusterConfig in. | 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 | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | 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 | - | - |
latestConfig |
KafkaClusterConfigLatestConfig defines nested fields for KafkaClusterConfig.LatestConfig. | object |
Yes | - | - |
Spec.latestConfig¶
Back to KafkaClusterConfig spec
KafkaClusterConfigLatestConfig defines nested fields for KafkaClusterConfig.LatestConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
configId |
ID cluster configuration | string |
No | - | - |
properties |
Cluster configuration key-value pairs | map[string, string] |
Yes | - | - |
timeCreated |
The date and time the KafkaClusterConfigVersion was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
versionNumber |
Version of the cluster configuration | integer |
No | - | - |
Status¶
KafkaClusterConfigStatus defines the observed state of KafkaClusterConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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 | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. | 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 | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. | string |
No | - | - |
latestConfig |
KafkaClusterConfigLatestConfig defines nested fields for KafkaClusterConfig.LatestConfig. | object |
No | - | - |
lifecycleDetails |
A message that describes the current state of the KafkaClusterConfig in more detail. For example, can be used to provide actionable information for a resource in the Failed state. | string |
No | - | - |
lifecycleState |
The current state of the KafkaClusterConfig. | 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 | - | - |
timeCreated |
The date and time the KafkaClusterConfig was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the KafkaClusterConfig was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.latestConfig¶
Back to KafkaClusterConfig status
KafkaClusterConfigLatestConfig defines nested fields for KafkaClusterConfig.LatestConfig.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
configId |
ID cluster configuration | string |
No | - | - |
properties |
Cluster configuration key-value pairs | map[string, string] |
Yes | - | - |
timeCreated |
The date and time the KafkaClusterConfigVersion was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
versionNumber |
Version of the cluster configuration | integer |
No | - | - |
Status.status¶
Back to KafkaClusterConfig 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 KafkaClusterConfig 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 KafkaClusterConfig 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 KafkaClusterConfig status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |