flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject [1/4] flink git commit: [FLINK-5258] [docs] Reorganize the docs to improve navigation and reduce duplication
Date Wed, 14 Dec 2016 14:10:35 GMT
Repository: flink
Updated Branches:
  refs/heads/master e4c767a37 -> 79d7e3017


http://git-wip-us.apache.org/repos/asf/flink/blob/79d7e301/docs/setup/local_setup.md
----------------------------------------------------------------------
diff --git a/docs/setup/local_setup.md b/docs/setup/local_setup.md
deleted file mode 100644
index c23a1df..0000000
--- a/docs/setup/local_setup.md
+++ /dev/null
@@ -1,153 +0,0 @@
----
-title:  "Local Setup"
-nav-title: Local
-nav-parent_id: deployment
-nav-pos: 1
----
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements.  See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership.  The ASF licenses this file
-to you 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
-
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied.  See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-This documentation is intended to provide instructions on how to run Flink locally on a single
machine.
-
-* This will be replaced by the TOC
-{:toc}
-
-## Download
-
-Go to the [downloads page]({{ site.download_url }}) and get the ready to run package. If
you want to interact with Hadoop (e.g. HDFS or HBase), make sure to pick the Flink package
**matching your Hadoop version**. When in doubt or you plan to just work with the local file
system pick the package for Hadoop 1.2.x.
-
-{% top %}
-
-## Requirements
-
-Flink runs on **Linux**, **Mac OS X** and **Windows**. The only requirement for a local setup
is **Java 1.7.x** or higher. The following manual assumes a *UNIX-like environment*, for Windows
see [Flink on Windows](#flink-on-windows).
-
-You can check the correct installation of Java by issuing the following command:
-
-~~~bash
-java -version
-~~~
-
-The command should output something comparable to the following:
-
-~~~bash
-java version "1.8.0_51"
-Java(TM) SE Runtime Environment (build 1.8.0_51-b16)
-Java HotSpot(TM) 64-Bit Server VM (build 25.51-b03, mixed mode)
-~~~
-
-{% top %}
-
-## Configuration
-
-**For local mode Flink is ready to go out of the box and you don't need to change the default
configuration.**
-
-The out of the box configuration will use your default Java installation. You can manually
set the environment variable `JAVA_HOME` or the configuration key `env.java.home` in `conf/flink-conf.yaml`
if you want to manually override the Java runtime to use. Consult the [configuration page](config.html)
for further details about configuring Flink.
-
-{% top %}
-
-## Starting Flink
-
-**You are now ready to start Flink.** Unpack the downloaded archive and change to the newly
created `flink` directory. There you can start Flink in local mode:
-
-~~~bash
-$ tar xzf flink-*.tgz
-$ cd flink
-$ bin/start-local.sh
-Starting jobmanager.
-~~~
-
-You can check that the system is running by checking the log files in the `logs` directory:
-
-~~~bash
-$ tail log/flink-*-jobmanager-*.log
-INFO ... - Starting JobManager
-INFO ... - Starting JobManager web frontend
-INFO ... - Web frontend listening at 127.0.0.1:8081
-INFO ... - Registered TaskManager at 127.0.0.1 (akka://flink/user/taskmanager)
-~~~
-
-The JobManager will also start a web frontend on port 8081, which you can check with your
browser at `http://localhost:8081`.
-
-{% top %}
-
-## Flink on Windows
-
-If you want to run Flink on Windows you need to download, unpack and configure the Flink
archive as mentioned above. After that you can either use the **Windows Batch** file (`.bat`)
or use **Cygwin**  to run the Flink Jobmanager.
-
-### 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`.
-
-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.
-~~~
-
-After that, you need to open a second terminal to run jobs using `flink.bat`.
-
-{% top %}
-
-### 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:
-
-~~~bash
-$ cd flink
-$ bin/start-local.sh
-Starting jobmanager.
-~~~
-
-{% top %}
-
-### Installing Flink from Git
-
-If you are installing Flink from the git repository and you are using the Windows git shell,
Cygwin can produce a failure similiar to this one:
-
-~~~bash
-c:/flink/bin/start-local.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:
-
-1. Start a Cygwin shell.
-
-2. Determine your home directory by entering
-
-~~~bash
-cd; pwd
-~~~
-
-It will return a path under the Cygwin root path.
-
-2.  Using NotePad, WordPad or a different text editor open the file `.bash_profile` in the
home directory and append the following: (If the file does not exist you have to create it)
-
-~~~bash
-export SHELLOPTS
-set -o igncr
-~~~
-
-Save the file and open a new bash shell.
-
-{% top %}

http://git-wip-us.apache.org/repos/asf/flink/blob/79d7e301/docs/setup/savepoints.md
----------------------------------------------------------------------
diff --git a/docs/setup/savepoints.md b/docs/setup/savepoints.md
index 231a4ff..2866635 100644
--- a/docs/setup/savepoints.md
+++ b/docs/setup/savepoints.md
@@ -1,7 +1,7 @@
 ---
 title: "Savepoints"
 nav-parent_id: setup
-nav-pos: 7
+nav-pos: 8
 ---
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
@@ -29,14 +29,15 @@ Programs written in the [Data Stream API](index.html) can resume execution
from
 
 ## Overview
 
-Savepoints are **manually triggered checkpoints**, which take a snapshot of the program and
write it out to a state backend. They rely on the regular checkpointing mechanism for this.
During execution programs are periodically snapshotted on the worker nodes and produce checkpoints.
For recovery only the last completed checkpoint is needed and older checkpoints can be safely
discarded as soon as a new one is completed.
-
-Savepoints are similar to these periodic checkpoints except that they are **triggered by
the user** and **don't automatically expire** when newer checkpoints are completed.
+In the example below the workers produce checkpoints **c<sub>1</sub>**, **c<sub>2</sub>**,
+**c<sub>3</sub>**, and **c<sub>4</sub>** for job *0xA312Bc*. Periodic
checkpoints **c<sub>1</sub>**
+and **c<sub>3</sub>** have already been *discarded* and **c<sub>4</sub>**
is the *latest
+checkpoint*. **c<sub>2</sub> is special**. It is the state associated with the
savepoint
+**s<sub>1</sub>** and has been triggered by the user and it doesn't expire automatically
(as
+c<sub>1</sub> and c<sub>3</sub> did after the completion of newer
checkpoints).
 
 <img src="{{ site.baseurl }}/fig/savepoints-overview.png" class="center" />
 
-In the above example the workers produce checkpoints **c<sub>1</sub>**, **c<sub>2</sub>**,
**c<sub>3</sub>**, and **c<sub>4</sub>** for job *0xA312Bc*. Periodic
checkpoints **c<sub>1</sub>** and **c<sub>3</sub>** have already been
*discarded* and **c<sub>4</sub>** is the *latest checkpoint*. **c<sub>2</sub>
is special**. It is the state associated with the savepoint **s<sub>1</sub>**
and has been triggered by the user and it doesn't expire automatically (as c<sub>1</sub>
and c<sub>3</sub> did after the completion of newer checkpoints).
-
 Note that **s<sub>1</sub>** is only a **pointer to the actual checkpoint data
c<sub>2</sub>**. This means that the actual state is *not copied* for the savepoint
and periodic checkpoint data is kept around.
 
 ## Configuration

http://git-wip-us.apache.org/repos/asf/flink/blob/79d7e301/docs/setup/security-ssl.md
----------------------------------------------------------------------
diff --git a/docs/setup/security-ssl.md b/docs/setup/security-ssl.md
index aa99a0a..19cdcae 100644
--- a/docs/setup/security-ssl.md
+++ b/docs/setup/security-ssl.md
@@ -1,7 +1,7 @@
 ---
 title: "SSL Setup"
 nav-parent_id: setup
-nav-pos: 8
+nav-pos: 9
 ---
 <!--
 Licensed to the Apache Software Foundation (ASF) under one

http://git-wip-us.apache.org/repos/asf/flink/blob/79d7e301/docs/start/index.md
----------------------------------------------------------------------
diff --git a/docs/start/index.md b/docs/start/index.md
new file mode 100644
index 0000000..c6cefe2
--- /dev/null
+++ b/docs/start/index.md
@@ -0,0 +1,26 @@
+---
+section-break: true
+nav-title: '<i class="fa fa-cogs title maindish" aria-hidden="true"></i> Installation
& Setup'
+title: "Installation & Setup"
+nav-id: "start"
+nav-parent_id: root
+nav-pos: 4
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you 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
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->


Mime
View raw message