Skip to content

KafkaACL

Usage example

Example 
apiVersion: aiven.io/v1alpha1
kind: KafkaACL
metadata:
  name: my-kafka-acl
spec:
  authSecretRef:
    name: aiven-token
    key: token

  project: my-aiven-project
  serviceName: my-kafka
  topic: my-topic
  username: my-user
  permission: admin

Info

To create this resource, a Secret containing Aiven token must be created first.

Apply the resource with:

kubectl apply -f example.yaml

Verify the newly created KafkaACL:

kubectl get kafkaacls my-kafka-acl

The output is similar to the following: 

Name            Service Name    Project             Username    Permission    Topic       
my-kafka-acl    my-kafka        my-aiven-project    my-user     admin         my-topic

KafkaACL

KafkaACL is the Schema for the kafkaacls API.

Required

  • apiVersion (string). Value aiven.io/v1alpha1.
  • kind (string). Value KafkaACL.
  • metadata (object). Data that identifies the object, including a name string and optional namespace.
  • spec (object). KafkaACLSpec defines the desired state of KafkaACL. See below for nested schema.

spec

Appears on KafkaACL.

KafkaACLSpec defines the desired state of KafkaACL.

Required

  • permission (string, Enum: admin, read, readwrite, write). Kafka permission to grant (admin, read, readwrite, write).
  • project (string, Immutable, Pattern: ^[a-zA-Z0-9_-]+$, MaxLength: 63). Identifies the project this resource belongs to.
  • serviceName (string, Immutable, Pattern: ^[a-z][-a-z0-9]+$, MaxLength: 63). Specifies the name of the service that this resource belongs to.
  • topic (string). Topic name pattern for the ACL entry.
  • username (string). Username pattern for the ACL entry.

Optional

authSecretRef

Appears on spec.

Authentication reference to Aiven token in a secret.

Required

  • key (string, MinLength: 1).
  • name (string, MinLength: 1).