Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kevdoran authored Oct 16, 2018
1 parent a1f794e commit 7b27a85
Showing 1 changed file with 49 additions and 1 deletion.
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,51 @@
# FlowOps
Automated, repeatable tasks for NiFi data flow operations.

Automated, repeatable tasks for [Apache NiFi](https://nifi.apache.org) data flow operations.

## Quickstart Guide

### FlowOps Docker Image

The FlowOps Docker image comes with useful tools for automating Apache NiFi data flow operations, such as the [Apache NiFi Toolkit CLI](https://github.com/apache/nifi/tree/master/nifi-toolkit/nifi-toolkit-cli) and [NiPyAPI](https://github.com/Chaffelson/nipyapi)

Pull from Dockerhub:

docker pull kevdoran/flowops:latest

Run interactively:

docker run -it kevdoran/flowops:latest

This will drop you into a bash shell on a flowops container. Most of the commands you need to get started are already on the path (e.g., the NiFi Toolkit /bin directory). Also, there are a number of [scripts](#scripts) located in `/scripts` that you may find useful.

If you want to use the FlowOps image to control NiFi or Registry containers running in an existing environment (e.g., one created by docker-compose), just specify the network those containers are bound too:

docker run -it --network <docker-network-name> flowops:latest

Lastly, FlowOps is designed to be included as part of a docker-compose configuration. For an example, see the NiFi & NiFi Registry [docker-compose.yml](https://github.com/kevdoran/flowops/blob/master/docker/demo/nifi-registry/docker-compose.yml) demo.

## Scripts

The FlowOps Docker image comes with a number of scripts to facilitate common actions. These are located in the `/scripts` directory in the flowops image.

TODO, provide documentation for provided / built-in scripts.

## Demos

### Apache NiFi & NiFi Registry

This demo starts the FlowOps demo that connects Apache NiFi and NiFi Registry containers in a docker-compose environment. See the [docker-compose.yml](https://github.com/kevdoran/flowops/blob/master/docker/demo/nifi-registry/docker-compose.yml) file in this repo for details.

#### From master branch

wget -qO- https://raw.githubusercontent.com/kevdoran/flowops/master/docker/demo/nifi-registry/docker-compose.yml | docker-compose -f - up

#### From a stable release

FO_VERSION=0.1.0 \
&& wget https://github.com/kevdoran/flowops/archive/v${FO_VERSION}.tar.gz \
&& tar -xzf flowops-v${FO_VERSION}.tar.gz \
&& cd flowops-v0.1.0/docker/demo/nifi-registry \
&& docker-compose up

In the above example, replace FO_VERSION=0.1.0 with the version you wish to use. Releases can be found at the [releases page](https://github.com/kevdoran/flowops/releases).

0 comments on commit 7b27a85

Please sign in to comment.