mirror of
https://github.com/singchia/frontier.git
synced 2025-11-03 02:43:22 +08:00
Merge pull request #62 from singchia/feat/readme
readme: fix spell error in yaml block
This commit is contained in:
37
README.md
37
README.md
@@ -2,6 +2,13 @@
|
|||||||
<img src="./docs/diagram/frontier-logo.png" width="30%" height="30%">
|
<img src="./docs/diagram/frontier-logo.png" width="30%" height="30%">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
[](https://goreportcard.com/report/github.com/singchia/frontier)
|
||||||
|
[](https://opensource.org/licenses/Apache-2.0)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
Frontier是一个go开发的全双工开源长连接网关,旨在让微服务直达边缘节点或客户端,反之边缘节点或客户端也同样直达微服务。对于两者,提供了全双工的单双向RPC调用,消息发布和接收,以及点对点流的功能。Frontier符合云原生架构,可以使用Operator快速部署一个集群,具有高可用和弹性,轻松支撑百万边缘节点或客户端在线的需求。
|
Frontier是一个go开发的全双工开源长连接网关,旨在让微服务直达边缘节点或客户端,反之边缘节点或客户端也同样直达微服务。对于两者,提供了全双工的单双向RPC调用,消息发布和接收,以及点对点流的功能。Frontier符合云原生架构,可以使用Operator快速部署一个集群,具有高可用和弹性,轻松支撑百万边缘节点或客户端在线的需求。
|
||||||
|
|
||||||
|
|
||||||
@@ -687,7 +694,7 @@ curl -X GET http://127.0.0.1:30010/v1/services/rpcs?service_id={service_id}
|
|||||||
|
|
||||||
简单起,你可以仅配置面向微服务和边缘节点的服务监听地址:
|
简单起,你可以仅配置面向微服务和边缘节点的服务监听地址:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# 微服务端配置
|
# 微服务端配置
|
||||||
servicebound:
|
servicebound:
|
||||||
# 监听网络
|
# 监听网络
|
||||||
@@ -710,7 +717,7 @@ edgebound:
|
|||||||
|
|
||||||
对于用户来说,比较重要的TLS配置在微服务、边缘节点和控制面都是支持的,另支持mTLS,Frontier由此校验客户端携带的证书。
|
对于用户来说,比较重要的TLS配置在微服务、边缘节点和控制面都是支持的,另支持mTLS,Frontier由此校验客户端携带的证书。
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
servicebound:
|
servicebound:
|
||||||
listen:
|
listen:
|
||||||
addr: 0.0.0.0:30011
|
addr: 0.0.0.0:30011
|
||||||
@@ -752,7 +759,7 @@ edgebound:
|
|||||||
|
|
||||||
**AMQP**
|
**AMQP**
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
mqm:
|
mqm:
|
||||||
amqp:
|
amqp:
|
||||||
# 是否允许
|
# 是否允许
|
||||||
@@ -762,15 +769,15 @@ mqm:
|
|||||||
# 生产者
|
# 生产者
|
||||||
producer:
|
producer:
|
||||||
# exchange名
|
# exchange名
|
||||||
exchange: ""
|
exchange: ""
|
||||||
# 等于Frontier内Topic的概念,数组值
|
# 等于Frontier内Topic的概念,数组值
|
||||||
routing_keys: null
|
routing_keys: null
|
||||||
```
|
```
|
||||||
对于AMQP来说,以上是最小配置,边缘节点Publish的消息Topic如果在routing_keys内,Frontier会Publish到exchange中,如果还有微服务或其他外部MQ也声明了该Topic,Frontier仍然会按照hashby来选择一个Publish。
|
对于AMQP来说,以上是最小配置,边缘节点Publish的消息Topic如果在routing_keys内,Frontier会Publish到exchange中,如果还有微服务或其他外部MQ也声明了该Topic,Frontier仍然会按照hashby来选择一个Publish。
|
||||||
|
|
||||||
**Kafka**
|
**Kafka**
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
mqm:
|
mqm:
|
||||||
kafka:
|
kafka:
|
||||||
# 是否允许
|
# 是否允许
|
||||||
@@ -780,13 +787,13 @@ mqm:
|
|||||||
# 生产者
|
# 生产者
|
||||||
producer:
|
producer:
|
||||||
# 数组值
|
# 数组值
|
||||||
topics: null
|
topics: null
|
||||||
```
|
```
|
||||||
对于Kafka来说,以上是最小配置,边缘节点Publish的消息Topic如果在上面数组中,Frontier会Publish过来。如果还有微服务或其他外部MQ也声明了该Topic,Frontier仍然会按照hashby来选择一个Publish。
|
对于Kafka来说,以上是最小配置,边缘节点Publish的消息Topic如果在上面数组中,Frontier会Publish过来。如果还有微服务或其他外部MQ也声明了该Topic,Frontier仍然会按照hashby来选择一个Publish。
|
||||||
|
|
||||||
**NATS**
|
**NATS**
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
mqm:
|
mqm:
|
||||||
nats:
|
nats:
|
||||||
# 是否允许
|
# 是否允许
|
||||||
@@ -809,7 +816,7 @@ NATS配置里,如果允许Jetstream,会优先使用Publish到Jetstream。如
|
|||||||
|
|
||||||
**NSQ**
|
**NSQ**
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
mqm:
|
mqm:
|
||||||
nsq:
|
nsq:
|
||||||
# 是否允许
|
# 是否允许
|
||||||
@@ -824,7 +831,7 @@ NSQ的Topic里,如果还有微服务或其他外部MQ也声明了该Topic,Fr
|
|||||||
|
|
||||||
**Redis**
|
**Redis**
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
mqm:
|
mqm:
|
||||||
redis:
|
redis:
|
||||||
# 是否允许
|
# 是否允许
|
||||||
@@ -844,7 +851,7 @@ mqm:
|
|||||||
|
|
||||||
### 其他配置
|
### 其他配置
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
daemon:
|
daemon:
|
||||||
# 是否开启PProf
|
# 是否开启PProf
|
||||||
pprof:
|
pprof:
|
||||||
@@ -925,7 +932,7 @@ Frontier需要主动连接Frontlas以上报自己、微服务和边缘的活跃
|
|||||||
|
|
||||||
**Frontier**的frontier.yaml需要添加如下配置:
|
**Frontier**的frontier.yaml需要添加如下配置:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
frontlas:
|
frontlas:
|
||||||
enable: true
|
enable: true
|
||||||
dial:
|
dial:
|
||||||
@@ -945,7 +952,7 @@ Frontier需要连接Frontlas,用来上报自己、微服务和边缘的活跃
|
|||||||
|
|
||||||
**Frontlas**的frontlas.yaml最小化配置:
|
**Frontlas**的frontlas.yaml最小化配置:
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
control_plane:
|
control_plane:
|
||||||
listen:
|
listen:
|
||||||
# 微服务改连接这个地址,用来发现集群的边缘节点所在的Frontier
|
# 微服务改连接这个地址,用来发现集群的边缘节点所在的Frontier
|
||||||
@@ -1038,7 +1045,7 @@ make install && make deploy
|
|||||||
|
|
||||||
**CR**
|
**CR**
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
apiVersion: frontier.singchia.io/v1alpha1
|
apiVersion: frontier.singchia.io/v1alpha1
|
||||||
kind: FrontierCluster
|
kind: FrontierCluster
|
||||||
metadata:
|
metadata:
|
||||||
|
|||||||
Reference in New Issue
Block a user