OpenYurt

https://openyurt.io/docs/
Admin
OpenYurt is a non-intrusive edge computing platform that unifies the management of distributed edge...
Tokens:58,441
Snippets:679
Trust Score:7.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install DNS Utilities

Source: https://openyurt.io/docs/faq/prometheus

If the `dig` command is not available, install the necessary DNS toolkit. Use `apt` for Ubuntu or `yum` for CentOS.

```bash
$ apt install dnsutils #ubuntu system  
```

```bash
$ yum install bind-utils #centos system  
```

--------------------------------

### Build OpenYurt Images and Start Cluster

Source: https://openyurt.io/docs/developer-manuals/local-up-openyurt

These commands build the necessary OpenYurt component images and then start a local OpenYurt cluster. You can specify the number of nodes and disable the default CNI.

```bash
# build OpenYurt components images and startup a OpenYurt cluster  
make docker-build  
  
# startup a OpenYurt cluster based on prepared images  
NODES_NUM=5 DISABLE_DEFAULT_CNI=true make local-up-openyurt  
  
# run e2e test  
make e2e-tests  
```

--------------------------------

### Install yurt-iot-dock Helm Chart

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Install the yurt-iot-dock helm chart into your Kubernetes cluster before deploying yurt-iot-dock using PlatformAdmin.

```bash
helm install yurt-iot-dock ./charts/yurt-iot-dock  

```

--------------------------------

### NodePort Isolation Annotation Examples

Source: https://openyurt.io/docs/user-manuals/network/service/nodeport-isolation

These examples demonstrate various configurations for the `nodeport.openyurt.io/listen` annotation to control NodePort service listening behavior across different node pools.

```yaml
- `nodeport.openyurt.io/listen=foo, bar`: Enable NodePort service listening on nodes in `foo` and `bar` NodePools.

```

```yaml
- `nodeport.openyurt.io/listen=foo, *`: Enable NodePort service listening on nodes in all NodePools.

```

```yaml
- `nodeport.openyurt.io/listen=-foo, -bar`: Disable NodePort service listening on nodes in all NodePools.

```

```yaml
- `nodeport.openyurt.io/listen=-foo, *`: Disable NodePort service listening only on nodes in `foo` NodePool.

```

```yaml
- `nodeport.openyurt.io/listen=foo,-foo`: Enable NodePort service listening on nodes in `foo` NodePool.

```

```yaml
- `nodeport.openyurt.io/listen=-foo`: Disable NodePort service listening on nodes in all NodePools (including `foo` NodePool).

```

--------------------------------

### Install Raven Proxy DNS

Source: https://openyurt.io/docs/installation/raven-l7-proxy-prepare

Apply the configuration to install the raven-proxy-dns component. This is a prerequisite for enabling the Raven L7 proxy.

```bash
$ kubectl apply -f config/setup/raven-proxy-dns.yaml
```

--------------------------------

### Install node-resource-manager

Source: https://openyurt.io/docs/core-concepts/node-resource-manager

Applies the node-resource-manager deployment to the cluster using kubectl. Ensure you have kubectl configured to interact with your cluster.

```bash
kubectl apply -f https://raw.githubusercontent.com/openyurtio/node-resource-manager/main/deploy/nrm.yaml
```

--------------------------------

### List All Gateways

Source: https://openyurt.io/docs/user-manuals/network/raven

Get a summary list of all deployed Gateway resources, showing their names and age.

```bash
kubectl get gateways
```

--------------------------------

### Verify Raven Proxy DNS Installation

Source: https://openyurt.io/docs/installation/raven-l7-proxy-prepare

Check if the raven-proxy-dns pods have been successfully installed and are running in the kube-system namespace.

```bash
$ kubectl -n kube-system get po
```

--------------------------------

### Create Static Pod Manifest

Source: https://openyurt.io/docs/user-manuals/workload/yurt-static-set

Example of creating a static pod manifest file for Nginx using a simple Pod definition.

```yaml
cat >  nginx.yaml << EOF
apiVersion: v1
kind: Pod
metadata:
  name: nginx
spec:
  containers:
  - name: web
    image: nginx:1.19.1
EOF


```

--------------------------------

### Add GOPATH/bin to PATH

Source: https://openyurt.io/docs/developer-manuals/local-up-openyurt

Ensure that binaries installed via `go install`, such as `kind`, are accessible in your shell. This command adds the Go binary directory to your system's PATH.

```bash
export PATH="$(go env GOPATH)/bin:$PATH"
```

--------------------------------

### Check Kubelet Logs for Yurthub Startup Issues

Source: https://openyurt.io/docs/faq/yurthub

If no Yurthub containers are in an exited state, examine the Kubelet logs for clues about why Yurthub failed to start.

```bash
journalctl -u kubelet
```

--------------------------------

### Node1 Host Network Configuration Example

Source: https://openyurt.io/docs/user-manuals/network/container-network/flannel

This illustrates the host network configuration on node1, which uses information from node2's annotations to set up forwarding rules (fdb, arp, route) for the VTEP device.

```bash
# node1 host network namespace.  
fdb:   9e:c9:07:f9:b3:8b dev flannel.1 dst 10.0.0.20 self permanent  
arp:   ? (172.30.133.0) at 9e:c9:07:f9:b3:8b [ether] PERM on flannel.1  
route: 172.30.133.0/26 via 172.30.133.0 dev flannel.1 onlink  
```

--------------------------------

### E2E Test Output Example

Source: https://openyurt.io/docs/developer-manuals/how-to-build-and-test

Example output indicating the success of end-to-end tests, showing the number of specs run, duration, and pass/fail status.

```text
Ran 5 of 5 Specs in 82.279 seconds  
SUCCESS! -- 5 Passed | 0 Failed | 0 Pending | 0 Skipped  
PASS  

```

--------------------------------

### Create Device with OpenYurt

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Create a virtual device using a pre-synchronized DeviceService and the previously defined DeviceProfile. This example creates a random boolean device.

```yaml
apiVersion: iot.openyurt.io/v1alpha1
kind: Device
metadata:
  name: openyurt-created-random-boolean-device
spec:
  adminState: UNLOCKED
  description: Example of Device Virtual
  labels:
  - openyurt-created-device-virtual-example
  managed: true
  nodePool: hangzhou
  notify: true
  operatingState: UP
  profileName: openyurt-created-random-boolean-deviceprofile
  protocols:
    other:
      Address: openyurt-created-device-virtual-bool-01
      Port: "300"
  serviceName: device-virtual

```

--------------------------------

### Get Test Pods and IPs

Source: https://openyurt.io/docs/user-manuals/network/raven

Lists all running pods and their associated IP addresses. This is useful for identifying the IPs needed for network testing.

```bash
$ kubectl get pod -o wide

```

--------------------------------

### Install Node Resource Manager

Source: https://openyurt.io/docs/user-manuals/storage/edge-local-storage

Applies the Node Resource Manager (NRM) deployment to your cluster using the provided YAML manifest.

```bash
kubectl apply -f https://raw.githubusercontent.com/openyurtio/node-resource-manager/main/deploy/nrm.yaml

```

--------------------------------

### Get Node Pool Information

Source: https://openyurt.io/docs/user-manuals/node-pool-management

Retrieve a list of all configured NodePools and their status, including the number of ready and not-ready nodes.

```bash
kubectl get np

```

--------------------------------

### Create YurtAppSet for Nginx Deployment

Source: https://openyurt.io/docs/user-manuals/workload/yurt-app-set

Define a YurtAppSet to deploy Nginx. This example specifies node pools, a nodepool selector, and a workload template. It also includes specific tweaks for 'np2xxxxxx' such as replica count, image version, and metadata patches.

```yaml
apiVersion: apps.openyurt.io/v1beta1
kind: YurtAppSet
metadata:
  name: example
  namespace: default
spec:
  revisionHistoryLimit: 5
  pools:
    - np1xxxxxx
    - np2xxxxxx
  nodepoolSelector:
    matchLabels:
      yurtappset.openyurt.io/type: "nginx"
  workload:
    workloadTemplate:
      deploymentTemplate:
        metadata:
          labels:
            app: example
        spec:
          replicas: 2
          selector:
            matchLabels:
              app: example
          template:
            metadata:
              labels:
                app: example
            spec:
              containers:
                - image: nginx:1.19.1
                  imagePullPolicy: Always
                  name: nginx
    workloadTweaks:
      - pools:
          - np2xxxxxx
        tweaks:
          replicas: 3
          containerImages:
            - name: nginx
              targetImage: nginx:1.20.1
          patches:
            - path: /metadata/labels
              operation: add
              value: {"foo": "bar"}

```

--------------------------------

### Create Node Pool with Mark Leader Election

Source: https://openyurt.io/docs/user-manuals/node-pool-management/create-a-node-pool

This example demonstrates creating an Edge type node pool with leader election enabled using the 'mark' strategy. It selects leader nodes based on a specific label and defines the resources for pool scope metadata.

```yaml
apiVersion: apps.openyurt.io/v1beta2
kind: NodePool
metadata:
  name: hangzhou
spec:
  type: Edge
  enableLeaderElection: true
  interConnectivity: true
  leaderElectionStrategy: mark
  leaderNodeLabelSelector:
    nodepool.openyurt.io/leader: "true"
  leaderReplicas: 2
  poolScopeMetadata:
    - group: ""
      resource: services
      version: v1
    - group: discovery.k8s.io
      resource: endpointslices
      version: v1
```

--------------------------------

### Create DeviceProfile with OpenYurt

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Define a DeviceProfile for a virtual device, specifying its resources and commands. This example creates a profile for a random boolean device.

```yaml
apiVersion: iot.openyurt.io/v1alpha1
kind: DeviceProfile
metadata:
  name: openyurt-created-random-boolean-deviceprofile
spec:
  description: Example of Device-Virtual Created By OpenYurt
  deviceCommands:
  - isHidden: false
    name: WriteBoolValue
    readWrite: W
    resourceOperations:
    - defaultValue: ""
      deviceResource: Bool
    - defaultValue: "false"
      deviceResource: EnableRandomization_Bool
  - isHidden: false
    name: WriteBoolArrayValue
    readWrite: W
    resourceOperations:
    - defaultValue: ""
      deviceResource: BoolArray
    - defaultValue: "false"
      deviceResource: EnableRandomization_BoolArray
  deviceResources:
  - description: used to decide whether to re-generate a random value
    isHidden: true
    name: EnableRandomization_Bool
    properties:
      defaultValue: "true"
      readWrite: W
      valueType: Bool
  - description: Generate random boolean value
    isHidden: false
    name: Bool
    properties:
      defaultValue: "true"
      readWrite: RW
      valueType: Bool
  - description: used to decide whether to re-generate a random value
    isHidden: true
    name: EnableRandomization_BoolArray
    properties:
      defaultValue: "true"
      readWrite: W
      valueType: Bool
  - description: Generate random boolean array value
    isHidden: false
    name: BoolArray
    properties:
      defaultValue: '[true]'
      readWrite: RW
      valueType: BoolArray
  labels:
  - openyurt-created-device-virtual-example
  manufacturer: OpenYurt Community
  model: OpenYurt-Device-Virtual-01
  nodePool: hangzhou

```

--------------------------------

### Host-Local IPAM Record Example

Source: https://openyurt.io/docs/user-manuals/network/container-network/flannel

This shows the default file-based record keeping for IP addresses allocated by host-local CNI, listing only the IP addresses.

```bash
$ ls /var/lib/cni/networks/cbr0  
172.30.132.194  172.30.132.198  172.30.132.201  
```

--------------------------------

### Modified Host-Local IPAM Record Example

Source: https://openyurt.io/docs/user-manuals/network/container-network/flannel

This demonstrates the enhanced host-local CNI record format, which includes the IP address, pod namespace, and pod name. This allows for IP address persistence across pod restarts.

```bash
$ ls /var/lib/cni/networks/cbr0  
172.30.132.194_kube-system_coredns-vstxh  172.30.132.198_kube-system_nginx-76df748b9-4cz95  172.30.132.201_kube-system_nginx-76df748b9-nf5l9  
```

--------------------------------

### Verify Node Configuration after Adding to Node Pool

Source: https://openyurt.io/docs/user-manuals/node-pool-management

Inspect the YAML output of a node to confirm that annotations, labels, and taints from its assigned NodePool have been applied. This example shows verification for 'k8s-node1'.

```bash
kubectl get node k8s-node1 -o yaml

```

--------------------------------

### Create Gateway CRs

Source: https://openyurt.io/docs/user-manuals/network/raven

Apply multiple Gateway Custom Resources using kubectl. This example demonstrates creating gateways for different locations and configurations, including proxy and tunnel endpoints.

```yaml
apiVersion: raven.openyurt.io/v1beta1
kind: Gateway
metadata:
  name: gw-hangzhou
spec:
  proxyConfig:
    Replicas: 1
  tunnelConfig:
    Replicas: 1
  endpoints:
    - nodeName: izbp15inok0kbfkg3in52rz
      underNAT: true
      port: 10262
      type: proxy
    - nodeName: izbp15inok0kbfkg3in52rz
      underNAT: true
      port: 4500
      underNAT: true
      type: tunnel
---
apiVersion: raven.openyurt.io/v1alpha1
kind: Gateway
metadata:
  name: gw-cloud
spec:
  exposeType: PublicIP
  proxyConfig:
    Replicas: 1
    proxyHTTPPort: 10255,9445
    proxyHTTPSPort: 10250,9100
  tunnelConfig:
    Replicas: 1
  endpoints:
    - nodeName: izwz9dohcv74iegqecp4axz
      underNAT: false
      port: 10262
      type: proxy
      publicIP: 120.79.xxx.xxx
    - nodeName: izwz9dohcv74iegqecp4axz
      underNAT: false
      port: 4500
      type: tunnel
      publicIP: 120.79.xxx.xxx

---
apiVersion: raven.openyurt.io/v1alpha1
kind: Gateway
metadata:
  name: gw-qingdao
spec:
  proxyConfig:
    Replicas: 1
  tunnelConfig:
    Replicas: 1
  endpoints:
  - nodeName: izm5eb24dmjfimuaybpnqzz
    underNAT: true
    port: 10262
    type: proxy
  - nodeName: izm5eb24dmjfimuaybpnr0z
    underNAT: true
    port: 4500
    type: tunnel
```

--------------------------------

### Check Pods Matching Deployment Label

Source: https://openyurt.io/docs/user-manuals/workload/yurt-app-set

List pods that match the 'app=example' label. This helps confirm that the pods for the deployed applications are running as expected, showing their readiness and age.

```bash
$ kubectl get pod -l app=example
NAME                                                              READY   STATUS    RESTARTS   AGE
example-np45a10e0d15114bbfa747ad0f02ede77f-pvpv6-6f8fd8669ns9rq   1/1     Running   0          4m24s
example-np45a10e0d15114bbfa747ad0f02ede77f-pvpv6-6f8fd8669sn92q   1/1     Running   0          4m24s
example-np93d46c5a4aa24702bb1d12b1641d0e43-fr25p-6fcf7db4f7c967   1/1     Running   0          4m24s
example-np93d46c5a4aa24702bb1d12b1641d0e43-fr25p-6fcf7db4fgw977   1/1     Running   0          4m24s
example-np93d46c5a4aa24702bb1d12b1641d0e43-fr25p-6fcf7db4fnlvnl   1/1     Running   0          4m24s

```

--------------------------------

### Verify Device Creation

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Check that the virtual devices, simulated by the device-virtual-go component, have been successfully created and registered. This command lists all active devices.

```bash
$ kubectl get device  
NAME                                     NODEPOOL   SYNCED   AGE  
hangzhou-random-binary-device            hangzhou   true     2d1h  
hangzhou-random-boolean-device           hangzhou   true     2d1h  
hangzhou-random-float-device             hangzhou   true     2d1h  
hangzhou-random-integer-device           hangzhou   true     2d1h  
hangzhou-random-unsignedinteger-device   hangzhou   true     2d1h  

```

--------------------------------

### Add 'get node' permission for Flannel ClusterRole

Source: https://openyurt.io/docs/user-manuals/network/container-network/flannel

Modify the Flannel ClusterRole to include 'get' permission for nodes. This is required after adjusting Flannel configurations.

```yaml
kind: ClusterRole
apiVersion: rbac.authorization.k8s.io/v1beta1
metadata:
  name: flannel
rules:
  - apiGroups:
      - ""
    resources:
      - pods
    verbs:
      - get
  - apiGroups:
      - ""
    resources:
      - nodes
    verbs:
+     - get
      - list
      - watch
  - apiGroups:
      - ""
    resources:
      - nodes/status
    verbs:
      - patch

```

--------------------------------

### Install raven-agent using Helm

Source: https://openyurt.io/docs/installation/manually-setup

Install the raven-agent component, which provides network communication capabilities between cloud and edge nodes, especially when they are in different network areas.

```bash
helm upgrade --install raven-agent -n kube-system openyurt/raven-agent  

```

--------------------------------

### Install OpenYurt CNI RPM

Source: https://openyurt.io/docs/user-manuals/network/container-network/flannel

This command installs the OpenYurt CNI package, which includes the modified host-local IPAM functionality for keeping pod IP addresses consistent.

```bash
rpm -ivh https://github.com/openyurtio/openyurt/releases/download/v0.7.0/openyurt-cni-0.8.7-0.x86_64.rpm  
```

--------------------------------

### Verify Device and DeviceProfile Creation

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Use kubectl commands to verify that the DeviceProfile and Device have been successfully created and synchronized in OpenYurt.

```bash
$ kubectl get deviceprofile openyurt-created-random-boolean-deviceprofile
NAME                                            NODEPOOL   SYNCED   AGE
openyurt-created-random-boolean-deviceprofile   hangzhou   true     15h

$ kubectl get device openyurt-created-random-boolean-device
NAME                                     NODEPOOL   SYNCED   AGE
openyurt-created-random-boolean-device   hangzhou   true     14h

```

--------------------------------

### Verify Device Service Creation

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

After deploying the virtual device driver, use kubectl to verify that the device service has been created and synchronized. This confirms the component is running and accessible.

```bash
$ kubectl get deviceservice  
NAME                      NODEPOOL   SYNCED   AGE  
hangzhou-device-virtual   hangzhou   true     2d1h  

```

--------------------------------

### Install yurt-manager using Helm

Source: https://openyurt.io/docs/installation/manually-setup

Install the yurt-manager component, which is essential for OpenYurt features like controllers and webhooks. It must be running on the control plane node before joining edge nodes.

```bash
helm upgrade --install yurt-manager -n kube-system openyurt/yurt-manager  

```

--------------------------------

### View NodePool Resource

Source: https://openyurt.io/docs/user-manuals/node-pool-management/edit-a-node-pool

Use `kubectl get nodepool` to view a specific NodePool or `kubectl get np -o yaml` to see its full YAML configuration. The short name `np` is supported.

```bash
kubectl get nodepool <NodePoolName>  
kubectl get np <NodePoolName> -o yaml  
```

--------------------------------

### yurtadm token help options

Source: https://openyurt.io/docs/reference/yurtadm/yurtadm_token

Displays help information for the yurtadm token command. Use this to understand available flags for token management.

```bash
  -h, --help   help for token  
```

--------------------------------

### Verify NodePool Changes

Source: https://openyurt.io/docs/user-manuals/node-pool-management/edit-a-node-pool

After editing a NodePool, use `kubectl get nodepool <NodePoolName> -o yaml` to inspect the updated resource. `kubectl get nodepools` provides a summary view, including leader election status if enabled.

```bash
kubectl get nodepool <NodePoolName> -o yaml  
kubectl get nodepools  
```

--------------------------------

### Initialize OpenYurt Cluster

Source: https://openyurt.io/docs/installation/yurtadm-init

Initialize an OpenYurt cluster with specified network configurations. This command deploys core components like kubeadm, kubectl, and others.

```bash
yurtadm init --apiserver-advertise-address=47.115.228.119 --yurt-tunnel-server-address=47.115.228.119 --pod-network-cidr=10.244.0.0/16 --service-cidr=10.96.0.0/12  
```

--------------------------------

### Get Pod Information

Source: https://openyurt.io/docs/user-manuals/workload/daemon-pod-updater

Retrieves information about the pods running on a node.

```APIDOC
## GET /pods

### Description
This API allows you to get information about the pods on the node.

### Method
GET

### Endpoint
/pods
```

--------------------------------

### Create kind Kubernetes Cluster

Source: https://openyurt.io/docs/installation/yurtcluster

Command to create a Kubernetes cluster using the specified kind configuration file.

```bash
# kind create cluster --config kind-cluster.yaml

Creating cluster "kind" ...
 ️ Ensuring node image (kindest/node:v1.21.1) 🖼
 ️ Preparing nodes 📦 📦 📦 📦
 ️ Writing configuration 📜
 ️ Starting control-plane 🕹️
 ️ Installing CNI 🔌
 ️ Installing StorageClass 💾
 ️ Joining worker nodes 🚜
Set kubectl context to "kind-kind"
You can now use your cluster with:

kubectl cluster-info --context kind-kind

Have a nice day! 👋

```

--------------------------------

### Get NodePool Status

Source: https://openyurt.io/docs/user-manuals/network/service/service-topology

Retrieve the status of all configured NodePools using kubectl.

```bash
$ kubectl get np
NAME       TYPE    READYNODES   NOTREADYNODES   AGE
beijing    Cloud   1            0               63s
hangzhou   Edge    1            0               63s
shanghai   Edge    1            0               63s
```

--------------------------------

### Get DaemonSet Pods

Source: https://openyurt.io/docs/user-manuals/workload/daemon-pod-updater

Retrieve a list of pods associated with the nginx-daemonset to monitor their status.

```bash
$ kubectl get pods | grep nginx-daemonset
```

--------------------------------

### Create Service with TopologyKeys

Source: https://openyurt.io/docs/user-manuals/network/service/service-topology

Creates a ClusterIP Service named 'svc-ud1' that selects pods with the label 'app: united-deployment1'. It uses 'openyurt.io/nodepool' as a topology key for routing.

```yaml
$ cat << EOF | kubectl apply -f -  
apiVersion: v1  
kind: Service  
metadata:  
  name: svc-ud1  
  annotations:  
    openyurt.io/topologyKeys: openyurt.io/nodepool  
spec:  
  selector:  
    app: united-deployment1  
  type: ClusterIP  
  ports:  
  - port: 80  
    targetPort: 9376  
EOF  

```

--------------------------------

### Verify Device Profile Creation

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Confirm that the device profiles for the simulated devices have been created and synchronized. This ensures that the system understands the data formats and capabilities of the virtual devices.

```bash
$ kubectl get deviceprofile  
NAME                                     NODEPOOL   SYNCED   AGE  
hangzhou-random-binary-device            hangzhou   true     2d1h  
hangzhou-random-boolean-device           hangzhou   true     2d1h  
hangzhou-random-float-device             hangzhou   true     2d1h  
hangzhou-random-integer-device           hangzhou   true     2d1h  
hangzhou-random-unsignedinteger-device   hangzhou   true     2d1h  

```

--------------------------------

### Verify metrics-server with kubectl

Source: https://openyurt.io/docs/user-manuals/observability/metrics-server

Run these commands after updating the metrics-server configuration to verify that CPU and memory metrics are appearing for pods and edge nodes.

```bash
kubectl top pods -A
```

```bash
kubectl top node <edge-node-name>
```

--------------------------------

### Get DaemonSet Pods

Source: https://openyurt.io/docs/user-manuals/workload/daemon-pod-updater

Retrieves a list of pods belonging to the nginx-daemonset. Useful for verifying deployment and identifying specific pods.

```bash
kubectl get pods -o wide | grep nginx-daemonset
```

--------------------------------

### Get Kubernetes Nodes

Source: https://openyurt.io/docs/user-manuals/network/service/service-topology

Lists the nodes in the Kubernetes cluster to verify version compatibility. Ensure Kubernetes v1.18 or above is used.

```bash
$ kubectl get node  
NAME                 STATUS   ROLES    AGE     VERSION  
kind-control-plane   Ready    master   6m21s   v1.18.19  
kind-worker          Ready    <none>   5m42s   v1.18.19  
kind-worker2         Ready    <none>   5m42s   v1.18.19  

```

--------------------------------

### Deploy Raven with WireGuard Backend

Source: https://openyurt.io/docs/user-manuals/network/raven

To switch Raven to use WireGuard as the VPN backend, ensure the WireGuard kernel module is loaded on the gateway node. Then, checkout the desired version and run the make deploy command with VPN_DRIVER set to wireguard.

```bash
cd raven
git checkout v0.4.1
VPN_DRIVER=wireguard make deploy

```

--------------------------------

### Kubernetes Service Port Mapping

Source: https://openyurt.io/docs/core-concepts/yurttunnel

An example of a Kubernetes Service definition for the x-tunnel-server-internal-svc, illustrating how ports are mapped to target ports.

```yaml
spec:
  ports:
  - name: https
    port: 10250
    protocol: TCP
    targetPort: 10263
  - name: http
    port: 10255
    protocol: TCP
    targetPort: 10264
  - name: dnat-9051 # add port mapping
    port: 9051
    protocol: TCP
    targetPort: 10264
```

--------------------------------

### Build OpenYurt Binaries with Make

Source: https://openyurt.io/docs/developer-manuals/ci-workflow

Builds all OpenYurt component binaries for the `linux/amd64` platform. This includes `yurtadm`, `yurtctl`, and various server/agent components. This command is part of the CI workflow and can be run locally.

```bash
make build
```

--------------------------------

### Check Kubernetes Node Status

Source: https://openyurt.io/docs/installation/manually-setup

Verify that your Kubernetes control plane has at least one ready node. This is a prerequisite for OpenYurt installation.

```bash
$ kubectl get nodes  
NAME                      STATUS   ROLES                  AGE     VERSION  
izwz9dohcv74iegqecp4axz   Ready    control-plane,master   6d1h    v1.22.11  

```

--------------------------------

### Get Pods from UnitedDeployments

Source: https://openyurt.io/docs/user-manuals/network/service/service-topology

Retrieves all pods associated with 'united-deployment1' and 'united-deployment2', displaying wide information including IP, Node, and status.

```bash
$ kubectl get pod -l "app in (united-deployment1,united-deployment2)" -owide  

```

--------------------------------

### Run Yurtadm Docs

Source: https://openyurt.io/docs/reference/yurtadm/yurtadm_docs

Execute the yurtadm docs command to generate API documentation. By default, it outputs to './docs/api/yurtadm'.

```bash
yurtadm docs
```

--------------------------------

### Get Raven Proxy DNS Service ClusterIP

Source: https://openyurt.io/docs/installation/raven-l7-proxy-prepare

Retrieve the ClusterIP address for the raven-proxy-dns service. This IP will be used in the Kube-apiserver configuration.

```bash
$ kubectl -n kube-system get svc raven-proxy-dns
```

--------------------------------

### Manually Add Component Configuration

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Manually add the deployment and service configuration for a new component, such as 'nginx-demo', to the 'platformadmin-framework' configmap.

```yaml
apiVersion: v1
data:
  framework: |
    components:
    - deployment:
        selector:
          matchLabels:
            app: nginx-demo
        strategy: {}
        template:
          metadata:
            creationTimestamp: null
            labels:
              app: nginx-demo
          spec:
            containers:
            - image: nginx
              imagePullPolicy: IfNotPresent
              name: nginx-demo
              ports:
              - containerPort: 80
                name: nginx
                protocol: TCP
              resources: {}
            hostname: nginx-demo
      name: nginx-demo
      service:
        ports:
        - name: nginx
          port: 80
          protocol: TCP
          targetPort: 80
        selector:
          app: nginx-demo
...

```

--------------------------------

### Deploy Yurt-IoT-Dock with PlatformAdmin

Source: https://openyurt.io/docs/core-concepts/yurt-iot-dock

This YAML configuration demonstrates how to deploy the yurt-iot-dock component by including it in the 'components' list of a PlatformAdmin CR. This allows for selective deployment of components to specific node pools.

```yaml
apiVersion: iot.openyurt.io/v1alpha2
kind: PlatformAdmin
metadata:
  name: edgex-sample
spec:
  version: minnesota
  poolName: hangzhou
  components:
  - name: yurt-iot-dock

```

--------------------------------

### Get Raven Gateway Configuration

Source: https://openyurt.io/docs/user-manuals/network/raven

Use this command to retrieve the YAML configuration of a Raven gateway. This is useful for inspecting current settings and troubleshooting.

```yaml
apiVersion: raven.openyurt.io/v1beta1
kind: Gateway
metadata:
  name: gw-hangzhou
spec:
  proxyConfig:
    Replicas: 1
  tunnelConfig:
    Replicas: 1
  endpoints:
    - nodeName: izbp15inok0kbfkg3in52rz
      underNAT: true
      port: 10262
      type: proxy
    - nodeName: izbp15inok0kbfkg3in52rz
      underNAT: true
      port: 4500
      underNAT: true
      type: tunnel
status:
  activeEndpoints:
  - config:
      enable-l7-proxy: "true"
    nodeName: izbp15inok0kbfkg3in52rz
    port: 10262
    publicIP: 120.79.xxx.xxx
    type: proxy
  - config:
      enable-l3-tunnel: "true"
    nodeName: izbp15inok0kbfkg3in52rz
    port: 4500
    publicIP: 120.79.xxx.xxx
    type: tunnel
  nodes:
  - nodeName: izbp15inok0kbfkg3in52rz
    privateIP: 172.16.2.103
    subnets:
    - 10.224.1.128/26
  - nodeName: izbp15inok0kbfkg3in52sz
    privateIP: 172.16.2.104
    subnets:
    - 10.224.1.0/26
```

--------------------------------

### Build OpenYurt Docker Image

Source: https://openyurt.io/docs/developer-manuals/how-to-build-and-test

Builds a Docker image for OpenYurt components, including compilation and packaging. Specify target platforms and region for proxy settings.

```bash
make docker-build TARGET_PLATFORMS="${TARGET_PLATFORMS}" REGION="${your_region}"  

```

```bash
make docker-build TARGET_PLATFORMS=linux/amd64 REGION=cn  

```

--------------------------------

### View Deployed Components

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Use kubectl to list all running pods and verify that EdgeX Foundry components have been successfully deployed.

```bash
kubectl get po
```

--------------------------------

### Check YurtAppSet Status

Source: https://openyurt.io/docs/user-manuals/workload/yurt-app-set

Use kubectl to get the status of YurtAppSet resources. This command shows the total, ready, and updated counts for each YurtAppSet.

```bash
$ kubectl get yas
NAME      TOTAL   READY   UPDATED   AGE
example   2       2       2         84s

```

--------------------------------

### Specify Target Platforms for MAC

Source: https://openyurt.io/docs/developer-manuals/local-up-openyurt

When running on a MAC, you may need to specify the target platforms for the `local-up-openyurt` command.

```bash
make local-up-openyurt TARGET_PLATFORMS= Linux /arm64
```

--------------------------------

### Create Cloud Node Pool

Source: https://openyurt.io/docs/user-manuals/node-pool-management

Use this YAML definition to create a NodePool of type 'Cloud'. Ensure Yurt-Manager is installed prior to applying this configuration.

```yaml
apiVersion: apps.openyurt.io/v1beta1
kind: NodePool
metadata:
  name: beijing
spec:
  type: Cloud

```

--------------------------------

### Add OpenYurt Helm Repository

Source: https://openyurt.io/docs/installation/manually-setup

Add the official OpenYurt Helm chart repository to your Helm client. This allows you to search for and install OpenYurt components.

```bash
helm repo add openyurt https://openyurtio.github.io/charts  

```

--------------------------------

### Run Unit Tests with Make

Source: https://openyurt.io/docs/developer-manuals/ci-workflow

Execute all Go test files ending with `_test.go` to verify function and module correctness. This command is part of the CI workflow and can also be run locally.

```bash
make test
```

--------------------------------

### Get Detailed YurtCluster Status

Source: https://openyurt.io/docs/installation/yurtcluster

Retrieve detailed status information for the YurtCluster, including node conversion status and observed generation. This is useful for troubleshooting.

```bash
# kubectl get yc cluster -oyaml
```

--------------------------------

### Create EdgeX Deployment with PlatformAdmin

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Create an EdgeX deployment named 'edgex-sample' of the 'minnesota' version within the 'hangzhou' node pool using PlatformAdmin.

```yaml
# Create an EdgeX deployment of the "Minnesota" version within the "hangzhou" node pool  
cat <<EOF | kubectl apply -f -  
apiVersion: iot.openyurt.io/v1alpha2  
kind: PlatformAdmin  
metadata:  
  name: edgex-sample  
spec:  
  version: minnesota  
  poolName: hangzhou  
EOF  
  
# Verify the deployment status to ensure everything is set up correctly  
kubectl get po  
NAME                                                              READY   STATUS    RESTARTS   AGE  
edgex-core-command-hangzhou-4j6pz-8668ff94d7-hqw2r                1/1     Running   0          61s  
edgex-core-common-config-bootstrapper-hangzhou-jnw2q-57bd99xr9p   1/1     Running   0          61s  
edgex-core-consul-hangzhou-6p9tj-798489c647-6xz4m                 1/1     Running   0          61s  
edgex-core-metadata-hangzhou-6l7v5-6f964fc4f-67f9p                1/1     Running   0          61s  
edgex-redis-hangzhou-cwgsw-5c7d7fc478-fsgp9                       1/1     Running   0          61s  

```

--------------------------------

### Deploy Application with LVM Local Storage

Source: https://openyurt.io/docs/user-manuals/storage/edge-local-storage

Deploys a sample Nginx application that mounts a PersistentVolumeClaim provisioned from LVM local storage.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: deployment-lvm
  labels:
    app: nginx
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.7.9
        volumeMounts:
          - name: lvm-pvc
            mountPath: "/data"
      volumes:
        - name: lvm-pvc
          persistentVolumeClaim:
            claimName: lvm-pvc

```

--------------------------------

### Modify Component Configuration via ConfigMap

Source: https://openyurt.io/docs/user-manuals/iot/edgex-foundry

Edit the 'platformadmin-framework' configmap to customize the configuration of EdgeX Foundry components. This example shows the structure for 'edgex-core-command'.

```yaml
apiVersion: v1
data:
  framework: |
    components:
    - deployment:
        selector:
          matchLabels:
            app: edgex-core-command
        strategy: {}
        template:
          metadata:
            creationTimestamp: null
            labels:
              app: edgex-core-command
          spec:
            containers:
            - env:
              - name: SERVICE_HOST
                value: edgex-core-command
              - name: EXTERNALMQTT_URL
                value: tcp://edgex-mqtt-broker:1883
              envFrom:
              - configMapRef:
                  name: common-variables
              image: openyurt/core-command:3.0.0
              imagePullPolicy: IfNotPresent
              name: edgex-core-command
              ports:
              - containerPort: 59882
                name: tcp-59882
                protocol: TCP
              resources: {}
            hostname: edgex-core-command
      name: edgex-core-command
      service:
        ports:
        - name: tcp-59882
          port: 59882
          protocol: TCP
          targetPort: 59882
        selector:
          app: edgex-core-command
...

```

--------------------------------

### Run Unit Tests

Source: https://openyurt.io/docs/developer-manuals/how-to-build-and-test

Executes unit tests for code within the cmd and pkg folders that have the `_test.go` suffix.

```bash
make test  

```
Tokens:
Raw