Skip to content

Commit 9ae3380

Browse files
committed
fix readme
1 parent 99e64d6 commit 9ae3380

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ A next-generation, high-performance analytical data store designed for a wide ra
281281

282282
<details>
283283

284-
<summary><b>Data Lineage & Observability with OpenLineage (via Marquez) and Prometheus</b></summary>
284+
<summary><b>Data Lineage & Observability with OpenLineage and Prometheus</b></summary>
285285

286286
<br>
287287

@@ -689,7 +689,7 @@ services:
689689
690690
To get the platform running, you first need to configure your local environment. This involves setting environment variables to select the edition you want to run (Community or Enterprise) and providing the file paths to your licenses. Once these prerequisites are set, you can launch the services using `docker compose`. You have two primary options: you can start all services (Kpow, Flex, and Pinot) together for a fully integrated experience, or you can run Kpow and Flex independently for more focused use cases. When you are finished, remember to run the corresponding `down` command to stop and remove the containers, and unset the environment variables to clean up your session.
691691
692-
### **1. Prerequisite: Configure Your Environment**
692+
### Prerequisite: Configure Your Environment
693693
694694
Before running any commands, configure your shell environment by uncommenting and setting the following variables in your terminal.
695695
@@ -710,7 +710,7 @@ Before running any commands, configure your shell environment by uncommenting an
710710
# export FLEX_LICENSE="/path/to/your/flex-license.env"
711711
```
712712
713-
### **2. How to Run the Stacks**
713+
### Run the Stacks
714714
715715
This platform is designed to be modular. You can run each stack individually or combine them to create a complete, integrated environment.
716716
@@ -813,7 +813,7 @@ docker compose -p metadata --profile omt -f ./compose-metadata.yml up -d
813813
docker compose -p metadata --profile omt -f ./compose-metadata.yml down
814814
```
815815
816-
### **3. Clean Up Your Environment**
816+
### Clean Up Your Environment
817817
818818
After stopping the services, run this command to unset the environment variables from your terminal session.
819819
@@ -847,7 +847,7 @@ The following sections show key services and their associated port mappings.
847847
848848
| Service Name | Port(s) (Host:Container) | Description |
849849
| :----------- | :------------------------- | :--------------------------------------------------------- |
850-
| `kpow` | `3000:3000`<br>`4000:4000` | Kpow Web UI (`3000`) and API (`4000`). |
850+
| `kpow` | `3000:3000`<br>`4000:4000` | Kpow Web UI (`3000`)<br>Kpow API (`4000`) |
851851
| `schema` | `8081:8081` | Confluent Schema Registry (manages Kafka message schemas). |
852852
| `connect` | `8083:8083` | Kafka Connect (framework for Kafka connectors). |
853853
| `kafka-1` | `9092:9092` | Kafka Broker 1 (primary listener). |
@@ -891,9 +891,9 @@ These services are launched from `compose-store.yml` using profiles.
891891
892892
#### StarRocks (`--profile starrocks`)
893893
894-
| Service Name | Port(s) (Host:Container) | Description |
895-
| :------------- | :------------------------- | :------------------------------------------------------------ |
896-
| `starrocks-fe` | `8030:8030`<br>`9030:9030` | StarRocks Frontend UI (`8030`) and MySQL SQL client (`9030`). |
894+
| Service Name | Port(s) (Host:Container) | Description |
895+
| :------------- | :------------------------- | :----------------------------------------------------------- |
896+
| `starrocks-fe` | `8030:8030`<br>`9030:9030` | StarRocks Frontend UI (`8030`)<br>MySQL SQL client (`9030`). |
897897
898898
### Observability Stacks
899899

0 commit comments

Comments
 (0)