Skip to content

Commit

Permalink
Merge pull request #112 from sophongo/netw
Browse files Browse the repository at this point in the history
update en/kpanda/network pages
  • Loading branch information
windsonsea authored Nov 27, 2024
2 parents 4728ab0 + 3101aa4 commit e45ae81
Show file tree
Hide file tree
Showing 104 changed files with 361 additions and 292 deletions.
60 changes: 30 additions & 30 deletions docs/admin/kpanda/network/create-services.md

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/admin/kpanda/workloads/pod-config/lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ __Unknown__ <br />(未知) | 因为某些原因无法取得 Pod 的状态,

| 参数 | 说明 | 举例值 |
| :-------- | :----------------------------------------------------------- | :------------------------------------------------ |
| 启动命令 | 【类型】选填<br />【含义】容器将按照启动命令进行启动。 | |
| 启动后命令 | 【类型】选填<br />【含义】容器启动后出发的命令<br /> | |
| 停止前命令 | 【类型】选填<br />【含义】容器在收到停止命令后执行的命令。确保升级或实例删除时可提前将实例中运行的业务排水。 | -- |
| 启动命令 |【类型】选填<br />【含义】容器将按照启动命令进行启动。 | |
| 启动后命令 |【类型】选填<br />【含义】容器启动后出发的命令<br /> | |
| 停止前命令 |【类型】选填<br />【含义】容器在收到停止命令后执行的命令。确保升级或实例删除时可提前将实例中运行的业务排水。 | -- |

### 启动命令

根据下表对启动命令进行配置。

| 参数 | 说明 | 举例值 |
| :------- | :----------------------------------------------------------- | :---------- |
| 运行命令 | 【类型】必填<br />【含义】输入可执行的命令,多个命令之间用空格进行分割,如命令本身带空格,则需要加(“”)。<br />【含义】多命令时,运行命令建议用/bin/sh或其他的shell,其他全部命令作为参数来传入。 | /run/server |
| 运行参数 | 【类型】选填<br />【含义】输入控制容器运行命令参数。<br /> | port=8080 |
| 运行命令 |【类型】必填<br />【含义】输入可执行的命令,多个命令之间用空格进行分割,如命令本身带空格,则需要加(“”)。<br />【含义】多命令时,运行命令建议用/bin/sh或其他的shell,其他全部命令作为参数来传入。 | /run/server |
| 运行参数 |【类型】选填<br />【含义】输入控制容器运行命令参数。<br /> | port=8080 |

### 启动后命令

Expand All @@ -39,8 +39,8 @@ __Unknown__ <br />(未知) | 因为某些原因无法取得 Pod 的状态,

| 参数 | 说明 | 举例值 |
| :------- | :----------------------------------------------------------- | :---------- |
| 运行命令 | 【类型】选填<br />【含义】输入可执行的命令,多个命令之间用空格进行分割,如命令本身带空格,则需要加(“”)。<br />【含义】多命令时,运行命令建议用/bin/sh或其他的shell,其他全部命令作为参数来传入。 | /run/server |
| 运行参数 | 【类型】选填<br />【含义】输入控制容器运行命令参数。<br /> | port=8080 |
| 运行命令 |【类型】选填<br />【含义】输入可执行的命令,多个命令之间用空格进行分割,如命令本身带空格,则需要加(“”)。<br />【含义】多命令时,运行命令建议用/bin/sh或其他的shell,其他全部命令作为参数来传入。 | /run/server |
| 运行参数 |【类型】选填<br />【含义】输入控制容器运行命令参数。<br /> | port=8080 |

### 停止前命令

Expand All @@ -50,6 +50,6 @@ __Unknown__ <br />(未知) | 因为某些原因无法取得 Pod 的状态,

| 参数 | 说明 | 举例值 |
| :------- | :----------------------------------------------------------- | :---------- |
| URL 路径 | 【类型】选填<br />【含义】请求的URL路径。<br />【含义】多命令时,运行命令建议用/bin/sh或其他的shell,其他全部命令作为参数来传入。 | /run/server |
| 端口 | 【类型】必填<br />【含义】请求的端口。<br /> | port=8080 |
| 节点地址 | 【类型】选填<br />【含义】请求的 IP 地址,默认是容器所在的节点 IP。<br /> | -- |
| URL 路径 |【类型】选填<br />【含义】请求的URL路径。<br />【含义】多命令时,运行命令建议用/bin/sh或其他的shell,其他全部命令作为参数来传入。 | /run/server |
| 端口 |【类型】必填<br />【含义】请求的端口。<br /> | port=8080 |
| 节点地址 |【类型】选填<br />【含义】请求的 IP 地址,默认是容器所在的节点 IP。<br /> | -- |
2 changes: 1 addition & 1 deletion docs/en/admin/baize/best-practice/deploy-nfs-in-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This article mainly introduces how to quickly deploy an NFS service and add it a

* NFS by default uses the node's storage as a data caching point,
so it is necessary to ensure that the disk itself has enough disk space.
* The installation method uses `Helm` and `Kubectl`, please make sure they are already installed.
* The installation method uses `Helm` and `Kubectl`, make sure they are already installed.

## Deployment Steps

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/baize/troubleshoot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ solutions for certain errors encountered during use.
!!! warning

This documentation is only applicable to version AI platform. If you encounter issues with
the use of AI Lab, please refer to this troubleshooting guide first.
the use of AI Lab, refer to this troubleshooting guide first.

In AI platform, the module name for AI Lab is `baize`,
which offers one-stop solutions for model training, inference, model management, and more.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/access-control/iam.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ IAM (Identity and Access Management) is an important module of global management

- Appropriate role

Access control pre-defines an administrator role for each sub-module, without user maintenance, you can directly authorize the predefined system roles of the platform to users to realize the modular management of the platform. For fine-grained permissions, please refer to [Permission Management](role.md).
Access control pre-defines an administrator role for each sub-module, without user maintenance, you can directly authorize the predefined system roles of the platform to users to realize the modular management of the platform. For fine-grained permissions, refer to [Permission Management](role.md).

- Enterprise-grade access control

Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin/ghippo/access-control/idprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Global management supports single sign-on based on LDPA and OIDC protocols. If y

- LDAP

LDAP refers to Lightweight Directory Access Protocol (Lightweight Directory Access Protocol), which is often used for single sign-on, that is, users can log in with one account password in multiple services. Global management supports LDAP for identity authentication, so the enterprise IdP that establishes identity authentication with AI platform through the LDAP protocol must support the LDAP protocol. For a detailed description of LDAP, please refer to: [Welcome to LDAP](ldap.md).
LDAP refers to Lightweight Directory Access Protocol (Lightweight Directory Access Protocol), which is often used for single sign-on, that is, users can log in with one account password in multiple services. Global management supports LDAP for identity authentication, so the enterprise IdP that establishes identity authentication with AI platform through the LDAP protocol must support the LDAP protocol. For a detailed description of LDAP, refer to: [Welcome to LDAP](ldap.md).

- OIDC

OIDC, short for OpenID Connect, is an identity authentication standard protocol based on the OAuth 2.0 protocol. Global management supports the OIDC protocol for identity authentication, so the enterprise IdP that establishes identity authentication with AI platform through the OIDC protocol must support the OIDC protocol. For a detailed description of OIDC, please refer to: [Welcome to OpenID Connect](https://openid.net/connect/).
OIDC, short for OpenID Connect, is an identity authentication standard protocol based on the OAuth 2.0 protocol. Global management supports the OIDC protocol for identity authentication, so the enterprise IdP that establishes identity authentication with AI platform through the OIDC protocol must support the OIDC protocol. For a detailed description of OIDC, refer to: [Welcome to OpenID Connect](https://openid.net/connect/).

- OAuth 2.0

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/access-control/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Premise: User mailboxes need to be set. There are two ways to set user mailboxes

![User center](https://docs.daocloud.io/daocloud-docs-images/docs/en/docs/ghippo/images/mailbox.png)

If the user forgets the password when logging in, please refer to [Reset Password](../password.md).
If the user forgets the password when logging in, refer to [Reset Password](../password.md).

## Delete users

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/audit/audit-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ You can manually clean up the logs, but it is recommended to export and save the

The audit logs related to Kubernetes in the auditing module are provided by the Insight module.
To reduce the storage pressure of the audit logs, Global Management by default does not collect Kubernetes-related logs.
If you need to record them, please refer to [Enabling K8s Audit Logs](./open-k8s-audit.md).
If you need to record them, refer to [Enabling K8s Audit Logs](./open-k8s-audit.md).
Once enabled, the cleanup function is consistent with the Global Management cleanup function,
but they do not affect each other.
6 changes: 3 additions & 3 deletions docs/en/admin/ghippo/audit/open-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If they exist, it means that Kubernetes audit logs are successfully enabled.
ls /var/log/kubernetes/audit
```

If they are not enabled, please refer to the [documentation on enabling/disabling Kubernetes audit logs](open-k8s-audit.md).
If they are not enabled, refer to the [documentation on enabling/disabling Kubernetes audit logs](open-k8s-audit.md).

#### Enable Collection of Kubernetes Audit Logs Process

Expand Down Expand Up @@ -95,7 +95,7 @@ If they exist, it means that Kubernetes audit logs are successfully enabled.
ls /var/log/kubernetes/audit
```
If they are not enabled, please refer to the [documentation on enabling/disabling Kubernetes audit logs](open-k8s-audit.md).
If they are not enabled, refer to the [documentation on enabling/disabling Kubernetes audit logs](open-k8s-audit.md).
#### Enable Collection of Kubernetes Audit Logs Process
Expand Down Expand Up @@ -172,7 +172,7 @@ If they exist, it means that K8s audit logs are successfully enabled.
ls /var/log/kubernetes/audit
```

If they are not enabled, please refer to the [documentation on enabling/disabling K8s audit logs](open-k8s-audit.md).
If they are not enabled, refer to the [documentation on enabling/disabling K8s audit logs](open-k8s-audit.md).

#### Enable Collection of K8s Audit Logs

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/best-practice/oem/custom-idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ as the Identity Provider for AI platform.

If there is a high customization requirement for the Ghippo login IdP, such as
supporting WeCom, WeChat, or other social organization login requirements,
please refer to this document for implementation.
refer to this document for implementation.

## Supported Versions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/*
Here, we inherit some of the functionalities from OIDC,
it can be written like this.
Keycloak does not have inheritance capabilities, please refer to how the OIDCIdentityProvider code is written.
Keycloak does not have inheritance capabilities, refer to how the OIDCIdentityProvider code is written.
public class OAuthIdentityProvider extends OIDCIdentityProvider {
}
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/best-practice/oem/oem-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ and clicking it will allow users to enter the customer system.
appearance customization in actual applications needs to be handled according to the actual situation.
Log in to the customer system, and through __Global Management__ -> __Settings__ -> __Appearance__,
you can customize platform background colors, logos, and names. For specific operations, please refer to
you can customize platform background colors, logos, and names. For specific operations, refer to
[Appearance Customization](../../platform-setting/appearance.md).
## Integrate Permission System (Optional)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/best-practice/super-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The specific operational steps are as follows:

1. Enable Isolation Mode between Folder/WS

Please refer to [Enable Isolation Mode between Folder/WS](../install/user-isolation.md).
Refer to [Enable Isolation Mode between Folder/WS](../install/user-isolation.md).

2. Plan Enterprise Architecture according to the Actual Situation

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/best-practice/ws-to-ns.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Follow the steps below to prepare a namespace that is not yet bound to any works

!!! info

Workspaces are primarily used to divide groups of resources and grant users (groups of users) different access rights to that resource. For a detailed description of the workspace, please refer to [Workspace and Folder](../workspace/workspace.md).
Workspaces are primarily used to divide groups of resources and grant users (groups of users) different access rights to that resource. For a detailed description of the workspace, refer to [Workspace and Folder](../workspace/workspace.md).


1. Click __OK__ to complete the creation of the namespace. On the right side of the namespace list, click ____ , and you can select __Bind Workspace__ from the pop-up menu.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/install/gm-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ In the end, we will get the following files:

The Guomi gateway used in this article supports SM2 and RSA TLS certificates. The advantage of dual certificates is that when the browser does not support SM2 TLS certificates, it automatically switches to RSA TLS certificates.

For more detailed configurations, please refer to the [Tongsuo official documentation](https://www.yuque.com/tsdoc/ts).
For more detailed configurations, refer to the [Tongsuo official documentation](https://www.yuque.com/tsdoc/ts).

We enter the Tengine container:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/install/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ class judge plain
class success,fail k8s
```

The user login screen is as shown in the figure below. For the specific login screen, please refer to the actual product.
The user login screen is as shown in the figure below. For the specific login screen, refer to the actual product.
4 changes: 2 additions & 2 deletions docs/en/admin/ghippo/permissions/kpanda.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The container management module uses the following roles:

!!! note

- For more information about permissions, please refer to the [Container Management Permission System Description](../../kpanda/permissions/permission-brief.md).
- For creating, managing, and deleting roles, please refer to [Role and Permission Management](../access-control/role.md).
- For more information about permissions, refer to the [Container Management Permission System Description](../../kpanda/permissions/permission-brief.md).
- For creating, managing, and deleting roles, refer to [Role and Permission Management](../access-control/role.md).
- The permissions of __Cluster Admin__ , __NS Admin__ , __NS Editor__ , __NS Viewer__ only take effect within the current cluster or namespace.

The permissions granted to each role are as follows:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin/ghippo/workspace/ws-permission.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Generally applicable to the following two use cases:
| - | Using Shared Resources [^1] | &check; | &cross; | &cross; |

[^1]:
For the operation scope of the roles of Workspace Admin, Workspace Editor, and Workspace Viewer in each module, please refer to the permission description:
For the operation scope of the roles of Workspace Admin, Workspace Editor, and Workspace Viewer in each module, refer to the permission description:

- [Container Management Permissions](../../kpanda/permissions/permission-brief.md)
8 changes: 4 additions & 4 deletions docs/en/admin/insight/alert-center/message.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ On the __Notification Settings__ page, you can configure how to send messages to

1. In the left navigation bar, click __Alert Center__ -> __Notification Settings__ -> __WeCom__ . Click __Add Group Robot__ and add one or more group robots.

For the URL of the WeCom group robot, please refer to the [official document of WeCom: How to use group robots](https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Overview.html).
For the URL of the WeCom group robot, refer to the [official document of WeCom: How to use group robots](https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Overview.html).

2. After the configuration is complete, the notification list will automatically return. Click ____ on the right side
of the list, select __Send Test Information__ , and you can also edit or delete the group robot.
Expand All @@ -28,7 +28,7 @@ On the __Notification Settings__ page, you can configure how to send messages to
1. In the left navigation bar, click __Alert Center__ -> __Notification Settings__ -> __DingTalk__ .
Click __Add Group Robot__ and add one or more group robots.

For the URL of the DingTalk group robot, please refer to the [official document of DingTalk: Custom Robot Access](https://developers.dingtalk.com/document/robots/custom-robot-access).
For the URL of the DingTalk group robot, refer to the [official document of DingTalk: Custom Robot Access](https://developers.dingtalk.com/document/robots/custom-robot-access).

2. After the configuration is complete, the notification list will automatically return. Click ____ on the right
side of the list, select __Send Test Information__ , and you can also edit or delete the group robot.
Expand All @@ -53,7 +53,7 @@ On the __Notification Settings__ page, you can configure how to send messages to
1. In the left navigation bar, click __Alert Center__ -> __Notification Settings__ -> __Webhook__ .
Click __New Webhook__ and add one or more Webhooks.

For the Webhook URL and more configuration methods, please refer to the [webhook document](https://github.com/webhooksite/webhook.site).
For the Webhook URL and more configuration methods, refer to the [webhook document](https://github.com/webhooksite/webhook.site).

2. After the configuration is complete, the notification list will automatically return. Click ____ on the right side
of the list, select __Send Test Information__ , and you can also edit or delete the Webhook.
Expand Down Expand Up @@ -81,7 +81,7 @@ On the __Notification Settings__ page, you can configure how to send messages to
2. Enter the name, the object receiving the message, phone number, and notification server in the pop-up window.

The notification server needs to be created in advance under __Notification Settings__ -> __Notification Server__ .
Currently, two cloud servers, Alibaba Cloud and Tencent Cloud, are supported. Please refer to your own
Currently, two cloud servers, Alibaba Cloud and Tencent Cloud, are supported. Refer to your own
cloud server information for the specific configuration parameters.

3. After the SMS group is successfully added, the notification list will automatically return. Click ____ on the
Expand Down
Loading

0 comments on commit e45ae81

Please sign in to comment.