Skip to content

Commit

Permalink
[FLINK-6489] [FLINK-8696] [docs] Update docs to use 'start-cluster.sh…
Browse files Browse the repository at this point in the history
…' instead of 'start-local.sh'

(and likewise for 'start-cluster.bat' vs. 'start-local.bat')
  • Loading branch information
StephanEwen committed Feb 21, 2018
1 parent 9a3ceda commit 566ba00
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/dev/batch/examples.md
Expand Up @@ -38,7 +38,7 @@ or __flink-examples-streaming__ module of the Flink source repository.

In order to run a Flink example, we assume you have a running Flink instance available. The "Quickstart" and "Setup" tabs in the navigation describe various ways of starting Flink.

The easiest way is running the `./bin/start-local.sh` script, which will start a JobManager locally.
The easiest way is running the `./bin/start-cluster.sh`, which by default starts a local cluster with one JobManager and one TaskManager.

Each binary release of Flink contains an `examples` directory with jar files for each of the examples on this page.

Expand Down
1 change: 0 additions & 1 deletion docs/ops/cli.md
Expand Up @@ -32,7 +32,6 @@ started from the same installation directory.

A prerequisite to using the command line interface is that the Flink
master (JobManager) has been started (via
`<flink-home>/bin/start-local.sh` or
`<flink-home>/bin/start-cluster.sh`) or that a YARN environment is
available.

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/run_example_quickstart.md
Expand Up @@ -348,7 +348,7 @@ to the location where you installed Flink and start a local cluster:

{% highlight bash %}
$ cd my/flink/directory
$ bin/start-local.sh
$ bin/start-cluster.sh
{% endhighlight %}

We also have to create the Kafka Topic, so that our program can write to it:
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/setup_quickstart.md
Expand Up @@ -91,7 +91,7 @@ $ cd build-target # this is where Flink is installed to
### Start a Local Flink Cluster

~~~bash
$ ./bin/start-local.sh # Start Flink
$ ./bin/start-cluster.sh # Start Flink
~~~

Check the __JobManager's web frontend__ at [http://localhost:8081](http://localhost:8081) and make sure everything is up and running. The web frontend should report a single available TaskManager instance.
Expand Down
17 changes: 9 additions & 8 deletions docs/start/flink_on_windows.md
Expand Up @@ -26,16 +26,17 @@ If you want to run Flink locally on a Windows machine you need to [download](htt

## Starting with Windows Batch Files

To start Flink in local mode from the *Windows Batch*, open the command window, navigate to the `bin/` directory of Flink and run `start-local.bat`.
To start Flink in from the *Windows Command Line*, open the command window, navigate to the `bin/` directory of Flink and run `start-cluster.bat`.

Note: The ``bin`` folder of your Java Runtime Environment must be included in Window's ``%PATH%`` variable. Follow this [guide](http://www.java.com/en/download/help/path.xml) to add Java to the ``%PATH%`` variable.

~~~bash
$ cd flink
$ cd bin
$ start-local.bat
Starting Flink job manager. Web interface by default on http://localhost:8081/.
Do not close this batch window. Stop job manager by pressing Ctrl+C.
$ start-cluster.bat
Starting a local cluster with one JobManager process and one TaskManager process.
You can terminate the processes via CTRL-C in the spawned shell windows.
Web interface by default on http://localhost:8081/.
~~~

After that, you need to open a second terminal to run jobs using `flink.bat`.
Expand All @@ -44,12 +45,12 @@ After that, you need to open a second terminal to run jobs using `flink.bat`.

## Starting with Cygwin and Unix Scripts

With *Cygwin* you need to start the Cygwin Terminal, navigate to your Flink directory and run the `start-local.sh` script:
With *Cygwin* you need to start the Cygwin Terminal, navigate to your Flink directory and run the `start-cluster.sh` script:

~~~bash
$ cd flink
$ bin/start-local.sh
Starting jobmanager.
$ bin/start-cluster.sh
Starting cluster.
~~~

{% top %}
Expand All @@ -59,7 +60,7 @@ Starting jobmanager.
If you are installing Flink from the git repository and you are using the Windows git shell, Cygwin can produce a failure similar to this one:

~~~bash
c:/flink/bin/start-local.sh: line 30: $'\r': command not found
c:/flink/bin/start-cluster.sh: line 30: $'\r': command not found
~~~

This error occurs because git is automatically transforming UNIX line endings to Windows style line endings when running in Windows. The problem is that Cygwin can only deal with UNIX style line endings. The solution is to adjust the Cygwin settings to deal with the correct line endings by following these three steps:
Expand Down

0 comments on commit 566ba00

Please sign in to comment.