This is an automated email from the ASF dual-hosted git repository. trohrmann pushed a commit to branch release-1.12 in repository https://gitbox.apache.org/repos/asf/flink.git
commit 1f88306e724531cceef6b98d54bc3d03e09e93fc Author: Till Rohrmann <[email protected]> AuthorDate: Tue Nov 24 18:04:19 2020 +0100 [FLINK-20342][docs] Reordered items in nav bar & fixed broken links from renaming ops/deployment into ops/resource-providers --- docs/ops/cli.md | 6 +++--- docs/ops/cli.zh.md | 6 +++--- docs/ops/config.md | 8 ++++---- docs/ops/config.zh.md | 8 ++++---- docs/ops/external_resources.md | 2 +- docs/ops/external_resources.zh.md | 2 +- docs/ops/filesystems/index.md | 2 +- docs/ops/filesystems/index.zh.md | 2 +- docs/ops/jobmanager_high_availability.md | 2 +- docs/ops/jobmanager_high_availability.zh.md | 8 ++++---- docs/ops/memory/index.md | 2 +- docs/ops/memory/index.zh.md | 2 +- docs/ops/memory/mem_setup.md | 2 +- docs/ops/memory/mem_setup.zh.md | 4 ++-- docs/ops/plugins.md | 2 +- docs/ops/plugins.zh.md | 2 +- docs/ops/production_ready.md | 2 +- docs/ops/production_ready.zh.md | 2 +- docs/ops/python_shell.md | 2 +- docs/ops/python_shell.zh.md | 2 +- docs/ops/resource-providers/docker.md | 8 ++++---- docs/ops/resource-providers/docker.zh.md | 8 ++++---- docs/ops/resource-providers/kubernetes.md | 14 +++++++------- docs/ops/resource-providers/kubernetes.zh.md | 14 +++++++------- docs/ops/resource-providers/yarn_setup.md | 2 +- docs/ops/resource-providers/yarn_setup.zh.md | 2 +- docs/ops/scala_shell.md | 2 +- docs/ops/scala_shell.zh.md | 2 +- docs/ops/security-kerberos.md | 2 +- docs/ops/security-kerberos.zh.md | 2 +- docs/ops/security-ssl.md | 2 +- docs/ops/security-ssl.zh.md | 2 +- docs/ops/state/index.md | 2 +- docs/ops/state/index.zh.md | 2 +- docs/ops/upgrading.md | 2 +- docs/ops/upgrading.zh.md | 2 +- 36 files changed, 68 insertions(+), 68 deletions(-) diff --git a/docs/ops/cli.md b/docs/ops/cli.md index 5717237..7454c51 100644 --- a/docs/ops/cli.md +++ b/docs/ops/cli.md @@ -2,7 +2,7 @@ title: "Command-Line Interface" nav-title: CLI nav-parent_id: ops -nav-pos: 7 +nav-pos: 10 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -108,7 +108,7 @@ These examples about how to submit a job in CLI. ./examples/batch/WordCount.jar \ --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out -- Run example program using a [per-job YARN cluster]({% link ops/deployment/yarn_setup.md %}#run-a-single-flink-job-on-hadoop-yarn) with 2 TaskManagers: +- Run example program using a [per-job YARN cluster]({% link ops/resource-providers/yarn_setup.md %}#run-a-single-flink-job-on-hadoop-yarn) with 2 TaskManagers: ./bin/flink run -m yarn-cluster \ ./examples/batch/WordCount.jar \ @@ -159,7 +159,7 @@ $ python --version ./bin/flink run -m myJMHost:8081 \ -py examples/python/table/batch/word_count.py -- Run Python Table program using a [per-job YARN cluster]({% link ops/deployment/yarn_setup.md %}#run-a-single-flink-job-on-hadoop-yarn) with 2 TaskManagers: +- Run Python Table program using a [per-job YARN cluster]({% link ops/resource-providers/yarn_setup.md %}#run-a-single-flink-job-on-hadoop-yarn) with 2 TaskManagers: ./bin/flink run -m yarn-cluster \ -py examples/python/table/batch/word_count.py diff --git a/docs/ops/cli.zh.md b/docs/ops/cli.zh.md index 98fe6ff..12f0b42 100644 --- a/docs/ops/cli.zh.md +++ b/docs/ops/cli.zh.md @@ -2,7 +2,7 @@ title: "命令行界面" nav-title: CLI nav-parent_id: ops -nav-pos: 7 +nav-pos: 10 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -111,7 +111,7 @@ option. ./examples/batch/WordCount.jar \ --input file:///home/user/hamlet.txt --output file:///home/user/wordcount_out -- Run example program using a [per-job YARN cluster]({% link ops/deployment/yarn_setup.zh.md %}#run-a-single-flink-job-on-hadoop-yarn) with 2 TaskManagers: +- Run example program using a [per-job YARN cluster]({% link ops/resource-providers/yarn_setup.zh.md %}#run-a-single-flink-job-on-hadoop-yarn) with 2 TaskManagers: ./bin/flink run -m yarn-cluster \ ./examples/batch/WordCount.jar \ @@ -162,7 +162,7 @@ $ python --version ./bin/flink run -m myJMHost:8081 \ -py examples/python/table/batch/word_count.py -- 提交一个运行在有两个TaskManager的[per-job YARN cluster]({% link ops/deployment/yarn_setup.zh.md %}#run-a-single-flink-job-on-hadoop-yarn)的Python Table的作业: +- 提交一个运行在有两个TaskManager的[per-job YARN cluster]({% link ops/resource-providers/yarn_setup.zh.md %}#run-a-single-flink-job-on-hadoop-yarn)的Python Table的作业: ./bin/flink run -m yarn-cluster \ -py examples/python/table/batch/word_count.py diff --git a/docs/ops/config.md b/docs/ops/config.md index 363a760..d39a677 100644 --- a/docs/ops/config.md +++ b/docs/ops/config.md @@ -2,7 +2,7 @@ title: "Configuration" nav-id: "config" nav-parent_id: ops -nav-pos: 4 +nav-pos: 9 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -39,9 +39,9 @@ The options in this section are the ones most commonly needed for a basic distri **Hostnames / Ports** -These options are only necessary for *standalone* application- or session deployments ([simple standalone]({% link ops/deployment/cluster_setup.md %}) or [Kubernetes]({% link ops/deployment/kubernetes.md %})). +These options are only necessary for *standalone* application- or session deployments ([simple standalone]({% link ops/resource-providers/cluster_setup.md %}) or [Kubernetes]({% link ops/resource-providers/kubernetes.md %})). -If you use Flink with [Yarn]({% link ops/deployment/yarn_setup.md %}), [Mesos]({% link ops/deployment/mesos.md %}), or the [*active* Kubernetes integration]({% link ops/deployment/native_kubernetes.md %}), the hostnames and ports are automatically discovered. +If you use Flink with [Yarn]({% link ops/resource-providers/yarn_setup.md %}), [Mesos]({% link ops/resource-providers/mesos.md %}), or the [*active* Kubernetes integration]({% link ops/resource-providers/native_kubernetes.md %}), the hostnames and ports are automatically discovered. - `rest.address`, `rest.port`: These are used by the client to connect to Flink. Set this to the hostname where the JobManager runs, or to the hostname of the (Kubernetes) service in front of the JobManager's REST interface. @@ -202,7 +202,7 @@ Please refer to the [Flink and Kerberos Docs]({% link ops/security-kerberos.md % This section contains options related to integrating Flink with resource orchestration frameworks, like Kubernetes, Yarn, Mesos, etc. Note that is not always necessary to integrate Flink with the resource orchestration framework. -For example, you can easily deploy Flink applications on Kubernetes without Flink knowing that it runs on Kubernetes (and without specifying any of the Kubernetes config options here.) See [this setup guide]({% link ops/deployment/kubernetes.md %}) for an example. +For example, you can easily deploy Flink applications on Kubernetes without Flink knowing that it runs on Kubernetes (and without specifying any of the Kubernetes config options here.) See [this setup guide]({% link ops/resource-providers/kubernetes.md %}) for an example. The options in this section are necessary for setups where Flink itself actively requests and releases resources from the orchestrators. diff --git a/docs/ops/config.zh.md b/docs/ops/config.zh.md index ecbfab2..0b2e4ba 100644 --- a/docs/ops/config.zh.md +++ b/docs/ops/config.zh.md @@ -2,7 +2,7 @@ title: "配置参数" nav-id: "config" nav-parent_id: ops -nav-pos: 4 +nav-pos: 9 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -39,9 +39,9 @@ The options in this section are the ones most commonly needed for a basic distri **Hostnames / Ports** -These options are only necessary for *standalone* application- or session deployments ([simple standalone]({% link ops/deployment/cluster_setup.zh.md %}) or [Kubernetes]({% link ops/deployment/kubernetes.zh.md %})). +These options are only necessary for *standalone* application- or session deployments ([simple standalone]({% link ops/resource-providers/cluster_setup.zh.md %}) or [Kubernetes]({% link ops/resource-providers/kubernetes.zh.md %})). -If you use Flink with [Yarn]({% link ops/deployment/yarn_setup.zh.md %}), [Mesos]({% link ops/deployment/mesos.zh.md %}), or the [*active* Kubernetes integration]({% link ops/deployment/native_kubernetes.zh.md %}), the hostnames and ports are automatically discovered. +If you use Flink with [Yarn]({% link ops/resource-providers/yarn_setup.zh.md %}), [Mesos]({% link ops/resource-providers/mesos.zh.md %}), or the [*active* Kubernetes integration]({% link ops/resource-providers/native_kubernetes.zh.md %}), the hostnames and ports are automatically discovered. - `rest.address`, `rest.port`: These are used by the client to connect to Flink. Set this to the hostname where the JobManager runs, or to the hostname of the (Kubernetes) service in front of the JobManager's REST interface. @@ -202,7 +202,7 @@ Please refer to the [Flink and Kerberos Docs]({% link ops/security-kerberos.zh.m This section contains options related to integrating Flink with resource orchestration frameworks, like Kubernetes, Yarn, Mesos, etc. Note that is not always necessary to integrate Flink with the resource orchestration framework. -For example, you can easily deploy Flink applications on Kubernetes without Flink knowing that it runs on Kubernetes (and without specifying any of the Kubernetes config options here.) See [this setup guide]({% link ops/deployment/kubernetes.zh.md %}) for an example. +For example, you can easily deploy Flink applications on Kubernetes without Flink knowing that it runs on Kubernetes (and without specifying any of the Kubernetes config options here.) See [this setup guide]({% link ops/resource-providers/kubernetes.zh.md %}) for an example. The options in this section are necessary for setups where Flink itself actively requests and releases resources from the orchestrators. diff --git a/docs/ops/external_resources.md b/docs/ops/external_resources.md index 879e435..79e5839 100644 --- a/docs/ops/external_resources.md +++ b/docs/ops/external_resources.md @@ -1,7 +1,7 @@ --- title: "External Resource Framework" nav-parent_id: ops -nav-pos: 10 +nav-pos: 16 nav-title: External Resources --- <!-- diff --git a/docs/ops/external_resources.zh.md b/docs/ops/external_resources.zh.md index 15a5a27..6792dc8 100644 --- a/docs/ops/external_resources.zh.md +++ b/docs/ops/external_resources.zh.md @@ -1,7 +1,7 @@ --- title: "扩展资源框架" nav-parent_id: ops -nav-pos: 10 +nav-pos: 16 nav-title: 扩展资源 --- <!-- diff --git a/docs/ops/filesystems/index.md b/docs/ops/filesystems/index.md index cef2f8d..b853007 100644 --- a/docs/ops/filesystems/index.md +++ b/docs/ops/filesystems/index.md @@ -3,7 +3,7 @@ title: "File Systems" nav-id: filesystems nav-parent_id: ops nav-show_overview: true -nav-pos: 12 +nav-pos: 4 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/filesystems/index.zh.md b/docs/ops/filesystems/index.zh.md index c95c96b..d987515 100644 --- a/docs/ops/filesystems/index.zh.md +++ b/docs/ops/filesystems/index.zh.md @@ -3,7 +3,7 @@ title: "文件系统" nav-id: filesystems nav-parent_id: ops nav-show_overview: true -nav-pos: 12 +nav-pos: 4 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/jobmanager_high_availability.md b/docs/ops/jobmanager_high_availability.md index e331d80..e9bf405 100644 --- a/docs/ops/jobmanager_high_availability.md +++ b/docs/ops/jobmanager_high_availability.md @@ -2,7 +2,7 @@ title: "JobManager High Availability (HA)" nav-title: High Availability (HA) nav-parent_id: ops -nav-pos: 2 +nav-pos: 6 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/jobmanager_high_availability.zh.md b/docs/ops/jobmanager_high_availability.zh.md index 5382cbe..fab035c 100644 --- a/docs/ops/jobmanager_high_availability.zh.md +++ b/docs/ops/jobmanager_high_availability.zh.md @@ -2,7 +2,7 @@ title: "JobManager 高可用 (HA)" nav-title: 高可用 (HA) nav-parent_id: ops -nav-pos: 2 +nav-pos: 6 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -216,7 +216,7 @@ Starting zookeeper daemon on host localhost.</pre> $ bin/yarn-session.sh -n 2</pre> ## Kubernetes Cluster High Availability -Kubernetes high availability service could support both [standalone Flink on Kubernetes]({{ site.baseurl}}/zh/ops/deployment/kubernetes.html) and [native Kubernetes integration]({{ site.baseurl}}/zh/ops/deployment/native_kubernetes.html). +Kubernetes high availability service could support both [standalone Flink on Kubernetes]({{ site.baseurl}}/zh/ops/resource-providers/kubernetes.html) and [native Kubernetes integration]({{ site.baseurl}}/zh/ops/resource-providers/native_kubernetes.html). When running Flink JobManager as a Kubernetes deployment, the replica count should be configured to 1 or greater. * The value `1` means that a new JobManager will be launched to take over leadership if the current one terminates exceptionally. @@ -230,9 +230,9 @@ high-availability.storageDir: hdfs:///flink/recovery {% endhighlight %} #### Example: Highly Available Standalone Flink Cluster on Kubernetes -Both session and job/application clusters support using the Kubernetes high availability service. Users just need to add the following Flink config options to [flink-configuration-configmap.yaml]({{ site.baseurl}}/zh/ops/deployment/kubernetes.html#common-cluster-resource-definitions). All other yamls do not need to be updated. +Both session and job/application clusters support using the Kubernetes high availability service. Users just need to add the following Flink config options to [flink-configuration-configmap.yaml]({{ site.baseurl}}/zh/ops/resource-providers/kubernetes.html#common-cluster-resource-definitions). All other yamls do not need to be updated. -<span class="label label-info">Note</span> The filesystem which corresponds to the scheme of your configured HA storage directory must be available to the runtime. Refer to [custom Flink image]({{ site.baseurl}}/zh/ops/deployment/docker.html#customize-flink-image) and [enable plugins]({{ site.baseurl}}/zh/ops/deployment/docker.html#using-plugins) for more information. +<span class="label label-info">Note</span> The filesystem which corresponds to the scheme of your configured HA storage directory must be available to the runtime. Refer to [custom Flink image]({{ site.baseurl}}/zh/ops/resource-providers/docker.html#customize-flink-image) and [enable plugins]({{ site.baseurl}}/zh/ops/resource-providers/docker.html#using-plugins) for more information. {% highlight yaml %} apiVersion: v1 diff --git a/docs/ops/memory/index.md b/docs/ops/memory/index.md index e2190e1..e52bd32 100644 --- a/docs/ops/memory/index.md +++ b/docs/ops/memory/index.md @@ -2,7 +2,7 @@ nav-title: 'Memory Configuration' nav-id: ops_mem nav-parent_id: ops -nav-pos: 5 +nav-pos: 12 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/memory/index.zh.md b/docs/ops/memory/index.zh.md index df2ae8f..03ef042 100644 --- a/docs/ops/memory/index.zh.md +++ b/docs/ops/memory/index.zh.md @@ -2,7 +2,7 @@ nav-title: '内存配置' nav-id: ops_mem nav-parent_id: ops -nav-pos: 5 +nav-pos: 12 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/memory/mem_setup.md b/docs/ops/memory/mem_setup.md index edb9413..a473d54 100644 --- a/docs/ops/memory/mem_setup.md +++ b/docs/ops/memory/mem_setup.md @@ -67,7 +67,7 @@ See also [how to configure memory for standalone deployments]({% link ops/memory If you configure *total process memory* you declare how much memory in total should be assigned to the Flink *JVM process*. For the containerized deployments it corresponds to the size of the requested container, see also [how to configure memory for containers]({% link ops/memory/mem_tuning.md %}#configure-memory-for-containers) -([Kubernetes]({% link ops/deployment/kubernetes.md %}), [Yarn]({% link ops/deployment/yarn_setup.md %}) or [Mesos]({% link ops/deployment/mesos.md %})). +([Kubernetes]({% link ops/resource-providers/kubernetes.md %}), [Yarn]({% link ops/resource-providers/yarn_setup.md %}) or [Mesos]({% link ops/resource-providers/mesos.md %})). Another way to set up the memory is to configure the required internal components of the *total Flink memory* which are specific to the concrete Flink process. Check how to configure them for [TaskManager]({% link ops/memory/mem_setup_tm.md %}#configure-heap-and-managed-memory) diff --git a/docs/ops/memory/mem_setup.zh.md b/docs/ops/memory/mem_setup.zh.md index 989a754..d72b9a8 100644 --- a/docs/ops/memory/mem_setup.zh.md +++ b/docs/ops/memory/mem_setup.zh.md @@ -60,12 +60,12 @@ Flink JVM 进程的*进程总内存（Total Process Memory）*包含了由 Flink Flink 会根据默认值或其他配置参数自动调整剩余内存部分的大小。 关于各内存部分的更多细节，请分别参考 [TaskManager]({% link ops/memory/mem_setup_tm.zh.md %}) 和 [JobManager]({% link ops/memory/mem_setup_jobmanager.zh.md %}) 的相关文档。 -对于[独立部署模式（Standalone Deployment）]({% link ops/deployment/cluster_setup.zh.md %})，如果你希望指定由 Flink 应用本身使用的内存大小，最好选择配置 *Flink 总内存*。 +对于[独立部署模式（Standalone Deployment）]({% link ops/resource-providers/cluster_setup.zh.md %})，如果你希望指定由 Flink 应用本身使用的内存大小，最好选择配置 *Flink 总内存*。 *Flink 总内存*会进一步划分为 *JVM 堆内存*和*堆外内存*。 更多详情请参考[如何为独立部署模式配置内存]({% link ops/memory/mem_tuning.zh.md %}#configure-memory-for-standalone-deployment)。 通过配置*进程总内存*可以指定由 Flink *JVM 进程*使用的总内存大小。 -对于容器化部署模式（Containerized Deployment），这相当于申请的容器（Container）大小，详情请参考[如何配置容器内存]({% link ops/memory/mem_tuning.zh.md %}#configure-memory-for-containers)（[Kubernetes]({% link ops/deployment/kubernetes.zh.md %})、[Yarn]({% link ops/deployment/yarn_setup.zh.md %}) 或 [Mesos]({% link ops/deployment/mesos.zh.md %})）。 +对于容器化部署模式（Containerized Deployment），这相当于申请的容器（Container）大小，详情请参考[如何配置容器内存]({% link ops/memory/mem_tuning.zh.md %}#configure-memory-for-containers)（[Kubernetes]({% link ops/resource-providers/kubernetes.zh.md %})、[Yarn]({% link ops/resource-providers/yarn_setup.zh.md %}) 或 [Mesos]({% link ops/resource-providers/mesos.zh.md %})）。 此外，还可以通过设置 *Flink 总内存*的特定内部组成部分的方式来进行内存配置。 不同进程需要设置的内存组成部分是不一样的。 diff --git a/docs/ops/plugins.md b/docs/ops/plugins.md index 38b3634..0cada81 100644 --- a/docs/ops/plugins.md +++ b/docs/ops/plugins.md @@ -2,7 +2,7 @@ title: "Plugins" nav-id: plugins nav-parent_id: ops -nav-pos: 14 +nav-pos: 5 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/plugins.zh.md b/docs/ops/plugins.zh.md index 38b3634..0cada81 100644 --- a/docs/ops/plugins.zh.md +++ b/docs/ops/plugins.zh.md @@ -2,7 +2,7 @@ title: "Plugins" nav-id: plugins nav-parent_id: ops -nav-pos: 14 +nav-pos: 5 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/production_ready.md b/docs/ops/production_ready.md index f982a3c..a028611 100644 --- a/docs/ops/production_ready.md +++ b/docs/ops/production_ready.md @@ -1,7 +1,7 @@ --- title: "Production Readiness Checklist" nav-parent_id: ops -nav-pos: 6 +nav-pos: 15 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/production_ready.zh.md b/docs/ops/production_ready.zh.md index 6c2e62f..93d9140 100644 --- a/docs/ops/production_ready.zh.md +++ b/docs/ops/production_ready.zh.md @@ -1,7 +1,7 @@ --- title: "生产就绪情况核对清单" nav-parent_id: ops -nav-pos: 6 +nav-pos: 15 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/python_shell.md b/docs/ops/python_shell.md index 58e6965..58785cf 100644 --- a/docs/ops/python_shell.md +++ b/docs/ops/python_shell.md @@ -1,7 +1,7 @@ --- title: "Python REPL" nav-parent_id: ops -nav-pos: 8 +nav-pos: 13 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/python_shell.zh.md b/docs/ops/python_shell.zh.md index 2f70049..09ba46c 100644 --- a/docs/ops/python_shell.zh.md +++ b/docs/ops/python_shell.zh.md @@ -1,7 +1,7 @@ --- title: "Python REPL" nav-parent_id: ops -nav-pos: 8 +nav-pos: 13 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/resource-providers/docker.md b/docs/ops/resource-providers/docker.md index f15558f..f8f7d69 100644 --- a/docs/ops/resource-providers/docker.md +++ b/docs/ops/resource-providers/docker.md @@ -26,7 +26,7 @@ under the License. [Docker](https://www.docker.com) is a popular container runtime. There are Docker images for Apache Flink available [on Docker Hub](https://hub.docker.com/_/flink). You can use the docker images to deploy a *Session* or *Job cluster* in a containerized environment, e.g., -[standalone Kubernetes]({% link ops/deployment/kubernetes.md %}) or [native Kubernetes]({% link ops/deployment/native_kubernetes.md %}). +[standalone Kubernetes]({% link ops/resource-providers/kubernetes.md %}) or [native Kubernetes]({% link ops/resource-providers/native_kubernetes.md %}). * This will be replaced by the TOC {:toc} @@ -67,18 +67,18 @@ You can run its entry point in the following modes: This allows you to deploy a standalone cluster (Session or Job) in any containerised environment, for example: * manually in a local Docker setup, -* [in a Kubernetes cluster]({% link ops/deployment/kubernetes.md %}), +* [in a Kubernetes cluster]({% link ops/resource-providers/kubernetes.md %}), * [with Docker Compose](#flink-with-docker-compose), * [with Docker swarm](#flink-with-docker-swarm). -<span class="label label-info">Note</span> [The native Kubernetes]({% link ops/deployment/native_kubernetes.md %}) also runs the same image by default +<span class="label label-info">Note</span> [The native Kubernetes]({% link ops/resource-providers/native_kubernetes.md %}) also runs the same image by default and deploys *TaskManagers* on demand so that you do not have to do it manually. The next chapters describe how to start a single Flink Docker container for various purposes. Once you've started Flink on Docker, you can access the Flink Webfrontend on [localhost:8081](http://localhost:8081/#/overview) or submit jobs like this `./bin/flink run ./examples/streaming/TopSpeedWindowing.jar`. -We recommend using [Docker Compose]({% link ops/deployment/docker.md %}#session-cluster-with-docker-compose) or [Docker Swarm]({% link ops/deployment/docker.md %}#session-cluster-with-docker-swarm) for deploying Flink as a Session Cluster to ease system configuration. +We recommend using [Docker Compose]({% link ops/resource-providers/docker.md %}#session-cluster-with-docker-compose) or [Docker Swarm]({% link ops/resource-providers/docker.md %}#session-cluster-with-docker-swarm) for deploying Flink as a Session Cluster to ease system configuration. ### Start a Session Cluster diff --git a/docs/ops/resource-providers/docker.zh.md b/docs/ops/resource-providers/docker.zh.md index 2a7ae45..4da1d4a 100644 --- a/docs/ops/resource-providers/docker.zh.md +++ b/docs/ops/resource-providers/docker.zh.md @@ -26,7 +26,7 @@ under the License. [Docker](https://www.docker.com) is a popular container runtime. There are Docker images for Apache Flink available [on Docker Hub](https://hub.docker.com/_/flink). You can use the docker images to deploy a *Session* or *Job cluster* in a containerized environment, e.g., -[standalone Kubernetes]({% link ops/deployment/kubernetes.zh.md %}) or [native Kubernetes]({% link ops/deployment/native_kubernetes.zh.md %}). +[standalone Kubernetes]({% link ops/resource-providers/kubernetes.zh.md %}) or [native Kubernetes]({% link ops/resource-providers/native_kubernetes.zh.md %}). * This will be replaced by the TOC {:toc} @@ -67,18 +67,18 @@ You can run its entry point in the following modes: This allows you to deploy a standalone cluster (Session or Job) in any containerised environment, for example: * manually in a local Docker setup, -* [in a Kubernetes cluster]({% link ops/deployment/kubernetes.zh.md %}), +* [in a Kubernetes cluster]({% link ops/resource-providers/kubernetes.zh.md %}), * [with Docker Compose](#flink-with-docker-compose), * [with Docker swarm](#flink-with-docker-swarm). -<span class="label label-info">Note</span> [The native Kubernetes]({% link ops/deployment/native_kubernetes.zh.md %}) also runs the same image by default +<span class="label label-info">Note</span> [The native Kubernetes]({% link ops/resource-providers/native_kubernetes.zh.md %}) also runs the same image by default and deploys *TaskManagers* on demand so that you do not have to do it manually. The next chapters describe how to start a single Flink Docker container for various purposes. Once you've started Flink on Docker, you can access the Flink Webfrontend on [localhost:8081](http://localhost:8081/#/overview) or submit jobs like this `./bin/flink run ./examples/streaming/TopSpeedWindowing.jar`. -We recommend using [Docker Compose]({% link ops/deployment/docker.zh.md %}#session-cluster-with-docker-compose) or [Docker Swarm]({% link ops/deployment/docker.zh.md %}#session-cluster-with-docker-swarm) for deploying Flink as a Session Cluster to ease system configuration. +We recommend using [Docker Compose]({% link ops/resource-providers/docker.zh.md %}#session-cluster-with-docker-compose) or [Docker Swarm]({% link ops/resource-providers/docker.zh.md %}#session-cluster-with-docker-swarm) for deploying Flink as a Session Cluster to ease system configuration. ### Start a Session Cluster diff --git a/docs/ops/resource-providers/kubernetes.md b/docs/ops/resource-providers/kubernetes.md index b7d617f..a9fae85 100644 --- a/docs/ops/resource-providers/kubernetes.md +++ b/docs/ops/resource-providers/kubernetes.md @@ -28,8 +28,8 @@ This page describes how to deploy a *Flink Job* and *Session cluster* on [Kubern * This will be replaced by the TOC {:toc} -{% info %} This page describes deploying a [standalone]({% link ops/deployment/cluster_setup.md %}) Flink cluster on top of Kubernetes. -You can find more information on native Kubernetes deployments [here]({% link ops/deployment/native_kubernetes.md %}). +{% info %} This page describes deploying a [standalone]({% link ops/resource-providers/cluster_setup.md %}) Flink cluster on top of Kubernetes. +You can find more information on native Kubernetes deployments [here]({% link ops/resource-providers/native_kubernetes.md %}). ## Setup Kubernetes @@ -43,9 +43,9 @@ If you want to run Kubernetes locally, we recommend using [MiniKube](https://kub ## Flink Docker image -Before deploying the Flink Kubernetes components, please read [the Flink Docker image documentation]({% link ops/deployment/docker.md %}), -[its tags]({% link ops/deployment/docker.md %}#image-tags), [how to customize the Flink Docker image]({% link ops/deployment/docker.md %}#customize-flink-image) and -[enable plugins]({% link ops/deployment/docker.md %}#using-plugins) to use the image in the Kubernetes definition files. +Before deploying the Flink Kubernetes components, please read [the Flink Docker image documentation]({% link ops/resource-providers/docker.md %}), +[its tags]({% link ops/resource-providers/docker.md %}#image-tags), [how to customize the Flink Docker image]({% link ops/resource-providers/docker.md %}#customize-flink-image) and +[enable plugins]({% link ops/resource-providers/docker.md %}#using-plugins) to use the image in the Kubernetes definition files. ## Deploy Flink cluster on Kubernetes @@ -138,13 +138,13 @@ A basic *Flink Job cluster* deployment in Kubernetes has three components: Check [the Job cluster specific resource definitions](#job-cluster-resource-definitions) and adjust them accordingly. The `args` attribute in the `jobmanager-job.yaml` has to specify the main class of the user job. -See also [how to specify the JobManager arguments]({% link ops/deployment/docker.md %}#jobmanager-additional-command-line-arguments) to understand +See also [how to specify the JobManager arguments]({% link ops/resource-providers/docker.md %}#jobmanager-additional-command-line-arguments) to understand how to pass other `args` to the Flink image in the `jobmanager-job.yaml`. The *job artifacts* should be available from the `job-artifacts-volume` in [the resource definition examples](#job-cluster-resource-definitions). The definition examples mount the volume as a local directory of the host assuming that you create the components in a minikube cluster. If you do not use a minikube cluster, you can use any other type of volume, available in your Kubernetes cluster, to supply the *job artifacts*. -Alternatively, you can build [a custom image]({% link ops/deployment/docker.md %}#start-a-job-cluster) which already contains the artifacts instead. +Alternatively, you can build [a custom image]({% link ops/resource-providers/docker.md %}#start-a-job-cluster) which already contains the artifacts instead. After creating [the common cluster components](#deploy-flink-cluster-on-kubernetes), use [the Job cluster specific resource definitions](#job-cluster-resource-definitions) to launch the cluster with the `kubectl` command: diff --git a/docs/ops/resource-providers/kubernetes.zh.md b/docs/ops/resource-providers/kubernetes.zh.md index 384c0d4..2b4c2b4 100644 --- a/docs/ops/resource-providers/kubernetes.zh.md +++ b/docs/ops/resource-providers/kubernetes.zh.md @@ -28,8 +28,8 @@ This page describes how to deploy a *Flink Job* and *Session cluster* on [Kubern * This will be replaced by the TOC {:toc} -{% info %} This page describes deploying a [standalone]({% link ops/deployment/cluster_setup.zh.md %}) Flink cluster on top of Kubernetes. -You can find more information on native Kubernetes deployments [here]({% link ops/deployment/native_kubernetes.zh.md %}). +{% info %} This page describes deploying a [standalone]({% link ops/resource-providers/cluster_setup.zh.md %}) Flink cluster on top of Kubernetes. +You can find more information on native Kubernetes deployments [here]({% link ops/resource-providers/native_kubernetes.zh.md %}). ## Setup Kubernetes @@ -43,9 +43,9 @@ If you want to run Kubernetes locally, we recommend using [MiniKube](https://kub ## Flink Docker image -Before deploying the Flink Kubernetes components, please read [the Flink Docker image documentation]({% link ops/deployment/docker.zh.md %}), -[its tags]({% link ops/deployment/docker.zh.md %}#image-tags), [how to customize the Flink Docker image]({% link ops/deployment/docker.zh.md %}#customize-flink-image) and -[enable plugins]({% link ops/deployment/docker.zh.md %}#using-plugins) to use the image in the Kubernetes definition files. +Before deploying the Flink Kubernetes components, please read [the Flink Docker image documentation]({% link ops/resource-providers/docker.zh.md %}), +[its tags]({% link ops/resource-providers/docker.zh.md %}#image-tags), [how to customize the Flink Docker image]({% link ops/resource-providers/docker.zh.md %}#customize-flink-image) and +[enable plugins]({% link ops/resource-providers/docker.zh.md %}#using-plugins) to use the image in the Kubernetes definition files. ## Deploy Flink cluster on Kubernetes @@ -138,13 +138,13 @@ A basic *Flink Job cluster* deployment in Kubernetes has three components: Check [the Job cluster specific resource definitions](#job-cluster-resource-definitions) and adjust them accordingly. The `args` attribute in the `jobmanager-job.yaml` has to specify the main class of the user job. -See also [how to specify the JobManager arguments]({% link ops/deployment/docker.zh.md %}#jobmanager-additional-command-line-arguments) to understand +See also [how to specify the JobManager arguments]({% link ops/resource-providers/docker.zh.md %}#jobmanager-additional-command-line-arguments) to understand how to pass other `args` to the Flink image in the `jobmanager-job.yaml`. The *job artifacts* should be available from the `job-artifacts-volume` in [the resource definition examples](#job-cluster-resource-definitions). The definition examples mount the volume as a local directory of the host assuming that you create the components in a minikube cluster. If you do not use a minikube cluster, you can use any other type of volume, available in your Kubernetes cluster, to supply the *job artifacts*. -Alternatively, you can build [a custom image]({% link ops/deployment/docker.zh.md %}#start-a-job-cluster) which already contains the artifacts instead. +Alternatively, you can build [a custom image]({% link ops/resource-providers/docker.zh.md %}#start-a-job-cluster) which already contains the artifacts instead. After creating [the common cluster components](#deploy-flink-cluster-on-kubernetes), use [the Job cluster specific resource definitions](#job-cluster-resource-definitions) to launch the cluster with the `kubectl` command: diff --git a/docs/ops/resource-providers/yarn_setup.md b/docs/ops/resource-providers/yarn_setup.md index 2f5f535..1df984f 100644 --- a/docs/ops/resource-providers/yarn_setup.md +++ b/docs/ops/resource-providers/yarn_setup.md @@ -252,7 +252,7 @@ The user-jars position in the class path can be controlled by setting the parame ## Run an application in Application Mode -To launch an application in [Application Mode]({% link ops/deployment/index.md %}#deployment-modes), you can type: +To launch an application in [Application Mode]({% link ops/resource-providers/index.md %}#deployment-modes), you can type: {% highlight bash %} ./bin/flink run-application -t yarn-application ./examples/batch/WordCount.jar diff --git a/docs/ops/resource-providers/yarn_setup.zh.md b/docs/ops/resource-providers/yarn_setup.zh.md index 06c50a0..5b00f1f 100644 --- a/docs/ops/resource-providers/yarn_setup.zh.md +++ b/docs/ops/resource-providers/yarn_setup.zh.md @@ -252,7 +252,7 @@ The user-jars position in the class path can be controlled by setting the parame ## Run an application in Application Mode -To launch an application in [Application Mode]({% link ops/deployment/index.zh.md %}#deployment-modes), you can type: +To launch an application in [Application Mode]({% link ops/resource-providers/index.zh.md %}#deployment-modes), you can type: {% highlight bash %} ./bin/flink run-application -t yarn-application ./examples/batch/WordCount.jar diff --git a/docs/ops/scala_shell.md b/docs/ops/scala_shell.md index cb6c409..8de455a 100644 --- a/docs/ops/scala_shell.md +++ b/docs/ops/scala_shell.md @@ -1,7 +1,7 @@ --- title: "Scala REPL" nav-parent_id: ops -nav-pos: 9 +nav-pos: 14 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/scala_shell.zh.md b/docs/ops/scala_shell.zh.md index cb6c409..8de455a 100644 --- a/docs/ops/scala_shell.zh.md +++ b/docs/ops/scala_shell.zh.md @@ -1,7 +1,7 @@ --- title: "Scala REPL" nav-parent_id: ops -nav-pos: 9 +nav-pos: 14 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/security-kerberos.md b/docs/ops/security-kerberos.md index cb46390..98b034b 100644 --- a/docs/ops/security-kerberos.md +++ b/docs/ops/security-kerberos.md @@ -1,7 +1,7 @@ --- title: "Kerberos Authentication Setup and Configuration" nav-parent_id: ops -nav-pos: 10 +nav-pos: 8 nav-title: Kerberos --- <!-- diff --git a/docs/ops/security-kerberos.zh.md b/docs/ops/security-kerberos.zh.md index 40b1503..3d09b05 100644 --- a/docs/ops/security-kerberos.zh.md +++ b/docs/ops/security-kerberos.zh.md @@ -1,7 +1,7 @@ --- title: "Kerberos Authentication Setup and Configuration" nav-parent_id: ops -nav-pos: 10 +nav-pos: 8 nav-title: Kerberos --- <!-- diff --git a/docs/ops/security-ssl.md b/docs/ops/security-ssl.md index 9a1dd4a..b5ed299 100644 --- a/docs/ops/security-ssl.md +++ b/docs/ops/security-ssl.md @@ -1,7 +1,7 @@ --- title: "SSL Setup" nav-parent_id: ops -nav-pos: 11 +nav-pos: 7 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/security-ssl.zh.md b/docs/ops/security-ssl.zh.md index fe5ed06..386c0a6 100644 --- a/docs/ops/security-ssl.zh.md +++ b/docs/ops/security-ssl.zh.md @@ -1,7 +1,7 @@ --- title: "SSL 设置" nav-parent_id: ops -nav-pos: 11 +nav-pos: 7 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/state/index.md b/docs/ops/state/index.md index 8725f87..c1a58ee 100644 --- a/docs/ops/state/index.md +++ b/docs/ops/state/index.md @@ -2,7 +2,7 @@ nav-title: 'State & Fault Tolerance' nav-id: ops_state nav-parent_id: ops -nav-pos: 3 +nav-pos: 2 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/state/index.zh.md b/docs/ops/state/index.zh.md index 27aab11..71f04a4 100644 --- a/docs/ops/state/index.zh.md +++ b/docs/ops/state/index.zh.md @@ -2,7 +2,7 @@ nav-title: '状态与容错' nav-id: ops_state nav-parent_id: ops -nav-pos: 3 +nav-pos: 2 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/upgrading.md b/docs/ops/upgrading.md index 513c5e9..90cd653 100644 --- a/docs/ops/upgrading.md +++ b/docs/ops/upgrading.md @@ -1,7 +1,7 @@ --- title: "Upgrading Applications and Flink Versions" nav-parent_id: ops -nav-pos: 13 +nav-pos: 11 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/upgrading.zh.md b/docs/ops/upgrading.zh.md index b683eea..45cc568 100644 --- a/docs/ops/upgrading.zh.md +++ b/docs/ops/upgrading.zh.md @@ -1,7 +1,7 @@ --- title: "升级应用程序和 Flink 版本" nav-parent_id: ops -nav-pos: 13 +nav-pos: 11 --- <!-- Licensed to the Apache Software Foundation (ASF) under one
