Skip to content

Commit

Permalink
Merge pull request #3205 from zhuxiujuan28/docs
Browse files Browse the repository at this point in the history
【documentation】增加离线安装文档
  • Loading branch information
ks-ci-bot authored Nov 1, 2024
2 parents f7a071b + 6e61832 commit c86a360
Show file tree
Hide file tree
Showing 595 changed files with 25,032 additions and 512 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// :ks_include_id: 9b12ede280884331985685925cf5dfc4
* 容器组列表提供以下信息:
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|名称
|容器组的名称。

|状态
|容器组的状态。

include::pods-para-podStatus_overview.adoc[]
// pod 状态不一样

|节点
|容器组所在的节点和节点的 IP 地址。

include::pods-para-podIpPool.adoc[]

// |应用
// |容器组所属的应用。

|项目
|容器组所属的项目。

|集群
|容器组所属的集群。

|更新时间
|容器组的更新时间。
|===
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// :ks_include_id: 8cc83a9c58b8460cbcf369b1a07288b1

* **运行中**:容器组已分配给某个节点,容器组中的所有容器都已被创建,至少有一个容器正在运行、启动或重启。
* **等待中**:容组器已被系统接受,但有至少一个容器尚未创建也未运行。此状态下,容器组可能正在等待调度,或等待容器镜像下载完成。
* **成功完成**:容器组中的所有容器都成功终止(以 0 退出码终止),并且不再重启。
* **失败**:容器组中的所有容器都已终止,并且至少有一个容器以非 0 退出码终止。
* **未知**:系统无法获取容器组状态。出现这种状态通常是由于系统与容器组所在的主机通信失败。
// 已完成 vs 成功完成:https://github.com/kubesphere/project/issues/3983#issuecomment-2246982909
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: 797c5d8830fe45bfb4452dd98086d8ed
本节介绍如何创建应用路由。
This section describes how to create an Ingress.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// :ks_include_id: 4f3a812c48b342fdb0cec7f38b00ce81
本节介绍如何删除应用路由。
This section describes how to delete an Ingress.

// Warning
include::../../../../_ks_components-en/admonitions/warning.adoc[]

删除应用路由后将无法通过应用路由访问其后端的服务,请谨慎执行此操作。
After deleting an Ingress, you will no longer be able to access its backend services through the Ingress. Please proceed with caution.

include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: 9a1f0d5fdb294c79a6051a90fe1a17be
本节介绍如何编辑应用路由注解。
This section describes how to edit Ingress annotations.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// :ks_include_id: ab9cb5143fe449bb900ce47e7fb62049
本节介绍如何编辑应用路由信息。
This section describes how to edit Ingress information.

您可以编辑应用路由的别名和描述。{ks_product-en}不支持编辑已创建应用路由的名称。
You can edit the alias and description of an Ingress. KubeSphere does not support editing the name of an already created Ingress.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: b4c404ff621146f799e720597d3aac84
本节介绍如何编辑路由规则。
This section describes how to edit routing rules.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// :ks_include_id: c69900173bca4b109a4b8a178ce15e64
本节介绍如何管理应用路由。
This section describes how to manage ingresses.

应用路由用于对服务进行聚合并提供给集群外部访问。每个应用路由包含域名及其子路径到不同服务的映射规则。来自客户端的业务流量先发送给集群网关或项目网关,集群网关或项目网关根据应用路由中定义的规则将业务流量转发给不同的服务,从而实现对多个服务的反向代理。
Ingresses are used to aggregate services and provide external access. Each ingress contains a domain name and its sub-paths mapped to different services. Business traffic from clients is first sent to the cluster gateway or project gateway, which then forwards the traffic to different services based on the rules defined in the ingress, thereby achieving reverse proxy for multiple services.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: 74e87c7e7c4a42b59f6c9013b617a2f7
本节介绍如何查看应用路由列表。
This section describes how to view the Ingress list.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: c74f0c52dbf440a98ed71f677036f155
本节介绍如何查看应用路由详情。
This section describes how to view Ingress details.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// Note
include::../../../../_ks_components-en/admonitions/note.adoc[]

{ks_product-en}的集群网关和项目网关底层基于 Nginx Ingress Controller 实现。您可以在应用路由上设置注解控制网关的行为。有关更多信息,请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/[Nginx Ingress Controller 官方文档]。
The cluster gateway and project gateway in KubeSphere are implemented based on Nginx Ingress Controller. You can set annotations on the Ingress to control the behavior of the gateway. For more information, see link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/[Nginx Ingress Controller Documentation].

include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
// :ks_include_id: 570405898db841389a0ce7ed42a9a8e3
. **基本信息**页签,设置应用路由的基本信息,然后点击**下一步**
. On the **Basic Information** tab, set the basic information for the Ingress, then click **Next**.
+
--

[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|名称
|应用路由的名称。名称只能包含小写字母、数字和连字符(-),必须以小写字母或数字开头和结尾,最长 253 个字符。
|Name
|The name of the Ingress. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 253 characters long.

|别名
|应用路由的别名。不同应用路由的别名可以相同。别名只能包含中文、字母、数字和连字符(-),不得以连字符(-)开头或结尾,最长 63 个字符。
|Alias
|The alias of the Ingress. Different Ingresses can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long.

|描述
|应用路由的描述。描述可包含任意字符,最长 256 个字符。
|Description
|The description of the Ingress. The description can contain any characters and can be up to 256 characters long.
|===
--

. **路由规则**页签,点击**添加路由规则**,设置路由规则参数,然后点击**下一步**
. On the **Routing Rules** tab, click **Add Routing Rule**, set the routing rule parameters, then click **Next**.
+
--
ifdef::multicluster[]
Expand All @@ -28,14 +28,14 @@ endif::[]
include::routes-para-routingRules.adoc[]
--

. **高级设置**页签,为应用路由设置标签和注解,然后点击**创建**
. On the **Advanced Settings** tab, set labels and annotations for the Ingress, then click **Create**.
+
--
* 点击**添加**可设置多条标签或注解。
* Click **Add** to set multiple labels or annotations.

* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。
* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of a created label or annotation to delete it.
include::routes-note-annotations.adoc[]

应用路由创建完成后将显示在应用路由列表中。
--
After the Ingress is created, it will be displayed in the Ingress list.
--
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// :ks_include_id: 1e5380a648764bae9ac650a53316501d
. 在需要删除的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18],然后在下拉列表中选择**删除**
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the ingress you want to delete, then select **Delete** from the dropdown list.

. **删除应用路由**对话框,输入应用路由的名称,然后点击**确定**
. In the **Delete Ingress** dialog, enter the name of the ingress, then click **OK**.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// :ks_include_id: 6ec380c8bcbe4e1589334e0b050b0b6c
. 选择需要删除的应用路由左侧的复选框,然后在应用路由列表上方点击**删除**
. Select the checkbox on the left side of the Ingresses you want to delete, then click **Delete** above the ingress list.

. **批量删除应用路由**对话框,输入应用路由的名称,然后点击**确定**
. In the **Delete Multiple Ingresses** dialog, enter the names of the Ingresses, then click **OK**.
+
--
include::../../note-separateNamesByComma.adoc[]
--
--
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
// :ks_include_id: 2ead4c416e934d44b2a8a404251bdfe8
. 在需要操作的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18],然后在下拉列表中选择**编辑注解**
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the ingress you want to edit, then select **Edit Annotations** from the dropdown list.

. **编辑注解**对话框,设置注解键值对,然后点击**确定**
. In the **Edit Annotations** dialog, set the annotation key-value pairs, then click **OK**.
+
--
* 点击**添加**可设置多条注解。
* Click **Add** to set multiple annotations.

* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。
* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of a created annotation to delete it.
include::routes-note-annotations.adoc[]
--
--
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
// :ks_include_id: 9f1f9315fbc0466396a168bfa897683f
. 在需要操作的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18],然后在下拉列表中选择**编辑信息**
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the Ingress you want to edit, then select **Edit Information** from the dropdown list.

. **编辑信息**对话框,设置应用路由的别名和描述,然后点击**确定**
. In the **Edit Information** dialog, set the alias and description of the ingress, then click **OK**.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|别名
|应用路由的别名。不同应用路由的别名可以相同。别名只能包含中文、字母、数字和连字符(-),不得以连字符(-)开头或结尾,最长 63 个字符。
|Alias
|The alias of the ingress. Different ingresses can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum length of 63 characters.

|描述
|应用路由的描述信息。描述可包含任意字符,最多包含 256 个字符。
|Description
|The description information of the ingress. The description can contain any characters, with a maximum of 256 characters.
|===
--
--
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// :ks_include_id: b0e0fbee5bf54cfda0ac0d8847b90185
. 在需要操作的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18],然后在下拉列表中选择**编辑路由规则**
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the ingress you want to edit, then select **Edit Routing Rules** from the dropdown list.

. **编辑路由规则**对话框,设置路由规则,然后点击**确定**
. In the **Edit Routing Rules** dialog, set the routing rules, then click **OK**.
+
--
include::routes-para-routingRules.adoc[]
--
--
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: 01c521d890b44fab91dfa6803d6a6bb5
. 在应用路由列表中点击一个应用路由的名称打开其详情页面。
. Click the name of an Ingress in the Ingress list to open its details page.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// :ks_include_id: a3a4d6c4c46d4b8dbf054da9c20cd804
* 在列表上方点击搜索框并设置搜索条件,可按名称搜索应用路由。
* Click the search box at the top of the list to search for Ingresses by name.
Original file line number Diff line number Diff line change
@@ -1,70 +1,71 @@
// :ks_include_id: 02ac1cebc06f4893a036c2e77c21d999
. 在应用路由详情页面左侧的**属性**区域查看应用路由的详细信息。
. On the Ingress details page, view the detailed information of the Ingress in the **Attributes** area on the left.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

// |集群
// |应用路由的所属集群。
// |Cluster
// |The cluster to which the Ingress belongs.

|项目
|应用路由的所属项目。
|Project
|The project to which the Ingress belongs.

|应用
|应用路由对应的应用。
|App
|The app corresponding to the Ingress.

// |网关地址
// |Gateway Address
// |
// include::../gatewaySettings/gatewaySettings-para-address.adoc[]

|创建时间
|应用路由的创建时间。
|Creation Time
|The creation time of the Ingress.

|创建者
|创建应用路由的用户。
|Creator
|The user who created the Ingress.
|===
--

. 在应用路由详情页面右侧的**资源状态**页签查看应用路由的路由规则。
. On the Ingress details page, view the routing rules of the Ingress in the **Resource Status** tab on the right.
+
--
**资源状态**页签显示当前应用路由的所有路由规则。
The **Resource Status** tab displays all routing rules of the current Ingress.

[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|域名和端口
|应用路由的域名和节点端口号。节点端口号仅在集群网关或项目网关的外部访问为 NodePort 时显示。
|Domain and Port
|The domain name and node port number of the Ingress. The node port number is only displayed when the external access mode of the cluster gateway or project gateway is NodePort.

* 如果集群网关或项目网关的外部访问模式为 NodePort,客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为集群中任意节点的 IP 地址,并通过域名、路径和端口号(例如 **example.com/test:30240**)访问应用路由。
* If the external access mode of the cluster gateway or project gateway is NodePort, clients need to resolve the domain name to the IP address of any node in the cluster through DNS service or local **hosts** file, and access the Ingress through the domain name, path, and port number (e.g., **example.com/test:30240**).
* 如果集群网关或项目网关的外部访问模式为 LoadBalancer,客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为项目网关负载均衡器的 IP 地址,并通过域名和路径(例如 **example.com/test**)访问应用路由。
* If the external access mode of the cluster gateway or project gateway is LoadBalancer, clients need to resolve the domain name to the IP address of the project gateway load balancer through DNS service or local **hosts** file, and access the Ingress through the domain name and path (e.g., **example.com/test**).
|协议
|应用路由支持的协议,取值为**HTTP** **HTTPS**
|Protocol
|The protocol supported by the Ingress, with values of **HTTP** or **HTTPS**.

|证书
|应用路由协议为 HTTPS 时,所使用的包含证书和私钥的保密字典的名称。仅在应用路由协议为 HTTPS 时显示。
|Certificate
|The name of the secret containing the certificate and private key used when the Ingress protocol is HTTPS. Only displayed when the Ingress protocol is HTTPS.

|路径
|域名的路径,每条路径对应一个服务。
|Path
|The path of the domain name, with each path corresponding to a service.

|服务
|域名路径所对应的服务的名称。
|Service
|The name of the service corresponding to the domain name path.

|端口
|域名路径所对应的服务的端口号。
|Port
|The port number of the service corresponding to the domain name path.
|===

在路由规则右侧点击**访问服务**可访问应用路由的后端服务。
Click **Access Service** on the right side of the routing rule to access the backend service of the Ingress.
--

. 在应用路由详情页面右侧点击**元数据**页签查看应用路由的**标签****注解**
. On the Ingress details page, click the **Metadata** tab on the right to view the **Labels** and **Annotations** of the Ingress.

. 在应用路由详情页面右侧点击**事件**页签查看应用路由的事件。
. On the Ingress details page, click the **Events** tab on the right to view events related to the Ingress.
+
--
include::../clusterManagement-para-eventsTab.adoc[]
--
--
Loading

0 comments on commit c86a360

Please sign in to comment.