Skip to content

Commit c70711d

Browse files
Haaroleangitbook-bot
authored andcommitted
GITBOOK-36: Add an AWS quickstart page
1 parent a227e21 commit c70711d

File tree

6 files changed

+71
-67
lines changed

6 files changed

+71
-67
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Versatile, fast and lightweight web UI for managing Apache Kafka® clusters. Built by developers, for developers.**
66

7-
****
7+
88

99
**UI for Apache Kafka is a free, open-source web UI to monitor and manage Apache Kafka clusters.**
1010

SUMMARY.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323

2424
## 👷♂ Configuration
2525

26-
* [Quick Start](configuration/quick-start.md)
26+
* [Quick Start](configuration/quick-start/README.md)
27+
* [via AWS Marketplace](configuration/quick-start/via-aws-marketplace.md)
2728
* [Configuration wizard](configuration/configuration-wizard.md)
2829
* [Configuration file](configuration/configuration-file.md)
2930
* [Compose examples](configuration/compose-examples.md)
@@ -46,8 +47,7 @@
4647
* [LDAP / Active Directory](configuration/authentication/ldap-active-directory.md)
4748
* [RBAC (Role based access control)](configuration/rbac-role-based-access-control.md)
4849
* [Data masking](configuration/data-masking.md)
49-
* [Serialization / SerDe](configuration/serialization-serde/README.md)
50-
* [Protobuf setup](configuration/serialization-serde/protobuf-setup.md)
50+
* [Serialization / SerDe](configuration/serialization-serde.md)
5151
* [OpenDataDiscovery Integration](configuration/opendatadiscovery-integration.md)
5252

5353
## ❓ FAQ

configuration/quick-start.md renamed to configuration/quick-start/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ The app in AWS Marketplace could be found by [this link](https://aws.amazon.com/
3939

4040
## Helm way
4141

42-
To install the app via Helm please refer to [this page](helm-charts/quick-start.md).
42+
To install the app via Helm please refer to [this page](../helm-charts/quick-start.md).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
description: How to Deploy Kafka UI from AWS Marketplace
3+
---
4+
5+
# via AWS Marketplace
6+
7+
### Step 1: Go to AWS Marketplace
8+
9+
Go to the AWS Marketplace website and sign in to your account.
10+
11+
### Step 2: Find UI for Apache Kafka
12+
13+
Either use the search bar to find "UI for Apache Kafka" or go to [marketplace product page](https://aws.amazon.com/marketplace/pp/prodview-ogtt5hfhzkq6a).
14+
15+
### Step 3: Subscribe and Configure
16+
17+
Click "Continue to Subscribe" and accept the terms and conditions. Click "Continue to Configuration".
18+
19+
### Step 4: Choose the Software Version and Region
20+
21+
Choose your desired software version and region. Click "Continue to Launch".
22+
23+
### Step 5: Launch the Instance
24+
25+
Choose "Launch from Website" and select your desired EC2 instance type. You can choose a free tier instance or choose a larger instance depending on your needs. We recommend having at least 512 RAM for an instant.
26+
27+
Next, select the VPC and subnet where you want the instance to be launched. If you don't have an existing VPC or subnet, you can create one by clicking "Create New VPC" or "Create New Subnet".
28+
29+
Choose your security group. A security group acts as a virtual firewall that controls traffic to and from your instance. If you don't have an existing security group, you can create a new one based on the _seller settings_ by clicking "Create New Based on Seller Settings".
30+
31+
Give your security group a name and description. The _seller settings_ will automatically populate the inbound and outbound rules for the security group based on best practices. You can review and modify the rules if necessary.
32+
33+
Click "Save" to create your new security group.
34+
35+
Select your key pair or create a new one. A key pair is used to securely connect to your instance via SSH. If you choose to create a new key pair, give it a name and click "Create". Your private key will be downloaded to your computer, so make sure to keep it in a safe place.
36+
37+
Finally, click "Launch" to deploy your instance. AWS will create the instance and install the Kafka UI software for you.
38+
39+
### Step 6: Check EC2 Status
40+
41+
To check the EC2 state please click on "EC2 console".
42+
43+
### Step 7: Access the Kafka UI
44+
45+
After the instance is launched, you can check its status on the EC2 dashboard. Once it's running, you can access the Kafka UI by copying the public DNS name or IP address provided by AWS and adding after the IP address or DNS name port 8080.\
46+
Example: `ec2-xx-xxx-x-xx.us-west-2.compute.amazonaws.com:8080`
47+
48+
### Step 8: Configure Kafka UI to Communicate with Brokers
49+
50+
If your broker is deployed in AWS then allow incoming from Kafka-ui EC2 by adding an ingress rule in the security group which is used for a broker.\
51+
If your broker is not in AWS then be sure that your broker can handle requests from Kafka-ui EC2 IP address.
52+
53+
That's it! You've successfully deployed the Kafka UI from AWS Marketplace.

configuration/serialization-serde/README.md renamed to configuration/serialization-serde.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ kafka:
4040
encoding: "UTF-16"
4141
```
4242
43-
#### Protobuf
43+
#### ProtobufFile
4444
4545
Class name: `com.provectus.kafka.ui.serdes.builtin.ProtobufFileSerde`
4646

@@ -54,10 +54,18 @@ kafka:
5454
serde:
5555
- name: ProtobufFile
5656
properties:
57-
# path to the protobuf schema files
57+
# protobufFilesDir specifies root location for proto files (will be scanned recursively)
58+
# NOTE: if 'protobufFilesDir' specified, then 'protobufFile' and 'protobufFiles' settings will be ignored
59+
protobufFilesDir: "/path/to/my-protobufs"
60+
# (DEPRECATED) protobufFile is the path to the protobuf schema. (deprecated: please use "protobufFiles")
61+
protobufFile: path/to/my.proto
62+
# (DEPRECATED) protobufFiles is the location of one or more protobuf schemas
5863
protobufFiles:
59-
- path/to/my.proto
60-
- path/to/another.proto
64+
- /path/to/my-protobufs/my.proto
65+
- /path/to/my-protobufs/another.proto
66+
# protobufMessageName is the default protobuf type that is used to deserialize
67+
# the message's value if the topic is not found in protobufMessageNameByTopic.
68+
protobufMessageName: my.DefaultValType
6169
# default protobuf type that is used for KEY serialization/deserialization
6270
# optional
6371
protobufMessageNameForKey: my.Type1
@@ -76,9 +84,7 @@ kafka:
7684
"topic.2": my.Type2
7785
```
7886

79-
Docker-compose sample for Protobuf serialization is here.
8087

81-
Legacy configuration for protobuf is here.
8288

8389
#### SchemaRegistry
8490

@@ -160,7 +166,7 @@ You can implement your own serde and register it in kafka-ui application. To do
160166
2. Implement `com.provectus.kafka.ui.serde.api.Serde` interface. See javadoc for implementation requirements.
161167
3. Pack your serde into uber jar, or provide directory with no-dependency jar and it's dependencies jars
162168

163-
Example pluggable serdes : https://github.com/provectus/kafkaui-smile-serde https://github.com/provectus/kafkaui-glue-sr-serde
169+
Example pluggable serdes : [kafka-smile-serde](https://github.com/provectus/kafkaui-smile-serde), [kafka-glue-sr-serde](https://github.com/provectus/kafkaui-glue-sr-serde)
164170

165171
Sample configuration:
166172

configuration/serialization-serde/protobuf-setup.md

-55
This file was deleted.

0 commit comments

Comments
 (0)