yandexcloud/crossplane-provider-yc@v0.5.1
KafkaCluster
mdb.yandex-cloud.jet.crossplane.io
KafkaCluster
yandexcloud/crossplane-provider-yc@v0.5.1mdb.yandex-cloud.jet.crossplane.io

KafkaCluster is the Schema for the KafkaClusters API. Manages a Kafka cluster within Yandex.Cloud.

Type

CRD

Group

mdb.yandex-cloud.jet.crossplane.io

Version

v1alpha1

apiVersion: mdb.yandex-cloud.jet.crossplane.io/v1alpha1

kind: KafkaCluster

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

KafkaClusterSpec defines the desired state of KafkaCluster

forProvider
requiredobject
requiredobject

No description provided.

config
array
array

Configuration of the Kafka cluster. The structure is documented below.

access
array
array

Access policy to the Kafka cluster. The structure is documented below.

kafka
array
array

Configuration of the Kafka subcluster. The structure is documented below.

array

User-defined settings for the Kafka cluster. The structure is documented below.

array

Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

version
string
zones
array
array

List of availability zones.

array

Configuration of the ZooKeeper subcluster. The structure is documented below.

array

Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

folderId
string
object

Reference to a Folder in resourcemanager to populate folderId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Folder in resourcemanager to populate folderId.

policy
object
object

Policies for selection.

resolve
string
array

A list of IDs of the host groups to place VMs of the cluster on.

labels
object
array

Maintenance policy of the Kafka cluster. The structure is documented below.

day
string
hour
number
type
string
name
string
networkId
string
object

Reference to a Network in vpc to populate networkId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in vpc to populate networkId.

policy
object
object

Policies for selection.

resolve
string
array

Security group ids, to which the Kafka cluster belongs.

array

References to SecurityGroup in vpc to populate securityGroupIds.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of SecurityGroup in vpc to populate securityGroupIds.

policy
object
object

Policies for selection.

resolve
string
array

IDs of the subnets, to which the Kafka cluster belongs.

array

References to Subnet in vpc to populate subnetIds.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of Subnet in vpc to populate subnetIds.

policy
object
object

Policies for selection.

resolve
string
topic
array
array

(Deprecated) To manage topics, please switch to using a separate resource type yandex_mdb_kafka_topic.

name
string
array

User-defined settings for the topic. The structure is documented below.

user
array
array

(Deprecated) To manage users, please switch to using a separate resource type yandex_mdb_kafka_user.

name
string
passwordSecretRef
requiredobject
requiredobject

The password of the user.

key
requiredstring
name
requiredstring
namespace
requiredstring
array

Set of permissions granted to the user. The structure is documented below.

array

Set of hosts, to which this permission grants access to.

role
string
topicName
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

config
array
array

Configuration of the Kafka cluster. The structure is documented below.

access
array
array

Access policy to the Kafka cluster. The structure is documented below.

kafka
array
array

Configuration of the Kafka subcluster. The structure is documented below.

array

User-defined settings for the Kafka cluster. The structure is documented below.

array

Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

version
string
zones
array
array

List of availability zones.

array

Configuration of the ZooKeeper subcluster. The structure is documented below.

array

Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

folderId
string
object

Reference to a Folder in resourcemanager to populate folderId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Folder in resourcemanager to populate folderId.

policy
object
object

Policies for selection.

resolve
string
array

A list of IDs of the host groups to place VMs of the cluster on.

labels
object
array

Maintenance policy of the Kafka cluster. The structure is documented below.

day
string
hour
number
type
string
name
string
networkId
string
object

Reference to a Network in vpc to populate networkId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in vpc to populate networkId.

policy
object
object

Policies for selection.

resolve
string
array

Security group ids, to which the Kafka cluster belongs.

array

References to SecurityGroup in vpc to populate securityGroupIds.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of SecurityGroup in vpc to populate securityGroupIds.

policy
object
object

Policies for selection.

resolve
string
array

IDs of the subnets, to which the Kafka cluster belongs.

array

References to Subnet in vpc to populate subnetIds.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of Subnet in vpc to populate subnetIds.

policy
object
object

Policies for selection.

resolve
string
topic
array
array

(Deprecated) To manage topics, please switch to using a separate resource type yandex_mdb_kafka_topic.

name
string
array

User-defined settings for the topic. The structure is documented below.

user
array
array

(Deprecated) To manage users, please switch to using a separate resource type yandex_mdb_kafka_user.

name
string
array

Set of permissions granted to the user. The structure is documented below.

array

Set of hosts, to which this permission grants access to.

role
string
topicName
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

KafkaClusterStatus defines the observed state of KafkaCluster.

object

No description provided.

config
array
array

Configuration of the Kafka cluster. The structure is documented below.

access
array
array

Access policy to the Kafka cluster. The structure is documented below.

kafka
array
array

Configuration of the Kafka subcluster. The structure is documented below.

array

User-defined settings for the Kafka cluster. The structure is documented below.

array

Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

version
string
zones
array
array

List of availability zones.

array

Configuration of the ZooKeeper subcluster. The structure is documented below.

array

Resources allocated to hosts of the ZooKeeper subcluster. The structure is documented below.

createdAt
string
folderId
string
health
string
host
array
array

A host of the Kafka cluster. The structure is documented below.

health
string
name
string
role
string
subnetId
string
zoneId
string
array

A list of IDs of the host groups to place VMs of the cluster on.

id
string
labels
object
array

Maintenance policy of the Kafka cluster. The structure is documented below.

day
string
hour
number
type
string
name
string
networkId
string
array

Security group ids, to which the Kafka cluster belongs.

status
string
array

IDs of the subnets, to which the Kafka cluster belongs.

topic
array
array

(Deprecated) To manage topics, please switch to using a separate resource type yandex_mdb_kafka_topic.

name
string
array

User-defined settings for the topic. The structure is documented below.

user
array
array

(Deprecated) To manage users, please switch to using a separate resource type yandex_mdb_kafka_user.

name
string
array

Set of permissions granted to the user. The structure is documented below.

array

Set of hosts, to which this permission grants access to.

role
string
topicName
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions