Supported versions: 5.0.x

CloudKarafka

Get started with Lenses. Click here to set it up with Docker and connect to a Cloud Karafka managed Kafka with the standard configuration.

1. Get your Lenses access key

Sign up with Lenses and download your access key.

2. Sign up for Cloud Karafka and create a Kafka

Cloud Karafka is a fully managed Apache Kafka streaming platform, deployable in the cloud of your choice.

Start by signing up for a Cloud Karafka account . Follow the in-product instructions to launch Kafka clusters within the Cloud Karafka user interface.

Cloud Karafka

Then, gather the connection points of your cluster.

Gather 1 connection point

  1. Kafka endpoint. Go to Details > Using SASL/SCRAM.
Kafka endpoint

3. Running Lenses with Docker

Run the following in a terminal.

docker run -e LENSES_PORT=8080 -p 8080:8080 lensesio/lenses

A message similar to the following should appear in the logs:

2021-12-16 18:17:04,322 INFO  [i.l.b.r.HttpServer] [ioapp-compute-6] Lenses http server started and listening to requests.

4. Login

Open your browser and go to:

http://localhost:8080

Login as admin:

User:     admin
Password: admin

5. Wizard setup

On the wizard step 2 on Bootstrap Servers configuration add the endpoints from above, comma separated. On our case it would be:

SASL_SSL://tricycle-01.srvs.cloudkafka.com:9094,
SASL_SSL://tricycle-02.srvs.cloudkafka.com:9094,
SASL_SSL://tricycle-03.srvs.cloudkafka.com:9094

Select SASL SSL from the Security Protocol options and in the SASL Mechanism choose SCRAM-SHA-256.

On the JAAS Configuration below add the username and the password provided in the Connection details.

org.apache.kafka.common.security.scram.ScramLoginModule required 
username="[Your_Connection_Details_Username]" 
password="[Your_Connection_Details_Password]"

Click on Test Kafka Brokers. And you should get the message: Validation completed successfully.

Broker Validation

6. Lenses License

On step 4 add your license by copy and pasting the JSON file. Again you should get the message: Validation completed successfully.

License Validation

7. Validation

Click on Save & Boot Lenses. It will shortly validate the configurations

Wizard Validation

8. Eureka!

Lenses Dashboard

Next Steps

Limitations

With Cloud Karafka, these endpoints are only available in specific configurations:

  • Kafka metrics via JMX, only with VPC peering.
  • Schema Registry
  • Kafka Connect

Without these endpoints the below Lenses features are not available: