Conduktor resource reference

Overview

Component	Reference
Console	Console API reference
Console	Console configuration reference
Console	Console CLI reference
Console	Terraform reference
Console	Console resources reference
Gateway	Gateway API reference
Gateway	Gateway configuration reference
Gateway	Gateway CLI reference
Gateway	Gateway resources reference

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 that you can 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 and 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 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 and 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 and ACLs

Limitations

We're working hard to bring everything that you can do using Console UI into the Conduktor CLI, APIs and Terraform.

For a quick visual reference, each resource will list the supported systems with relevant tags:

Console UI CLI API Terraform

Conduktor labels

Conduktor labels allow you to add metadata, filter and organize your resources. Check the following table for the list of currently supported resources.

• Full label support
• Partial label support (no UI yet)
• Label support upcoming

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	✅	✅	🚫