Add flink docker image docs

flink/README-short.txt

@@ -0,0 +1 @@
+Apache Flink is an open source stream processing framework with powerful stream- and batch-processing capabilities.

flink/README.md

@@ -0,0 +1,15 @@
+<!--
+
+********************************************************************************
+
+WARNING:
+
+    DO NOT EDIT "flink/README.md"
+
+    IT IS AUTO-GENERATED
+
+    (from the other files in "flink/" combined with a set of templates)
+
+********************************************************************************
+
+-->

flink/content.md

@@ -0,0 +1,95 @@
+# What is Apache Flink?
+
+Apache Flink is an open source stream processing framework with powerful stream- and batch-processing capabilities.
+
+Learn more about Flink at [http://flink.apache.org/](http://flink.apache.org/)
+
+> [wikipedia.org/wiki/Apache_Flink](https://en.wikipedia.org/wiki/Apache_Flink)
+
+%%LOGO%%
+
+# How to use this Docker image
+
+## Run a flink local cluster
+
+To run a single Flink local cluster:
+
+```console
+$ docker run --name flink_local -p 8081:8081 -t flink local
+```
+
+Then with a web browser go to `http://localhost:8081/` to see the Flink Job Manager Console (adjust the hostname for your docker host).
+
+To use Flink, you can submit a job to the cluster using the Web UI or you can also do it from a different flink container, for example:
+
+```console
+$ docker run -t flink flink run -m <jobmanager:port> -c <your_class> <your_jar> <your_params>
+```
+
+## Running a job manager or a task manager
+
+You can run an jobmanager (master).
+
+```console
+$ docker run --name flink_jobmanager -d -t flink taskmanager
+```
+
+You can also run a taskmanager (worker). Notice that workers need to register with the jobmanager directly or via zookeeper so the master starts to send them tasks to execute.
+
+```console
+$ docker run --name flink_taskmanager -d -t flink taskmanager
+```
+
+## Running a cluster using Docker Compose
+
+With Docker Compose you can create a Flink cluster:
+
+```yml
+version: "2.1"
+services:
+  jobmanager:
+    image: ${FLINK_DOCKER_IMAGE_NAME:-flink}
+    expose:
+      - "6123"
+    ports:
+      - "8081:8081"
+    command: jobmanager
+    environment:
+      - JOB_MANAGER_RPC_ADDRESS=jobmanager
+
+  taskmanager:
+    image: ${FLINK_DOCKER_IMAGE_NAME:-flink}
+    expose:
+      - "6121"
+      - "6122"
+    depends_on:
+      - jobmanager
+    command: taskmanager
+    links:
+      - "jobmanager:jobmanager"
+    environment:
+      - JOB_MANAGER_RPC_ADDRESS=jobmanager
+```
+
+and just run `docker-compose up`.
+
+Scale the cluster up or down to *N* TaskManagers:
+
+```console
+docker-compose scale taskmanager=<N>
+```
+
+## Configuration
+
+For reference these are the default ports used by flink image:
+
+- The Web Client is on port `8081`
+- JobManager RPC port `6123`
+- TaskManagers RPC port `6122`
+- TaskManagers Data port `6121`
+
+# About this repository
+
+This repository is available on [github.com/docker-flink/docker-flink](https://github.com/docker-flink/docker-flink), and the official build is on the [Docker Hub](https://hub.docker.com/_/flink/).
+
+This repository is maintained by members of the Apache Flink community.

flink/github-repo

@@ -0,0 +1 @@
+https://github.com/docker-flink/docker-flink

flink/license.md

@@ -0,0 +1,3 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+	      https://www.apache.org/licenses/LICENSE-2.0

flink/user-feedback.md

@@ -0,0 +1,9 @@
+## Issues
+
+Please report issues with this docker image on this [Github project](https://github.com/docker-flink/docker-flink).
+
+For general questions about Flink, see the [Community & Project Info](https://flink.apache.org/community.html), in particular the flink user mailing list.
+
+## Contributing
+
+If you want to contribute to Flink, see the [Flink Contribution Guide](https://flink.apache.org/how-to-contribute.html).