Skip to content

Commit

Permalink
add glossary and proposal template (openyurtio#233)
Browse files Browse the repository at this point in the history
  • Loading branch information
charleszheng44 authored and zyjhtangtang committed Mar 31, 2021
1 parent fe3cb9a commit d98b054
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions docs/proposals/00_openyurt-glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Table of Contents

This document lists terms for the OpenYurt implementation.

[C](#c) | [E](#e) | [N](#n) | [U](#u) | [Y](#y)

## C
---

### CloudNode

The node that runs on the cloud. The control-plane and other cluster management components are usually running on the CloudNode.

## E
---

### EdgeNode

The node that is accessible to the edge device. The EdgeNodes are usually located in a sub-optimal network environment. They may be disconnected from the cloud node at any time.

### End User

Represents a user of the OpenYurt cluster.

## N
---

### NodePool

The CRD represents a pool of edge nodes in the same network region.

## U
---

### UnitedDeployment

The CRD defines the way of deploying homogeneous workloads with different versions/configurations by NodePools.

## Y
---

### YurtControllerManager

Controller Manager for OpenYurt like Kube Controller Manager for K8s, and include nodelifecycle controller at present, more controllers will be added in the future.

### YurtHub

A reverse proxy and cache response on local disk. when cloud-edge network is normal, forward the requests from edge to cloud, and when cloud-edge network is disconnected, the local cache is returned to edge client.

### YurtTunnel

The network tunnel helps CloudNodes to send HTTP requests to EdgeNodes located in an isolated network.

### YurtTunnel Server

The server of the YurtTunnel runs on each CloudNode and redirects HTTP requests to corresponding agents.

### YurtTunnel Agent

The agent of the YurtTunnel that runs on each EdgeNode receives requests from the YurtTunnel Server and sends requests to destination hosts.

### YurtAppManager

The controller manager includes the NodePool Controller and the UnitedDeployment Controller.

0 comments on commit d98b054

Please sign in to comment.