@ -23,3 +23,110 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Introduction
Standalone mode is Flink’s simplest deployment mode. This short guide will show you how to download the latest stable version of Flink, install, and run it.
You will also run an example Flink CDC job and view it in the web UI.
## Preparation
Flink runs on all UNIX-like environments, i.e. Linux, Mac OS X, and Cygwin (for Windows).
You can refer [overview]({{< ref "docs/connectors/overview" >}}) to check supported versions and download [the binary release](https://flink.apache.org/downloads/) of Flink,
then extract the archive:
```bash
tar -xzf flink-*.tgz
```
You should set `FLINK_HOME` environment variables like:
```bash
export FLINK_HOME=/path/flink-*
```
### Start and stop a local cluster
To start a local cluster, run the bash script that comes with Flink:
```bash
cd /path/flink-*
./bin/start-cluster.sh
```
Flink is now running as a background process. You can check its status with the following command:
```bash
ps aux | grep flink
```
You should be able to navigate to the web UI at [localhost:8081](http://localhost:8081) to view
the Flink dashboard and see that the cluster is up and running.
To quickly stop the cluster and all running components, you can use the provided script:
```bash
./bin/stop-cluster.sh
```
## Set up Flink CDC
Download the tar file of Flink CDC from [release page](https://github.com/apache/flink-cdc/releases), then extract the archive:
```bash
tar -xzf flink-cdc-*.tar.gz
```
Extracted `flink-cdc` contains four directories: `bin`,`lib`,`log` and `conf`.
Download the connector jars from [release page](https://github.com/apache/flink-cdc/releases), and move it to the `lib` directory.
Download links are available only for stable releases, SNAPSHOT dependencies need to be built based on specific branch by yourself.
## Submit a Flink CDC Job
Here is an example file for synchronizing the entire database `mysql-to-doris.yaml`: