# superedge1

**Repository Path**: wangzhiguo920601/superedge1

## Basic Information

- **Project Name**: superedge1
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-29
- **Last Updated**: 2024-06-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

简体中文 | [English](./README.md)

# SuperEdge

[![Version](https://img.shields.io/badge/SuperEdge-0.8.0-blue)](https://github.com/superedge/superedge/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/superedge/superedge)](https://goreportcard.com/report/github.com/superedge/superedge)
[![License](https://img.shields.io/badge/License-Apache--2.0-orange)](https://www.apache.org/licenses/LICENSE-2.0.html)

<div align="left">
  <img src="docs/img/SuperEdge-icon-color.png" width=30% title="SuperEdge Architecture">
</div>

## 什么是SuperEdge?

SuperEdge是Kubernetes原生的边缘容器方案，它将Kubernetes强大的容器管理能力扩展到边缘计算场景中，针对边缘计算场景中常见的技术挑战提供了解决方案，如：单集群节点跨地域、云边网络不可靠、边缘节点位于NAT网络等。这些能力可以让应用很容易地部署到边缘计算节点上，并且可靠地运行。

SuperEdge可以帮助您很方便地把分布在各处的计算资源放到一个Kubernetes集群中管理，包括但不限于：边缘云计算资源、私有云资源、现场设备，打造属于您的边缘PaaS平台。 

SuperEdge支持所有Kubernetes资源类型、API接口、使用方式、运维工具，无额外的学习成本。也兼容其他云原生项目，如：Prometheus，使用者可以结合其他所需的云原生项目一起使用。

SuperEdge项目由以下公司共同发起：腾讯、Intel、VMware、虎牙直播、寒武纪、首都在线和美团。


## 项目特性

SuperEdge具有如下特性:

- **Kubernetes 原生**：SuperEdge 以无侵入的方式将 Kubernetes 强大的容器编排、调度能力拓展到边缘端，其原生支持 Kubernetes，完全兼容 Kubernetes 所有 API 及资源，无额外学习成本
- **边缘自治**：SuperEdge 提供 L3 级边缘自治能力，当边缘节点与云端网络连接不稳定或处于离线状态时，边缘节点可以自主工作，化解了网络不可靠所带来的不利影响
- **分布式节点健康监测**：SuperEdge 是业内首个提供边缘侧健康监测能力的开源容器管理系统。SuperEdge 能在边缘侧持续守护进程，并收集节点的故障信息，实现更加快速和精准的问题发现与报告。此外，其分布式的设计还可以实现多区域、多范围的监测和管理
- **内置边缘编排能力**：SuperEdge 能够自动部署多区域的微服务，方便管理运行于多个地区的微服务。同时，网格内闭环服务可以有效减少运行负载，提高系统的容错能力和可用性
- **内网穿透**：SuperEdge 能够保证 Kubernetes 节点在有无公共网络的情况下都可以连续运行和维护，并且同时支持传输控制协议（TCP）、超文本传输协议（HTTP）、超文本传输安全协议（HTTPS）和SSH协议


## 体系架构

<div align="center">
  <img src="docs/img/superedge_arch.png" width=80% title="SuperEdge Architecture">
</div>

云端组件：

- [**tunnel-cloud**](docs/components/tunnel_CN.md): 云端tunnel服务组件，用于建立云边长连接隧道，支持代理tcp/http/https流量
- [**application-grid controller**](docs/components/serviceGroup_CN.md): 应用网络（ServiceGroup）控制器
- [**edge-health admission**](docs/components/edge-health_CN.md): 分布式节点健康检查机制云端组件，辅助Kubernetes控制器工作

边端组件:

- [**lite-apiserver**](docs/components/lite-apiserver_CN.md): 节点侧轻量版apiserver shadow，代理节点组件到云端apiserver的请求，缓存关键数据以用于边缘自治
- [**edge-health**](docs/components/edge-health_CN.md): 分布式节点健康检查，用于感知边缘节点状态，支持对节点分区域检查能力
- [**tunnel-edge**](docs/components/tunnel_CN.md): 边缘tunnel服务组件，主动与tunnel-cloud建立长连接，将云端请求代理到对应的边缘服务，如：kubelet、业务pod等
- [**application-grid wrapper**](docs/components/serviceGroup_CN.md): 应用网格流量控制组件，可将svc之间的流量闭环在同一个应用网格之中，避免跨网格访问

## 快速入门指南

如果您想快速从零开始初始化一套 SuperEdge 边缘集群，可以使用 SuperEdge 独立的开源子项目 [**edgeadm**](https://github.com/superedge/edgeadm) ，此项目已经从 SuperEdge 项目中独立，详细使用手册请参考[**一键安装边缘独立集群**](https://github.com/superedge/edgeadm/blob/main/docs/installation/install_edge_kubernetes_CN.md)。下面快速了解一下 edgeadm 使用方式：

-   下载安装包
> 注意修改"arch=amd64"参数，目前支持[amd64, arm64], kubernetes版本可选[1.22.6, 1.20.6, 1.18.2], 注意下载自己机器对应的体系结构，其他参数不变

```shell
arch=amd64 version=v0.7.0 kubernetesVersion=1.20.6 && rm -rf edgeadm-linux-* && wget https://superedge-1253687700.cos.ap-guangzhou.myqcloud.com/$version/$arch/edgeadm-linux-$arch-$version-k8s-$kubernetesVersion.tgz && tar -xzvf edgeadm-linux-* && cd edgeadm-linux-$arch-$version-k8s-$kubernetesVersion && ./edgeadm
```

-   安装边缘 Kubernetes master 节点
```shell
./edgeadm init --kubernetes-version=1.20.6 --image-repository superedge.tencentcloudcr.com/superedge --service-cidr=10.96.0.0/12 --pod-network-cidr=192.168.0.0/16 --install-pkg-path ./kube-linux-*.tar.gz --apiserver-cert-extra-sans=<Master节点外网IP> --apiserver-advertise-address=<Master节点内网IP> --enable-edge=true
```

-   Join 边缘节点
```shell
./edgeadm join <Master节点外网IP/Master节点内网IP/域名>:Port --token xxxx --discovery-token-ca-cert-hash sha256:xxxxxxxxxx --install-pkg-path <edgeadm kube-*静态安装包地址> --enable-edge=true 
```

## 更多资料
- [资料列表](./docs/tutorial_CN.md)

## 联系方式

如果您有任何疑问或需要支持，请随时与我们联系：
- [Slack](https://join.slack.com/t/superedge-workspace/shared_invite/zt-srf4srqc-L_I4Z1zncTJ6lr4AwbzEUA)
- [网上论坛](https://groups.google.com/g/superedge)
- [社区例会](https://docs.qq.com/doc/DSFVJbHVFUnVKdFlE)
- 微信群

<div align="center">
  <img src="docs/img/wechat-group.png" width=20% title="SuperEdge WeChat group">
</div>
## 参与项目

欢迎您[参与](./CONTRIBUTING.md)完善项目

## 故障和反馈

您在使用SuperEdge的过程中遇到任何故障可通过[联系方式](./README_CN.md#:~:text=Slack,%E4%BF%A1%E7%BE%A4)和我们联系，或者通过[故障](./SECURITY.md)给我们反馈。

## 开源许可

[**Apache License 2.0**](./LICENSE)