ServerlessCluster

kafka.services.k8s.aws/v1alpha1

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

Metadata

Property	Value
Scope	Namespaced
Kind	`ServerlessCluster`
ListKind	`ServerlessClusterList`
Plural	`serverlessclusters`
Singular	`serverlesscluster`

Spec

associatedSCRAMSecretRefs:
  from: 
    name: string
    namespace: string
associatedSCRAMSecrets:
- string
name: string
provisioned: 
  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
  numberOfBrokerNodes: integer
  openMonitoring: 
    prometheus: 
      jmxExporter: 
        enabledInBroker: boolean
      nodeExporter: 
        enabledInBroker: boolean
  storageMode: string
serverless: 
  clientAuthentication: 
    sasl: 
      iam: 
        enabled: boolean
  vpcConfigs:
    securityGroupIDs:
    - string
    subnetIDs:
    - 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
|| name
Required | string
The name of the cluster. | | provisioned
Optional | object
Information about the provisioned cluster. | | provisioned.brokerNodeGroupInfo
Optional | object
Describes the setup to be used for Apache Kafka broker nodes in the cluster. | | provisioned.brokerNodeGroupInfo.brokerAZDistribution
Optional | string
The distribution of broker nodes across Availability Zones. This is an optional
parameter. If you don’t specify it, Amazon MSK gives it the value DEFAULT.
You can also explicitly set this parameter to the value DEFAULT. No other
values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones
that correspond to the subnets you provide when you create the cluster. | | provisioned.brokerNodeGroupInfo.clientSubnets
Optional | array
| | provisioned.brokerNodeGroupInfo.clientSubnets.[]
Required | string
|| provisioned.brokerNodeGroupInfo.connectivityInfo
Optional | object
Information about the broker access configuration. | | provisioned.brokerNodeGroupInfo.connectivityInfo.publicAccess
Optional | object
Public access control for brokers. | | provisioned.brokerNodeGroupInfo.connectivityInfo.publicAccess.type
Optional | string
| | provisioned.brokerNodeGroupInfo.instanceType
Optional | string
| | provisioned.brokerNodeGroupInfo.securityGroups
Optional | array
| | provisioned.brokerNodeGroupInfo.securityGroups.[]
Required | string
|| provisioned.brokerNodeGroupInfo.storageInfo
Optional | object
Contains information about storage volumes attached to MSK broker nodes. | | provisioned.brokerNodeGroupInfo.storageInfo.ebsStorageInfo
Optional | object
Contains information about the EBS storage volumes attached to Apache Kafka
broker nodes. | | provisioned.brokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput
Optional | object
Contains information about provisioned throughput for EBS storage volumes
attached to kafka broker nodes. | | provisioned.brokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.enabled
Optional | boolean
| | provisioned.brokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.volumeThroughput
Optional | integer
| | provisioned.brokerNodeGroupInfo.storageInfo.ebsStorageInfo.volumeSize
Optional | integer
| | provisioned.clientAuthentication
Optional | object
Includes all client authentication information. | | provisioned.clientAuthentication.sasl
Optional | object
Details for client authentication using SASL. | | provisioned.clientAuthentication.sasl.iam
Optional | object
Details for IAM access control. | | provisioned.clientAuthentication.sasl.iam.enabled
Optional | boolean
| | provisioned.clientAuthentication.sasl.scram
Optional | object
Details for SASL/SCRAM client authentication. | | provisioned.clientAuthentication.sasl.scram.enabled
Optional | boolean
| | provisioned.clientAuthentication.tls
Optional | object
Details for client authentication using TLS. | | provisioned.clientAuthentication.tls.certificateAuthorityARNList
Optional | array
| | provisioned.clientAuthentication.tls.certificateAuthorityARNList.[]
Required | string
|| provisioned.clientAuthentication.tls.enabled
Optional | boolean
| | provisioned.clientAuthentication.unauthenticated
Optional | object
| | provisioned.clientAuthentication.unauthenticated.enabled
Optional | boolean
| | provisioned.configurationInfo
Optional | object
Specifies the configuration to use for the brokers. | | provisioned.configurationInfo.arn
Optional | string
| | provisioned.configurationInfo.revision
Optional | integer
| | provisioned.encryptionInfo
Optional | object
Includes encryption-related information, such as the AWS KMS key used for
encrypting data at rest and whether you want MSK to encrypt your data in
transit. | | provisioned.encryptionInfo.encryptionAtRest
Optional | object
The data-volume encryption details. | | provisioned.encryptionInfo.encryptionAtRest.dataVolumeKMSKeyID
Optional | string
| | provisioned.encryptionInfo.encryptionInTransit
Optional | object
The settings for encrypting data in transit. | | provisioned.encryptionInfo.encryptionInTransit.clientBroker
Optional | string
Client-broker encryption in transit setting. | | provisioned.encryptionInfo.encryptionInTransit.inCluster
Optional | boolean
| | provisioned.enhancedMonitoring
Optional | string
Specifies which metrics are gathered for the MSK cluster. This property has
the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER,
and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each
of these levels of monitoring, see Monitoring (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html). | | provisioned.kafkaVersion
Optional | string
| | provisioned.loggingInfo
Optional | object
| | provisioned.loggingInfo.brokerLogs
Optional | object
| | provisioned.loggingInfo.brokerLogs.cloudWatchLogs
Optional | object
| | provisioned.loggingInfo.brokerLogs.cloudWatchLogs.enabled
Optional | boolean
| | provisioned.loggingInfo.brokerLogs.cloudWatchLogs.logGroup
Optional | string
| | provisioned.loggingInfo.brokerLogs.firehose
Optional | object
| | provisioned.loggingInfo.brokerLogs.firehose.deliveryStream
Optional | string
| | provisioned.loggingInfo.brokerLogs.firehose.enabled
Optional | boolean
| | provisioned.loggingInfo.brokerLogs.s3
Optional | object
| | provisioned.loggingInfo.brokerLogs.s3.bucket
Optional | string
| | provisioned.loggingInfo.brokerLogs.s3.enabled
Optional | boolean
| | provisioned.loggingInfo.brokerLogs.s3.prefix
Optional | string
| | provisioned.numberOfBrokerNodes
Optional | integer
| | provisioned.openMonitoring
Optional | object
JMX and Node monitoring for the MSK cluster. | | provisioned.openMonitoring.prometheus
Optional | object
Prometheus settings. | | provisioned.openMonitoring.prometheus.jmxExporter
Optional | object
Indicates whether you want to turn on or turn off the JMX Exporter. | | provisioned.openMonitoring.prometheus.jmxExporter.enabledInBroker
Optional | boolean
| | provisioned.openMonitoring.prometheus.nodeExporter
Optional | object
Indicates whether you want to turn on or turn off the Node Exporter. | | provisioned.openMonitoring.prometheus.nodeExporter.enabledInBroker
Optional | boolean
| | provisioned.storageMode
Optional | string
Controls storage mode for various supported storage tiers. | | serverless
Optional | object
Information about the serverless cluster. | | serverless.clientAuthentication
Optional | object
Includes all client authentication information. | | serverless.clientAuthentication.sasl
Optional | object
Details for client authentication using SASL. | | serverless.clientAuthentication.sasl.iam
Optional | object
Details for IAM access control. | | serverless.clientAuthentication.sasl.iam.enabled
Optional | boolean
| | serverless.vpcConfigs
Optional | array
| | serverless.vpcConfigs.[]
Required | object
The configuration of the Amazon VPCs for the cluster. || serverless.vpcConfigs.[].securityGroupIDs
Optional | array
| | serverless.vpcConfigs.[].securityGroupIDs.[]
Required | string
|| serverless.vpcConfigs.[].subnetIDs
Optional | array
| | serverless.vpcConfigs.[].subnetIDs.[]
Required | string
|| tags
Optional | object
A map of tags that you want the cluster to have. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
currentVersion: string
state: string
type: 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. 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
currentVersion Optional	string The current version of the MSK cluster.
state Optional	string The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
type Optional	string The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

ServerlessCluster

Metadata#

Spec#

Status#

Metadata

Spec

Status