Configuration

Kafka Cluster

The ENVIRONMENT_NAME variable provides a UI friendly name for your Kafka cluster.

Requirements

Kpow requires at least one configured Kafka cluster to operate.

When configuring Multi-Cluster installations the first cluster configured is your Primary Cluster and contains all the snapshot, metrics, and audit metadata for the installation.

A Kafka cluster can have multiple associated Schema registries and/or Kafka connect clusters.

Compatibility

Kpow is compatible with Apache Kafka 1.0+.

Kpow has been tested and is compatible with Apache Kafka, Amazon MSK, Red Had AMQ Streams, Red Hat OpenShift Streams for Apache Kafka, Aiven Managed Kafka, Instaclustr Managed Kafka, Confluent Platform, and Confluent Cloud.

Kpow is not officially supported with Redpanda.

You may experience reduced function or unpredictable behaviour when using Kpow with Redpanda. Kpow Support is strictly limited to Apache Kafka only.

*****Some disk related metrics and telemetry are not available when using Kpow Azure Event Hubs.

FIPS

Kpow is capable of integrating with FIPS compliant Kafka clusters.

Contact [email protected] for assistance.

Access Control

User permissions to Kafka cluster resources are defined by Cluster actions.

Configuration

Kpow connects to a Kafka with the same configuration as a Kafka consumer or producer.

This configuration may be familiar to you, and is provided to Kpow by environment variables.

The list of connection variables follows, many are optional. See the Kafka client docs for more.

Need to create a Keystore from certificate files? This Stackoverflow answer might help.

VariableDescription
ENVIRONMENT_NAMEOptional, UI friendly label for this cluster and resources
CLUSTER_IDOptional, unique identifier for the cluster. Required when connecting to Azure Event Hubs or Redpanda.
BOOTSTRAPThe Kafka cluster bootstrap URL
KAFKA_VARIANT'EVENT_HUBS' for Azure Event Hubs or 'RHOSAK' for Red Had OpenShift Streams for Apache Kafka, otherwise do not set.
SECURITY_PROTOCOLPLAINTEXT, SSL, SASL_PLAINTEXT, or SASL_SSL
SASL_MECHANISMGSSAPI, AUTHBEARER, PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512
SASL_JAAS_CONFIGJava Authentication and Authorization Service config
SSL_KEYSTORE_LOCATIONThe path to a keystore for auth with certificates
SSL_KEYSTORE_PASSWORDThe password to access the auth keystore
SSL_KEY_PASSWORDThe password of the key within the keystore
SSL_KEYSTORE_TYPEThe file format of the keystore file
SSL_KEYMANAGER_ALGORITHMThe key manager algorithm used for SSL
SSL_TRUSTSTORE_LOCATIONThe path to a truststore for auth with certificates
SSL_TRUSTSTORE_PASSWORDThe password to access the auth truststore
SSL_TRUSTSTORE_TYPEThe file format of the truststore file
SSL_TRUSTMANAGER_ALGORITHMThe trust manager algorithm user for SSL
SSL_ENDPOINT_IDENTIFICATION_ALGORITHMOften required when authenticating via SSL
SSL_PROVIDERName of the security provider used for SSL
SSL_CIPHER_SUITESA list of cipher suites
SSL_PROTOCOLTLS, TLSv1.1, or TLSv1.2
SSL_ENABLED_PROTOCOLSThe list of protocols enabled for SSL
SSL_KEYSTORE_KEY<p><strong></strong></p><p>Private key in the format specified by <code>SSL_KEYSTORE_TYPE</code>. See: <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-651+-+Support+PEM+format+for+SSL+certificates+and+private+key">KIP-651</a></p>
SSL_KEYSTORE_CERTIFICATE_CHAINCertificate chain in the format specified by SSL_KEYSTORE_TYPE. See: KIP-651
SSL_TRUSTSTORE_CERTIFICATESTrusted certificates in the format specified by SSL_KEYSTORE_TYPE. See: KIP-651
Previous
Environment Variables