Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: wbc6080 <[email protected]>
  • Loading branch information
wbc6080 committed Feb 1, 2024
1 parent a25f668 commit 08c13b7
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 49 deletions.
6 changes: 3 additions & 3 deletions docs/concept/device/device_crds.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Device CRDs
sidebar_position: 3
---
KubeEdge supports device management with the help of Kubernetes [CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) and Device Mapper corresponding to the device being used.
We currently use Device Model and Device Instance to define the device, which all are CRDs in cluster.
We currently use Device Model and Device Instance to define the device.

## Notice
Device CRDs are updated from v1alpha2 to v1beta1 in release v1.15.
Expand Down Expand Up @@ -44,7 +44,7 @@ A `device instance` represents an actual device object.
The device spec is static, including device properties list, it describes the details of each property, including its name, type, access method.

### Device Instance Sample
A sample device instance like below, For complete Device Instance definition, you can refer to [device-instance](https://github.com/kubeedge/kubeedge/blob/master/build/crds/devices/devices_v1beta1_device.yaml)
A sample device instance like below. For complete Device Instance definition, you can refer to [device-instance](https://github.com/kubeedge/kubeedge/blob/master/build/crds/devices/devices_v1beta1_device.yaml).
```yaml
apiVersion: devices.kubeedge.io/v1beta1
kind: Device
Expand Down Expand Up @@ -99,7 +99,7 @@ In the above example, a device named beta1-device is defined, the model associat
and the node where the device runs is worker-node1. It defines device properties in the spec.properties field,
including message reporting frequency, message push method (spec.properties.pushMethod),
and parameters required to access the device (spec.properties.visitors). In addition, the protocol used
by the device is defined in the spec.protocol field.
by the device is defined in the `spec.protocol` field.

## Usage of Device CRD

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 3
---

KubeEdge 借助 Kubernetes [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) 和与设备对应的 Device Mapper 来支持设备管理。
目前我们使用Device Model和Device Instance来定义设备,它们都是集群中的CRD
目前我们使用Device Model和Device Instance来定义设备。

## 注意

Expand All @@ -13,7 +13,7 @@ KubeEdge 借助 Kubernetes [CRD](https://kubernetes.io/docs/concepts/extend-kube

## 设备模型

设备模型(Device Model)描述了一类设备公开的设备属性。 设备模型是一种“物理模型”,它约束物理设备的属性和参数。
设备模型(Device Model)描述了一类设备公开的设备属性。设备模型是一种“物理模型”,它约束物理设备的属性和参数。

### 设备模型示例
如下所示是设备模型的示例。完整的设备模型定义,可以参考[device-model](https://github.com/kubeedge/kubeedge/blob/master/build/crds/devices/devices_v1beta1_devicemodel.yaml)
Expand Down Expand Up @@ -43,58 +43,58 @@ spec:
设备实例的spec字段是静态的,包括设备属性列表,它描述了每个属性的详细信息,包括其名称、类型、访问方法。
### 设备实例示例
如下所示为设备实例的一个示例,有关完整的设备实例定义,您可以参考 [device-instance](https://github.com/kubeedge/kubeedge/blob/master/build/crds/devices/devices_v1beta1_device.yaml)
如下所示为设备实例的一个示例,有关完整的设备实例定义,您可以参考 [device-instance](https://github.com/kubeedge/kubeedge/blob/master/build/crds/devices/devices_v1beta1_device.yaml)
```yaml
apiVersion: devices.kubeedge.io/v1beta1
kind: Device
metadata:
name: beta1-device
name: beta1-device
spec:
deviceModelRef:
name: beta1-model
nodeName: worker-node1
properties:
- name: temp
collectCycle: 10000000000 # The frequency of reporting data to the cloud, once every 10 seconds
reportCycle: 10000000000 # The frequency of data push to user applications or databases, once every 10 seconds
reportToCloud: true
desired:
value: "30"
pushMethod:
mqtt:
address: tcp://127.0.0.1:1883
topic: temp
qos: 0
retained: false
dbMethod:
influxdb2:
influxdb2ClientConfig:
url: http://127.0.0.1:8086
org: test-org
bucket: test-bucket
influxdb2DataConfig:
measurement: stat
tag:
unit: temperature
fieldKey: beta1test
visitors:
protocolName: modbus
configData:
register: "HoldingRegister"
offset: 2
limit: 1
scale: 1
isSwap: true
isRegisterSwap: true
protocol:
protocolName: modbus
configData:
ip: 172.17.0.3
port: 1502
deviceModelRef:
name: beta1-model
nodeName: worker-node1
properties:
- name: temp
collectCycle: 10000000000 # The frequency of reporting data to the cloud, once every 10 seconds
reportCycle: 10000000000 # The frequency of data push to user applications or databases, once every 10 seconds
reportToCloud: true
desired:
value: "30"
pushMethod:
mqtt:
address: tcp://127.0.0.1:1883
topic: temp
qos: 0
retained: false
dbMethod:
influxdb2:
influxdb2ClientConfig:
url: http://127.0.0.1:8086
org: test-org
bucket: test-bucket
influxdb2DataConfig:
measurement: stat
tag:
unit: temperature
fieldKey: beta1test
visitors:
protocolName: modbus
configData:
register: "HoldingRegister"
offset: 2
limit: 1
scale: 1
isSwap: true
isRegisterSwap: true
protocol:
protocolName: modbus
configData:
ip: 172.17.0.3
port: 1502

```

上面的例子中,定义了一个名为 beta1-device 的设备,与之关联的设备模型为 beta1-model, 设备运行的节点为worker-node1。
上面的例子中,定义了一个名为 beta1-device 的设备,与之关联的设备模型为beta1-model,设备运行的节点为worker-node1。
示例文件在spec.properties字段中定义设备属性,包括消息上报频率、消息推送方式(spec.properties.pushMethod)、以及
访问设备所需的参数(spec.properties.visitors)。此外,设备使用的协议在spec.protocol字段中定义。

Expand Down

0 comments on commit 08c13b7

Please sign in to comment.