Topic
Creates a topic in Kafka.- API key(s): AdminToken, AppToken
- Managed with: API, CLI, UI, TF
- Labels support: Full
metadata.cluster
is a valid Kafka clustermetadata.name
has to belong to the application instancespec.replicationFactor
andspec.partitions
are immutable and can’t be modified once the topic is createdspec.configs
has to be a valid Kafka topic config
metadata.description
(optional), the description field in markdown that will be displayed in the Topic Catalog page in the UI.metadata.descriptionIsEditable
(optional), defaults totrue
. Defines whether the description can be updated in the UI.metadata.catalogVisibility
(optional), can bePUBLIC
orPRIVATE
. When the topic is linked to a Self-service application, defines whether the topic is visible (PUBLIC
) in the Topic Catalog or not (PRIVATE
). If empty, the visibility in the topic list is inherited fromspec.defaultCatalogVisibility
.
- Kafka:
- Topic is created / updated.
- In dry-run mode, topic creation is validated against the Kafka cluster using AdminClient’s CreateTopicOption.validateOnly(true) flag.
Subject
Creates a subject in the schema registry.- API key(s): AdminToken, AppToken
- Managed with: API, CLI, UI
- Labels support: Partial
metadata.cluster
is a valid Kafka cluster.metadata.name
has to belong to the application instance.- Mandatory
spec.schema
orspec.schemaFile
should be set:schema
requires an inline schema.schemaFile
requires a path to a file that contains the schema relative to the CLI (version >=0.2.5) execution path.
spec.format
is mandatory. Defines the schema format: AVRO, PROTOBUF or JSON.spec.compatibility
(optional), defines the subject compatibility mode:BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
orNONE
. If undefined, the compatibility mode will be the one defined at the schema registry global level.spec.references
(optional), specifies the names of referenced schemas.
- Kafka/schema registry:
- subject is created/updated.
- in dry-run mode, subject will be checked against the schema registry’s compatibility API.
Connector
Creates a connector on a Kafka Connect cluster.- API key(s): AdminToken, AppToken
- Managed with: API, CLI, UI
- Labels support: Partial
metadata.connectCluster
is a valid Kafka Connect clustermetadata.name
has to belong to the application instance
metadata.autoRestart.enabled
(optional), default is"false"
. Defines whether Console’s automatic restart feature is enabled for this connector.metadata.autoRestart.frequencySeconds
(optional), default is600
, meaning 10 minutes. Defines the delay between consecutive restart attempts.
Service account
Manages the ACLs of a service account in Kafka. This does not create the service account, only assigns the ACLs.- API key(s): AdminToken
- Managed with: API, CLI, UI
- Labels support: Full
-
metadata.cluster
is a valid Kafka cluster. -
metadata.name
is a valid, pre-existing service account. -
spec.authorization.type
has to beKAFKA_ACL
(not supported for Aiven Kafka clusters) orAIVEN_ACL
(is only supported for Aiven Kafka clusters). When set toKAFKA_ACL
:spec.acls[].type
has to be a valid Kafka resource type.spec.acls[].operations
has to contain only operations that are valid for the resource type.spec.acls[].host
(optional), will default to*
.spec.acls[].permission
(optional), will default toAllow
.
AIVEN_ACL
:spec.acls[].resourceType
has to be a valid resource type on Aiven Kafka forTOPIC
or a valid resource forSCHEMA
.spec.acls[].name
has to be a valid resource name on Aiven Kafka. For schemas, it has to match^(Config:|Subject:[A-Za-z0-9/_.*?-]+)
.spec.acls[].permission
has to contain only operations that are valid for the resource type.
- Kafka:
- Service account ACLs are created/updated.
- In dry-run mode, service account ACLs are validated against the aforementioned criteria, ensuring the ACL definitions are legal.