红帽全球峰会此内容没有您所选择的语言版本。
Chapter 2. API concepts
The Streams for Apache Kafka Proxy Operator uses a declarative API based on OpenShift custom resources to manage proxy deployments.
The operator takes 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-
KafkaServiceandKafkaProtocolFilterresources may reference aSecretto provide security-sensitive data such as TLS certificates or passwords. ConfigMap-
KafkaServiceandKafkaProtocolFilterresources may reference aConfigMapto provide non-sensitive configuration such as trusted CA certificates.
Figure 2.1. Example input resources and the references between them
Based on the input resources, the operator generates the core OpenShift resources needed to deploy the Streams for Apache Kafka Proxy, such as the following:
ConfigMap- Provides the proxy configuration file mounted into the proxy container.
Deployment-
Manages the proxy
Podand 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
2.2. Custom resource API compatibility
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.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}