Resources Reference
Overview
The Resources Reference page lists all the concepts that can be manipulated in Console, as well as how to manage them using an Infra as Code (IaC) approach.
There are two kinds of API Keys to use with the CLI, Terraform and Public API:
- Admin API Key have all permissions over all resources in Console
- Application API Key permission are scoped to Application instances & Ownership model defined in Self-service
In general, Admin API Key can bypass Application owners and "act" as an Application API Key
The resources presented here can be managed from the CLI, the Public API, Terraform, or the Console UI.
- CLI, Terraform and Public API uses an API Key to validate permissions.
- Console UI relies on RBAC model to validate what the user can do.
Resources
The resources are split into 3 categories:
- Console Resources are resources that exist only in Console such as
- Cluster Configurations
- Users, Groups & Permissions
- Alerts, DataMasking Policies
- Kafka Resources are Kafka resources that gets created in the Kafka ecosystem
- Topics
- Subjects
- Connectors
- ...
- Self-service resources
- Application Groups
- Topic Policies
- Instance Service Accounts & ACLs
Limitations
Terraform support
We're working hard to bring everything that you can do using the Console UI into the CLI, Public API, and Terraform.
You can visualize the availability for each resource using the following tags:
- CLI API Terraform Console UI
Conduktor labels
Conduktor labels allow you to add metadata, filter and organize your resources. Check the following table for the list of currently supported and incoming resources:
- Full Label Support
- Partial Label Support (No UI yet)
- Label Support Incoming
Limitations summary
| Resource | API/CLI Support | Terraform Support | Label Support |
|---|---|---|---|
| Console Resources | |||
| ConsoleGroup | ✅ | ✅ | 🚫 |
| ConsoleUser | ✅ | ✅ | 🚫 |
| KafkaCluster | ✅ | ✅ | ⚠️ (Not in UI) |
| KafkaConnectCluster | ✅ | ✅ | ⚠️ (Not in UI) |
| KsqlDBCluster | ✅ | ⚠️(Generic Resource) | 🚫 |
| Alert | ✅ | ⚠️(Generic Resource) | 🚫 |
| DataMaskingPolicy | 🚫 | 🚫 | 🚫 |
| Certificate | 🚫(V1 API only) | 🚫 | 🚫 |
| PartnerZone | ✅ | ⚠️(Generic Resource) | ⚠️ (Not in UI) |
| Kafka Resources | |||
| Topic | ✅ | ✅ | ✅ |
| Subject | ✅ | ⚠️(Generic Resource) | ⚠️ (Not in UI) |
| Connector | ✅ | ⚠️(Generic Resource) | ⚠️ (Not in UI) |
| ServiceAccount | ✅ | ✅ | |
| Self-Service Resources | |||
| Application | ✅ | ✅ | 🚫 |
| ApplicationInstance | ✅ | ✅ | 🚫 |
| ApplicationInstancePermission | ✅ | ⚠️(Generic Resource) | 🚫 |
| ApplicationGroup | ✅ | ⚠️(Generic Resource) | 🚫 |
| TopicPolicy | ✅ | ✅ | 🚫 |