ingress: add edge ingress md

i18n/zh/docusaurus-plugin-content-docs/version-v0.5.0/user-manuals/network/edge-ingress.md

@@ -1,3 +1,115 @@
 ---
-title: Edge Ingress
+title: 边缘Ingress
 ---
+
+本文档介绍如何在云边协同场景下通过边缘Ingress访问边缘节点池提供的服务。
+
+
+通常情况下，通过边缘Ingress访问边缘服务只需要两个步骤：
+
+1.启用节点池上的边缘Ingress功能。
+
+2.同K8S一样创建并部署ingress规则以访问相应的服务。
+
+
+请按以下详细步骤尝试YurtIngress功能：
+
+---
+1.启用节点池上的边缘Ingress功能
+---
+YurtIngress opeator负责将nginx ingress controller部署到需要启用边缘Ingress功能的节点池中。
+假设您的OpenYurt集群中有4个节点池：pool01、pool02、pool03、pool04，如果您想要在pool01和pool03上启用边缘ingress功能，可以按如下方式创建YurtIngress CR：
+
+1). 创建YurtIngress CR yaml文件: (比如: yurtingress-test.yaml)
+
+      apiVersion: apps.openyurt.io/v1alpha1
+      kind: YurtIngress
+      metadata:
+        name: yurtingress-singleton
+      spec:
+          ingress_controller_replicas_per_pool: 1
+          pools:
+            - name: pool01
+            - name: pool03
+
+提示：
+
+a). YurtIngress CR是集群级别的单例实例，CR名称必须为“yurtIngress-singleton”
+
+b). 在spec中，“ingress_controller_replicas_per_pool”表示部署在每个节点池上的ingress控制器副本数，它主要用于HA高可用场景。
+
+c). 在spec中，“pools”表示要在其上开启ingress功能的节点池列表，目前只支持池名，以后可以扩展为支持节点池个性化配置。
+
+2). 部署YurtIngress CR yaml文件：
+
+    kubectl apply -f yurtingress-test.yaml
+    yurtingress.apps.openyurt.io/yurtingress-singleton created
+
+然后您可以查看YurtIngress CR的状态:
+
+    kubectl get ying
+    NAME                    NGINX-INGRESS-VERSION   REPLICAS-PER-POOL   READYNUM   NOTREADYNUM   AGE
+    yurtingress-singleton   0.48.1                  1                   2          0             3m13s
+
+成功部署ingress controller后，每个节点池将暴漏一个NodePort类型的Service服务：
+
+    kubectl get svc -A
+    ingress-nginx   pool01-ingress-nginx-controller   NodePort    192.167.107.123   <none>    80:32255/TCP,443:32275/TCP   53m
+    ingress-nginx   pool03-ingress-nginx-controller   NodePort    192.167.48.114    <none>    80:30531/TCP,443:30916/TCP   53m
+
+提示:
+
+a). “ying”是YurtIngress资源的简称
+
+b). YurtIngress目前仅支持固定版本的nginx ingress controller，我们将在未来对其进行增强，以支持用户可配置nginx ingress controller映像/版本。
+
+c). 当“READYNUM”与您部署的节点池数量一致时，表示ingress功能已在您定义的所有节点池上就绪。
+
+d). 当“NOTREADYNUM”一直不为0时，可以使用“kubectl describe ying yurtingress-singleton”来查看原因及详细信息。此外，您还可以检查相应的部署（xxx-ingress-nginx-controller，xxx代表节点池名），以找出ingress功能还未就绪的原因。
+
+e). 对于成功启用ingress功能的每个NodePool，会为用户暴漏一个NodePort类型的服务用来访问nginx ingress controller。
+
+---
+2.同K8S一样创建并部署ingress规则以访问相应的服务
+---
+
+当上述步骤1完成后，您已经通过Yurtingress成功的将nginx ingress controller部署到相应的节点池中。接下来的用法就和K8S中使用ingress的体验一致了。
+
+假设您的业务应用被部署到了多个节点池中（例如pool01和pool03），并且它们通过一个全局的service（例如myapp service）对外暴漏，当您想要访问pool01提供的服务时，您可以如下操作：
+
+1). 创建ingress规则yaml文件: (比如: ingress-myapp.yaml)
+
+    apiVersion: extensions/v1beta1
+    kind: Ingress
+    metadata:
+      name: ingress-myapp
+      annotations:
+        ingress.kubernetes.io/rewrite-target: /
+    spec:
+      ingressclassName: pool01
+      rules:
+      - http:
+          paths:
+            - path: /myapp
+              backend:
+              serviceName: myapp-service
+              servicePort: xxx
+
+提示:
+
+a). 由哪个节点池提供ingress功能是由ingress class决定的，因此您需要将ingress class定义为您想要访问服务的节点池名称。
+
+b). 不同K8S版本的ingress CR定义可能不同，您需要确保ingress CR的定义与集群K8S版本匹配。
+
+2). 部署ingress规则yaml文件:
+
+      kubectl apply -f ingress-myapp.yaml
+      ingress.extensions/ingress-myapp created
+
+
+成功完成上述所有步骤后，您就可以通过ingress controller NodePort service验证边缘Ingress功能了：
+
+      curl xxx:32255/myapp
+
+      "xxx"       代表节点池pool01中的节点IP地址
+      "32255"     代表对应节点池中ingress controller暴漏的service NodePort

versioned_docs/version-v0.5.0/user-manuals/network/edge-ingress.md

@@ -1,3 +1,121 @@
 ---
 title: Edge Ingress
 ---
+
+This document introduces how to access Edge services through Edge Ingress in Cloud Edge scenarios.
+
+Generally, it only needs 2 steps to use the Edge Ingress feature:
+1. Enable the ingress feature on NodePools which provide your desired services.
+2. Create and apply the ingress rule as K8S to access your desired services.
+
+Follow the details below to try the Edge Ingress feature:
+
+---
+1.Enable the ingress feature on NodePools which provide your desired services
+---
+YurtIngress operator is responsible for deploying the nginx ingress controller to the corresponding NodePools.
+Suppose you have created 4 NodePools in your OpenYurt cluster: pool01, pool02, pool03, pool04, and you want to
+enable edge ingress feature on pool01 and pool03, you can create the YurtIngress CR as below:
+
+1). Create the YurtIngress CR yaml file: (for example: yurtingress-test.yaml)
+
+      apiVersion: apps.openyurt.io/v1alpha1
+      kind: YurtIngress
+      metadata:
+        name: yurtingress-singleton
+      spec:
+          ingress_controller_replicas_per_pool: 1
+          pools:
+            - name: pool01
+            - name: pool03
+
+Notes:
+
+a). YurtIngress CR is a singleton instance from the cluster level, and the CR name must be "yurtingress-singleton".
+
+b). In spec, the "ingress_controller_replicas_per_pool" represents the ingress controller replicas deployed on every pool,
+    It is used for the HA usage scenarios.
+
+c). In spec, the "pools" represents the pools list on which you want to enable ingress feature.
+    Currently it only supports the pool name, but it can be extended to support pool personalized configruations in future.
+
+
+2). Apply the YurtIngress CR yaml file
+
+    kubectl apply -f yurtingress-test.yaml
+    yurtingress.apps.openyurt.io/yurtingress-singleton created
+
+Then you can get the YurtIngress CR to check the status:
+
+    kubectl get ying
+    NAME                    NGINX-INGRESS-VERSION   REPLICAS-PER-POOL   READYNUM   NOTREADYNUM   AGE
+    yurtingress-singleton   0.48.1                  1                   2          0             3m13s
+
+When the ingress controller is enabled successfully, a per-pool NodePort service is created to expose the ingress controller serivce:
+
+    kubectl get svc -A
+    ingress-nginx   pool01-ingress-nginx-controller   NodePort    192.167.107.123   <none>    80:32255/TCP,443:32275/TCP   53m
+    ingress-nginx   pool03-ingress-nginx-controller   NodePort    192.167.48.114    <none>    80:30531/TCP,443:30916/TCP   53m
+
+Notes:
+
+a). "ying" is the shortName of YurtIngress resource.
+
+b). Currently YurtIngress only supports the fixed nginx ingress controller version, we will enhance it in future to support user configurable
+    nginx ingress controller images/versions.
+
+c). When the "READYNUM" equals the pool number you defined in the YurtIngress CR, it represents the ingress feature is ready on all the pool you defined.
+
+d). If the "NOTREADYNUM" is not 0 all the times, you can use "kubectl describe ying yurtingress-singleton" to check the details for the reasons.
+    Also you can check the corresponding deployment (xxx-ingress-nginx-controller, "xxx" represents the pool name) to figure out the reasons why the
+    ingress is not ready yet.
+
+e). For every NodePool which ingress is enable successfully, it exposes a NodePort type service for users to access the nginx ingress controller.
+
+---
+2.Create and apply the ingress rule as K8S to access your desired services
+---
+When the step 1 above is done, you have successfully deployed the nginx ingress controller to the related NodePools, and the following
+ingress user experience is totally consistent with K8S.
+
+Suppose your app workload is deployed to several NodePools(e.g. pool01 and pool03), and it exposes a global service(e.g. myapp service), and you
+want to access the service provided by pool01:
+
+1). Create the ingress rule yaml file: (for example: ingress-myapp.yaml)
+
+    apiVersion: extensions/v1beta1
+    kind: Ingress
+    metadata:
+      name: ingress-myapp
+      annotations:
+        ingress.kubernetes.io/rewrite-target: /
+    spec:
+      ingressclassName: pool01
+      rules:
+      - http:
+          paths:
+            - path: /myapp
+              backend:
+              serviceName: myapp-service
+              servicePort: xxx
+
+Notes:
+
+a). Ingress class decides which NodePool to provide the ingress capability, so you need to define the ingress class to your desired NodePool name.
+
+b). The ingress CR definition may be different for different K8S versions, so you need ensure the CR definition matches with your cluster K8S version.
+
+
+2). Apply the ingress rule yaml file:
+
+      kubectl apply -f ingress-myapp.yaml
+      ingress.extensions/ingress-myapp created
+
+
+
+After all the steps above are done successfully, you can verify the edge ingress feature through the ingress controller NodePort service:
+
+      curl xxx:32255/myapp
+
+      "xxx" 	represents any NodeIP in NodePool pool01
+      "32255" 	represents the NodePort which pool01 nginx ingress controller service exposes