diff --git a/api/README.md b/api/README.md
index e37e6be..8960f4a 100644
--- a/api/README.md
+++ b/api/README.md
@@ -6,10 +6,32 @@


-It combines two functionalities
+Ylem API Microservice combines two functionalities:
1. OAuth-server that allows issuing OAuth tokens for customers' applications and provides an API for the UI to be used for it.
2. API gateway responsible for checking OAuth authorization token validity, checking for allowed scopes, and proxying the request to backend APIs.
+# Usage
+
+## Build an app
+
+``` bash
+$ go build
+```
+
+## Run database migrations
+
+``` bash
+$ ./ylem_api db migrations migrate
+```
+
+## Start application server
+
+``` bash
+$ ./ylem_api server serve
+```
+
+It is now available inside the Ylem network on http://ylem_api:7339 or from the host machine on http://127.0.0.1:7339
+
## Run tests
``` bash
diff --git a/backend/integrations/README.md b/backend/integrations/README.md
index da9c026..71c1740 100644
--- a/backend/integrations/README.md
+++ b/backend/integrations/README.md
@@ -1,28 +1,35 @@
-# Ylem integrations
-Service responsible for external and internal integrations
+# YLEM INTEGRATIONS MICROSERVICE
-# Installation & running
+
+
+
+
+
-## With Docker
+Ylem Integrations Microservice is responsible for integrating with APIs, data storages, queue managers, and other external data sources and destinations. It also provides and API for the integration with Ylem UI.
+
+# Usage
+
+## Build an app
``` bash
-$ docker-compose up
+$ go build
```
-## Run data migrations
+## Run database migrations
``` bash
-$ make migrate
+$ ./ylem_integrations db migrations migrate
```
-# Usage
-
-## Build an app
+## Start application server
``` bash
-$ make
+$ ./ylem_integrations server serve
```
+It is now available inside the Ylem network on http://ylem_integrations:7339 or from the host machine on http://127.0.0.1:7339
+
## Run tests
``` bash
@@ -35,7 +42,7 @@ $ go test ./tests/... -v -vet=off
$ go test ./tests/... -coverpkg=./...
```
-Or if you want an advanced coverage report
+## Run tests with an advanced coverage report
``` bash
$ go test ./tests/... -coverpkg=./... -coverprofile cover.out
@@ -44,10 +51,18 @@ $ go tool cover -html cover.out -o cover.html
And then open cover.html
-## Run server
+# Linter
+
+## Install Golang linter on MacOS
``` bash
-$ make run
+$ brew install golangci-lint
+$ brew upgrade golangci-lint
```
-It is available on http://localhost:7337
+## Check the code with it
+
+``` bash
+$ golangci-lint run
+```
+More information is in the official documentation: https://golangci-lint.run/
diff --git a/backend/pipelines/README.md b/backend/pipelines/README.md
index 555cdba..5561407 100644
--- a/backend/pipelines/README.md
+++ b/backend/pipelines/README.md
@@ -1,13 +1,12 @@
-# Ylem pipelines
-Pipeline management service.
+# YLEM PIPELINES MICROSERVICE
-# Installation & running
+
+
+
+
+
-## With Docker
-
-``` bash
-$ docker-compose up
-```
+Ylem Pipelines Microservice provides functionality for managing pipelines and tasks and an API for integration with Ylem UI.
# Usage
@@ -17,24 +16,20 @@ $ docker-compose up
$ go build
```
-## Run data migrations
-
-``` bash
-$ migrate -path /go/src/ylem_pipelines/db/migration -database "mysql://${DATABASE_USER}:${DATABASE_PASSWORD}@(${DATABASE_HOST}:${DATABASE_PORT})/${DATABASE_NAME}" -verbose up
-```
-
-**OR**
+## Run database migrations
``` bash
$ ./ylem_pipelines db migrations migrate
```
-## Load fixtures
+## Start application server
``` bash
-$ ./ylem_pipelines db fixtures load
+$ ./ylem_pipelines server serve
```
+It is now available inside the Ylem network on http://ylem_pipelines:7336 or from the host machine on http://127.0.0.1:7336
+
## Run tests
``` bash
@@ -47,7 +42,7 @@ $ go test ./tests/... -v -vet=off
$ go test ./tests/... -coverpkg=./...
```
-Or if you want an advanced coverage report
+## Run tests with an advanced coverage report
``` bash
$ go test ./tests/... -coverpkg=./... -coverprofile cover.out
@@ -56,26 +51,6 @@ $ go tool cover -html cover.out -o cover.html
And then open cover.html
-## Run server
-
-``` bash
-$ ./ylem_pipelines server serve
-```
-
-It is available on http://localhost:7336
-
-## Run schedule generator
-
-``` bash
-$ ./ylem_pipelines schedulegen start
-```
-
-## Run schedule publisher
-
-``` bash
-$ ./ylem_pipelines schedulepub start
-```
-
# Linter
## Install Golang linter on MacOS
diff --git a/backend/statistics/README.md b/backend/statistics/README.md
index ff13192..c16295f 100644
--- a/backend/statistics/README.md
+++ b/backend/statistics/README.md
@@ -1,13 +1,12 @@
-# Ylem statistics
-Statistics service
+# YLEM STATISTICS MICROSERVICE
-# Installation & running
+
+
+
+
+
-## With Docker
-
-``` bash
-$ docker-compose up
-```
+Ylem Statistics Microservice stores and aggregates statistical information about pipeline and task runs and provides an API for integration with Ylem UI dashboards.
# Usage
@@ -17,6 +16,20 @@ $ docker-compose up
$ go build
```
+## Run database migrations
+
+``` bash
+$ ./ylem_statistics db migrations migrate
+```
+
+## Start application server
+
+``` bash
+$ ./ylem_statistics server serve
+```
+
+It is now available inside the Ylem network on http://ylem_statistics:7332 or from the host machine on http://127.0.0.1:7332
+
## Run tests
``` bash
@@ -29,7 +42,7 @@ $ go test ./tests/... -v -vet=off
$ go test ./tests/... -coverpkg=./...
```
-Or if you want an advanced coverage report
+## Run tests with an advanced coverage report
``` bash
$ go test ./tests/... -coverpkg=./... -coverprofile cover.out
@@ -38,14 +51,6 @@ $ go tool cover -html cover.out -o cover.html
And then open cover.html
-## Run server
-
-``` bash
-$ ./ylem_statistics
-```
-
-It is available on http://localhost:7335
-
# Linter
## Install Golang linter on MacOS
@@ -61,4 +66,3 @@ $ brew upgrade golangci-lint
$ golangci-lint run
```
More information is in the official documentation: https://golangci-lint.run/
-
diff --git a/backend/users/README.md b/backend/users/README.md
index 065413a..bb77f58 100644
--- a/backend/users/README.md
+++ b/backend/users/README.md
@@ -1,4 +1,4 @@
-# YLEM USER MICROSERVICE
+# YLEM USERS MICROSERVICE


@@ -6,7 +6,7 @@


-Ylem User Microservice is responsible for storing user data, performing authorization, and providing an API for the UI.
+Ylem Users Microservice is responsible for storing user data, performing authorization, and providing an API for the UI.
# Usage
diff --git a/processor/python_processor/README.md b/processor/python_processor/README.md
index 729f494..773d54c 100644
--- a/processor/python_processor/README.md
+++ b/processor/python_processor/README.md
@@ -1,14 +1,20 @@
-# Ylem Python code processor
+# YLEM PYTHON CODE PROCESSOR
-## Description
-Python code processor is an API for evaluating Python expressions.
+
+
+
+
+
-It executes arbitrary Python code and returns the results.
+Python code processor is an API for evaluating Python expressions from the "Code" pipeline task. It executes arbitrary Python code and returns the results.
-## Endpoints
+It is available inside the Ylem network on http://ylem_python_processor:7338 or from the host machine on http://127.0.0.1:7338.
-### POST /eval
-#### Request body:
+# Endpoints
+
+## POST /eval
+
+### Request body:
```js
{
@@ -17,10 +23,10 @@ It executes arbitrary Python code and returns the results.
}
```
-#### Response body:
+### Response body:
```js
{
"statusCode": 200,
"body": "{\"value\": 2}" // execution result
}
-```
\ No newline at end of file
+```
diff --git a/processor/taskrunner/README.md b/processor/taskrunner/README.md
index 2adfad1..e025e53 100644
--- a/processor/taskrunner/README.md
+++ b/processor/taskrunner/README.md
@@ -1,23 +1,42 @@
-# Task runner cluster node
+# YLEM TASK RUNNER MICROSERVICE
-A node can serve as a load balancer or a task runner.
+
+
+
+
+
-## Load balancer
+Ylem Task Runners Microservice combines two functionalities:
+1. Task runner that executes tasks and pipelines.
+2. Load balancer that decides how to distribute tasks between Apache Kafka partitions.
-```bash
-$ ./taskrunner loadbalancer start
+More information can be found in our task-processing documentation: https://docs.ylem.co/open-source-edition/task-processing-architecture
+
+# Usage
+
+## Build an app
+
+``` bash
+$ go build
```
-Currently simply transfers messages from one topic to another with no real load balancing logic.
+## Run database migrations
+
+``` bash
+$ ./ylem_taskrunner db migrations migrate
+$ ./ylem_loadbalancer db migrations migrate
+```
-## Task runner
+## Start application server
-```bash
-$ ./taskrunner taskrunner start
+``` bash
+$ ./ylem_taskrunner server serve
+$ ./ylem_loadbalancer server serve
```
-Can currently imitate execution of a run query task.
-Accepts a task message from load balancer output topic, sleeps for some random time and produces a valid output.
+Task runner is now available inside the Ylem network on http://ylem_taskrunner:7335 or from the host machine on http://127.0.0.1:7335.
+
+Load balancer is now available inside the Ylem network on http://ylem_loadbalancer:7334 or from the host machine on http://127.0.0.1:7334.
## Run tests
@@ -31,7 +50,7 @@ $ go test ./tests/... -v -vet=off
$ go test ./tests/... -coverpkg=./...
```
-Or if you want an advanced coverage report
+## Run tests with an advanced coverage report
``` bash
$ go test ./tests/... -coverpkg=./... -coverprofile cover.out
@@ -39,3 +58,20 @@ $ go tool cover -html cover.out -o cover.html
```
And then open cover.html
+
+# Linter
+
+## Install Golang linter on MacOS
+
+``` bash
+$ brew install golangci-lint
+$ brew upgrade golangci-lint
+```
+
+## Check the code with it
+
+``` bash
+$ golangci-lint run
+```
+
+More information is in the official documentation: https://golangci-lint.run/