+
#### Conductor UI URL
[http://localhost:5000/](http://localhost:5000)
-
+
### 4. Exiting Compose
@@ -81,7 +81,7 @@ To build and run the server image, without using `docker-compose`, from the `doc
docker build -t conductor:server -f server/Dockerfile ../
docker run -p 8080:8080 -d --name conductor_server conductor:server
```
-This builds the image `conductor:server` and runs it in a container named `conductor_server`. The API should now be accessible at `localhost:8080`.
+This builds the image `conductor:server` and runs it in a container named `conductor_server`. The API should now be accessible at `{{ server_host }}`.
To 'login' to the running container, use the command:
```
@@ -120,56 +120,55 @@ docker build -t conductor:serverAndUI -f serverAndUI/Dockerfile ../
- With interal DB: `docker run -p 8080:8080 -p 80:5000 -d -t conductor:serverAndUI`
- With external DB: `docker run -p 8080:8080 -p 80:5000 -d -t -e "CONFIG_PROP=config.properties" conductor:serverAndUI`
+## Elasticsearch
+Elasticsearch is optional, please be aware that disable it will make most of the conductor UI not functional.
+### How to enable Elasticsearch
+* Set `conductor.indexing.enabled=true` in your_config.properties
+* Add config related to elasticsearch
+ E.g.: `conductor.elasticsearch.url=http://es:9200`
-## Potential problem when using Docker Images
-
-#### Not enough memory
-
- 1. You will need at least 16 GB of memory to run everything. You can modify the docker compose to skip using
- Elasticsearch if you have no option to run this with your memory options.
- 2. To disable Elasticsearch using Docker Compose - follow the steps listed here: **TODO LINK**
+### How to disable Elasticsearch
+* Set `conductor.indexing.enabled=false` in your_config.properties
+* Comment out all the config related to elasticsearch
+E.g.: `conductor.elasticsearch.url=http://es:9200`
-#### Elasticsearch fails to come up in arm64 based CPU machines
- 1. As of writing this article, Conductor relies on 6.8.x version of Elasticsearch. This version doesn't have an
- arm64 based Docker image. You will need to use Elasticsearch 7.x which requires a bit of customization to get up
- and running
+## Troubleshooting
+To troubleshoot a failed startup, check the server logss located at `/app/logs` (default directory in dockerfile)
-#### Elasticsearch remains in yellow health state
+## Potential problem when using Docker Images
-When you run Elasticsearch, sometimes the health remains in the *yellow* state. Conductor server by default requires
-*green* state to run when indexing is enabled. To work around this, you can use the following property: `conductor.elasticsearch.clusterHealthColor=yellow`.
+### Not enough memory
+You will need at least 16 GB of memory to run everything. You can modify the docker compose to skip using
+Elasticsearch if you have no option to run this with your memory options.
-Reference: [Issue 2262][issue2262]
+To disable Elasticsearch using Docker Compose - follow the steps above.
-#### Elasticsearch timeout
+### Elasticsearch fails to come up in arm64 based CPU machines
+As of writing this article, Conductor relies on 6.8.x version of Elasticsearch. This version doesn't have an
+arm64 based Docker image. You will need to use Elasticsearch 7.x which requires a bit of customization to get up
+and running
-By default, a standalone (single node) Elasticsearch has a *yellow* status which will cause timeout (`java.net.SocketTimeoutException`) for Conductor server (required status is *green*).
-Spin up a cluster (more than one node) to prevent the timeout or use config option `conductor.elasticsearch.clusterHealthColor=yellow`.
+### Elasticsearch remains in Yellow health
-Reference: [Issue 2262][issue2262]
+When you run Elasticsearch, sometimes the health remains in Yellow state. Conductor server by default requires
+Green state to run when indexing is enabled. To work around this, you can use the following property:
+`conductor.elasticsearch.clusterHealthColor=yellow`
-#### Changes in config-*.properties do not take effect
-Config is copy into image during docker build. You have to rebuild the image or better, link a volume to it to reflect new changes.
+See Github [issue](https://github.com/Netflix/conductor/issues/2262)
-#### To troubleshoot a failed startup
-Check the log of the server, which is located at `/app/logs` (default directory in dockerfile)
+### Elasticsearch timeout
+Symptom: Standalone (single node) Elasticsearch has a yellow status which will cause timeout for the Conductor server at startup (Required: Green).
-#### Unable to access to conductor:server API on port 8080
-It may takes some time for conductor server to start. Please check server log for potential error.
+Solution: Spin up a cluster (more than one node) to prevent the timeout or use config option `conductor.elasticsearch.clusterHealthColor=yellow`.
-#### Elasticsearch
-Elasticsearch is optional, please be aware that disable it will make most of the conductor UI not functional.
+See Github [issue](https://github.com/Netflix/conductor/issues/2262)
-##### How to enable Elasticsearch
-* Set `conductor.indexing.enabled=true` in your_config.properties
-* Add config related to elasticsearch
- E.g.: `conductor.elasticsearch.url=http://es:9200`
+### Changes in config-*.properties do not take effect
+Config is copied into the image during the docker build. You have to rebuild the image or better, link a volume to it
+to reflect new changes automatically.
-##### How to disable Elasticsearch
-* Set `conductor.indexing.enabled=false` in your_config.properties
-* Comment out all the config related to elasticsearch
-E.g.: `conductor.elasticsearch.url=http://es:9200`
+### Unable to access to conductor:server API on port 8080
+It may takes some time for conductor server to start. Please check server log for errors.
-[issue2262]: https://github.com/Netflix/conductor/issues/2262
diff --git a/docs/docs/gettingstarted/hosted.md b/docs/devguide/running/hosted.md
similarity index 100%
rename from docs/docs/gettingstarted/hosted.md
rename to docs/devguide/running/hosted.md
diff --git a/docs/docs/gettingstarted/source.md b/docs/devguide/running/source.md
similarity index 85%
rename from docs/docs/gettingstarted/source.md
rename to docs/devguide/running/source.md
index f3a478656..97a0f4a98 100644
--- a/docs/docs/gettingstarted/source.md
+++ b/docs/devguide/running/source.md
@@ -5,7 +5,7 @@ In this article we will explore how you can set up Netflix Conductor on your loc
features.
### Prerequisites
-1. JDK 17 or greater
+1. JDK 11 or greater
2. (Optional) Docker if you want to run tests. You can install docker from [here](https://www.docker.com/get-started/).
3. Node for building and running UI. Instructions at [https://nodejs.org](https://nodejs.org).
4. Yarn for building and running UI. Instructions at [https://classic.yarnpkg.com/en/docs/install](https://classic.yarnpkg.com/en/docs/install).
@@ -48,9 +48,9 @@ server $ ../gradlew bootRun
```
Navigate to the swagger API docs:
-[http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config](http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config)
+[http://{{ server_host }}/swagger-ui/index.html?configUrl=/api-docs/swagger-config](http://{{ server_host }}/swagger-ui/index.html?configUrl=/api-docs/swagger-config)
-
+
## Download and Run
As an alternative to building from source, you can download and run the pre-compiled JAR.
@@ -61,7 +61,7 @@ export REPO_URL=https://repo1.maven.org/maven2/com/netflix/conductor/conductor-s
curl $REPO_URL/$CONDUCTOR_VER/conductor-server-$CONDUCTOR_VER-boot.jar \
--output conductor-server-$CONDUCTOR_VER-boot.jar; java -jar conductor-server-$CONDUCTOR_VER-boot.jar
```
-Navigate to the swagger URL: [http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config](http://localhost:8080/swagger-ui/index.html?configUrl=/api-docs/swagger-config)
+Navigate to the swagger URL: [http://{{ server_host }}/swagger-ui/index.html?configUrl=/api-docs/swagger-config](http://{{ server_host }}/swagger-ui/index.html?configUrl=/api-docs/swagger-config)
@@ -87,7 +87,7 @@ ui $ yarn run start
Launch UI [http://localhost:5000](http://localhost:5000)
-
+
## Summary
1. By default in-memory persistence is used, so any workflows created or excuted will be wiped out once the server is terminated.
diff --git a/docs/docs/img/tutorial/swagger.png b/docs/devguide/running/swagger.png
similarity index 100%
rename from docs/docs/img/tutorial/swagger.png
rename to docs/devguide/running/swagger.png
diff --git a/docs/docs/apispec.md b/docs/docs/apispec.md
deleted file mode 100644
index 94df57fca..000000000
--- a/docs/docs/apispec.md
+++ /dev/null
@@ -1,173 +0,0 @@
-# API Specification
-
-## Task & Workflow Metadata
-| Endpoint | Description | Input |
-|------------------------------------------|:---------------------------------|-------------------------------------------------------------|
-| `GET /metadata/taskdefs` | Get all the task definitions | n/a |
-| `GET /metadata/taskdefs/{taskType}` | Retrieve task definition | Task Name |
-| `POST /metadata/taskdefs` | Register new task definitions | List of [Task Definitions](/configuration/taskdef.html) |
-| `PUT /metadata/taskdefs` | Update a task definition | A [Task Definition](/configuration/taskdef.html) |
-| `DELETE /metadata/taskdefs/{taskType}` | Delete a task definition | Task Name |
-|||
-| `GET /metadata/workflow` | Get all the workflow definitions | n/a |
-| `POST /metadata/workflow` | Register new workflow | [Workflow Definition](/configuration/workflowdef.html) |
-| `PUT /metadata/workflow` | Register/Update new workflows | List of [Workflow Definition](/configuration/workflowdef.html) |
-| `GET /metadata/workflow/{name}?version=` | Get the workflow definitions | workflow name, version (optional) |
-|||
-
-## Start A Workflow
-### With Input only
-See [Start Workflow Request](/gettingstarted/startworkflow.html).
-
-#### Output
-Id of the workflow (GUID)
-
-### With Input and Task Domains
-```
-POST /workflow
-{
- //JSON payload for Start workflow request
-}
-```
-#### Start workflow request
-JSON for start workflow request
-```
-{
- "name": "myWorkflow", // Name of the workflow
- "version": 1, // Version
- “correlationId”: “corr1”, // correlation Id
- "priority": 1, // Priority
- "input": {
- // Input map.
- },
- "taskToDomain": {
- // Task to domain map
- }
-}
-```
-
-#### Output
-Id of the workflow (GUID)
-
-
-## Retrieve Workflows
-| Endpoint | Description |
-|-----------------------------------------------------------------------------|-----------------------------------------------|
-| `GET /workflow/{workflowId}?includeTasks=true | false` |Get Workflow State by workflow Id. If includeTasks is set, then also includes all the tasks executed and scheduled.|
-| `GET /workflow/running/{name}` | Get all the running workflows of a given type |
-| `GET /workflow/running/{name}/correlated/{correlationId}?includeClosed=true | false&includeTasks=true |false`|Get all the running workflows filtered by correlation Id. If includeClosed is set, also includes workflows that have completed running.|
-| `GET /workflow/search` | Search for workflows. See Below. |
-
-
-## Search for Workflows
-Conductor uses Elasticsearch for indexing workflow execution and is used by search APIs.
-
-`GET /workflow/search?start=&size=&sort=&freeText=&query=`
-
-| Parameter | Description |
-|-----------|------------------------------------------------------------------------------------------------------------------|
-| start | Page number. Defaults to 0 |
-| size | Number of results to return |
-| sort | Sorting. Format is: `ASC:Redirecting ...
+ + \ No newline at end of file diff --git a/docs/docs/img/timeline.png b/docs/home/timeline.png similarity index 100% rename from docs/docs/img/timeline.png rename to docs/home/timeline.png diff --git a/docs/docs/img/workflow.svg b/docs/home/workflow.svg similarity index 100% rename from docs/docs/img/workflow.svg rename to docs/home/workflow.svg diff --git a/docs/docs/img/logo.svg b/docs/img/logo.svg similarity index 100% rename from docs/docs/img/logo.svg rename to docs/img/logo.svg diff --git a/docs/docs/img/netflix-oss.png b/docs/img/netflix-oss.png similarity index 100% rename from docs/docs/img/netflix-oss.png rename to docs/img/netflix-oss.png diff --git a/docs/docs/index.md b/docs/index.md similarity index 73% rename from docs/docs/index.md rename to docs/index.md index c1a0bd096..f9a4f8a6f 100644 --- a/docs/docs/index.md +++ b/docs/index.md @@ -1,28 +1,34 @@ -
+ 
Open Source
+ 
Open Source
Modular
+ 
Modular
Proven
+ 
Proven
Control
+ 
Control
Polyglot
+ 
Polyglot
Scalable
+ 
Scalable
Service Orchestration
+ 
Service Orchestration
Workflow definitions are decoupled from task implementations. This allows the creation of process flows in which each individual task can be implemented by an encapsulated microservice.
Designing a workflow orchestrator that is resilient and horizontally scalable is not a simple problem. At Netflix we have developed a solution in Conductor.
@@ -139,9 +143,9 @@
Service Choreography
+ 
Service Choreography
-