此内容没有您所选择的语言版本。

Chapter 2. API concepts


The operator takes these custom resources and core OpenShift resources as inputs:

KafkaProxy
Defines an instance of the proxy.
VirtualKafkaCluster
Represents a logical Kafka cluster that will be exposed to Kafka clients.
KafkaProxyIngress
Configures how a virtual cluster is exposed on the network to Kafka clients.
KafkaService
Specifies a backend Kafka cluster for a virtual cluster.
KafkaProtocolFilter
Specifies filter mechanisms for use with a virtual cluster.
Secret
KafkaService and KafkaProtocolFilter resources may reference a Secret to provide security-sensitive data such as TLS certificates or passwords.
ConfigMap
KafkaService and KafkaProtocolFilter resources may reference a ConfigMap to provide non-sensitive configuration such as trusted CA certificates.

Figure 2.1. Example input resources and the references between them

Diagram showing the input resources, KafkaProxy, VirtualKafkaCluster, etc, as boxes, connected by arrows representing the references between the resources.

Based on the input resources just described, the operator generates the core OpenShift resources needed to deploy the Streams for Apache Kafka Proxy, such as:

ConfigMap
Provides the proxy configuration file mounted into the proxy container.
Deployment
Manages the proxy Pod and container.
Service
Exposes the proxy over the network to other workloads in the same OpenShift cluster.

The API is decomposed into multiple custom resources in a similar way to the OpenShift Gateway API, and for similar reasons. You can make use of Kubernete’s Role-Based Access Control (RBAC) to divide responsibility for different aspects of the overall proxy functionality to different roles (people) in your organization.

For example, you might grant networking engineers the ability to configure KafkaProxy and KafkaProxyIngress, while giving application developers the ability to configure VirtualKafkaCluster, KafkaService, and KafkaProtocolFilter resources.

Figure 2.2. Generated OpenShift resources and the relationships between them

Diagram showing the output resources, Deployment, Pod, ConfigMap, Service, with arrows showing the Deployment managing the Pod, the Pod mounting the ConfigMap, and the Service selecting the Pod.

2.2. Compatibility

2.2.1. Custom resource APIs

Streams for Apache Kafka Proxy custom resource definitions are packaged and deployed alongside the operator. Currently, there’s only a single version of the custom resource APIs: v1alpha1.

Future updates to the operator may introduce new versions of the custom resource APIs. At that time the operator will be backwards compatible with older versions of those APIs and an upgrade procedure will be used to upgrade existing custom resources to the new API version.

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat
返回顶部