Cluster

kafka.services.k8s.aws/v1alpha1

Type	Link
GoDoc	kafka-controller/apis/v1alpha1#Cluster

Metadata

Property	Value
Scope	Namespaced
Kind	`Cluster`
ListKind	`ClusterList`
Plural	`clusters`
Singular	`cluster`

Returns information about a cluster of either the provisioned or the serverless type.

Spec

associatedSCRAMSecretRefs:
  from: 
    name: string
    namespace: string
associatedSCRAMSecrets:
- string
brokerNodeGroupInfo: 
  brokerAZDistribution: string
  clientSubnets:
  - string
  connectivityInfo: 
    publicAccess: 
      type_: string
  instanceType: string
  securityGroups:
  - string
  storageInfo: 
    ebsStorageInfo: 
      provisionedThroughput: 
        enabled: boolean
        volumeThroughput: integer
      volumeSize: integer
clientAuthentication: 
  sasl: 
    iam: 
      enabled: boolean
    scram: 
      enabled: boolean
  tls: 
    certificateAuthorityARNList:
    - string
    enabled: boolean
  unauthenticated: 
    enabled: boolean
configurationInfo: 
  arn: string
  revision: integer
encryptionInfo: 
  encryptionAtRest: 
    dataVolumeKMSKeyID: string
  encryptionInTransit: 
    clientBroker: string
    inCluster: boolean
enhancedMonitoring: string
kafkaVersion: string
loggingInfo: 
  brokerLogs: 
    cloudWatchLogs: 
      enabled: boolean
      logGroup: string
    firehose: 
      deliveryStream: string
      enabled: boolean
    s3: 
      bucket: string
      enabled: boolean
      prefix: string
name: string
numberOfBrokerNodes: integer
openMonitoring: 
  prometheus: 
    jmxExporter: 
      enabledInBroker: boolean
    nodeExporter: 
      enabledInBroker: boolean
storageMode: string
tags: {}

Field	Description
associatedSCRAMSecretRefs Optional	array
associatedSCRAMSecretRefs.[] Required	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
  name: my-api || **associatedSCRAMSecretRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| associatedSCRAMSecretRefs.[].from.name
Optional | string
| | associatedSCRAMSecretRefs.[].from.namespace
Optional | string
| | associatedSCRAMSecrets
Optional | array
| | associatedSCRAMSecrets.[]
Required | string
|| brokerNodeGroupInfo
Required | object
Information about the brokers. | | brokerNodeGroupInfo.brokerAZDistribution
Optional | string
The distribution of broker nodes across Availability Zones. By default, broker
nodes are distributed among the Availability Zones of your Region. Currently,
the only supported value is DEFAULT. You can either specify this value explicitly
or leave it out. | | brokerNodeGroupInfo.clientSubnets
Optional | array
| | brokerNodeGroupInfo.clientSubnets.[]
Required | string
|| brokerNodeGroupInfo.connectivityInfo
Optional | object
Information about the broker access configuration. | | brokerNodeGroupInfo.connectivityInfo.publicAccess
Optional | object
Broker public access control. | | **brokerNodeGroupInfo.connectivityInfo.publicAccess.type_**
Optional | **string**
| | **brokerNodeGroupInfo.instanceType**
Optional | **string**
| | **brokerNodeGroupInfo.securityGroups**
Optional | **array**
| | **brokerNodeGroupInfo.securityGroups.[]**
Required | **string**
|| **brokerNodeGroupInfo.storageInfo**
Optional | **object**
Contains information about storage volumes attached to MSK broker nodes. | | **brokerNodeGroupInfo.storageInfo.ebsStorageInfo**
Optional | **object**
Contains information about the EBS storage volumes attached to Apache Kafka
broker nodes. | | **brokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput**
Optional | **object**
Contains information about provisioned throughput for EBS storage volumes
attached to kafka broker nodes. | | **brokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.enabled**
Optional | **boolean**
| | **brokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.volumeThroughput**
Optional | **integer**
| | **brokerNodeGroupInfo.storageInfo.ebsStorageInfo.volumeSize**
Optional | **integer**
| | **clientAuthentication**
Optional | **object**
Includes all client authentication related information. | | **clientAuthentication.sasl**
Optional | **object**
| | **clientAuthentication.sasl.iam**
Optional | **object**
| | **clientAuthentication.sasl.iam.enabled**
Optional | **boolean**
| | **clientAuthentication.sasl.scram**
Optional | **object**
| | **clientAuthentication.sasl.scram.enabled**
Optional | **boolean**
| | **clientAuthentication.tls**
Optional | **object**
Details for client authentication using TLS. | | **clientAuthentication.tls.certificateAuthorityARNList**
Optional | **array**
| | **clientAuthentication.tls.certificateAuthorityARNList.[]**
Required | **string**
|| **clientAuthentication.tls.enabled**
Optional | **boolean**
| | **clientAuthentication.unauthenticated**
Optional | **object**
Contains information about unauthenticated traffic to the cluster. | | **clientAuthentication.unauthenticated.enabled**
Optional | **boolean**
| | **configurationInfo**
Optional | **object**
Represents the configuration that you want MSK to use for the cluster. | | **configurationInfo.arn**
Optional | **string**
| | **configurationInfo.revision**
Optional | **integer**
| | **encryptionInfo**
Optional | **object**
Includes all encryption-related information. | | **encryptionInfo.encryptionAtRest**
Optional | **object**
The data-volume encryption details. | | **encryptionInfo.encryptionAtRest.dataVolumeKMSKeyID**
Optional | **string**
| | **encryptionInfo.encryptionInTransit**
Optional | **object**
The settings for encrypting data in transit. | | **encryptionInfo.encryptionInTransit.clientBroker**
Optional | **string**
Client-broker encryption in transit setting. | | **encryptionInfo.encryptionInTransit.inCluster**
Optional | **boolean**
| | **enhancedMonitoring**
Optional | **string**
Specifies the level of monitoring for the MSK cluster. The possible values
are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. | | **kafkaVersion**
Required | **string**
The version of Apache Kafka. | | **loggingInfo**
Optional | **object**
LoggingInfo details. | | **loggingInfo.brokerLogs**
Optional | **object**
The broker logs configuration for this MSK cluster. | | **loggingInfo.brokerLogs.cloudWatchLogs**
Optional | **object**
Details of the CloudWatch Logs destination for broker logs. | | **loggingInfo.brokerLogs.cloudWatchLogs.enabled**
Optional | **boolean**
| | **loggingInfo.brokerLogs.cloudWatchLogs.logGroup**
Optional | **string**
| | **loggingInfo.brokerLogs.firehose**
Optional | **object**
Firehose details for BrokerLogs. | | **loggingInfo.brokerLogs.firehose.deliveryStream**
Optional | **string**
| | **loggingInfo.brokerLogs.firehose.enabled**
Optional | **boolean**
| | **loggingInfo.brokerLogs.s3**
Optional | **object**
The details of the Amazon S3 destination for broker logs. | | **loggingInfo.brokerLogs.s3.bucket**
Optional | **string**
| | **loggingInfo.brokerLogs.s3.enabled**
Optional | **boolean**
| | **loggingInfo.brokerLogs.s3.prefix**
Optional | **string**
| | **name**
Required | **string**
The name of the cluster. | | **numberOfBrokerNodes**
Required | **integer**
The number of Apache Kafka broker nodes in the Amazon MSK cluster. | | **openMonitoring**
Optional | **object**
The settings for open monitoring. | | **openMonitoring.prometheus**
Optional | **object**
Prometheus settings. | | **openMonitoring.prometheus.jmxExporter**
Optional | **object**
Indicates whether you want to enable or disable the JMX Exporter. | | **openMonitoring.prometheus.jmxExporter.enabledInBroker**
Optional | **boolean**
| | **openMonitoring.prometheus.nodeExporter**
Optional | **object**
Indicates whether you want to enable or disable the Node Exporter. | | **openMonitoring.prometheus.nodeExporter.enabledInBroker**
Optional | **boolean**
| | **storageMode**
Optional | **string**
This controls storage mode for supported storage tiers. | | **tags**
Optional | **object**
Create tags when creating the cluster. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
state: string
zookeeperConnectString: string
zookeeperConnectStringTLS: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
state Optional	string The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
zookeeperConnectString Optional	string
zookeeperConnectStringTLS Optional	string

Cluster

Metadata#

Spec#

Status#

Metadata

Spec

Status