Rill Flow

https://github.com/weibocom/rill-flow
Admin
Rill Flow is a high-performance, scalable distributed workflow orchestration service that supports...
Tokens:3,420
Snippets:42
Trust Score:7.3
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Start Test Server

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/apps/test-server/README.md

These commands navigate to the test server directory, install the necessary dependencies using pnpm, and then start the test server. The test server is used for testing interfaces like upload, websocket, and login.

```bash
cd ./test/server
pnpm install
pnpm run start
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.zh-CN.md

Navigates to the rill-flow-ui directory and installs the project dependencies using pnpm.

```Bash
cd rill-flow-ui

pnpm install
```

--------------------------------

### Install project dependencies using pnpm

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.md

These commands navigate to the flow-graph directory and install the project's dependencies using pnpm.

```Bash
cd flow-graph

pnpm install
```

--------------------------------

### Install project dependencies

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.zh-CN.md

These commands navigate to the flow-graph directory and install the project's dependencies using pnpm.

```bash
cd flow-graph

pnpm install
```

--------------------------------

### Run the Application

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.zh-CN.md

Starts the development server using pnpm.

```Bash
pnpm serve
```

--------------------------------

### Install pnpm Package Manager

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.zh-CN.md

Installs pnpm globally using npm, specifying a mirror registry for faster downloads.

```Shell
npm install -g pnpm --registry=https://registry.npmmirror.com
```

--------------------------------

### Run the development server

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.md

This command starts the development server using pnpm.

```Bash
pnpm serve
```

--------------------------------

### Install nvm via curl

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.md

This command downloads and executes the nvm installation script. nvm is used for managing Node.js versions.

```Shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
```

--------------------------------

### Run the application

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.zh-CN.md

This command starts the development server using pnpm.

```bash
pnpm serve
```

--------------------------------

### Install pnpm globally

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.md

This command installs the pnpm package manager globally using npm, specifying a mirror registry for faster downloads.

```Shell
npm install -g pnpm --registry=https://registry.npmmirror.com
```

--------------------------------

### Install nvm via curl

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.zh-CN.md

This command downloads and executes the nvm installation script. nvm is used for managing Node.js versions.

```shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
```

--------------------------------

### Install and Set Default Node.js Version

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.zh-CN.md

Installs Node.js version 18.19.0 and sets it as the default version using nvm.

```Shell
nvm install v18.19.0
nvm alias default v18.19.0
```

--------------------------------

### Install nvm (Node Version Manager)

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.zh-CN.md

Installs nvm using a curl command. nvm is used for managing different Node.js versions.

```Shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
```

--------------------------------

### Install pnpm globally

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.zh-CN.md

This command installs the pnpm package manager globally using npm, specifying a mirror registry for faster downloads.

```shell
npm install -g pnpm --registry=https://registry.npmmirror.com
```

--------------------------------

### Install Node.js v18.19.0 and set as default

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.md

These commands install Node.js version 18.19.0 using nvm and then set it as the default Node.js version for the system.

```Shell
nvm install v18.19.0
nvm alias default v18.19.0
```

--------------------------------

### Build for Production

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.zh-CN.md

Builds the application for production using pnpm.

```Bash
pnpm build:prod
```

--------------------------------

### Install and alias Node.js version

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.zh-CN.md

These commands install Node.js version 18.19.0 using nvm and set it as the default Node.js version.

```shell
nvm install v18.19.0
nvm alias default v18.19.0
```

--------------------------------

### Build the project for production

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.md

This command builds the project for production using pnpm.

```Bash
pnpm build:prod
```

--------------------------------

### Installing Project Dependencies with PNPM

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.md

These commands navigate to the rill-flow-ui directory and install the project dependencies using PNPM. The `cd` command changes the current directory, and `pnpm install` installs the dependencies listed in the project's package.json file.

```Shell
cd rill-flow-ui

pnpm install
```

--------------------------------

### Running the Development Server with PNPM

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.md

This command starts the development server using PNPM. The `pnpm serve` command typically executes a script defined in the project's package.json file, which starts the development server with hot-reloading and other development-friendly features.

```Shell
pnpm serve
```

--------------------------------

### Build the application for production

Source: https://github.com/weibocom/rill-flow/blob/main/flow-graph/README.zh-CN.md

This command builds the application for production using pnpm.

```bash
pnpm build:prod
```

--------------------------------

### Installing NVM via Shell Script

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.md

This command downloads and executes a shell script to install Node Version Manager (NVM). NVM is used to manage multiple Node.js versions on a single machine. This script retrieves the installation script from the specified URL and executes it using bash.

```Shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
```

--------------------------------

### Installing PNPM Globally

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.md

This command installs the PNPM package manager globally using NPM. PNPM is used as an alternative to NPM or Yarn for managing project dependencies. The --registry flag specifies a mirror registry to speed up the installation process.

```Shell
npm install -g pnpm --registry=https://registry.npmmirror.com
```

--------------------------------

### Installing and Setting Default Node.js Version

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.md

These commands use NVM to install Node.js version 18.19.0 and set it as the default global version. The first command installs the specified Node.js version, and the second command sets it as the default, ensuring that it's used in new shell sessions.

```Shell
nvm install v18.19.0
nvm alias default v18.19.0
```

--------------------------------

### Starting Rill Flow Services with Docker Compose

Source: https://github.com/weibocom/rill-flow/blob/main/README.md

This command navigates to the Docker directory within the Rill Flow source code and starts all the defined services using Docker Compose. The -d flag runs the services in detached mode.

```shell
cd rill-flow/docker
docker-compose up -d
```

--------------------------------

### Deploy Java Executor with Docker Compose

Source: https://github.com/weibocom/rill-flow/blob/main/executors/spring-boot/README.md

This command deploys the Java executor using Docker Compose. It defines a service named sample-executor using the weibocom/rill-flow-sample:spring-boot-executor image and starts the service in detached mode.

```shell
cat <<EOF > docker-compose-sample.yaml
version: '3'
services:
  sample-executor:
    image: weibocom/rill-flow-sample:spring-boot-executor
EOF
docker-compose up -d
```

--------------------------------

### Verifying Rill Flow Installation

Source: https://github.com/weibocom/rill-flow/blob/main/README_zh_CN.md

This command checks the status of the services defined in the docker-compose.yml file. It displays the name, command, state, and ports of each service, allowing you to verify that Rill Flow has been successfully installed.

```shell
docker-compose ps
```

--------------------------------

### Starting Rill Flow Services with Docker Compose

Source: https://github.com/weibocom/rill-flow/blob/main/README_zh_CN.md

This command navigates to the docker directory within the Rill Flow source code and starts all the defined services using Docker Compose. The -d flag runs the services in detached mode.

```shell
cd rill-flow/docker
docker-compose up -d
```

--------------------------------

### Deploy Python Executor with Docker Compose

Source: https://github.com/weibocom/rill-flow/blob/main/executors/fastapi/README.md

This YAML file defines a Docker Compose configuration for deploying the Python executor. It specifies the image to use and starts the executor in detached mode.

```shell
cat <<EOF > docker-compose-sample.yaml
version: '3'
services:
  sample-executor:
    image: weibocom/rill-flow-sample:sample-executor 
EOF
docker-compose up -d
```

--------------------------------

### Building the Project for Production with PNPM

Source: https://github.com/weibocom/rill-flow/blob/main/rill-flow-ui/README.md

This command builds the project for production using PNPM. The `pnpm build:prod` command executes a script defined in the project's package.json file, which typically performs optimizations like minification, bundling, and tree shaking to prepare the application for deployment.

```Shell
pnpm build:prod
```

--------------------------------

### Build Docker Image for Flow-let

Source: https://github.com/weibocom/rill-flow/blob/main/flow-let/fastapi/README.md

This script builds a Docker image for the flow-let component using the provided Rill Flow packaging script. It allows users to create a containerized version of flow-let for deployment.

```Shell
sh build_image.sh
```

--------------------------------

### Defining a Simple Workflow in YAML

Source: https://github.com/weibocom/rill-flow/blob/main/README.md

This YAML configuration defines a simple workflow named 'greet' within the 'rillFlowSimple' workspace. It includes two tasks, 'Bob' and 'Alice', which call the sample-executor service to generate greetings. It specifies input schemas, task dependencies, and input mappings.

```yaml
version: 1.0.0
workspace: rillFlowSimple
dagName: greet
alias: release
type: flow
inputSchema: >-
  [{"required":true,"name":"Bob","type":"String"},{"required":true,"name":"Alice","type":"String"}]
tasks:
  - category: function
    name: Bob
    resourceName: http://sample-executor:8000/greet.json?user=Bob
    pattern: task_sync
    tolerance: false
    next: Alice
    inputMappings:
      - source: "$.context.Bob"
        target: "$.input.Bob"
  - category: function
    name: Alice
    resourceName: http://sample-executor:8000/greet.json?user=Alice
    pattern: task_sync
    tolerance: false
    inputMappings:
      - source: "$.context.Alice"
        target: "$.input.Alice"
```

--------------------------------

### Deploy Flow-let with Docker Compose

Source: https://github.com/weibocom/rill-flow/blob/main/flow-let/fastapi/README.md

This Docker Compose configuration deploys flow-let as a sidecar container alongside a custom executor. It defines the flow-let service, specifies the image to use, and sets the upstream_url environment variable to forward requests to the executor.

```Shell
cat <<EOF > docker-compose-flow-let-sidecar.yaml
version: '3'
services:
  flow-let:
    image: weibocom/rill-flow-let:fastapi
    environment:
     upstream_url: http://{executor-host}:{port} 
EOF
docker-compose up -d
```

--------------------------------

### Build Docker Image for Java Executor

Source: https://github.com/weibocom/rill-flow/blob/main/executors/spring-boot/README.md

This script builds a Docker image for the Java executor using the provided Rill Flow packaging script. It requires the build_image.sh script to be present in the executor-web/docker/ directory.

```shell
sh build_image.sh
```

--------------------------------

### Listing Project Dependencies

Source: https://github.com/weibocom/rill-flow/blob/main/docs/samples/txt2video/wav2lip/requirements.txt

This code snippet lists the Python dependencies required for the rill-flow project. It includes specific versions for certain packages to ensure compatibility and avoid potential conflicts.

```Python
tqdm
PyYAML>=5.1
scikit-image>=0.14.0
scipy>=1.1.0
opencv-python<=4.6.0.66
imageio==2.9.0
imageio-ffmpeg
librosa==0.8.1
numba==0.57.1
easydict
munch
natsort
matplotlib
numpy==1.21.6
torch>=1.7.1
torchvision
uvicorn
fastapi
```

--------------------------------

### Cloning Rill Flow Repository

Source: https://github.com/weibocom/rill-flow/blob/main/README_zh_CN.md

This command clones the Rill Flow repository from GitHub to your local machine. This is the first step in setting up the Rill Flow service.

```shell
git clone https://github.com/weibocom/rill-flow.git
```

--------------------------------

### Cloning Rill Flow Repository using Git

Source: https://github.com/weibocom/rill-flow/blob/main/README.md

This command clones the Rill Flow source code repository from GitHub to your local machine. This is the first step in setting up the Rill Flow service.

```shell
git clone https://github.com/weibocom/rill-flow.git
```

--------------------------------

### Build Docker Image for Python Executor

Source: https://github.com/weibocom/rill-flow/blob/main/executors/fastapi/README.md

This shell script builds a Docker image for the Python executor using the provided Rill Flow packaging script. It is a prerequisite for deploying the executor.

```shell
sh build_image.sh
```

--------------------------------

### Defining Python Package Dependencies

Source: https://github.com/weibocom/rill-flow/blob/main/docs/samples/txt2video/moviepy/requirements.txt

This snippet defines the Python package dependencies for the project. It specifies the name and version of each required package, ensuring that the project has the necessary libraries to run.

```Python
click==8.1.7
einops==0.7.0
encodec==0.1.1
filelock==3.13.1
fsspec==2023.10.0
h11==0.14.0
Jinja2==3.1.2
MarkupSafe==2.1.3
mpmath==1.3.0
networkx==3.2.1
typing_extensions==4.8.0
uvicorn==0.24.0.post1
fastapi
moviepy
```

--------------------------------

### Sample Rill Flow Task Definition in YAML

Source: https://github.com/weibocom/rill-flow/blob/main/README_zh_CN.md

This YAML file defines a simple Rill Flow task with two function tasks, Bob and Alice. It specifies the task category, resource name, pattern, tolerance, input mappings, and task dependencies.

```yaml
version: 1.0.0
workspace: rillFlowSimple
dagName: greet
alias: release
type: flow
inputSchema: >-
  [{"required":true,"name":"Bob","type":"String"},{"required":true,"name":"Alice","type":"String"}]
tasks:
  - category: function
    name: Bob
    resourceName: http://sample-executor:8000/greet.json?user=Bob
    pattern: task_sync
    tolerance: false
    next: Alice
    inputMappings:
      - source: "$.context.Bob"
        target: "$.input.Bob"
  - category: function
    name: Alice
    resourceName: http://sample-executor:8000/greet.json?user=Alice
    pattern: task_sync
    tolerance: false
    inputMappings:
      - source: "$.context.Alice"
        target: "$.input.Alice"
```

--------------------------------

### Listing Python Package Dependencies

Source: https://github.com/weibocom/rill-flow/blob/main/docs/samples/txt2video/bark/requirements.txt

This code snippet lists the Python package dependencies required for the Rill Flow project. Each line specifies a package name and its corresponding version number. These packages are essential for the project's functionality.

```Python
click==8.1.7
einops==0.7.0
encodec==0.1.1
filelock==3.13.1
fsspec==2023.10.0
h11==0.14.0
Jinja2==3.1.2
MarkupSafe==2.1.3
mpmath==1.3.0
networkx==3.2.1
numpy==1.26.2
sympy==1.12
torch==2.1.1
torchaudio==2.1.1
typing_extensions==4.8.0
uvicorn==0.24.0.post1
ipython
fastapi
transformers
scipy
funcy
```

--------------------------------

### Checking Rill Flow Service Status with Docker Compose

Source: https://github.com/weibocom/rill-flow/blob/main/README.md

This command checks the status of the Rill Flow services managed by Docker Compose. It displays the name, command, state, and ports of each service.

```shell
docker-compose ps
```
Tokens:
Raw