From bce0652f5738282d0ea60402abaac07a4ec78535 Mon Sep 17 00:00:00 2001 From: Maciej Swiderski Date: Tue, 28 Feb 2023 12:01:39 +0100 Subject: [PATCH] updated readme files to be up to date and more useful --- document-processor/README.md | 2 +- event-streams-orders/README.md | 8 +++++--- event-streams-sensors/README.md | 4 ++-- mysql-operator/README.md | 2 +- user-registration-function/README.md | 2 +- user-registration-gcp-cloudrun/README.md | 2 +- user-registration-sw/README.md | 2 +- user-registration/README.md | 2 +- vacation-requests/README.md | 2 +- weather-conditions/README.md | 2 +- workflows-java-dsl/README.md | 2 +- 11 files changed, 16 insertions(+), 14 deletions(-) diff --git a/document-processor/README.md b/document-processor/README.md index 041c13a..220e40d 100644 --- a/document-processor/README.md +++ b/document-processor/README.md @@ -4,7 +4,7 @@ this is an example showing batch processing use cases backed by workflow. It uses Automatiko project to build self described service. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/batch.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/batch.html) ## Run it diff --git a/event-streams-orders/README.md b/event-streams-orders/README.md index deb6dc3..f90b0f5 100644 --- a/event-streams-orders/README.md +++ b/event-streams-orders/README.md @@ -4,13 +4,15 @@ this is an example showing event stream use cases backed by workflow. It uses Automatiko project to build self described service that makes use of Apache Kafka as event source. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/orders.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/orders.html) ## Run it -The only thing that is needed is Apache Kafka running that will be accessible. It needs to be given as part of run command via environment variable `KAFKA_SERVERS` +The only thing that is needed is Apache Kafka running that will be accessible. +Redpanda can be used as Kafka broker, see installation instructions [here](https://docs.redpanda.com/docs/get-started/quick-start/?quickstart=docker#deploy-redpanda). +Kafka broker needs to be given as part of run command via environment variable `KAFKA_BOOTSTRAP_SERVERS` -`docker run -e KAFKA_SERVERS=KAFKA_HOST:9092 -p 8080:8080 automatik/event-streams-orders` +`docker run -e KAFKA_BOOTSTRAP_SERVERS=KAFKA_HOST:9092 -p 8080:8080 automatiko/event-streams-orders` once this is done you can see the fully described service at: diff --git a/event-streams-sensors/README.md b/event-streams-sensors/README.md index 42039e8..5c9719e 100644 --- a/event-streams-sensors/README.md +++ b/event-streams-sensors/README.md @@ -4,13 +4,13 @@ this is an example showing event stream use cases backed by workflow for IoT. It uses Automatiko project to build self described service that makes use of MQTT broker as event source. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/leaks.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/leaks.html) ## Run it The only thing that is needed is MQTT broker running that will be accessible. It needs to be given as part of run command via environment variable `MQTT_SERVER` and `MQTT_PORT` -`docker run -e MQTT_SERVER=MQTT_HOST -e MQTT_PORT=1883 -p 8080:8080 automatik/event-streams-sensors` +`docker run -e MQTT_SERVER=MQTT_HOST -e MQTT_PORT=1883 -p 8080:8080 automatiko/event-streams-sensors` once this is done you can see the fully described service at: diff --git a/mysql-operator/README.md b/mysql-operator/README.md index 140af12..1daa810 100644 --- a/mysql-operator/README.md +++ b/mysql-operator/README.md @@ -4,7 +4,7 @@ this is an example showing Kubernetes Operator use cases backed by workflow. It uses Automatiko project to build self described service. -See complete description of this example [here](https://automatikio.com/component-main/0.3.0/examples/operator.html) +See complete description of this example [here](https://docs.automatiko.io/main0.3.0/examples/operator.html) ## Run it diff --git a/user-registration-function/README.md b/user-registration-function/README.md index d9abcab..1c6fa06 100644 --- a/user-registration-function/README.md +++ b/user-registration-function/README.md @@ -6,7 +6,7 @@ this is an example showing workflow as a function use case. It implements common that performs various checks and registers users in the Swagger PetStore service. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration-function.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration-function.html) ## Run it diff --git a/user-registration-gcp-cloudrun/README.md b/user-registration-gcp-cloudrun/README.md index a66e5e4..3e3be03 100644 --- a/user-registration-gcp-cloudrun/README.md +++ b/user-registration-gcp-cloudrun/README.md @@ -10,7 +10,7 @@ This examples illustrates how a workflow is sliced into functions that are compo the actual logic steered by the workflow definition. Yet each function can be invoked at anytime making the workflow to act as a definition that can start at any place and continue according to defined flow of activities eka functions. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration.html) ## Run it diff --git a/user-registration-sw/README.md b/user-registration-sw/README.md index a4f6974..95c7d31 100644 --- a/user-registration-sw/README.md +++ b/user-registration-sw/README.md @@ -10,7 +10,7 @@ This examples illustrates how a workflow is sliced into functions that are compo the actual logic steered by the workflow definition. Yet each function can be invoked at anytime making the workflow to act as a definition that can start at any place and continue according to defined flow of activities eka functions. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration.html) ## Run it diff --git a/user-registration/README.md b/user-registration/README.md index a4f6974..95c7d31 100644 --- a/user-registration/README.md +++ b/user-registration/README.md @@ -10,7 +10,7 @@ This examples illustrates how a workflow is sliced into functions that are compo the actual logic steered by the workflow definition. Yet each function can be invoked at anytime making the workflow to act as a definition that can start at any place and continue according to defined flow of activities eka functions. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration.html) ## Run it diff --git a/vacation-requests/README.md b/vacation-requests/README.md index a9cacfd..3a6fa11 100644 --- a/vacation-requests/README.md +++ b/vacation-requests/README.md @@ -9,7 +9,7 @@ emplyee requesting vacations. It takes advantage of workflow features such as - tracking - all vacation requests submitted are tracked - user interactions - tasks are assigned to individuals to take actions when needed -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/vacations.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/vacations.html) ## Run it diff --git a/weather-conditions/README.md b/weather-conditions/README.md index 4948f74..d7722a6 100644 --- a/weather-conditions/README.md +++ b/weather-conditions/README.md @@ -5,7 +5,7 @@ this is an example showing service orchestration use case. It implements common scenario for workflows - that multiple services needs to be invoked and depending on the results another set of services might be called again. -See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/weather.html) +See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/weather.html) ## Run it diff --git a/workflows-java-dsl/README.md b/workflows-java-dsl/README.md index 20cf9d3..7c264e8 100644 --- a/workflows-java-dsl/README.md +++ b/workflows-java-dsl/README.md @@ -4,7 +4,7 @@ This is a set of sample workflows illustrating use of Workflow Java DSL of Automatiko. -Take a look at the getting started with Workflow Java DSL [here](https://automatikio.com/component-main/0.0.0/getting-started-code.html) +Take a look at the getting started with Workflow Java DSL [here](https://docs.automatiko.io/main/0.0.0/getting-started-code.html) Samples covered: