This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new c6d06e5 [Improve] Rename k8s deployment.md (#363)
c6d06e5 is described below
commit c6d06e5ef13c8ad017177b8a0bb4d00f347e1c8f
Author: Cancai Cai <[email protected]>
AuthorDate: Thu May 2 11:28:26 2024 +0800
[Improve] Rename k8s deployment.md (#363)
Co-authored-by: tison <[email protected]>
---
docs/flink-k8s/1-deployment.md | 18 +++++++++---------
.../current/flink-k8s/1-deployment.md | 22 +++++++++++-----------
2 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs/flink-k8s/1-deployment.md b/docs/flink-k8s/1-deployment.md
index 0701713..b8f310f 100644
--- a/docs/flink-k8s/1-deployment.md
+++ b/docs/flink-k8s/1-deployment.md
@@ -14,7 +14,7 @@ At now, one StreamPark only supports one Kubernetes
cluster.You can submit [Fear
## Environments requirement
-Additional operating environment to run StreamPark Flink-K8s is as below:
+Additional operating environment to run StreamPark Flink-Kubernetes is as
below:
* Kubernetes
* Maven（StreamPark runNode）
* Docker（StreamPark runNode）
@@ -39,9 +39,9 @@ kubectl cluster-info
### configuration for coKubernetes RBAC
-User can configure RBAC for K8s Namespace by referring to
Flink-Docs：https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/resource-providers/native_kubernetes/#rbac
+User can configure RBAC for Kubernetes Namespace by referring to
Flink-Docs：https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/resource-providers/native_kubernetes/#rbac
-When Flink Namespace is `flink-dev` and there are no needed to explicitly
specify K8s accounts, user can allocate resource to clusterrolebinding by the
way as below
+When Flink Namespace is `flink-dev` and there are no needed to explicitly
specify Kubernetes accounts, user can allocate resource to clusterrolebinding
by the way as below
```
@@ -80,12 +80,12 @@ parameter descriptions are as below：
* **Flink Base Docker Image**： Base Flink Docker Image Tag can be obtained
from [DockerHub - offical/flink](https://hub.docker.com/_/flink) .And user can
also use private image when Docker Register Account owns `pull` permission of
it.
-* **Rest-Service Exposed Type**：Description of candidate values for native
Flink K8s configuration
[kubernetes.rest-service.exposed.type](https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/config/#kubernetes)
：
+* **Rest-Service Exposed Type**：Description of candidate values for native
Flink Kubernetes configuration
[kubernetes.rest-service.exposed.type](https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/config/#kubernetes)
：
* `ClusterIP`：ip that StreamPark can access；
* `LoadBalancer`：resource of LoadBalancer should be allocated in advance，
Flink Namespace own permission of automatic binding，and StreamPark can access
LoadBalancer`s gateway；
- * `NodePort`：StreamPark can access all K8s nodes；
-* **Kubernetes Pod Template**： It`s Flink custom configuration of
pod-template.The container-name must be flink-main-container. If the k8s pod
needs a secret key to pull the docker image, please fill in the information
about
-the secret key in the pod template file.The example pod-template is as below：
+ * `NodePort`：StreamPark can access all Kubernetes nodes；
+* **Kubernetes Pod Template**: This is Flink's custom configuration of
pod-template. The `container-name` must be `flink-main-container`. If the
Kubernetes pod needs a secret key to pull the Docker image, please fill in the
information about
+the secret key in the pod template file. Below is an example of pod-template:
```
apiVersion: v1
@@ -101,7 +101,7 @@ the secret key in the pod template file.The example
pod-template is as below：
- name: regsecret
```
-* **Dynamic Option**：It`s dynamic parameter of Flink on k8s（part of parameters
can also be defined in pod-template）which should start with -D.Details are
in[Flink on Kubernetes
parameters](https://nightlies.apache.org/flink/flink-docs-release-1.13/zh/docs/deployment/config/#kubernetes)
+* **Dynamic Option**: Dynamic options of Flink on Kubernetes (part of
parameters can also be defined in pod-template). Options should start with
`-D`. Details can be found at [Flink on Kubernetes
parameters](https://nightlies.apache.org/flink/flink-docs-release-1.13/zh/docs/deployment/config/#kubernetes).
After the job is started, it is supported to directly access the corresponding
Flink Web UI page on the Detail page of the task：
@@ -114,7 +114,7 @@ The additional configuration of Flink-Native-Kubernetes
Session Job will be deci
## other configuration
-StreamPark parameter related to Flink-K8s in `applicaton.yml` are as below.And
in most condition, it is no need to change it.
+StreamPark parameters related to Flink-Kubernetes in `applicaton.yml` are as
below. And in most conditions, there is no need to change it.
| Configuration item |
Description
| Default value |
|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|---------------|
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md
index 4d47276..4d3f581 100755
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/flink-k8s/1-deployment.md
@@ -15,7 +15,7 @@ StreamPark Flink Kubernetes 基于 [Flink Native
Kubernetes](https://ci.apache.o
## 额外环境要求
-StreamPark Flink-K8s 需要具备以下额外的运行环境：
+StreamPark Flink-Kubernetes 需要具备以下额外的运行环境：
* Kubernetes
* Maven（StreamPark 运行节点具备）
@@ -30,7 +30,7 @@ StreamPark 实例并不需要强制部署在 Kubernetes 所在节点上，可以
### Kubernetes 连接配置
-StreamPark 直接使用系统 `～/.kube/config ` 作为 Kubernetes 集群的连接凭证，最为简单的方式是直接拷贝
Kubernetes 节点的 `.kube/config` 到 StreamPark 节点用户目录，各云服务商 Kubernetes
服务也都提供了相关配置的快速下载。当然为了权限约束，也可以自行生成对应 k8s 自定义账户的 config。
+StreamPark 直接使用系统 `～/.kube/config ` 作为 Kubernetes 集群的连接凭证，最为简单的方式是直接拷贝
Kubernetes 节点的 `.kube/config` 到 StreamPark 节点用户目录，各云服务商 Kubernetes
服务也都提供了相关配置的快速下载。当然为了权限约束，也可以自行生成对应 Kubernetes 自定义账户的 config。
完成后，可以通过 StreamPark 所在机器的 kubectl 快速检查目标 Kubernetes 集群的连通性：
@@ -40,9 +40,9 @@ kubectl cluster-info
### Kubernetes RBAC 配置
-同样的，需要准备 Flink 所使用 K8s Namespace 的 RBAC 资源，请参考
Flink-Docs：https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/resource-providers/native_kubernetes/#rbac
+同样的，需要准备 Flink 所使用 Kubernetes Namespace 的 RBAC 资源，请参考
Flink-Docs：https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/resource-providers/native_kubernetes/#rbac
-假设使用 Flink Namespace 为 `flink-dev`，不明确指定 K8s 账户，可以如下创建简单 clusterrolebinding 资源：
+假设使用 Flink Namespace 为 `flink-dev`，不明确指定 Kubernetes 账户，可以如下创建简单
clusterrolebinding 资源：
```
kubectl create clusterrolebinding flink-role-binding-default
--clusterrole=edit --serviceaccount=flink-dev:default
@@ -81,10 +81,10 @@ docker pull <your_register_addr>/streampark/busybox
* **Flink Base Docker Image**： 基础 Flink Docker 镜像的 Tag，可以直接从 [DockerHub -
offical/flink](https://hub.docker.com/_/flink) 获取，也支持用户私有的底层镜像，此时在 setting 设置
Docker Register Account 需要具备该私有镜像 `pull` 权限。
* **Rest-Service Exposed Type**：对应 Flink 原生
[kubernetes.rest-service.exposed.type](https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/config/#kubernetes)
配置，各个候选值说明：
- * `ClusterIP`：需要 StreamPark 可直接访问 K8s 内部网络；
- * `LoadBalancer`：需要 K8s 提前创建 LoadBalancer 资源，且 Flink Namespace 具备自动绑定权限，同时
StreamPark 可以访问该 LoadBalancer 网关；
- * `NodePort`：需要 StreamPark 可以直接连通所有 K8s 节点；
-* **Kubernetes Pod Template**： Flink 自定义 pod-template
配置，注意container-name必须为flink-main-container，如果k8s pod拉取docker镜像需要秘钥，请在pod
template文件中补全秘钥相关信息，pod-template模板如下：
+ * `ClusterIP`：需要 StreamPark 可直接访问 Kubernetes 内部网络；
+ * `LoadBalancer`：需要 Kubernetes 提前创建 LoadBalancer 资源，且 Flink Namespace
具备自动绑定权限，同时 StreamPark 可以访问该 LoadBalancer 网关；
+ * `NodePort`：需要 StreamPark 可以直接连通所有 Kubernetes 节点；
+* **Kubernetes Pod Template**： Flink 自定义 pod-template 配置，注意 `container-name`
必须为 `flink-main-container`，如果 Kubernetes pod 拉取 Docker 镜像需要秘钥，请在 pod
模板文件中补全秘钥相关信息，pod 模板如下：
```
apiVersion: v1
kind: Pod
@@ -98,7 +98,7 @@ docker pull <your_register_addr>/streampark/busybox
imagePullSecrets:
- name: regsecret
```
-* **Dynamic Option**： Flink on
k8s动态参数（部分参数也可在pod-template文件中定义），该参数需要以-D开头，详情见[Flink on
Kubernetes相关参数](https://nightlies.apache.org/flink/flink-docs-release-1.13/zh/docs/deployment/config/#kubernetes)
+* **Dynamic Option**： Flink on Kubernetes 动态参数（部分参数也可在 pod-template
文件中定义），该参数需要以 `-D` 开头，详情见 [Flink on
Kubernetes相关参数](https://nightlies.apache.org/flink/flink-docs-release-1.13/zh/docs/deployment/config/#kubernetes)。
任务启动后，支持在该任务的 Detail 页直接访问对应的 Flink Web UI 页面：
@@ -106,13 +106,13 @@ docker pull <your_register_addr>/streampark/busybox
### Session 任务发布
-Flink-Native-Kubernetes Session 任务 K8s 额外的配置（pod-template 等）完全由提前部署的
Flink-Session 集群决定，请直接参考
Flink-Doc：https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/resource-providers/native_kubernetes
+Flink-Native-Kubernetes Session 任务 Kubernetes 额外的配置（pod-template 等）完全由提前部署的
Flink-Session 集群决定，请直接参考
Flink-Doc：https://ci.apache.org/projects/flink/flink-docs-stable/docs/deployment/resource-providers/native_kubernetes
<br></br>
## 相关参数配置
-StreamPark 在 `applicaton.yml` Flink-K8s 相关参数如下，默认情况下不需要额外调整默认值。
+StreamPark 在 `applicaton.yml` Flink-Kubernetes 相关参数如下，默认情况下不需要额外调整默认值。
| 配置项 | 描述
| 默认值 |
|:-----------------------------------------------------------------------|-----------------------------------------------------------|
------- |
