Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[en] Add access-guide docs to kant #4112

Merged
merged 1 commit into from
Mar 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions docs/en/docs/kant/user-guide/node/access-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Edge Node Onboarding

According to the node access guide, obtain the installation files and access commands, install the EdgeCore edge core software on the node, so that the edge node can establish a connection with the platform and be included in platform management.

When the edge node is first onboarded, the latest version of the EdgeCore edge core software is automatically installed.

!!! note

The relationship between the access guide and the actual edge node machine is one-to-many. The installation files and access commands from one access guide can be used on multiple actual edge nodes.

## Prerequisites

- The node has been prepared as required and the node environment has been configured, please refer to [Edge Node Access Requirements](./join-rqmt.md) for details
- The edge node access guide has been created, please refer to [Creating an Access Guide](./create-access-guide.md) for details

<!-- Add screenshot later -->

## Steps

1. On the Edge Node List page, click the **Access Guide** button, and a pop-up window with the access guide will appear on the right.

1. Based on the node environment configuration, select the corresponding access guide.

1. Click the **Download File** button, which will redirect you to the download center. In the download list, select the edge installation package corresponding to the version and architecture: `kantadm_{version}_{architecture}.tar.gz`. It is recommended to choose the latest version.

<!-- Add screenshot later -->

1. Copy the edge installation package to the edge node to be accessed and unzip it.

Unzip command:

```shell
tar -zxf kantadm_{version}_{architecture}.tar.gz
```

!!! note

Place the unpacked kantadm binary file in the `/usr/local/bin` directory.

1. Access the node by executing the command using either a token or certificate.

**Token Installation**

1. On the access guide interface, click the __Token Installation__ tab in the third step to display the token installation steps.

!!! note

The token in the installation command is valid for 24 hours. For a long-term valid installation method, please use certificate installation.

1. Access the node by executing the following command.

```shell
kantadm join --cloudcore-host=10.31.226.14 --websocket-port=30000 --node-prefix=edge --token=b2d6bb5d9312c39ffac08ecfd5030bed006b8b67d0799d632d381f19fca9e765.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTQ2NTk3NDV9.0sdaWbYSTURmAYmQwDn_zF7P9TwcRTSMhwPw6l87U7E --cgroup-driver=cgroupfs --remote-runtime-endpoint= --version=v1.12.2 --batch-name=edge --edge-registry=docker.m.daocloud.io/kubeedge --quic-port=30001 --http-port=30002 --stream-port=30003 --tunnel-port=30004 --labels=test=1,test1=1
```

**Certificate Installation**

1. On the access guide interface, click the __Certificate Installation__ tab in the third step to display the certificate installation steps.

1. Click the __Download Certificate__ button to download the certificate to your local machine.

1. Save the certificate and execute the following command.

```shell
mkdir -p /etc/kant && mv ./cert.tar /etc/kant/cert.tar
```

1. Access the node by executing the following command.

```shell
kantadm join --cloudcore-host=10.2.129.13 --websocket-port=30000 --node-prefix=sh --remote-runtime-endpoint=unix:///run/containerd/containerd.sock --cgroup-driver=cgroupfs --version=v1.12.6 --batch-name=guide-test --edge-registry=docker.m.daocloud.io/kubeedge --quic-port=30001 --http-port=30002 --stream-port=30003 --tunnel-port=30004
```

1. Verify if the edge node has been successfully onboarded.

1. Select __Edge Computing__ -> __Cloud-Edge Collaboration__ from the left navigation bar to enter the edge unit list page.

1. Click on the edge unit name to enter the edge unit details page.

1. Select __Edge Resources__ -> __Edge Nodes__ from the left navigation bar to enter the edge node list page.

1. Check the status of the edge node. If the current status is __Healthy__, it means the onboarding was successful.

<!-- Add screenshot later -->
29 changes: 29 additions & 0 deletions docs/en/docs/kant/user-guide/node/create-access-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Create an Integration Guide

Nodes of the same type can be configured with the same edge node configuration. By creating an integration guide, you can obtain the edge node configuration file and installation program. The relationship between the installation guide and the edge nodes follows a one-to-many relationship, which improves management efficiency and saves operational costs.

The following explains the steps to create an integration guide and manage integration guides.

## Steps

1. On the Edge Node List page, click the **Guide Management** button to enter the guide management list page, then click the **Create Integration Guide** button in the top right corner.

<!-- ![Guide Management](../../images/integration-guide-01.png) -->

2. Fill in the registration information.

- Guide Name: The guide name cannot be empty and is limited to 253 characters.
- Node Prefix: The node name consists of "node prefix-random code".
- Driver Mode: The control group (CGroup) driver used for resource management and configuration of Pods and containers, such as CPU and memory resource requests and limits.
- CRI Service Address: The socket file or TCP address for communication between the CRI Client and CRI Server locally, for example, `unix:///run/containerd/containerd.sock`.
- KubeEdge Edge Image Repository: The repository address for storing KubeEdge components (Mosquitto, installation package, pause) images. If the edge and cloud images are in the same repository, you can click the **Reference Cloud Address** button to quickly fill it in.
- Description: Description information for the integration guide.
- Tags: Tags information for the integration guide.

<!-- ![Create Integration Guide](../../images/integration-guide-02.png) -->

3. After completing the information filling, click the **OK** button to complete the creation of the integration guide.

## Next Steps

After creating the guide, you can view the **Integration Guide** and follow the integration process prompts to complete the onboarding operation for the edge nodes. For details, please refer to the [Node Integration Guide](./integration-guide.md).
8 changes: 2 additions & 6 deletions docs/en/docs/kant/user-guide/node/index.md
Original file line number Diff line number Diff line change
@@ -10,13 +10,9 @@ To manage edge nodes, the following steps need to be completed:
1. Prepare and configure the edge nodes. The edge nodes need to meet specific requirements,
which can be found in the [Edge Node Access Requirements](./join-rqmt.md).

2. Create a batch task for registering the edge nodes in the cloud-edge coordination module to
obtain the installation guide. For detailed instructions, refer to
[Batch Registration of Edge Nodes](./batch-registration.md).
2. Create an access guide in the Cloud-Edge Collaboration module to obtain the edge node configuration file and installation program. For details, please refer to [Creating an Access Guide](./create-access-guide.md).

3. Follow the installation guide to obtain the installation tool and configuration files for the edge nodes,
and complete the process of connecting and managing the edge nodes. For more details,
see [Managing Edge Nodes](./managed-node.md).
3. Follow the installation guide to complete the onboarding operation for the edge nodes. For details, please refer to [Edge Node Onboarding](./access-guide.md).

The usage workflow is as follows:

4 changes: 2 additions & 2 deletions docs/en/navigation.yml
Original file line number Diff line number Diff line change
@@ -1052,8 +1052,8 @@ nav:
- Edge Node:
- Overview: kant/user-guide/node/index.md
- Requirements to Join Edge Node: kant/user-guide/node/join-rqmt.md
- Batch Register Edge Nodes: kant/user-guide/node/batch-registration.md
- Connect Edge Nodes: kant/user-guide/node/managed-node.md
- Create Integration Guide: kant/user-guide/node/create-access-guide.md
- Edge Node Onboarding: kant/user-guide/node/access-guide.md
- Manage Edge Nodes: kant/user-guide/node/manage-node.md
- Batch Upgrade Edge Nodes: kant/user-guide/node/batch-upgrade.md
- Edge Node Group:
22 changes: 11 additions & 11 deletions docs/zh/docs/kant/user-guide/node/access-guide.md
Original file line number Diff line number Diff line change
@@ -10,8 +10,8 @@

## 前提条件

- 已经按要求准备好节点,并配置好节点环境,具体请参见[边缘节点接入要求](./join-rqmt.md)
- 已经创建好边缘节点接入指南,具体请参见[创建接入指南](./create-access-guide.md)
- 已经按要求准备好节点,并配置好节点环境,具体请参见[边缘节点接入要求](./join-rqmt.md)
- 已经创建好边缘节点接入指南,具体请参见[创建接入指南](./create-access-guide.md)

![接入指南](../../images/access-guide-03.png)

@@ -21,7 +21,7 @@

1. 根据节点环境配置,选择对应的接入指南。

1. 点击 **下载文件** 按钮,跳转到下载中心,在下载列表中选择对应版本和架构的边端安装包kantadm_{版本}_{架构}.tar.gz。建议选择最新版本。
1. 点击 **下载文件** 按钮,跳转到下载中心,在下载列表中选择对应版本和架构的边端安装包`kantadm_{版本}_{架构}.tar.gz`。建议选择最新版本。

![下载边端安装包](../../images/access-guide-04.png)

@@ -35,7 +35,7 @@

!!! note

将解压后的 kantadm 二进制文件放到 /usr/local/bin 目录下。
将解压后的 kantadm 二进制文件放到 `/usr/local/bin` 目录下。

1. 通过 token 或证书方式,执行命令,接入节点。

@@ -49,9 +49,9 @@

1. 接入节点,执行如下命令。

```shell
kantadm join --cloudcore-host=10.31.226.14 --websocket-port=30000 --node-prefix=edge --token=b2d6bb5d9312c39ffac08ecfd5030bed006b8b67d0799d632d381f19fca9e765.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTQ2NTk3NDV9.0sdaWbYSTURmAYmQwDn_zF7P9TwcRTSMhwPw6l87U7E --cgroup-driver=cgroupfs --remote-runtime-endpoint= --version=v1.12.2 --batch-name=edge --edge-registry=docker.m.daocloud.io/kubeedge --quic-port=30001 --http-port=30002 --stream-port=30003 --tunnel-port=30004 --labels=test=1,test1=1
```
```shell
kantadm join --cloudcore-host=10.31.226.14 --websocket-port=30000 --node-prefix=edge --token=b2d6bb5d9312c39ffac08ecfd5030bed006b8b67d0799d632d381f19fca9e765.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTQ2NTk3NDV9.0sdaWbYSTURmAYmQwDn_zF7P9TwcRTSMhwPw6l87U7E --cgroup-driver=cgroupfs --remote-runtime-endpoint= --version=v1.12.2 --batch-name=edge --edge-registry=docker.m.daocloud.io/kubeedge --quic-port=30001 --http-port=30002 --stream-port=30003 --tunnel-port=30004 --labels=test=1,test1=1
```

**证书安装**

@@ -67,9 +67,9 @@

1. 接入节点,执行如下命令。

```shell
kantadm join --cloudcore-host=10.2.129.13 --websocket-port=30000 --node-prefix=sh --remote-runtime-endpoint=unix:///run/containerd/containerd.sock --cgroup-driver=cgroupfs --version=v1.12.6 --batch-name=guide-test --edge-registry=docker.m.daocloud.io/kubeedge --quic-port=30001 --http-port=30002 --stream-port=30003 --tunnel-port=30004
```
```shell
kantadm join --cloudcore-host=10.2.129.13 --websocket-port=30000 --node-prefix=sh --remote-runtime-endpoint=unix:///run/containerd/containerd.sock --cgroup-driver=cgroupfs --version=v1.12.6 --batch-name=guide-test --edge-registry=docker.m.daocloud.io/kubeedge --quic-port=30001 --http-port=30002 --stream-port=30003 --tunnel-port=30004
```

1. 验证边缘节点是否纳管成功。

@@ -81,4 +81,4 @@

1. 查看边缘节点的状态,当前状态为 __健康__ 表示纳管成功。

![边缘节点纳管成果](../../images/access-guide-05.png)
![边缘节点纳管成果](../../images/access-guide-05.png)
7 changes: 4 additions & 3 deletions docs/zh/docs/kant/user-guide/node/create-access-guide.md
Original file line number Diff line number Diff line change
@@ -17,8 +17,9 @@
- 节点前缀:节点名称由“节点前缀-随机码”组成。
- 驱动方式:控制组(CGroup)的驱动,用于对 Pod 和容器进行资源管理和资源配置,如CPU和内存资源的请求和限制。
- CRI 服务地址:CRI Client 和 CRI Server 在本地进行通信的 socket 文件或者 TCP 地址,
例如 __unix:///run/containerd/containerd.sock__
- KubeEdge 边端镜像仓库:存储 KubeEdge 组件(Mosquitto、installation-package、pause)镜像仓库地址,如果边端镜像和云端镜像在一个镜像仓库,您可以点击 **引用云端地址** 按钮,快速填写。
例如 `unix:///run/containerd/containerd.sock`
- KubeEdge 边端镜像仓库:存储 KubeEdge 组件(Mosquitto、installation-package、pause)镜像仓库地址,
如果边端镜像和云端镜像在一个镜像仓库,您可以点击 **引用云端地址** 按钮,快速填写。
- 描述:接入指南描述信息。
- 标签:接入指南标签信息。

@@ -28,4 +29,4 @@

## 后续操作

完成指南创建后,您可以查看 **接入指南**,并根据接入流程提示,完成对边缘节点的纳管操作,具体请参见[节点接入指南](./access-guide.md)
完成指南创建后,您可以查看 **接入指南** ,并根据接入流程提示,完成对边缘节点的纳管操作,具体请参见[节点接入指南](./access-guide.md)