Skip to content

Commit d491260

Browse files
authored
fix(docs): readme for UI development (#181)
Signed-off-by: Derek Wang <[email protected]>
1 parent e0d33d7 commit d491260

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

Diff for: docs/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# Numaflow
22

3-
Numaflow is a Kubernetes-native platform for running massive parallel data processing and streaming jobs. A Numaflow Pipeline is implemented as a Kubernetes custom resource, and consists of one or more source, data processing, and sink vertices.
3+
Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices.
4+
5+
Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a full-featured stream processing platforms.
46

57
## Key Features
68

7-
- Kubernetes-native: If you know Kubernetes, you already know 90% of what you need to use Numaflow.
9+
- Kubernetes-native: If you know Kubernetes, you already know how to use Numaflow.
810
- Language agnostic: Use your favorite programming language.
911
- Exactly-Once semantics: No input element is duplicated or lost even as pods are rescheduled or restarted.
1012
- Auto-scaling with back-pressure: Each vertex automatically scales from zero to whatever is needed.
1113

14+
## Data Integrity Guarantees:
15+
16+
- Minimally provide at-least-once semantics
17+
- Provide exactly-once semantics for unbounded and near real-time data sources
18+
- Preserving order is not required
19+
1220
## Roadmap
1321

1422
- Data aggregation (e.g. group-by)

Diff for: ui/README.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,22 @@
11
# Numaflow UI
22

3-
![Numaflow Image](../docs/assets/numa.svg)
3+
![Numaflow Image](../docs/assets/numaproj.svg)
44

55
A web-based UI for Numaflow
66

77
The UI has the following features:
88
* View running pipelines in your namespace
99
* View Vertex and Edge Information of your pipeline
1010
* View BackPressure and Pending Messages
11-
* View Container (main/udf) Logs for a given vertex
11+
* View Container Logs for a given vertex
1212

1313
## Development
1414

15-
This explains how to set up a development environment so you can get started with UI development
15+
See [Development Guide](../docs/development.md).
1616

17-
### Prerequisites
18-
19-
Follow the instructions below to set up your development environment.
20-
21-
### Install requirements
22-
23-
These tools are required for development.
24-
25-
1. [`Numaflow`](https://github.com/numaproj/numaflow/blob/master/docs/DEVELOPMENT.md): Follow the document to prepare `Numaflow` development environment.
26-
1. [`node`](https://nodejs.org/en/download/): NodeJS - `brew install node`.
27-
1. [`yarn`](https://yarnpkg.com/): Package manager - `brew install yarn`
17+
```shell
18+
# Build image and deploy to a k3d cluster
19+
make start
20+
# Port-forward, and access https://localhost:8443
21+
kubectl -n numaflow-system port-forward svc/numaflow-server 8443
22+
```

0 commit comments

Comments
 (0)