diff --git a/docs/faq/_category_.json b/docs/faq/_category_.json
index f47762ef5a..c9774033c1 100644
--- a/docs/faq/_category_.json
+++ b/docs/faq/_category_.json
@@ -1,6 +1,6 @@
{
"label": "Frequently Asked Questions (FAQ)",
- "position": 9,
+ "position": 10,
"link": {
"type": "generated-index"
}
diff --git a/docs/reference/_category_.json b/docs/reference/_category_.json
new file mode 100644
index 0000000000..e2ab7d953b
--- /dev/null
+++ b/docs/reference/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Reference",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/_category_.json b/docs/reference/kubeedge-api/_category_.json
new file mode 100644
index 0000000000..149ec7f2b2
--- /dev/null
+++ b/docs/reference/kubeedge-api/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "KubeEge API",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/apps-resources/_category_.json b/docs/reference/kubeedge-api/apps-resources/_category_.json
new file mode 100644
index 0000000000..3e28584b70
--- /dev/null
+++ b/docs/reference/kubeedge-api/apps-resources/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Apps Resources",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/apps-resources/edge-application-v1alpha1.md b/docs/reference/kubeedge-api/apps-resources/edge-application-v1alpha1.md
new file mode 100644
index 0000000000..6b947c81d9
--- /dev/null
+++ b/docs/reference/kubeedge-api/apps-resources/edge-application-v1alpha1.md
@@ -0,0 +1,899 @@
+---
+api_metadata:
+ apiVersion: "apps.kubeedge.io/v1alpha1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/apps/v1alpha1"
+ kind: "EdgeApplication"
+content_type: "api_reference"
+description: "EdgeApplication is the Schema for the edgeapplications API."
+title: "EdgeApplication v1alpha1"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: apps.kubeedge.io/v1alpha1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/apps/v1alpha1"`
+
+## EdgeApplication
+
+EdgeApplication is the Schema for the edgeapplications API
+
+
+
+- **apiVersion**: apps.kubeedge.io/v1alpha1
+
+- **kind**: EdgeApplication
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([EdgeApplicationSpec](../apps-resources/edge-application-v1alpha1#edgeapplicationspec))
+
+ Spec represents the desired behavior of EdgeApplication.
+
+- **status** ([EdgeApplicationStatus](../apps-resources/edge-application-v1alpha1#edgeapplicationstatus))
+
+ Status represents the status of PropagationStatus.
+
+## EdgeApplicationSpec
+
+EdgeApplicationSpec defines the desired state of EdgeApplication
+
+
+
+- **workloadScope** (WorkloadScope), required
+
+ WorkloadScope represents which node groups the workload will be deployed in.
+
+
+
+ *WorkloadScope represents which node groups the workload should be deployed in.*
+
+ - **workloadScope.targetNodeGroups** ([]TargetNodeGroup)
+
+ TargetNodeGroups represents the target node groups of workload to be deployed.
+
+
+
+ *TargetNodeGroup represents the target node group of workload to be deployed, including override rules to apply for this node group.*
+
+ - **workloadScope.targetNodeGroups.name** (string), required
+
+ Name represents the name of target node group
+
+ - **workloadScope.targetNodeGroups.overriders** (Overriders)
+
+ Overriders represents the override rules that would apply on workload.
+
+
+
+ *Overriders represents the override rules that would apply on resources.*
+
+ - **workloadScope.targetNodeGroups.overriders.argsOverriders** ([]CommandArgsOverrider)
+
+ ArgsOverriders represents the rules dedicated to handling container args
+
+
+
+ *CommandArgsOverrider represents the rules dedicated to handling command/args overrides.*
+
+ - **workloadScope.targetNodeGroups.overriders.argsOverriders.containerName** (string), required
+
+ The name of container
+
+ - **workloadScope.targetNodeGroups.overriders.argsOverriders.operator** (string), required
+
+ Operator represents the operator which will apply on the command/args.
+
+ - **workloadScope.targetNodeGroups.overriders.argsOverriders.value** ([]string)
+
+ Value to be applied to command/args. Items in Value which will be appended after command/args when Operator is 'add'. Items in Value which match in command/args will be deleted when Operator is 'remove'. If Value is empty, then the command/args will remain the same.
+
+ - **workloadScope.targetNodeGroups.overriders.commandOverriders** ([]CommandArgsOverrider)
+
+ CommandOverriders represents the rules dedicated to handling container command
+
+
+
+ *CommandArgsOverrider represents the rules dedicated to handling command/args overrides.*
+
+ - **workloadScope.targetNodeGroups.overriders.commandOverriders.containerName** (string), required
+
+ The name of container
+
+ - **workloadScope.targetNodeGroups.overriders.commandOverriders.operator** (string), required
+
+ Operator represents the operator which will apply on the command/args.
+
+ - **workloadScope.targetNodeGroups.overriders.commandOverriders.value** ([]string)
+
+ Value to be applied to command/args. Items in Value which will be appended after command/args when Operator is 'add'. Items in Value which match in command/args will be deleted when Operator is 'remove'. If Value is empty, then the command/args will remain the same.
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders** ([]EnvOverrider)
+
+ EnvOverriders will override the env field of the container
+
+
+
+ *EnvOverrider represents the rules dedicated to handling env overrides.*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.containerName** (string), required
+
+ The name of container
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.operator** (string), required
+
+ Operator represents the operator which will apply on the env.
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value** ([]EnvVar)
+
+ Value to be applied to env. Must not be empty when operator is 'add' or 'replace'. When the operator is 'remove', the matched value in env will be deleted and only the name of the value will be matched. If Value is empty, then the env will remain the same.
+
+
+
+ *EnvVar represents an environment variable present in a Container.*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.name** (string), required
+
+ Name of the environment variable. Must be a C_IDENTIFIER.
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.value** (string)
+
+ Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom** (EnvVarSource)
+
+ Source for the environment variable's value. Cannot be used if value is not empty.
+
+
+
+ *EnvVarSource represents a source for the value of an EnvVar.*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.configMapKeyRef** (ConfigMapKeySelector)
+
+ Selects a key of a ConfigMap.
+
+
+
+ *Selects a key from a ConfigMap.*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.configMapKeyRef.key** (string), required
+
+ The key to select.
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.configMapKeyRef.name** (string)
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.configMapKeyRef.optional** (boolean)
+
+ Specify whether the ConfigMap or its key must be defined
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.fieldRef** (ObjectFieldSelector)
+
+ Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+
+
+
+ *ObjectFieldSelector selects an APIVersioned field of an object.*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.fieldRef.fieldPath** (string), required
+
+ Path of the field to select in the specified API version.
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.fieldRef.apiVersion** (string)
+
+ Version of the schema the FieldPath is written in terms of, defaults to "v1".
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.resourceFieldRef** (ResourceFieldSelector)
+
+ Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+
+
+
+ *ResourceFieldSelector represents container resources (cpu, memory) and their output format*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.resourceFieldRef.resource** (string), required
+
+ Required: resource to select
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.resourceFieldRef.containerName** (string)
+
+ Container name: required for volumes, optional for env vars
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.resourceFieldRef.divisor** ([Quantity](../common-definitions/quantity#quantity))
+
+ Specifies the output format of the exposed resources, defaults to "1"
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.secretKeyRef** (SecretKeySelector)
+
+ Selects a key of a secret in the pod's namespace
+
+
+
+ *SecretKeySelector selects a key of a Secret.*
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.secretKeyRef.key** (string), required
+
+ The key of the secret to select from. Must be a valid secret key.
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.secretKeyRef.name** (string)
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ - **workloadScope.targetNodeGroups.overriders.envOverriders.value.valueFrom.secretKeyRef.optional** (boolean)
+
+ Specify whether the Secret or its key must be defined
+
+ - **workloadScope.targetNodeGroups.overriders.imageOverriders** ([]ImageOverrider)
+
+ ImageOverriders represents the rules dedicated to handling image overrides.
+
+
+
+ *ImageOverrider represents the rules dedicated to handling image overrides.*
+
+ - **workloadScope.targetNodeGroups.overriders.imageOverriders.component** (string), required
+
+ Component is part of image name. Basically we presume an image can be made of '[registry/]repository[:tag]'. The registry could be: - k8s.gcr.io - fictional.registry.example:10443 The repository could be: - kube-apiserver - fictional/nginx The tag cloud be: - latest - v1.19.1 - @sha256:dbcc1c35ac38df41fd2f5e4130b32ffdb93ebae8b3dbe638c23575912276fc9c
+
+ - **workloadScope.targetNodeGroups.overriders.imageOverriders.operator** (string), required
+
+ Operator represents the operator which will apply on the image.
+
+ - **workloadScope.targetNodeGroups.overriders.imageOverriders.predicate** (ImagePredicate)
+
+ Predicate filters images before applying the rule.
+
+ Defaults to nil, in that case, the system will automatically detect image fields if the resource type is Pod, ReplicaSet, Deployment or StatefulSet by following rule:
+ - Pod: /spec/containers/<N>/image
+ - ReplicaSet: /spec/template/spec/containers/<N>/image
+ - Deployment: /spec/template/spec/containers/<N>/image
+ - StatefulSet: /spec/template/spec/containers/<N>/image
+ In addition, all images will be processed if the resource object has more than one containers.
+
+ If not nil, only images matches the filters will be processed.
+
+
+
+ *ImagePredicate describes images filter.*
+
+ - **workloadScope.targetNodeGroups.overriders.imageOverriders.predicate.path** (string), required
+
+ Path indicates the path of target field
+
+ - **workloadScope.targetNodeGroups.overriders.imageOverriders.value** (string)
+
+ Value to be applied to image. Must not be empty when operator is 'add' or 'replace'. Defaults to empty and ignored when operator is 'remove'.
+
+ - **workloadScope.targetNodeGroups.overriders.replicas** (int32)
+
+ Replicas will override the replicas field of deployment
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders** ([]ResourcesOverrider)
+
+ ResourcesOverriders will override the resources field of the container
+
+
+
+ *ResourcesOverrider represents the rules dedicated to handling resources overrides.*
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders.containerName** (string), required
+
+ The name of container
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders.value** (ResourceRequirements)
+
+ Value to be applied to resources. Must not be empty
+
+
+
+ *ResourceRequirements describes the compute resource requirements.*
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders.value.claims** ([]ResourceClaim)
+
+ *Map: unique values on key name will be kept during a merge*
+
+ Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
+
+ This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
+
+ This field is immutable. It can only be set for containers.
+
+
+
+ *ResourceClaim references one entry in PodSpec.ResourceClaims.*
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders.value.claims.name** (string), required
+
+ Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders.value.limits** (map[string][Quantity](../common-definitions/quantity#quantity))
+
+ Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+
+ - **workloadScope.targetNodeGroups.overriders.resourcesOverriders.value.requests** (map[string][Quantity](../common-definitions/quantity#quantity))
+
+ Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+
+- **workloadTemplate** (ResourceTemplate)
+
+ WorkloadTemplate contains original templates of resources to be deployed as an EdgeApplication.
+
+
+
+ *ResourceTemplate represents original templates of resources to be deployed as an EdgeApplication.*
+
+ - **workloadTemplate.manifests** ([]Manifest)
+
+ Manifests represent a list of Kubernetes resources to be deployed on the managed node groups.
+
+
+
+ *Manifest represents a resource to be deployed on managed node groups.*
+
+## EdgeApplicationStatus
+
+EdgeApplicationStatus defines the observed state of EdgeApplication
+
+
+
+- **workloadStatus** ([]ManifestStatus)
+
+ WorkloadStatus contains running statuses of generated resources.
+
+
+
+ *ManifestStatus contains running status of a specific manifest in spec.*
+
+ - **workloadStatus.identifier** (ResourceIdentifier), required
+
+ Identifier represents the identity of a resource linking to manifests in spec.
+
+
+
+ *ResourceIdentifier provides the identifiers needed to interact with any arbitrary object.*
+
+ - **workloadStatus.identifier.ordinal** (int32), required
+
+ Ordinal represents an index in manifests list, so the condition can still be linked to a manifest even though manifest cannot be parsed successfully.
+
+ - **workloadStatus.identifier.group** (string)
+
+ Group is the group of the resource.
+
+ - **workloadStatus.identifier.kind** (string)
+
+ Kind is the kind of the resource.
+
+ - **workloadStatus.identifier.name** (string)
+
+ Name is the name of the resource
+
+ - **workloadStatus.identifier.namespace** (string)
+
+ Namespace is the namespace of the resource
+
+ - **workloadStatus.identifier.resource** (string)
+
+ Resource is the resource type of the resource
+
+ - **workloadStatus.identifier.version** (string)
+
+ Version is the version of the resource.
+
+ - **workloadStatus.conditions** (string)
+
+ Conditions contain the different condition statuses for this manifest. Valid condition types are: 1. Processing: this workload is under processing and the current state of manifest does not match the desired. 2. Available: the current status of this workload matches the desired.
+
+## EdgeApplicationList
+
+EdgeApplicationList contains a list of EdgeApplication
+
+
+
+- **apiVersion**: apps.kubeedge.io/v1alpha1
+
+- **kind**: EdgeApplicationList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)), required
+
+## Operations
+
+
+
+### `get` read the specified EdgeApplication
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+### `get` read status of the specified EdgeApplication
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+### `list` list or watch objects of kind EdgeApplication
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([EdgeApplicationList](../apps-resources/edge-application-v1alpha1#edgeapplicationlist)): OK
+
+### `list` list or watch objects of kind EdgeApplication
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/edgeapplications
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([EdgeApplicationList](../apps-resources/edge-application-v1alpha1#edgeapplicationlist)): OK
+
+### `create` create an EdgeApplication
+
+#### HTTP Request
+
+POST /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+201 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): Created
+
+202 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): Accepted
+
+### `update` replace the specified EdgeApplication
+
+#### HTTP Request
+
+PUT /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+201 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): Created
+
+### `update` replace status of the specified EdgeApplication
+
+#### HTTP Request
+
+PUT /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+201 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): Created
+
+### `patch` partially update the specified EdgeApplication
+
+#### HTTP Request
+
+PATCH /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+201 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): Created
+
+### `patch` partially update status of the specified EdgeApplication
+
+#### HTTP Request
+
+PATCH /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): OK
+
+201 ([EdgeApplication](../apps-resources/edge-application-v1alpha1#edgeapplication)): Created
+
+### `delete` delete an EdgeApplication
+
+#### HTTP Request
+
+DELETE /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the EdgeApplication
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of EdgeApplication
+
+#### HTTP Request
+
+DELETE /apis/apps.kubeedge.io/v1alpha1/namespaces/{namespace}/edgeapplications
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/apps-resources/node-group-v1alpha1.md b/docs/reference/kubeedge-api/apps-resources/node-group-v1alpha1.md
new file mode 100644
index 0000000000..acf7bf301b
--- /dev/null
+++ b/docs/reference/kubeedge-api/apps-resources/node-group-v1alpha1.md
@@ -0,0 +1,496 @@
+---
+api_metadata:
+ apiVersion: "apps.kubeedge.io/v1alpha1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/apps/v1alpha1"
+ kind: "NodeGroup"
+content_type: "api_reference"
+description: "NodeGroup is the Schema for the nodegroups API."
+title: "NodeGroup v1alpha1"
+weight: 2
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: apps.kubeedge.io/v1alpha1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/apps/v1alpha1"`
+
+## NodeGroup
+
+NodeGroup is the Schema for the nodegroups API
+
+
+
+- **apiVersion**: apps.kubeedge.io/v1alpha1
+
+- **kind**: NodeGroup
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([NodeGroupSpec](../apps-resources/node-group-v1alpha1#nodegroupspec))
+
+ Spec represents the specification of the desired behavior of member nodegroup.
+
+- **status** ([NodeGroupStatus](../apps-resources/node-group-v1alpha1#nodegroupstatus))
+
+ Status represents the status of member nodegroup.
+
+## NodeGroupSpec
+
+NodeGroupSpec defines the desired state of NodeGroup
+
+
+
+- **matchLabels** (map[string]string)
+
+ MatchLabels are used to select nodes that have these labels.
+
+- **nodes** ([]string)
+
+ Nodes contains names of all the nodes in the nodegroup.
+
+## NodeGroupStatus
+
+NodeGroupStatus contains the observed status of all selected nodes in this NodeGroup, including nodes that have been one of the members of this NodeGroup and those have not.
+
+
+
+- **nodeStatuses** ([]NodeStatus)
+
+ NodeStatuses is a status list of all selected nodes.
+
+
+
+ *NodeStatus contains status of node that selected by this NodeGroup.*
+
+ - **nodeStatuses.nodeName** (string), required
+
+ NodeName contains name of this node.
+
+ - **nodeStatuses.readyStatus** (string), required
+
+ ReadyStatus contains ready status of this node.
+
+ - **nodeStatuses.selectionStatus** (string), required
+
+ SelectionStatus contains status of the selection result for this node.
+
+ - **nodeStatuses.selectionStatusReason** (string)
+
+ SelectionStatusReason contains human-readable reason for this SelectionStatus.
+
+## NodeGroupList
+
+NodeGroupList contains a list of NodeGroup
+
+
+
+- **apiVersion**: apps.kubeedge.io/v1alpha1
+
+- **kind**: NodeGroupList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)), required
+
+## Operations
+
+
+
+### `get` read the specified NodeGroup
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+### `get` read status of the specified NodeGroup
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+### `list` list or watch objects of kind NodeGroup
+
+#### HTTP Request
+
+GET /apis/apps.kubeedge.io/v1alpha1/nodegroups
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([NodeGroupList](../apps-resources/node-group-v1alpha1#nodegrouplist)): OK
+
+### `create` create a NodeGroup
+
+#### HTTP Request
+
+POST /apis/apps.kubeedge.io/v1alpha1/nodegroups
+
+#### Parameters
+
+- **body**: [NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+201 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): Created
+
+202 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): Accepted
+
+### `update` replace the specified NodeGroup
+
+#### HTTP Request
+
+PUT /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **body**: [NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+201 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): Created
+
+### `update` replace status of the specified NodeGroup
+
+#### HTTP Request
+
+PUT /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **body**: [NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+201 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): Created
+
+### `patch` partially update the specified NodeGroup
+
+#### HTTP Request
+
+PATCH /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+201 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): Created
+
+### `patch` partially update status of the specified NodeGroup
+
+#### HTTP Request
+
+PATCH /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): OK
+
+201 ([NodeGroup](../apps-resources/node-group-v1alpha1#nodegroup)): Created
+
+### `delete` delete a NodeGroup
+
+#### HTTP Request
+
+DELETE /apis/apps.kubeedge.io/v1alpha1/nodegroups/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeGroup
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of NodeGroup
+
+#### HTTP Request
+
+DELETE /apis/apps.kubeedge.io/v1alpha1/nodegroups
+
+#### Parameters
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/common-definitions/_category_.json b/docs/reference/kubeedge-api/common-definitions/_category_.json
new file mode 100644
index 0000000000..8411bcb645
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Common Definitions",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/common-definitions/delete-options.md b/docs/reference/kubeedge-api/common-definitions/delete-options.md
new file mode 100644
index 0000000000..50c9a6a5d5
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/delete-options.md
@@ -0,0 +1,62 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+ kind: "DeleteOptions"
+content_type: "api_reference"
+description: "DeleteOptions may be provided when deleting an API object."
+title: "DeleteOptions"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+DeleteOptions may be provided when deleting an API object.
+
+
+
+- **apiVersion** (string)
+
+ APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+
+- **dryRun** ([]string)
+
+ When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
+
+- **gracePeriodSeconds** (int64)
+
+ The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+- **kind** (string)
+
+ Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+- **orphanDependents** (boolean)
+
+ Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+
+- **preconditions** (Preconditions)
+
+ Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
+
+
+
+ *Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.*
+
+ - **preconditions.resourceVersion** (string)
+
+ Specifies the target ResourceVersion
+
+ - **preconditions.uid** (string)
+
+ Specifies the target UID.
+
+- **propagationPolicy** (string)
+
+ Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+
diff --git a/docs/reference/kubeedge-api/common-definitions/label-selector.md b/docs/reference/kubeedge-api/common-definitions/label-selector.md
new file mode 100644
index 0000000000..e98b2f8d26
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/label-selector.md
@@ -0,0 +1,46 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+ kind: "LabelSelector"
+content_type: "api_reference"
+description: "A label selector is a label query over a set of resources."
+title: "LabelSelector"
+weight: 2
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
+
+
+
+- **matchExpressions** ([]LabelSelectorRequirement)
+
+ matchExpressions is a list of label selector requirements. The requirements are ANDed.
+
+
+
+ *A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.*
+
+ - **matchExpressions.key** (string), required
+
+ key is the label key that the selector applies to.
+
+ - **matchExpressions.operator** (string), required
+
+ operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+
+ - **matchExpressions.values** ([]string)
+
+ values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+
+- **matchLabels** (map[string]string)
+
+ matchLabels is a map of [key,value] pairs. A single [key,value] in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
+
diff --git a/docs/reference/kubeedge-api/common-definitions/list-meta.md b/docs/reference/kubeedge-api/common-definitions/list-meta.md
new file mode 100644
index 0000000000..1a4c08876a
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/list-meta.md
@@ -0,0 +1,38 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+ kind: "ListMeta"
+content_type: "api_reference"
+description: "ListMeta describes metadata that synthetic resources must have, including lists and various status objects."
+title: "ListMeta"
+weight: 3
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of [ObjectMeta, ListMeta].
+
+
+
+- **continue** (string)
+
+ continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
+
+- **remainingItemCount** (int64)
+
+ remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
+
+- **resourceVersion** (string)
+
+ String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+
+- **selfLink** (string)
+
+ Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+
diff --git a/docs/reference/kubeedge-api/common-definitions/node-selector-requirement.md b/docs/reference/kubeedge-api/common-definitions/node-selector-requirement.md
new file mode 100644
index 0000000000..80cf3ccae2
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/node-selector-requirement.md
@@ -0,0 +1,42 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/api/core/v1"
+ kind: "NodeSelectorRequirement"
+content_type: "api_reference"
+description: "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values."
+title: "NodeSelectorRequirement"
+weight: 4
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/api/core/v1"`
+
+A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+
+
+- **key** (string), required
+
+ The label key that the selector applies to.
+
+- **operator** (string), required
+
+ Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+
+ Possible enum values:
+ - `"DoesNotExist"`
+ - `"Exists"`
+ - `"Gt"`
+ - `"In"`
+ - `"Lt"`
+ - `"NotIn"`
+
+- **values** ([]string)
+
+ An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
+
diff --git a/docs/reference/kubeedge-api/common-definitions/object-meta.md b/docs/reference/kubeedge-api/common-definitions/object-meta.md
new file mode 100644
index 0000000000..7df5fabbb6
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/object-meta.md
@@ -0,0 +1,178 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+ kind: "ObjectMeta"
+content_type: "api_reference"
+description: "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
+title: "ObjectMeta"
+weight: 5
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+
+
+
+- **annotations** (map[string]string)
+
+ Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
+
+- **creationTimestamp** (Time)
+
+ CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
+
+ Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+
+
+
+ *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
+
+- **deletionGracePeriodSeconds** (int64)
+
+ Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
+
+- **deletionTimestamp** (Time)
+
+ DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
+
+ Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+
+
+
+ *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
+
+- **finalizers** ([]string)
+
+ Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
+
+- **generateName** (string)
+
+ GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
+
+ If this field is specified and the generated name exists, the server will return a 409.
+
+ Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+
+- **generation** (int64)
+
+ A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
+
+- **labels** (map[string]string)
+
+ Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
+
+- **managedFields** ([]ManagedFieldsEntry)
+
+ ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
+
+
+
+ *ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.*
+
+ - **managedFields.apiVersion** (string)
+
+ APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
+
+ - **managedFields.fieldsType** (string)
+
+ FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
+
+ - **managedFields.fieldsV1** (FieldsV1)
+
+ FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
+
+
+
+ *FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
+
+ Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
+
+ The exact format is defined in sigs.k8s.io/structured-merge-diff*
+
+ - **managedFields.manager** (string)
+
+ Manager is an identifier of the workflow managing these fields.
+
+ - **managedFields.operation** (string)
+
+ Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
+
+ - **managedFields.subresource** (string)
+
+ Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
+
+ - **managedFields.time** (Time)
+
+ Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
+
+
+
+ *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
+
+- **name** (string)
+
+ Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+
+- **namespace** (string)
+
+ Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
+
+ Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
+
+- **ownerReferences** ([]OwnerReference)
+
+ *Patch strategy: merge on key `uid`*
+
+ List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
+
+
+
+ *OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.*
+
+ - **ownerReferences.apiVersion** (string), required
+
+ API version of the referent.
+
+ - **ownerReferences.kind** (string), required
+
+ Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+ - **ownerReferences.name** (string), required
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+
+ - **ownerReferences.uid** (string), required
+
+ UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+
+ - **ownerReferences.blockOwnerDeletion** (boolean)
+
+ If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
+
+ - **ownerReferences.controller** (boolean)
+
+ If true, this reference points to the managing controller.
+
+- **resourceVersion** (string)
+
+ An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
+
+ Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+
+- **selfLink** (string)
+
+ Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+
+- **uid** (string)
+
+ UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
+
+ Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+
diff --git a/docs/reference/kubeedge-api/common-definitions/patch.md b/docs/reference/kubeedge-api/common-definitions/patch.md
new file mode 100644
index 0000000000..efa84e32b9
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/patch.md
@@ -0,0 +1,22 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+ kind: "Patch"
+content_type: "api_reference"
+description: "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body."
+title: "Patch"
+weight: 6
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+
+
+
diff --git a/docs/reference/kubeedge-api/common-definitions/quantity.md b/docs/reference/kubeedge-api/common-definitions/quantity.md
new file mode 100644
index 0000000000..b3f709e8d8
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/quantity.md
@@ -0,0 +1,58 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/api/resource"
+ kind: "Quantity"
+content_type: "api_reference"
+description: "Quantity is a fixed-point representation of a number."
+title: "Quantity"
+weight: 7
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/api/resource"`
+
+Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.
+
+The serialization format is:
+
+``` \ ::= \\
+
+ (Note that \ may be empty, from the "" case in \.)
+
+\ ::= 0 | 1 | ... | 9 \ ::= \ | \\ \ ::= \ | \.\ | \. | .\ \ ::= "+" | "-" \ ::= \ | \\ \ ::= \ | \ | \ \ ::= Ki | Mi | Gi | Ti | Pi | Ei
+
+ (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
+
+\ ::= m | "" | k | M | G | T | P | E
+
+ (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
+
+\ ::= "e" \ | "E" \ ```
+
+No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
+
+When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.
+
+Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:
+
+- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.
+
+The sign will be omitted unless the number is negative.
+
+Examples:
+
+- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"
+
+Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.
+
+Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)
+
+This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
+
+
+
diff --git a/docs/reference/kubeedge-api/common-definitions/status.md b/docs/reference/kubeedge-api/common-definitions/status.md
new file mode 100644
index 0000000000..75d3e48042
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-definitions/status.md
@@ -0,0 +1,102 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: "k8s.io/apimachinery/pkg/apis/meta/v1"
+ kind: "Status"
+content_type: "api_reference"
+description: "Status is a return value for calls that don't return other objects."
+title: "Status"
+weight: 8
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
+
+Status is a return value for calls that don't return other objects.
+
+
+
+- **apiVersion** (string)
+
+ APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+
+- **code** (int32)
+
+ Suggested HTTP return code for this status, 0 if not set.
+
+- **details** (StatusDetails)
+
+ Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
+
+
+
+ *StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.*
+
+ - **details.causes** ([]StatusCause)
+
+ The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
+
+
+
+ *StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.*
+
+ - **details.causes.field** (string)
+
+ The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
+
+ Examples:
+ "name" - the field "name" on the current resource
+ "items[0].name" - the field "name" on the first array entry in "items"
+
+ - **details.causes.message** (string)
+
+ A human-readable description of the cause of the error. This field may be presented as-is to a reader.
+
+ - **details.causes.reason** (string)
+
+ A machine-readable description of the cause of the error. If this value is empty there is no information available.
+
+ - **details.group** (string)
+
+ The group attribute of the resource associated with the status StatusReason.
+
+ - **details.kind** (string)
+
+ The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+ - **details.name** (string)
+
+ The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
+
+ - **details.retryAfterSeconds** (int32)
+
+ If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
+
+ - **details.uid** (string)
+
+ UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+
+- **kind** (string)
+
+ Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+- **message** (string)
+
+ A human-readable description of the status of this operation.
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+ Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+- **reason** (string)
+
+ A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
+
+- **status** (string)
+
+ Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+
diff --git a/docs/reference/kubeedge-api/common-parameter/_category_.json b/docs/reference/kubeedge-api/common-parameter/_category_.json
new file mode 100644
index 0000000000..a03c59caac
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-parameter/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Common Parameter",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/common-parameter/common-parameters.md b/docs/reference/kubeedge-api/common-parameter/common-parameters.md
new file mode 100644
index 0000000000..f5a4575422
--- /dev/null
+++ b/docs/reference/kubeedge-api/common-parameter/common-parameters.md
@@ -0,0 +1,144 @@
+---
+api_metadata:
+ apiVersion: ""
+ import: ""
+ kind: "Common Parameters"
+content_type: "api_reference"
+description: ""
+title: "Common Parameters"
+weight: 8
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+## allowWatchBookmarks
+
+allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
+
+
+
+## continue
+
+The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".
+
+This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
+
+
+
+## dryRun
+
+When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
+
+
+
+## fieldManager
+
+fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
+
+
+
+## fieldSelector
+
+A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
+
+
+## fieldValidation
+
+fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
+
+
+
+## force
+
+Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
+
+
+
+## gracePeriodSeconds
+
+The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+
+
+
+## labelSelector
+
+A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
+
+
+## limit
+
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
+
+The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
+
+
+
+## namespace
+
+object name and auth scope, such as for teams and projects
+
+
+
+## pretty
+
+If 'true', then the output is pretty printed.
+
+
+
+## propagationPolicy
+
+Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+
+
+
+## resourceVersion
+
+resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.
+
+Defaults to unset
+
+
+
+## resourceVersionMatch
+
+resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.
+
+Defaults to unset
+
+
+
+## sendInitialEvents
+
+`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.
+
+When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan
+ is interpreted as "data at least as new as the provided `resourceVersion`"
+ and the bookmark event is send when the state is synced
+ to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
+ If `resourceVersion` is unset, this is interpreted as "consistent read" and the
+ bookmark event is send when the state is synced at least to the moment
+ when request started being processed.
+- `resourceVersionMatch` set to any other value or unset
+ Invalid error is returned.
+
+Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise.
+
+
+
+## timeoutSeconds
+
+Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
+
+
+
+## watch
+
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
+
+
diff --git a/docs/reference/kubeedge-api/devices-resources/_category_.json b/docs/reference/kubeedge-api/devices-resources/_category_.json
new file mode 100644
index 0000000000..d0cc8e658c
--- /dev/null
+++ b/docs/reference/kubeedge-api/devices-resources/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Devices Resources",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/devices-resources/device-model-v1alpha2.md b/docs/reference/kubeedge-api/devices-resources/device-model-v1alpha2.md
new file mode 100644
index 0000000000..d924803260
--- /dev/null
+++ b/docs/reference/kubeedge-api/devices-resources/device-model-v1alpha2.md
@@ -0,0 +1,670 @@
+---
+api_metadata:
+ apiVersion: "devices.kubeedge.io/v1alpha2"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/devices/v1alpha2"
+ kind: "DeviceModel"
+content_type: "api_reference"
+description: "DeviceModel is the Schema for the device model API."
+title: "DeviceModel v1alpha2"
+weight: 3
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: devices.kubeedge.io/v1alpha2`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/devices/v1alpha2"`
+
+## DeviceModel
+
+DeviceModel is the Schema for the device model API
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1alpha2
+
+- **kind**: DeviceModel
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([DeviceModelSpec](../devices-resources/device-model-v1alpha2#devicemodelspec))
+
+## DeviceModelSpec
+
+DeviceModelSpec defines the model / template for a device.It is a blueprint which describes the device capabilities and access mechanism via property visitors.
+
+
+
+- **properties** ([]DeviceProperty)
+
+ Required: List of device properties.
+
+
+
+ *DeviceProperty describes an individual device property / attribute like temperature / humidity etc.*
+
+ - **properties.description** (string)
+
+ The device property description.
+
+ - **properties.name** (string)
+
+ Required: The device property name.
+
+ - **properties.type** (PropertyType)
+
+ Required: PropertyType represents the type and data validation of the property.
+
+
+
+ *Represents the type and data validation of a property. Only one of its members may be specified.*
+
+ - **properties.type.boolean** (PropertyTypeBoolean)
+
+
+
+ **
+
+ - **properties.type.boolean.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.type.boolean.defaultValue** (boolean)
+
+ - **properties.type.bytes** (PropertyTypeBytes)
+
+
+
+ **
+
+ - **properties.type.bytes.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.type.double** (PropertyTypeDouble)
+
+
+
+ **
+
+ - **properties.type.double.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.type.double.defaultValue** (double)
+
+ - **properties.type.double.maximum** (double)
+
+ - **properties.type.double.minimum** (double)
+
+ - **properties.type.double.unit** (string)
+
+ The unit of the property
+
+ - **properties.type.float** (PropertyTypeFloat)
+
+
+
+ **
+
+ - **properties.type.float.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.type.float.defaultValue** (float)
+
+ - **properties.type.float.maximum** (float)
+
+ - **properties.type.float.minimum** (float)
+
+ - **properties.type.float.unit** (string)
+
+ The unit of the property
+
+ - **properties.type.int** (PropertyTypeInt64)
+
+
+
+ **
+
+ - **properties.type.int.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.type.int.defaultValue** (int64)
+
+ - **properties.type.int.maximum** (int64)
+
+ - **properties.type.int.minimum** (int64)
+
+ - **properties.type.int.unit** (string)
+
+ The unit of the property
+
+ - **properties.type.string** (PropertyTypeString)
+
+
+
+ **
+
+ - **properties.type.string.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.type.string.defaultValue** (string)
+
+- **protocol** (string)
+
+ Required for DMI: Protocol name used by the device.
+
+## DeviceModelList
+
+DeviceModelList contains a list of DeviceModel
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1alpha2
+
+- **kind**: DeviceModelList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)), required
+
+## Operations
+
+
+
+### `get` read the specified DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+### `get` read status of the specified DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+### `list` list or watch objects of kind DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceModelList](../devices-resources/device-model-v1alpha2#devicemodellist)): OK
+
+### `list` list or watch objects of kind DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/devicemodels
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceModelList](../devices-resources/device-model-v1alpha2#devicemodellist)): OK
+
+### `create` create a DeviceModel
+
+#### HTTP Request
+
+POST /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): Created
+
+202 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): Accepted
+
+### `update` replace the specified DeviceModel
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): Created
+
+### `update` replace status of the specified DeviceModel
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): Created
+
+### `patch` partially update the specified DeviceModel
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): Created
+
+### `patch` partially update status of the specified DeviceModel
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1alpha2#devicemodel)): Created
+
+### `delete` delete a DeviceModel
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of DeviceModel
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devicemodels
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/devices-resources/device-model-v1beta1.md b/docs/reference/kubeedge-api/devices-resources/device-model-v1beta1.md
new file mode 100644
index 0000000000..1dd368b383
--- /dev/null
+++ b/docs/reference/kubeedge-api/devices-resources/device-model-v1beta1.md
@@ -0,0 +1,584 @@
+---
+api_metadata:
+ apiVersion: "devices.kubeedge.io/v1beta1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/devices/v1beta1"
+ kind: "DeviceModel"
+content_type: "api_reference"
+description: "DeviceModel is the Schema for the device model API."
+title: "DeviceModel v1beta1"
+weight: 4
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: devices.kubeedge.io/v1beta1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/devices/v1beta1"`
+
+## DeviceModel
+
+DeviceModel is the Schema for the device model API
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1beta1
+
+- **kind**: DeviceModel
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([DeviceModelSpec](../devices-resources/device-model-v1beta1#devicemodelspec))
+
+## DeviceModelSpec
+
+DeviceModelSpec defines the model for a device.It is a blueprint which describes the device capabilities and access mechanism via property visitors.
+
+
+
+- **properties** ([]ModelProperty)
+
+ Required: List of device properties.
+
+
+
+ *ModelProperty describes an individual device property / attribute like temperature / humidity etc.*
+
+ - **properties.accessMode** (string)
+
+ Required: Access mode of property, ReadWrite or ReadOnly.
+
+ - **properties.description** (string)
+
+ The device property description.
+
+ - **properties.maximum** (string)
+
+ - **properties.minimum** (string)
+
+ - **properties.name** (string)
+
+ Required: The device property name. Note: If you need to use the built-in stream data processing function, you need to define Name as saveFrame or saveVideo
+
+ - **properties.type** (string)
+
+ Required: Type of device property, ENUM: INT,FLOAT,DOUBLE,STRING,BOOLEAN,BYTES,STREAM
+
+ - **properties.unit** (string)
+
+ The unit of the property
+
+- **protocol** (string)
+
+ Required: Protocol name used by the device.
+
+## DeviceModelList
+
+DeviceModelList contains a list of DeviceModel
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1beta1
+
+- **kind**: DeviceModelList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)), required
+
+## Operations
+
+
+
+### `get` read the specified DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+### `get` read status of the specified DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+### `list` list or watch objects of kind DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceModelList](../devices-resources/device-model-v1beta1#devicemodellist)): OK
+
+### `list` list or watch objects of kind DeviceModel
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/devicemodels
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceModelList](../devices-resources/device-model-v1beta1#devicemodellist)): OK
+
+### `create` create a DeviceModel
+
+#### HTTP Request
+
+POST /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeviceModel](../devices-resources/device-model-v1beta1#devicemodel), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): Created
+
+202 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): Accepted
+
+### `update` replace the specified DeviceModel
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeviceModel](../devices-resources/device-model-v1beta1#devicemodel), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): Created
+
+### `update` replace status of the specified DeviceModel
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeviceModel](../devices-resources/device-model-v1beta1#devicemodel), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): Created
+
+### `patch` partially update the specified DeviceModel
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): Created
+
+### `patch` partially update status of the specified DeviceModel
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): OK
+
+201 ([DeviceModel](../devices-resources/device-model-v1beta1#devicemodel)): Created
+
+### `delete` delete a DeviceModel
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the DeviceModel
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of DeviceModel
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devicemodels
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/devices-resources/device-v1alpha2.md b/docs/reference/kubeedge-api/devices-resources/device-v1alpha2.md
new file mode 100644
index 0000000000..9aff46f8da
--- /dev/null
+++ b/docs/reference/kubeedge-api/devices-resources/device-v1alpha2.md
@@ -0,0 +1,988 @@
+---
+api_metadata:
+ apiVersion: "devices.kubeedge.io/v1alpha2"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/devices/v1alpha2"
+ kind: "Device"
+content_type: "api_reference"
+description: "Device is the Schema for the devices API."
+title: "Device v1alpha2"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: devices.kubeedge.io/v1alpha2`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/devices/v1alpha2"`
+
+## Device
+
+Device is the Schema for the devices API
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1alpha2
+
+- **kind**: Device
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([DeviceSpec](../devices-resources/device-v1alpha2#devicespec))
+
+- **status** ([DeviceStatus](../devices-resources/device-v1alpha2#devicestatus))
+
+## DeviceSpec
+
+DeviceSpec represents a single device instance. It is an instantation of a device model.
+
+
+
+- **data** (DeviceData)
+
+ Data section describe a list of time-series properties which should be processed on edge node.
+
+
+
+ *DeviceData reports the device's time-series data to edge MQTT broker. These data should not be processed by edgecore. Instead, they can be processed by third-party data-processing apps like EMQX kuiper.*
+
+ - **data.dataProperties** ([]DataProperty)
+
+ Required: A list of data properties, which are not required to be processed by edgecore
+
+
+
+ *DataProperty represents the device property for external use.*
+
+ - **data.dataProperties.metadata** (map[string]string)
+
+ Additional metadata like timestamp when the value was reported etc.
+
+ - **data.dataProperties.propertyName** (string)
+
+ Required: The property name for which should be processed by external apps. This property should be present in the device model.
+
+ - **data.dataTopic** (string)
+
+ Topic used by mapper, all data collected from dataProperties should be published to this topic, the default value is $ke/events/device/+/data/update
+
+- **deviceModelRef** (LocalObjectReference)
+
+ Required: DeviceModelRef is reference to the device model used as a template to create the device instance.
+
+
+
+ *LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.*
+
+ - **deviceModelRef.name** (string)
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+- **nodeSelector** (NodeSelector)
+
+ NodeSelector indicates the binding preferences between devices and nodes. Refer to k8s.io/kubernetes/pkg/apis/core NodeSelector for more details
+
+
+
+ *A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
+
+ - **nodeSelector.nodeSelectorTerms** ([]NodeSelectorTerm), required
+
+ Required. A list of node selector terms. The terms are ORed.
+
+
+
+ *A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
+
+ - **nodeSelector.nodeSelectorTerms.matchExpressions** ([][NodeSelectorRequirement](../common-definitions/node-selector-requirement#nodeselectorrequirement))
+
+ A list of node selector requirements by node's labels.
+
+ - **nodeSelector.nodeSelectorTerms.matchFields** ([][NodeSelectorRequirement](../common-definitions/node-selector-requirement#nodeselectorrequirement))
+
+ A list of node selector requirements by node's fields.
+
+- **propertyVisitors** ([]DevicePropertyVisitor)
+
+ List of property visitors which describe how to access the device properties. PropertyVisitors must unique by propertyVisitor.propertyName.
+
+
+
+ *DevicePropertyVisitor describes the specifics of accessing a particular device property. Visitors are intended to be consumed by device mappers which connect to devices and collect data / perform actions on the device.*
+
+ - **propertyVisitors.bluetooth** (VisitorConfigBluetooth)
+
+ Bluetooth represents a set of additional visitor config fields of bluetooth protocol.
+
+
+
+ *Common visitor configurations for bluetooth protocol*
+
+ - **propertyVisitors.bluetooth.characteristicUUID** (string)
+
+ Required: Unique ID of the corresponding operation
+
+ - **propertyVisitors.bluetooth.dataConverter** (BluetoothReadConverter)
+
+ Responsible for converting the data being read from the bluetooth device into a form that is understandable by the platform
+
+
+
+ *Specifies the operations that may need to be performed to convert the data*
+
+ - **propertyVisitors.bluetooth.dataConverter.endIndex** (int32)
+
+ Required: Specifies the end index of incoming byte stream to be considered to convert the data the value specified should be inclusive for example if 3 is specified it includes the third index
+
+ - **propertyVisitors.bluetooth.dataConverter.orderOfOperations** ([]BluetoothOperations)
+
+ Specifies in what order the operations(which are required to be performed to convert incoming data into understandable form) are performed
+
+
+
+ *Specify the operation that should be performed to convert incoming data into understandable form*
+
+ - **propertyVisitors.bluetooth.dataConverter.orderOfOperations.operationType** (string)
+
+ Required: Specifies the operation to be performed to convert incoming data
+
+ - **propertyVisitors.bluetooth.dataConverter.orderOfOperations.operationValue** (double)
+
+ Required: Specifies with what value the operation is to be performed
+
+ - **propertyVisitors.bluetooth.dataConverter.shiftLeft** (int32)
+
+ Refers to the number of bits to shift left, if left-shift operation is necessary for conversion
+
+ - **propertyVisitors.bluetooth.dataConverter.shiftRight** (int32)
+
+ Refers to the number of bits to shift right, if right-shift operation is necessary for conversion
+
+ - **propertyVisitors.bluetooth.dataConverter.startIndex** (int32)
+
+ Required: Specifies the start index of the incoming byte stream to be considered to convert the data. For example: start-index:2, end-index:3 concatenates the value present at second and third index of the incoming byte stream. If we want to reverse the order we can give it as start-index:3, end-index:2
+
+ - **propertyVisitors.bluetooth.dataWrite** (map[string][]byte)
+
+ Responsible for converting the data coming from the platform into a form that is understood by the bluetooth device For example: "ON":[1], "OFF":[0]
+
+ - **propertyVisitors.collectCycle** (int64)
+
+ Define how frequent mapper will collect from device.
+
+ - **propertyVisitors.customizedProtocol** (VisitorConfigCustomized)
+
+ CustomizedProtocol represents a set of visitor config fields of bluetooth protocol.
+
+
+
+ *Common visitor configurations for customized protocol*
+
+ - **propertyVisitors.customizedProtocol.configData** (CustomizedValue)
+
+ Required: The configData of customized protocol
+
+
+
+ *CustomizedValue contains a map type data*
+
+ - **propertyVisitors.customizedProtocol.protocolName** (string)
+
+ Required: name of customized protocol
+
+ - **propertyVisitors.customizedValues** (CustomizedValue)
+
+ Customized values for visitor of provided protocols
+
+
+
+ *CustomizedValue contains a map type data*
+
+ - **propertyVisitors.modbus** (VisitorConfigModbus)
+
+ Modbus represents a set of additional visitor config fields of modbus protocol.
+
+
+
+ *Common visitor configurations for modbus protocol*
+
+ - **propertyVisitors.modbus.isRegisterSwap** (boolean)
+
+ Indicates whether the high and low register swapped. Defaults to false.
+
+ - **propertyVisitors.modbus.isSwap** (boolean)
+
+ Indicates whether the high and low byte swapped. Defaults to false.
+
+ - **propertyVisitors.modbus.limit** (int64)
+
+ Required: Limit number of registers to read/write.
+
+ - **propertyVisitors.modbus.offset** (int64)
+
+ Required: Offset indicates the starting register number to read/write data.
+
+ - **propertyVisitors.modbus.register** (string)
+
+ Required: Type of register
+
+ - **propertyVisitors.modbus.scale** (double)
+
+ The scale to convert raw property data into final units. Defaults to 1.0
+
+ - **propertyVisitors.opcua** (VisitorConfigOPCUA)
+
+ Opcua represents a set of additional visitor config fields of opc-ua protocol.
+
+
+
+ *Common visitor configurations for opc-ua protocol*
+
+ - **propertyVisitors.opcua.browseName** (string)
+
+ The name of opc-ua node
+
+ - **propertyVisitors.opcua.nodeID** (string)
+
+ Required: The ID of opc-ua node, e.g. "ns=1,i=1005"
+
+ - **propertyVisitors.propertyName** (string)
+
+ Required: The device property name to be accessed. This should refer to one of the device properties defined in the device model.
+
+ - **propertyVisitors.reportCycle** (int64)
+
+ Define how frequent mapper will report the value.
+
+- **protocol** (ProtocolConfig)
+
+ Required: The protocol configuration used to connect to the device.
+
+
+
+ *Only one of its members may be specified.*
+
+ - **protocol.bluetooth** (ProtocolConfigBluetooth)
+
+ Protocol configuration for bluetooth
+
+
+
+ **
+
+ - **protocol.bluetooth.macAddress** (string)
+
+ Unique identifier assigned to the device.
+
+ - **protocol.common** (ProtocolConfigCommon)
+
+ Configuration for protocol common part
+
+
+
+ *Only one of COM or TCP may be specified.*
+
+ - **protocol.common.collectRetryTimes** (int64)
+
+ Define retry times of mapper will collect from device.
+
+ - **protocol.common.collectTimeout** (int64)
+
+ Define timeout of mapper collect from device.
+
+ - **protocol.common.collectType** (string)
+
+ Define collect type, sync or async.
+
+ - **protocol.common.com** (ProtocolConfigCOM)
+
+
+
+ **
+
+ - **protocol.common.com.baudRate** (int64)
+
+ Required. BaudRate 115200|57600|38400|19200|9600|4800|2400|1800|1200|600|300|200|150|134|110|75|50
+
+ - **protocol.common.com.dataBits** (int64)
+
+ Required. Valid values are 8, 7, 6, 5.
+
+ - **protocol.common.com.parity** (string)
+
+ Required. Valid options are "none", "even", "odd". Defaults to "none".
+
+ - **protocol.common.com.serialPort** (string)
+
+ Required.
+
+ - **protocol.common.com.stopBits** (int64)
+
+ Required. Bit that stops 1|2
+
+ - **protocol.common.commType** (string)
+
+ Communication type, like tcp client, tcp server or COM
+
+ - **protocol.common.customizedValues** (CustomizedValue)
+
+ Customized values for provided protocol
+
+
+
+ *CustomizedValue contains a map type data*
+
+ - **protocol.common.reconnRetryTimes** (int64)
+
+ Reconnecting retry times
+
+ - **protocol.common.reconnTimeout** (int64)
+
+ Reconnection timeout
+
+ - **protocol.common.tcp** (ProtocolConfigTCP)
+
+
+
+ **
+
+ - **protocol.common.tcp.ip** (string)
+
+ Required.
+
+ - **protocol.common.tcp.port** (int64)
+
+ Required.
+
+ - **protocol.customizedProtocol** (ProtocolConfigCustomized)
+
+ Configuration for customized protocol
+
+
+
+ **
+
+ - **protocol.customizedProtocol.configData** (CustomizedValue)
+
+ Any config data
+
+
+
+ *CustomizedValue contains a map type data*
+
+ - **protocol.customizedProtocol.protocolName** (string)
+
+ Unique protocol name Required.
+
+ - **protocol.modbus** (ProtocolConfigModbus)
+
+ Protocol configuration for modbus
+
+
+
+ *Only one of its members may be specified.*
+
+ - **protocol.modbus.slaveID** (int64)
+
+ Required. 0-255
+
+ - **protocol.opcua** (ProtocolConfigOpcUA)
+
+ Protocol configuration for opc-ua
+
+
+
+ **
+
+ - **protocol.opcua.certificate** (string)
+
+ Certificate for access opc server.
+
+ - **protocol.opcua.password** (string)
+
+ Password for access opc server.
+
+ - **protocol.opcua.privateKey** (string)
+
+ PrivateKey for access opc server.
+
+ - **protocol.opcua.securityMode** (string)
+
+ Defaults to "none".
+
+ - **protocol.opcua.securityPolicy** (string)
+
+ Defaults to "none".
+
+ - **protocol.opcua.timeout** (int64)
+
+ Timeout seconds for the opc server connection.???
+
+ - **protocol.opcua.url** (string)
+
+ Required: The URL for opc server endpoint.
+
+ - **protocol.opcua.userName** (string)
+
+ Username for access opc server.
+
+## DeviceStatus
+
+DeviceStatus reports the device state and the desired/reported values of twin attributes.
+
+
+
+- **twins** ([]Twin)
+
+ A list of device twins containing desired/reported desired/reported values of twin properties. Optional: A passive device won't have twin properties and this list could be empty.
+
+
+
+ *Twin provides a logical representation of control properties (writable properties in the device model). The properties can have a Desired state and a Reported state. The cloud configures the `Desired`state of a device property and this configuration update is pushed to the edge node. The mapper sends a command to the device to change this property value as per the desired state . It receives the `Reported` state of the property once the previous operation is complete and sends the reported state to the cloud. Offline device interaction in the edge is possible via twin properties for control/command operations.*
+
+ - **twins.desired** (TwinProperty)
+
+ Required: the desired property value.
+
+
+
+ *TwinProperty represents the device property for which an Expected/Actual state can be defined.*
+
+ - **twins.desired.value** (string), required
+
+ Required: The value for this property.
+
+ - **twins.desired.metadata** (map[string]string)
+
+ Additional metadata like timestamp when the value was reported etc.
+
+ - **twins.propertyName** (string)
+
+ Required: The property name for which the desired/reported values are specified. This property should be present in the device model.
+
+ - **twins.reported** (TwinProperty)
+
+ Required: the reported property value.
+
+
+
+ *TwinProperty represents the device property for which an Expected/Actual state can be defined.*
+
+ - **twins.reported.value** (string), required
+
+ Required: The value for this property.
+
+ - **twins.reported.metadata** (map[string]string)
+
+ Additional metadata like timestamp when the value was reported etc.
+
+## DeviceList
+
+DeviceList contains a list of Device
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1alpha2
+
+- **kind**: DeviceList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][Device](../devices-resources/device-v1alpha2#device)), required
+
+## Operations
+
+
+
+### `get` read the specified Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+### `get` read status of the specified Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+### `list` list or watch objects of kind Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceList](../devices-resources/device-v1alpha2#devicelist)): OK
+
+### `list` list or watch objects of kind Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1alpha2/devices
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceList](../devices-resources/device-v1alpha2#devicelist)): OK
+
+### `create` create a Device
+
+#### HTTP Request
+
+POST /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Device](../devices-resources/device-v1alpha2#device), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+201 ([Device](../devices-resources/device-v1alpha2#device)): Created
+
+202 ([Device](../devices-resources/device-v1alpha2#device)): Accepted
+
+### `update` replace the specified Device
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Device](../devices-resources/device-v1alpha2#device), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+201 ([Device](../devices-resources/device-v1alpha2#device)): Created
+
+### `update` replace status of the specified Device
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Device](../devices-resources/device-v1alpha2#device), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+201 ([Device](../devices-resources/device-v1alpha2#device)): Created
+
+### `patch` partially update the specified Device
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+201 ([Device](../devices-resources/device-v1alpha2#device)): Created
+
+### `patch` partially update status of the specified Device
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1alpha2#device)): OK
+
+201 ([Device](../devices-resources/device-v1alpha2#device)): Created
+
+### `delete` delete a Device
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of Device
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1alpha2/namespaces/{namespace}/devices
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/devices-resources/device-v1beta1.md b/docs/reference/kubeedge-api/devices-resources/device-v1beta1.md
new file mode 100644
index 0000000000..2c0d679fc4
--- /dev/null
+++ b/docs/reference/kubeedge-api/devices-resources/device-v1beta1.md
@@ -0,0 +1,876 @@
+---
+api_metadata:
+ apiVersion: "devices.kubeedge.io/v1beta1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/devices/v1beta1"
+ kind: "Device"
+content_type: "api_reference"
+description: "Device is the Schema for the devices API."
+title: "Device v1beta1"
+weight: 2
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: devices.kubeedge.io/v1beta1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/devices/v1beta1"`
+
+## Device
+
+Device is the Schema for the devices API
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1beta1
+
+- **kind**: Device
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([DeviceSpec](../devices-resources/device-v1beta1#devicespec))
+
+- **status** ([DeviceStatus](../devices-resources/device-v1beta1#devicestatus))
+
+## DeviceSpec
+
+DeviceSpec represents a single device instance.
+
+
+
+- **deviceModelRef** (LocalObjectReference)
+
+ Required: DeviceModelRef is reference to the device model used as a template to create the device instance.
+
+
+
+ *LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.*
+
+ - **deviceModelRef.name** (string)
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+- **nodeName** (string)
+
+ NodeName is a request to schedule this device onto a specific node. If it is non-empty, the scheduler simply schedules this device onto that node, assuming that it fits resource requirements.
+
+- **properties** ([]DeviceProperty)
+
+ List of properties which describe the device properties. properties list item must be unique by properties.Name.
+
+
+
+ *DeviceProperty describes the specifics all the properties of the device.*
+
+ - **properties.collectCycle** (int64)
+
+ Define how frequent mapper will collect from device.
+
+ - **properties.desired** (TwinProperty)
+
+ The desired property value.
+
+
+
+ *TwinProperty represents the device property for which an Expected/Actual state can be defined.*
+
+ - **properties.desired.value** (string), required
+
+ Required: The value for this property.
+
+ - **properties.desired.metadata** (map[string]string)
+
+ Additional metadata like timestamp when the value was reported etc.
+
+ - **properties.name** (string)
+
+ Required: The device property name to be accessed. It must be unique. Note: If you need to use the built-in stream data processing function, you need to define Name as saveFrame or saveVideo
+
+ - **properties.pushMethod** (PushMethod)
+
+ PushMethod represents the protocol used to push data, please ensure that the mapper can access the destination address.
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod** (DBMethodConfig)
+
+ DBMethod represents the method used to push data to database, please ensure that the mapper can access the destination address.
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.TDEngine** (DBMethodTDEngine)
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.TDEngine.TDEngineClientConfig** (TDEngineClientConfig)
+
+ tdengineClientConfig of tdengine database
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.TDEngine.TDEngineClientConfig.addr** (string)
+
+ addr of tdEngine database
+
+ - **properties.pushMethod.dbMethod.TDEngine.TDEngineClientConfig.dbName** (string)
+
+ dbname of tdEngine database
+
+ - **properties.pushMethod.dbMethod.influxdb2** (DBMethodInfluxdb2)
+
+ method configuration for database
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2ClientConfig** (Influxdb2ClientConfig)
+
+ Config of influx database
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2ClientConfig.bucket** (string)
+
+ Bucket of the user in influx database
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2ClientConfig.org** (string)
+
+ Org of the user in influx database
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2ClientConfig.url** (string)
+
+ Url of influx database
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2DataConfig** (Influxdb2DataConfig)
+
+ config of device data when push to influx database
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2DataConfig.fieldKey** (string)
+
+ FieldKey of the user data
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2DataConfig.measurement** (string)
+
+ Measurement of the user data
+
+ - **properties.pushMethod.dbMethod.influxdb2.influxdb2DataConfig.tag** (map[string]string)
+
+ the tag of device data
+
+ - **properties.pushMethod.dbMethod.mysql** (DBMethodMySQL)
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.mysql.mysqlClientConfig** (MySQLClientConfig)
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.mysql.mysqlClientConfig.addr** (string)
+
+ mysql address,like localhost:3306
+
+ - **properties.pushMethod.dbMethod.mysql.mysqlClientConfig.database** (string)
+
+ database name
+
+ - **properties.pushMethod.dbMethod.mysql.mysqlClientConfig.userName** (string)
+
+ user name
+
+ - **properties.pushMethod.dbMethod.redis** (DBMethodRedis)
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.redis.redisClientConfig** (RedisClientConfig)
+
+ RedisClientConfig of redis database
+
+
+
+ **
+
+ - **properties.pushMethod.dbMethod.redis.redisClientConfig.addr** (string)
+
+ Addr of Redis database
+
+ - **properties.pushMethod.dbMethod.redis.redisClientConfig.db** (int32)
+
+ Db of Redis database
+
+ - **properties.pushMethod.dbMethod.redis.redisClientConfig.minIdleConns** (int32)
+
+ MinIdleConns of Redis database
+
+ - **properties.pushMethod.dbMethod.redis.redisClientConfig.poolsize** (int32)
+
+ Poolsize of Redis database
+
+ - **properties.pushMethod.http** (PushMethodHTTP)
+
+ HTTP Push method configuration for http
+
+
+
+ **
+
+ - **properties.pushMethod.http.hostName** (string)
+
+ - **properties.pushMethod.http.port** (int64)
+
+ - **properties.pushMethod.http.requestPath** (string)
+
+ - **properties.pushMethod.http.timeout** (int64)
+
+ - **properties.pushMethod.mqtt** (PushMethodMQTT)
+
+ MQTT Push method configuration for mqtt
+
+
+
+ **
+
+ - **properties.pushMethod.mqtt.address** (string)
+
+ broker address, like mqtt://127.0.0.1:1883
+
+ - **properties.pushMethod.mqtt.qos** (int32)
+
+ qos of mqtt publish param
+
+ - **properties.pushMethod.mqtt.retained** (boolean)
+
+ Is the message retained
+
+ - **properties.pushMethod.mqtt.topic** (string)
+
+ publish topic for mqtt
+
+ - **properties.reportCycle** (int64)
+
+ Define how frequent mapper will report the value.
+
+ - **properties.reportToCloud** (boolean)
+
+ whether be reported to the cloud
+
+ - **properties.visitors** (VisitorConfig)
+
+ Visitors are intended to be consumed by device mappers which connect to devices and collect data / perform actions on the device. Required: Protocol relevant config details about the how to access the device property.
+
+
+
+ **
+
+ - **properties.visitors.configData** (CustomizedValue)
+
+ Required: The configData of customized protocol
+
+
+
+ *CustomizedValue contains a map type data*
+
+ - **properties.visitors.protocolName** (string)
+
+ Required: name of customized protocol
+
+- **protocol** (ProtocolConfig)
+
+ Required: The protocol configuration used to connect to the device.
+
+
+
+ **
+
+ - **protocol.configData** (CustomizedValue)
+
+ Any config data
+
+
+
+ *CustomizedValue contains a map type data*
+
+ - **protocol.protocolName** (string)
+
+ Unique protocol name Required.
+
+## DeviceStatus
+
+DeviceStatus reports the device state and the desired/reported values of twin attributes.
+
+
+
+- **twins** ([]Twin)
+
+ A list of device twins containing desired/reported desired/reported values of twin properties. Optional: A passive device won't have twin properties and this list could be empty.
+
+
+
+ *Twin provides a logical representation of control properties (writable properties in the device model). The properties can have a Desired state and a Reported state. The cloud configures the `Desired`state of a device property and this configuration update is pushed to the edge node. The mapper sends a command to the device to change this property value as per the desired state . It receives the `Reported` state of the property once the previous operation is complete and sends the reported state to the cloud. Offline device interaction in the edge is possible via twin properties for control/command operations.*
+
+ - **twins.observedDesired** (TwinProperty)
+
+ The meaning of here is to indicate desired value of `deviceProperty.Desired` that the mapper has received in current cycle. Useful in cases that people want to check whether the mapper is working appropriately and its internal status is up-to-date. This value should be only updated by devicecontroller upstream.
+
+
+
+ *TwinProperty represents the device property for which an Expected/Actual state can be defined.*
+
+ - **twins.observedDesired.value** (string), required
+
+ Required: The value for this property.
+
+ - **twins.observedDesired.metadata** (map[string]string)
+
+ Additional metadata like timestamp when the value was reported etc.
+
+ - **twins.propertyName** (string)
+
+ Required: The property name for which the desired/reported values are specified. This property should be present in the device model.
+
+ - **twins.reported** (TwinProperty)
+
+ Required: the reported property value.
+
+
+
+ *TwinProperty represents the device property for which an Expected/Actual state can be defined.*
+
+ - **twins.reported.value** (string), required
+
+ Required: The value for this property.
+
+ - **twins.reported.metadata** (map[string]string)
+
+ Additional metadata like timestamp when the value was reported etc.
+
+## DeviceList
+
+DeviceList contains a list of Device
+
+
+
+- **apiVersion**: devices.kubeedge.io/v1beta1
+
+- **kind**: DeviceList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][Device](../devices-resources/device-v1beta1#device)), required
+
+## Operations
+
+
+
+### `get` read the specified Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+### `get` read status of the specified Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+### `list` list or watch objects of kind Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceList](../devices-resources/device-v1beta1#devicelist)): OK
+
+### `list` list or watch objects of kind Device
+
+#### HTTP Request
+
+GET /apis/devices.kubeedge.io/v1beta1/devices
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([DeviceList](../devices-resources/device-v1beta1#devicelist)): OK
+
+### `create` create a Device
+
+#### HTTP Request
+
+POST /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Device](../devices-resources/device-v1beta1#device), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+201 ([Device](../devices-resources/device-v1beta1#device)): Created
+
+202 ([Device](../devices-resources/device-v1beta1#device)): Accepted
+
+### `update` replace the specified Device
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Device](../devices-resources/device-v1beta1#device), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+201 ([Device](../devices-resources/device-v1beta1#device)): Created
+
+### `update` replace status of the specified Device
+
+#### HTTP Request
+
+PUT /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Device](../devices-resources/device-v1beta1#device), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+201 ([Device](../devices-resources/device-v1beta1#device)): Created
+
+### `patch` partially update the specified Device
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+201 ([Device](../devices-resources/device-v1beta1#device)): Created
+
+### `patch` partially update status of the specified Device
+
+#### HTTP Request
+
+PATCH /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Device](../devices-resources/device-v1beta1#device)): OK
+
+201 ([Device](../devices-resources/device-v1beta1#device)): Created
+
+### `delete` delete a Device
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Device
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of Device
+
+#### HTTP Request
+
+DELETE /apis/devices.kubeedge.io/v1beta1/namespaces/{namespace}/devices
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/operations-resources/_category_.json b/docs/reference/kubeedge-api/operations-resources/_category_.json
new file mode 100644
index 0000000000..4cf6463860
--- /dev/null
+++ b/docs/reference/kubeedge-api/operations-resources/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Operations Resources",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/operations-resources/image-pre-pull-job-v1alpha1.md b/docs/reference/kubeedge-api/operations-resources/image-pre-pull-job-v1alpha1.md
new file mode 100644
index 0000000000..d7e60acc74
--- /dev/null
+++ b/docs/reference/kubeedge-api/operations-resources/image-pre-pull-job-v1alpha1.md
@@ -0,0 +1,592 @@
+---
+api_metadata:
+ apiVersion: "operations.kubeedge.io/v1alpha1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/operations/v1alpha1"
+ kind: "ImagePrePullJob"
+content_type: "api_reference"
+description: "ImagePrePullJob is used to prepull images on edge node."
+title: "ImagePrePullJob v1alpha1"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: operations.kubeedge.io/v1alpha1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/operations/v1alpha1"`
+
+## ImagePrePullJob
+
+ImagePrePullJob is used to prepull images on edge node.
+
+
+
+- **apiVersion**: operations.kubeedge.io/v1alpha1
+
+- **kind**: ImagePrePullJob
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([ImagePrePullJobSpec](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljobspec)), required
+
+ Spec represents the specification of the desired behavior of ImagePrePullJob.
+
+- **status** ([ImagePrePullJobStatus](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljobstatus))
+
+ Status represents the status of ImagePrePullJob.
+
+## ImagePrePullJobSpec
+
+ImagePrePullSpec represents the specification of the desired behavior of ImagePrePullJob.
+
+
+
+- **imagePrePullTemplate** (ImagePrePullTemplate)
+
+ ImagePrepullTemplate represents original templates of imagePrePull
+
+
+
+ *ImagePrePullTemplate represents original templates of imagePrePull*
+
+ - **imagePrePullTemplate.checkItems** ([]string)
+
+ CheckItems specifies the items need to be checked before the task is executed. The default CheckItems value is disk.
+
+ - **imagePrePullTemplate.concurrency** (int32)
+
+ Concurrency specifies the maximum number of edge nodes that can pull images at the same time. The default Concurrency value is 1.
+
+ - **imagePrePullTemplate.failureTolerate** (string)
+
+ FailureTolerate specifies the task tolerance failure ratio. The default FailureTolerate value is 0.1.
+
+ - **imagePrePullTemplate.imageSecrets** (string)
+
+ ImageSecret specifies the secret for image pull if private registry used. Use [namespace]/[secretName] in format.
+
+ - **imagePrePullTemplate.images** ([]string)
+
+ Images is the image list to be prepull
+
+ - **imagePrePullTemplate.labelSelector** ([LabelSelector](../common-definitions/label-selector#labelselector))
+
+ LabelSelector is a filter to select member clusters by labels. It must match a node's labels for the NodeUpgradeJob to be operated on that node. Please note that sets of NodeNames and LabelSelector are ORed. Users must set one and can only set one.
+
+ - **imagePrePullTemplate.nodeNames** ([]string)
+
+ NodeNames is a request to select some specific nodes. If it is non-empty, the upgrade job simply select these edge nodes to do upgrade operation. Please note that sets of NodeNames and LabelSelector are ORed. Users must set one and can only set one.
+
+ - **imagePrePullTemplate.retryTimes** (int32)
+
+ RetryTimes specifies the retry times if image pull failed on each edgenode. Default to 0
+
+ - **imagePrePullTemplate.timeoutSeconds** (int64)
+
+ TimeoutSeconds limits the duration of the node prepull job on each edgenode. Default to 300. If set to 0, we'll use the default value 300.
+
+## ImagePrePullJobStatus
+
+ImagePrePullJobStatus stores the status of ImagePrePullJob. contains images prepull status on multiple edge nodes.
+
+
+
+- **action** (string)
+
+ Action represents for the action of the ImagePrePullJob. There are two possible action values: Success, Failure.
+
+- **event** (string)
+
+ Event represents for the event of the ImagePrePullJob. There are four possible event values: Init, Check, Pull, TimeOut.
+
+- **reason** (string)
+
+ Reason represents for the reason of the ImagePrePullJob.
+
+- **state** (string)
+
+ State represents for the state phase of the ImagePrePullJob. There are five possible state values: "", checking, pulling, successful, failed.
+
+- **status** ([]ImagePrePullStatus)
+
+ Status contains image prepull status for each edge node.
+
+
+
+ *ImagePrePullStatus stores image prepull status for each edge node.*
+
+ - **status.imageStatus** ([]ImageStatus)
+
+ ImageStatus represents the prepull status for each image
+
+
+
+ *ImageStatus stores the prepull status for each image.*
+
+ - **status.imageStatus.image** (string)
+
+ Image is the name of the image
+
+ - **status.imageStatus.reason** (string)
+
+ Reason represents the fail reason if image pull failed
+
+ - **status.imageStatus.state** (string)
+
+ State represents for the state phase of this image pull on the edge node There are two possible state values: successful, failed.
+
+ - **status.nodeStatus** (TaskStatus)
+
+ TaskStatus represents the status for each node
+
+
+
+ *TaskStatus stores the status of Upgrade for each edge node.*
+
+ - **status.nodeStatus.action** (string)
+
+ Action represents for the action of the ImagePrePullJob. There are three possible action values: Success, Failure, TimeOut.
+
+ - **status.nodeStatus.event** (string)
+
+ Event represents for the event of the ImagePrePullJob. There are three possible event values: Init, Check, Pull.
+
+ - **status.nodeStatus.nodeName** (string)
+
+ NodeName is the name of edge node.
+
+ - **status.nodeStatus.reason** (string)
+
+ Reason represents for the reason of the ImagePrePullJob.
+
+ - **status.nodeStatus.state** (string)
+
+ State represents for the upgrade state phase of the edge node. There are several possible state values: "", Upgrading, BackingUp, RollingBack and Checking.
+
+ - **status.nodeStatus.time** (string)
+
+ Time represents for the running time of the ImagePrePullJob.
+
+- **time** (string)
+
+ Time represents for the running time of the ImagePrePullJob.
+
+## ImagePrePullJobList
+
+ImagePrePullJobList is a list of ImagePrePullJob.
+
+
+
+- **apiVersion**: operations.kubeedge.io/v1alpha1
+
+- **kind**: ImagePrePullJobList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+ Standard list metadata.
+
+- **items** ([][ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)), required
+
+ List of ImagePrePullJob.
+
+## Operations
+
+
+
+### `get` read the specified ImagePrePullJob
+
+#### HTTP Request
+
+GET /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+### `get` read status of the specified ImagePrePullJob
+
+#### HTTP Request
+
+GET /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+### `list` list or watch objects of kind ImagePrePullJob
+
+#### HTTP Request
+
+GET /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([ImagePrePullJobList](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljoblist)): OK
+
+### `create` create an ImagePrePullJob
+
+#### HTTP Request
+
+POST /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs
+
+#### Parameters
+
+- **body**: [ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+201 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): Created
+
+202 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): Accepted
+
+### `update` replace the specified ImagePrePullJob
+
+#### HTTP Request
+
+PUT /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **body**: [ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+201 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): Created
+
+### `update` replace status of the specified ImagePrePullJob
+
+#### HTTP Request
+
+PUT /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **body**: [ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+201 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): Created
+
+### `patch` partially update the specified ImagePrePullJob
+
+#### HTTP Request
+
+PATCH /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+201 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): Created
+
+### `patch` partially update status of the specified ImagePrePullJob
+
+#### HTTP Request
+
+PATCH /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): OK
+
+201 ([ImagePrePullJob](../operations-resources/image-pre-pull-job-v1alpha1#imageprepulljob)): Created
+
+### `delete` delete an ImagePrePullJob
+
+#### HTTP Request
+
+DELETE /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ImagePrePullJob
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of ImagePrePullJob
+
+#### HTTP Request
+
+DELETE /apis/operations.kubeedge.io/v1alpha1/imageprepulljobs
+
+#### Parameters
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/operations-resources/node-upgrade-job-v1alpha1.md b/docs/reference/kubeedge-api/operations-resources/node-upgrade-job-v1alpha1.md
new file mode 100644
index 0000000000..9865f2a152
--- /dev/null
+++ b/docs/reference/kubeedge-api/operations-resources/node-upgrade-job-v1alpha1.md
@@ -0,0 +1,558 @@
+---
+api_metadata:
+ apiVersion: "operations.kubeedge.io/v1alpha1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/operations/v1alpha1"
+ kind: "NodeUpgradeJob"
+content_type: "api_reference"
+description: "NodeUpgradeJob is used to upgrade edge node from cloud side."
+title: "NodeUpgradeJob v1alpha1"
+weight: 2
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: operations.kubeedge.io/v1alpha1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/operations/v1alpha1"`
+
+## NodeUpgradeJob
+
+NodeUpgradeJob is used to upgrade edge node from cloud side.
+
+
+
+- **apiVersion**: operations.kubeedge.io/v1alpha1
+
+- **kind**: NodeUpgradeJob
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([NodeUpgradeJobSpec](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejobspec))
+
+ Specification of the desired behavior of NodeUpgradeJob.
+
+- **status** ([NodeUpgradeJobStatus](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejobstatus))
+
+ Most recently observed status of the NodeUpgradeJob.
+
+## NodeUpgradeJobSpec
+
+NodeUpgradeJobSpec is the specification of the desired behavior of the NodeUpgradeJob.
+
+
+
+- **checkItems** ([]string)
+
+ CheckItems specifies the items need to be checked before the task is executed. The default CheckItems value is nil.
+
+- **concurrency** (int32)
+
+ Concurrency specifies the max number of edge nodes that can be upgraded at the same time. The default Concurrency value is 1.
+
+- **failureTolerate** (string)
+
+ FailureTolerate specifies the task tolerance failure ratio. The default FailureTolerate value is 0.1.
+
+- **image** (string)
+
+ Image specifies a container image name, the image contains: keadm and edgecore. keadm is used as upgradetool, to install the new version of edgecore. The image name consists of registry hostname and repository name, if it includes the tag or digest, the tag or digest will be overwritten by Version field above. If the registry hostname is empty, docker.io will be used as default. The default image name is: kubeedge/installation-package.
+
+- **labelSelector** ([LabelSelector](../common-definitions/label-selector#labelselector))
+
+ LabelSelector is a filter to select member clusters by labels. It must match a node's labels for the NodeUpgradeJob to be operated on that node. Please note that sets of NodeNames and LabelSelector are ORed. Users must set one and can only set one.
+
+- **nodeNames** ([]string)
+
+ NodeNames is a request to select some specific nodes. If it is non-empty, the upgrade job simply select these edge nodes to do upgrade operation. Please note that sets of NodeNames and LabelSelector are ORed. Users must set one and can only set one.
+
+- **timeoutSeconds** (int64)
+
+ TimeoutSeconds limits the duration of the node upgrade job. Default to 300. If set to 0, we'll use the default value 300.
+
+- **version** (string)
+
+## NodeUpgradeJobStatus
+
+NodeUpgradeJobStatus stores the status of NodeUpgradeJob. contains multiple edge nodes upgrade status.
+
+
+
+- **action** (string)
+
+ Action represents for the action of the ImagePrePullJob. There are two possible action values: Success, Failure.
+
+- **currentVersion** (string)
+
+ CurrentVersion represents for the current status of the EdgeCore.
+
+- **event** (string)
+
+ Event represents for the event of the ImagePrePullJob. There are six possible event values: Init, Check, BackUp, Upgrade, TimeOut, Rollback.
+
+- **historicVersion** (string)
+
+ HistoricVersion represents for the historic status of the EdgeCore.
+
+- **nodeStatus** ([]TaskStatus)
+
+ Status contains upgrade Status for each edge node.
+
+
+
+ *TaskStatus stores the status of Upgrade for each edge node.*
+
+ - **nodeStatus.action** (string)
+
+ Action represents for the action of the ImagePrePullJob. There are three possible action values: Success, Failure, TimeOut.
+
+ - **nodeStatus.event** (string)
+
+ Event represents for the event of the ImagePrePullJob. There are three possible event values: Init, Check, Pull.
+
+ - **nodeStatus.nodeName** (string)
+
+ NodeName is the name of edge node.
+
+ - **nodeStatus.reason** (string)
+
+ Reason represents for the reason of the ImagePrePullJob.
+
+ - **nodeStatus.state** (string)
+
+ State represents for the upgrade state phase of the edge node. There are several possible state values: "", Upgrading, BackingUp, RollingBack and Checking.
+
+ - **nodeStatus.time** (string)
+
+ Time represents for the running time of the ImagePrePullJob.
+
+- **reason** (string)
+
+ Reason represents for the reason of the ImagePrePullJob.
+
+- **state** (string)
+
+ State represents for the state phase of the NodeUpgradeJob. There are several possible state values: "", Upgrading, BackingUp, RollingBack and Checking.
+
+- **time** (string)
+
+ Time represents for the running time of the ImagePrePullJob.
+
+## NodeUpgradeJobList
+
+NodeUpgradeJobList is a list of NodeUpgradeJob.
+
+
+
+- **apiVersion**: operations.kubeedge.io/v1alpha1
+
+- **kind**: NodeUpgradeJobList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+ Standard list metadata.
+
+- **items** ([][NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)), required
+
+ List of NodeUpgradeJobs.
+
+## Operations
+
+
+
+### `get` read the specified NodeUpgradeJob
+
+#### HTTP Request
+
+GET /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+### `get` read status of the specified NodeUpgradeJob
+
+#### HTTP Request
+
+GET /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+### `list` list or watch objects of kind NodeUpgradeJob
+
+#### HTTP Request
+
+GET /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([NodeUpgradeJobList](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejoblist)): OK
+
+### `create` create a NodeUpgradeJob
+
+#### HTTP Request
+
+POST /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs
+
+#### Parameters
+
+- **body**: [NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+201 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): Created
+
+202 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): Accepted
+
+### `update` replace the specified NodeUpgradeJob
+
+#### HTTP Request
+
+PUT /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **body**: [NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+201 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): Created
+
+### `update` replace status of the specified NodeUpgradeJob
+
+#### HTTP Request
+
+PUT /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **body**: [NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+201 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): Created
+
+### `patch` partially update the specified NodeUpgradeJob
+
+#### HTTP Request
+
+PATCH /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+201 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): Created
+
+### `patch` partially update status of the specified NodeUpgradeJob
+
+#### HTTP Request
+
+PATCH /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): OK
+
+201 ([NodeUpgradeJob](../operations-resources/node-upgrade-job-v1alpha1#nodeupgradejob)): Created
+
+### `delete` delete a NodeUpgradeJob
+
+#### HTTP Request
+
+DELETE /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the NodeUpgradeJob
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of NodeUpgradeJob
+
+#### HTTP Request
+
+DELETE /apis/operations.kubeedge.io/v1alpha1/nodeupgradejobs
+
+#### Parameters
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/policy-resources/_category_.json b/docs/reference/kubeedge-api/policy-resources/_category_.json
new file mode 100644
index 0000000000..baf17b7521
--- /dev/null
+++ b/docs/reference/kubeedge-api/policy-resources/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Policy Resources",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/policy-resources/service-account-access-v1alpha1.md b/docs/reference/kubeedge-api/policy-resources/service-account-access-v1alpha1.md
new file mode 100644
index 0000000000..178185cbff
--- /dev/null
+++ b/docs/reference/kubeedge-api/policy-resources/service-account-access-v1alpha1.md
@@ -0,0 +1,838 @@
+---
+api_metadata:
+ apiVersion: "policy.kubeedge.io/v1alpha1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/policy/v1alpha1"
+ kind: "ServiceAccountAccess"
+content_type: "api_reference"
+description: "ServiceAccountAccess is the Schema for the ServiceAccountAccess API."
+title: "ServiceAccountAccess v1alpha1"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: policy.kubeedge.io/v1alpha1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/policy/v1alpha1"`
+
+## ServiceAccountAccess
+
+ServiceAccountAccess is the Schema for the ServiceAccountAccess API
+
+
+
+- **apiVersion**: policy.kubeedge.io/v1alpha1
+
+- **kind**: ServiceAccountAccess
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** (AccessSpec)
+
+ Spec represents the specification of rbac.
+
+
+
+ *AccessSpec defines the desired state of AccessSpec*
+
+ - **spec.accessClusterRoleBinding** ([]AccessClusterRoleBinding)
+
+ AccessClusterRoleBinding represents rbac ClusterRoleBinding plus detailed ClusterRole info.
+
+
+
+ *AccessClusterRoleBinding represents rbac ClusterRoleBinding plus detailed ClusterRole info.*
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding** (ClusterRoleBinding)
+
+ ClusterRoleBinding represents rbac ClusterRoleBinding.
+
+
+
+ *ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.*
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.roleRef** (RoleRef), required
+
+ RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable.
+
+
+
+ *RoleRef contains information that points to the role being used*
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.roleRef.apiGroup** (string), required
+
+ APIGroup is the group for the resource being referenced
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.roleRef.kind** (string), required
+
+ Kind is the type of resource being referenced
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.roleRef.name** (string), required
+
+ Name is the name of resource being referenced
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.apiVersion** (string)
+
+ APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.kind** (string)
+
+ Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+ Standard object's metadata.
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.subjects** ([]Subject)
+
+ Subjects holds references to the objects the role applies to.
+
+
+
+ *Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.*
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.subjects.kind** (string), required
+
+ Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.subjects.name** (string), required
+
+ Name of the object being referenced.
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.subjects.apiGroup** (string)
+
+ APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
+
+ - **spec.accessClusterRoleBinding.clusterRoleBinding.subjects.namespace** (string)
+
+ Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
+ - **spec.accessClusterRoleBinding.rules** ([]PolicyRule)
+
+ Rules contains role rules.
+
+
+
+ *PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.*
+
+ - **spec.accessClusterRoleBinding.rules.verbs** ([]string), required
+
+ Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
+
+ - **spec.accessClusterRoleBinding.rules.apiGroups** ([]string)
+
+ APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
+
+ - **spec.accessClusterRoleBinding.rules.nonResourceURLs** ([]string)
+
+ NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
+
+ - **spec.accessClusterRoleBinding.rules.resourceNames** ([]string)
+
+ ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
+
+ - **spec.accessClusterRoleBinding.rules.resources** ([]string)
+
+ Resources is a list of resources this rule applies to. '*' represents all resources.
+
+ - **spec.accessRoleBinding** ([]AccessRoleBinding)
+
+ AccessRoleBinding represents rbac rolebinding plus detailed role info.
+
+
+
+ *AccessRoleBinding represents rbac rolebinding plus detailed role info.*
+
+ - **spec.accessRoleBinding.roleBinding** (RoleBinding)
+
+ RoleBinding represents rbac rolebinding.
+
+
+
+ *RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.*
+
+ - **spec.accessRoleBinding.roleBinding.roleRef** (RoleRef), required
+
+ RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable.
+
+
+
+ *RoleRef contains information that points to the role being used*
+
+ - **spec.accessRoleBinding.roleBinding.roleRef.apiGroup** (string), required
+
+ APIGroup is the group for the resource being referenced
+
+ - **spec.accessRoleBinding.roleBinding.roleRef.kind** (string), required
+
+ Kind is the type of resource being referenced
+
+ - **spec.accessRoleBinding.roleBinding.roleRef.name** (string), required
+
+ Name is the name of resource being referenced
+
+ - **spec.accessRoleBinding.roleBinding.apiVersion** (string)
+
+ APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+
+ - **spec.accessRoleBinding.roleBinding.kind** (string)
+
+ Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+ - **spec.accessRoleBinding.roleBinding.metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+ Standard object's metadata.
+
+ - **spec.accessRoleBinding.roleBinding.subjects** ([]Subject)
+
+ Subjects holds references to the objects the role applies to.
+
+
+
+ *Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.*
+
+ - **spec.accessRoleBinding.roleBinding.subjects.kind** (string), required
+
+ Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
+
+ - **spec.accessRoleBinding.roleBinding.subjects.name** (string), required
+
+ Name of the object being referenced.
+
+ - **spec.accessRoleBinding.roleBinding.subjects.apiGroup** (string)
+
+ APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
+
+ - **spec.accessRoleBinding.roleBinding.subjects.namespace** (string)
+
+ Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
+ - **spec.accessRoleBinding.rules** ([]PolicyRule)
+
+ Rules contains role rules.
+
+
+
+ *PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.*
+
+ - **spec.accessRoleBinding.rules.verbs** ([]string), required
+
+ Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
+
+ - **spec.accessRoleBinding.rules.apiGroups** ([]string)
+
+ APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
+
+ - **spec.accessRoleBinding.rules.nonResourceURLs** ([]string)
+
+ NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
+
+ - **spec.accessRoleBinding.rules.resourceNames** ([]string)
+
+ ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
+
+ - **spec.accessRoleBinding.rules.resources** ([]string)
+
+ Resources is a list of resources this rule applies to. '*' represents all resources.
+
+ - **spec.serviceAccount** (ServiceAccount)
+
+ ServiceAccount is one-to-one corresponding relations with the serviceaccountaccess.
+
+
+
+ *ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets*
+
+ - **spec.serviceAccount.apiVersion** (string)
+
+ APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+
+ - **spec.serviceAccount.automountServiceAccountToken** (boolean)
+
+ AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
+
+ - **spec.serviceAccount.imagePullSecrets** ([]LocalObjectReference)
+
+ ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
+
+
+
+ *LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.*
+
+ - **spec.serviceAccount.imagePullSecrets.name** (string)
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ - **spec.serviceAccount.kind** (string)
+
+ Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+ - **spec.serviceAccount.metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+ Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+
+ - **spec.serviceAccount.secrets** ([]ObjectReference)
+
+ *Patch strategy: merge on key `name`*
+
+ Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
+
+
+
+ *ObjectReference contains enough information to let you inspect or modify the referred object.*
+
+ - **spec.serviceAccount.secrets.apiVersion** (string)
+
+ API version of the referent.
+
+ - **spec.serviceAccount.secrets.fieldPath** (string)
+
+ If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers[name]" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
+
+ - **spec.serviceAccount.secrets.kind** (string)
+
+ Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+
+ - **spec.serviceAccount.secrets.name** (string)
+
+ Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ - **spec.serviceAccount.secrets.namespace** (string)
+
+ Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+
+ - **spec.serviceAccount.secrets.resourceVersion** (string)
+
+ Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+
+ - **spec.serviceAccount.secrets.uid** (string)
+
+ UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+
+ - **spec.serviceAccountUid** (string)
+
+ ServiceAccountUID is the uid of serviceaccount.
+
+- **status** (AccessStatus)
+
+ Status represents the node list which store the rules.
+
+
+
+ *AccessStatus defines the observed state of ServiceAccountAccess*
+
+ - **status.nodeList** ([]string)
+
+ NodeList represents the node name which store the rules.
+
+## ServiceAccountAccessList
+
+ServiceAccountAccessList contains a list of ServiceAccountAccess
+
+
+
+- **apiVersion**: policy.kubeedge.io/v1alpha1
+
+- **kind**: ServiceAccountAccessList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)), required
+
+## Operations
+
+
+
+### `get` read the specified ServiceAccountAccess
+
+#### HTTP Request
+
+GET /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+### `get` read status of the specified ServiceAccountAccess
+
+#### HTTP Request
+
+GET /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+### `list` list or watch objects of kind ServiceAccountAccess
+
+#### HTTP Request
+
+GET /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([ServiceAccountAccessList](../policy-resources/service-account-access-v1alpha1#serviceaccountaccesslist)): OK
+
+### `list` list or watch objects of kind ServiceAccountAccess
+
+#### HTTP Request
+
+GET /apis/policy.kubeedge.io/v1alpha1/serviceaccountaccesses
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([ServiceAccountAccessList](../policy-resources/service-account-access-v1alpha1#serviceaccountaccesslist)): OK
+
+### `create` create a ServiceAccountAccess
+
+#### HTTP Request
+
+POST /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+201 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): Created
+
+202 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): Accepted
+
+### `update` replace the specified ServiceAccountAccess
+
+#### HTTP Request
+
+PUT /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+201 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): Created
+
+### `update` replace status of the specified ServiceAccountAccess
+
+#### HTTP Request
+
+PUT /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+201 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): Created
+
+### `patch` partially update the specified ServiceAccountAccess
+
+#### HTTP Request
+
+PATCH /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+201 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): Created
+
+### `patch` partially update status of the specified ServiceAccountAccess
+
+#### HTTP Request
+
+PATCH /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): OK
+
+201 ([ServiceAccountAccess](../policy-resources/service-account-access-v1alpha1#serviceaccountaccess)): Created
+
+### `delete` delete a ServiceAccountAccess
+
+#### HTTP Request
+
+DELETE /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ServiceAccountAccess
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of ServiceAccountAccess
+
+#### HTTP Request
+
+DELETE /apis/policy.kubeedge.io/v1alpha1/namespaces/{namespace}/serviceaccountaccesses
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/reliable-syncs-resources/_category_.json b/docs/reference/kubeedge-api/reliable-syncs-resources/_category_.json
new file mode 100644
index 0000000000..5e548ffade
--- /dev/null
+++ b/docs/reference/kubeedge-api/reliable-syncs-resources/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Reliable Syncs Resources",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/reliable-syncs-resources/object-sync-v1alpha1.md b/docs/reference/kubeedge-api/reliable-syncs-resources/object-sync-v1alpha1.md
new file mode 100644
index 0000000000..cf67b89479
--- /dev/null
+++ b/docs/reference/kubeedge-api/reliable-syncs-resources/object-sync-v1alpha1.md
@@ -0,0 +1,578 @@
+---
+api_metadata:
+ apiVersion: "reliablesyncs.kubeedge.io/v1alpha1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/reliablesyncs/v1alpha1"
+ kind: "ObjectSync"
+content_type: "api_reference"
+description: "ObjectSync stores the state of the namespaced object that was successfully persisted to the edge node."
+title: "ObjectSync v1alpha1"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: reliablesyncs.kubeedge.io/v1alpha1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/reliablesyncs/v1alpha1"`
+
+## ObjectSync
+
+ObjectSync stores the state of the namespaced object that was successfully persisted to the edge node. ObjectSync name is a concatenation of the node name which receiving the object and the object UUID.
+
+
+
+- **apiVersion**: reliablesyncs.kubeedge.io/v1alpha1
+
+- **kind**: ObjectSync
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+ Standard Kubernetes object's metadata.
+
+- **spec** ([ObjectSyncSpec](../reliable-syncs-resources/object-sync-v1alpha1#objectsyncspec))
+
+- **status** ([ObjectSyncStatus](../reliable-syncs-resources/object-sync-v1alpha1#objectsyncstatus))
+
+## ObjectSyncSpec
+
+ObjectSyncSpec stores the details of objects that persist to the edge.
+
+
+
+- **objectAPIVersion** (string)
+
+ ObjectAPIVersion is the APIVersion of the object that was successfully persist to the edge node.
+
+- **objectKind** (string)
+
+ ObjectType is the kind of the object that was successfully persist to the edge node.
+
+- **objectName** (string)
+
+ ObjectName is the name of the object that was successfully persist to the edge node.
+
+## ObjectSyncStatus
+
+ObjectSyncStatus stores the resourceversion of objects that persist to the edge.
+
+
+
+- **objectResourceVersion** (string)
+
+ ObjectResourceVersion is the resourceversion of the object that was successfully persist to the edge node.
+
+## ObjectSyncList
+
+ObjectSyncList is a list of ObjectSync.
+
+
+
+- **apiVersion**: reliablesyncs.kubeedge.io/v1alpha1
+
+- **kind**: ObjectSyncList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+ Standard list metadata.
+
+- **items** ([][ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)), required
+
+ List of ObjectSync.
+
+## Operations
+
+
+
+### `get` read the specified ObjectSync
+
+#### HTTP Request
+
+GET /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+### `get` read status of the specified ObjectSync
+
+#### HTTP Request
+
+GET /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+### `list` list or watch objects of kind ObjectSync
+
+#### HTTP Request
+
+GET /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([ObjectSyncList](../reliable-syncs-resources/object-sync-v1alpha1#objectsynclist)): OK
+
+### `list` list or watch objects of kind ObjectSync
+
+#### HTTP Request
+
+GET /apis/reliablesyncs.kubeedge.io/v1alpha1/objectsyncs
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([ObjectSyncList](../reliable-syncs-resources/object-sync-v1alpha1#objectsynclist)): OK
+
+### `create` create an ObjectSync
+
+#### HTTP Request
+
+POST /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+201 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): Created
+
+202 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): Accepted
+
+### `update` replace the specified ObjectSync
+
+#### HTTP Request
+
+PUT /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+201 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): Created
+
+### `update` replace status of the specified ObjectSync
+
+#### HTTP Request
+
+PUT /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+201 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): Created
+
+### `patch` partially update the specified ObjectSync
+
+#### HTTP Request
+
+PATCH /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+201 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): Created
+
+### `patch` partially update status of the specified ObjectSync
+
+#### HTTP Request
+
+PATCH /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): OK
+
+201 ([ObjectSync](../reliable-syncs-resources/object-sync-v1alpha1#objectsync)): Created
+
+### `delete` delete an ObjectSync
+
+#### HTTP Request
+
+DELETE /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the ObjectSync
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of ObjectSync
+
+#### HTTP Request
+
+DELETE /apis/reliablesyncs.kubeedge.io/v1alpha1/namespaces/{namespace}/objectsyncs
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
diff --git a/docs/reference/kubeedge-api/rules-resources/_category_.json b/docs/reference/kubeedge-api/rules-resources/_category_.json
new file mode 100644
index 0000000000..bf388ad0c5
--- /dev/null
+++ b/docs/reference/kubeedge-api/rules-resources/_category_.json
@@ -0,0 +1,7 @@
+{
+ "label": "Rules Resources",
+ "position": 9,
+ "link": {
+ "type": "generated-index"
+ }
+}
diff --git a/docs/reference/kubeedge-api/rules-resources/rule-v1.md b/docs/reference/kubeedge-api/rules-resources/rule-v1.md
new file mode 100644
index 0000000000..16d9e56ecf
--- /dev/null
+++ b/docs/reference/kubeedge-api/rules-resources/rule-v1.md
@@ -0,0 +1,584 @@
+---
+api_metadata:
+ apiVersion: "rules.kubeedge.io/v1"
+ import: "github.com/kubeedge/kubeedge/pkg/apis/rules/v1"
+ kind: "Rule"
+content_type: "api_reference"
+description: "Rule is the Schema for the rules API."
+title: "Rule"
+weight: 1
+auto_generated: true
+---
+
+[//]: # (The file is auto-generated from the Go source code of the component using a generic generator,)
+[//]: # (which is forked from [reference-docs](https://github.com/kubernetes-sigs/reference-docs.)
+[//]: # (To update the reference content, please follow the `reference-api.sh`.)
+
+`apiVersion: rules.kubeedge.io/v1`
+
+`import "github.com/kubeedge/kubeedge/pkg/apis/rules/v1"`
+
+## Rule
+
+Rule is the Schema for the rules API
+
+
+
+- **apiVersion**: rules.kubeedge.io/v1
+
+- **kind**: Rule
+
+- **metadata** ([ObjectMeta](../common-definitions/object-meta#objectmeta))
+
+- **spec** ([RuleSpec](../rules-resources/rule-v1#rulespec)), required
+
+- **status** ([RuleStatus](../rules-resources/rule-v1#rulestatus))
+
+## RuleSpec
+
+RuleSpec defines rule of message delivery.
+
+
+
+- **source** (string), required
+
+ Source represents where the messages come from. Its value is the same with ruleendpoint name. For example, rest or eventbus.
+
+- **sourceResource** (map[string]string), required
+
+ SourceResource is a map representing the resource info of source. For rest ruleendpoint type its value is ["path":"/a/b"]. For eventbus ruleendpoint type its value is ["topic":"<user define string>","node_name":"xxxx"]
+
+- **target** (string), required
+
+ Target represents where the messages go to. its value is the same with ruleendpoint name. For example, eventbus or api or servicebus.
+
+- **targetResource** (map[string]string), required
+
+ targetResource is a map representing the resource info of target. For api ruleendpoint type its value is ["resource":"http://a.com"]. For eventbus ruleendpoint type its value is ["topic":"/xxxx"]. For servicebus ruleendpoint type its value is ["path":"/request_path"].
+
+## RuleStatus
+
+RuleStatus defines status of message delivery.
+
+
+
+- **errors** ([]string), required
+
+ Errors represents failed reasons of message delivery of rule.
+
+- **failMessages** (int64), required
+
+ FailMessages represents failed count of message delivery of rule.
+
+- **successMessages** (int64), required
+
+ SuccessMessages represents success count of message delivery of rule.
+
+## RuleList
+
+RuleList contains a list of Rule
+
+
+
+- **apiVersion**: rules.kubeedge.io/v1
+
+- **kind**: RuleList
+
+- **metadata** ([ListMeta](../common-definitions/list-meta#listmeta))
+
+- **items** ([][Rule](../rules-resources/rule-v1#rule)), required
+
+## Operations
+
+
+
+### `get` read the specified Rule
+
+#### HTTP Request
+
+GET /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+### `get` read status of the specified Rule
+
+#### HTTP Request
+
+GET /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+### `list` list or watch objects of kind Rule
+
+#### HTTP Request
+
+GET /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([RuleList](../rules-resources/rule-v1#rulelist)): OK
+
+### `list` list or watch objects of kind Rule
+
+#### HTTP Request
+
+GET /apis/rules.kubeedge.io/v1/rules
+
+#### Parameters
+
+- **allowWatchBookmarks** (*in query*): boolean
+
+ [allowWatchBookmarks](../common-parameter/common-parameters#allowwatchbookmarks)
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+- **watch** (*in query*): boolean
+
+ [watch](../common-parameter/common-parameters#watch)
+
+#### Response
+
+200 ([RuleList](../rules-resources/rule-v1#rulelist)): OK
+
+### `create` create a Rule
+
+#### HTTP Request
+
+POST /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Rule](../rules-resources/rule-v1#rule), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+201 ([Rule](../rules-resources/rule-v1#rule)): Created
+
+202 ([Rule](../rules-resources/rule-v1#rule)): Accepted
+
+### `update` replace the specified Rule
+
+#### HTTP Request
+
+PUT /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Rule](../rules-resources/rule-v1#rule), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+201 ([Rule](../rules-resources/rule-v1#rule)): Created
+
+### `update` replace status of the specified Rule
+
+#### HTTP Request
+
+PUT /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Rule](../rules-resources/rule-v1#rule), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+201 ([Rule](../rules-resources/rule-v1#rule)): Created
+
+### `patch` partially update the specified Rule
+
+#### HTTP Request
+
+PATCH /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+201 ([Rule](../rules-resources/rule-v1#rule)): Created
+
+### `patch` partially update status of the specified Rule
+
+#### HTTP Request
+
+PATCH /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}/status
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [Patch](../common-definitions/patch#patch), required
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldManager** (*in query*): string
+
+ [fieldManager](../common-parameter/common-parameters#fieldmanager)
+
+- **fieldValidation** (*in query*): string
+
+ [fieldValidation](../common-parameter/common-parameters#fieldvalidation)
+
+- **force** (*in query*): boolean
+
+ [force](../common-parameter/common-parameters#force)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+#### Response
+
+200 ([Rule](../rules-resources/rule-v1#rule)): OK
+
+201 ([Rule](../rules-resources/rule-v1#rule)): Created
+
+### `delete` delete a Rule
+
+#### HTTP Request
+
+DELETE /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules/{name}
+
+#### Parameters
+
+- **name** (*in path*): string, required
+
+ name of the Rule
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+
+202 ([Status](../common-definitions/status#status)): Accepted
+
+### `deletecollection` delete collection of Rule
+
+#### HTTP Request
+
+DELETE /apis/rules.kubeedge.io/v1/namespaces/{namespace}/rules
+
+#### Parameters
+
+- **namespace** (*in path*): string, required
+
+ [namespace](../common-parameter/common-parameters#namespace)
+
+- **body**: [DeleteOptions](../common-definitions/delete-options#deleteoptions)
+
+
+
+- **continue** (*in query*): string
+
+ [continue](../common-parameter/common-parameters#continue)
+
+- **dryRun** (*in query*): string
+
+ [dryRun](../common-parameter/common-parameters#dryrun)
+
+- **fieldSelector** (*in query*): string
+
+ [fieldSelector](../common-parameter/common-parameters#fieldselector)
+
+- **gracePeriodSeconds** (*in query*): integer
+
+ [gracePeriodSeconds](../common-parameter/common-parameters#graceperiodseconds)
+
+- **labelSelector** (*in query*): string
+
+ [labelSelector](../common-parameter/common-parameters#labelselector)
+
+- **limit** (*in query*): integer
+
+ [limit](../common-parameter/common-parameters#limit)
+
+- **pretty** (*in query*): string
+
+ [pretty](../common-parameter/common-parameters#pretty)
+
+- **propagationPolicy** (*in query*): string
+
+ [propagationPolicy](../common-parameter/common-parameters#propagationpolicy)
+
+- **resourceVersion** (*in query*): string
+
+ [resourceVersion](../common-parameter/common-parameters#resourceversion)
+
+- **resourceVersionMatch** (*in query*): string
+
+ [resourceVersionMatch](../common-parameter/common-parameters#resourceversionmatch)
+
+- **sendInitialEvents** (*in query*): boolean
+
+ [sendInitialEvents](../common-parameter/common-parameters#sendinitialevents)
+
+- **timeoutSeconds** (*in query*): integer
+
+ [timeoutSeconds](../common-parameter/common-parameters#timeoutseconds)
+
+#### Response
+
+200 ([Status](../common-definitions/status#status)): OK
+