Skip to content

Commit

Permalink
docker and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
v1r3n committed Dec 8, 2023
1 parent b412fe3 commit 18cb5b2
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 8 deletions.
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![Github release](https://img.shields.io/github/v/release/Netflix/conductor.svg)](https://GitHub.com/Netflix/conductor/releases)
[![CI](https://github.com/Netflix/conductor/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Netflix/conductor/actions/workflows/ci.yml)
[![License](https://img.shields.io/github/license/Netflix/conductor.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![NetflixOSS Lifecycle](https://img.shields.io/osslifecycle/Netflix/conductor.svg)]()

[![GitHub stars](https://img.shields.io/github/stars/Netflix/conductor.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Netflix/conductor/stargazers/)
[![GitHub forks](https://img.shields.io/github/forks/Netflix/conductor.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Netflix/conductor/network/)
Expand All @@ -18,6 +17,7 @@ For more information, see [Main Documentation Site](https://orkes.io/content)

## Releases
The latest version is [![Github release](https://img.shields.io/github/v/release/Netflix/conductor.svg)](https://GitHub.com/Netflix/conductor/releases)

The next scheduled release is in Dec 2023.

## Resources
Expand All @@ -35,11 +35,40 @@ SDK support for creating workflows using code is available in multiple languages


## Getting Started - Building & Running Conductor
### Using Docker:
The easiest way to get started is with Docker containers. Please follow the instructions [here](https://conductor.netflix.com/devguide/running/docker.html).

### From Source:
Conductor Server is a [Spring Boot](https://spring.io/projects/spring-boot) project and follows all applicable conventions. See instructions [here](https://conductor.netflix.com/devguide/running/source.html).
If you wish to build your own distribution, you can run ```./gradlew build``` from this project that products the runtime artifacts.
The runnable server is in server/ module.

### Using Docker (Recommended)
A production ready container is published by Orkes from (https://github.com/orkes-io/orkes-conductor-community)

Follow the steps below to launch the docker container:

#### Simple self-contained script to launch the docker image
```shell
curl https://raw.githubusercontent.com/orkes-io/orkes-conductor-community/main/scripts/run_local.sh | sh
```

#### Using docker run manually (Provides more control)
```shell

# Create volumes for persistent stores
# Used to create a persistent volume that will preserve the
docker volume create postgres
docker volume create redis

docker run --init -p 8080:8080 -p 1234:5000 --mount source=redis,target=/redis \
--mount source=postgres,target=/pgdata orkesio/orkes-conductor-community-standalone:latest
```

Navigate to http://localhost:1234 once the container starts to launch UI.

## Docker Containers for production usage
```shell
docker pull orkesio/orkes-conductor-community:latest
```


## Database Requirements

Expand Down
8 changes: 4 additions & 4 deletions docker/server/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#
# conductor:server - Combined Netflix conductor server & UI
# conductor:server - Combined conductor server & UI
#
# ===========================================================================================================
# 0. Builder stage
# ===========================================================================================================
FROM alpine:3.18 AS builder

LABEL maintainer="Netflix OSS <[email protected]>"
LABEL maintainer="Orkes OSS <[email protected]>"

# ===========================================================================================================
# 0. Build Conductor Server
Expand All @@ -32,7 +32,7 @@ RUN mkdir server-build
WORKDIR server-build
RUN ls -ltr

RUN git clone https://github.com/Netflix/conductor-community.git
RUN git clone https://github.com/conductor-oss/conductor-community.git

# Copy the project directly onto the image
WORKDIR conductor-community
Expand All @@ -50,7 +50,7 @@ RUN pwd
# ===========================================================================================================
FROM alpine:3.18

LABEL maintainer="Netflix OSS <[email protected]>"
LABEL maintainer="Orkes OSS <[email protected]>"

RUN apk add openjdk17
RUN apk add nginx
Expand Down

0 comments on commit 18cb5b2

Please sign in to comment.