Resources on Jikkou

ACL for Aiven Apache Kafka®

Mon, 01 Jan 0001 00:00:00 +0000

The KafkaTopicAclEntry resources are used to manage the Access Control Lists in Aiven for Apache Kafka®. A KafkaTopicAclEntry resource defines the permission to be granted to a user for one or more kafka topics.

`KafkaTopicAclEntry`

Specification

Here is the resource definition file for defining a KafkaTopicAclEntry.

---
apiVersion: "kafka.aiven.io/v1beta1" # The api version (required)
kind: "KafkaTopicAclEntry" # The resource kind (required)
metadata:
 labels: { }
 annotations: { }
spec:
 permission: <> # The permission. Accepted values are: READ, WRITE, READWRITE, ADMIN
 username: <>  # The username
 topic: <>  # Topic name or glob pattern

Example

Here is a simple example that shows how to define a single ACL entry using the KafkaTopicAclEntry resource type.

Quotas for Aiven Apache Kafka®

Mon, 01 Jan 0001 00:00:00 +0000

The KafkaQuota resources are used to manage the Quotas in Aiven for Apache Kafka® service. For more details, see https://docs.aiven.io/docs/products/kafka/concepts/kafka-quotas

`KafkaQuota`

Specification

Here is the resource definition file for defining a KafkaQuota.

---
apiVersion: "kafka.aiven.io/v1beta1" # The api version (required)
kind: "KafkaQuota" # The resource kind (required)
metadata:
 labels: { }
 annotations: { }
spec:
 user: <string> # The username: (Optional: 'default' if null)
 clientId: <string>  # The client-id
 consumerByteRate: <number>  # The quota in bytes for restricting data consumption
 producerByteRate: <number>  # The quota in bytes for restricting data production
 requestPercentage: <number>

Example

Here is a simple example that shows how to define a single ACL entry using the KafkaQuota resource type.

ACL for Aiven Schema Registry

Mon, 01 Jan 0001 00:00:00 +0000

The SchemaRegistryAclEntry resources are used to manage the Access Control Lists in Aiven for Schema Registry. A SchemaRegistryAclEntry resource defines the permission to be granted to a user for one or more Schema Registry Subjects.

`SchemaRegistryAclEntry`

Specification

Here is the resource definition file for defining a SchemaRegistryAclEntry.

---
apiVersion: "kafka.aiven.io/v1beta1" # The api version (required)
kind: "SchemaRegistryAclEntry" # The resource kind (required)
metadata:
 labels: { }
 annotations: { }
spec:
 permission: <> # The permission. Accepted values are: READ, WRITE
 username: <>  # The username
 resource: <>  # The Schema Registry ACL entry resource name pattern

NOTE: The resource name pattern should be Config: or Subject:<subject_name> where subject_name must consist of alpha-numeric characters, underscores, dashes, dots and glob characters * and ?.

Subject for Aiven Schema Registry

Mon, 01 Jan 0001 00:00:00 +0000

SchemaRegistrySubject resources are used to define the subject schemas you want to manage on your Schema Registry. A SchemaRegistrySubject resource defines the schema, the compatibility level, and the references to be associated with a subject version.

`SchemaRegistrySubject`

Specification

Here is the resource definition file for defining a SchemaRegistrySubject.

apiVersion: "kafka.aiven.io/v1beta1" # The api version (required)
kind: "SchemaRegistrySubject" # The resource kind (required)
metadata:
 name: <The name of the subject>  # (required)
 labels: { }
 annotations: { }
spec:
 schemaRegistry:
 vendor: 'Karapace' # (optional) The vendor of the Schema Registry
 compatibilityLevel: <compatibility_level>  # (optional) The schema compatibility level for this subject.
 schemaType: <The schema format> # (required) Accepted values are: AVRO, PROTOBUF, JSON
 schema:
 $ref: <url or path>  # 
 references: # Specifies the names of referenced schemas (optional array).
 - name: <>  # The name for the reference.
 subject: <>  # The subject under which the referenced schema is registered.
 version: <>  # The exact version of the schema under the registered subject.
]

The metadata.name property is mandatory and specifies the name of the Subject.