From 58a23dfe87c49069577b98f2ea5ca832de0c51fc Mon Sep 17 00:00:00 2001 From: singchia Date: Fri, 31 May 2024 00:25:23 +0800 Subject: [PATCH 1/4] readme: add badger --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9c67438..1a170b2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@

+[![Go Report Card](https://goreportcard.com/badge/github.com/singchia/frontier)](https://goreportcard.com/report/github.com/singchia/frontier) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + Frontier是一个go开发的全双工开源长连接网关，旨在让微服务直达边缘节点或客户端，反之边缘节点或客户端也同样直达微服务。对于两者，提供了全双工的单双向RPC调用，消息发布和接收，以及点对点流的功能。Frontier符合云原生架构，可以使用Operator快速部署一个集群，具有高可用和弹性，轻松支撑百万边缘节点或客户端在线的需求。 From 5f9e02e35ef10e9d8a0ee655ba61e875d18b6240 Mon Sep 17 00:00:00 2001 From: singchia Date: Fri, 31 May 2024 00:26:31 +0800 Subject: [PATCH 2/4] readme: add badger --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 1a170b2..0c7d57e 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@

+
+ [![Go Report Card](https://goreportcard.com/badge/github.com/singchia/frontier)](https://goreportcard.com/report/github.com/singchia/frontier) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +
+ Frontier是一个go开发的全双工开源长连接网关，旨在让微服务直达边缘节点或客户端，反之边缘节点或客户端也同样直达微服务。对于两者，提供了全双工的单双向RPC调用，消息发布和接收，以及点对点流的功能。Frontier符合云原生架构，可以使用Operator快速部署一个集群，具有高可用和弹性，轻松支撑百万边缘节点或客户端在线的需求。 From 17533574cc72b0a517d5c6e9d391557ea91e5618 Mon Sep 17 00:00:00 2001 From: singchia Date: Fri, 31 May 2024 00:28:11 +0800 Subject: [PATCH 3/4] readme: add yaml block type --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0c7d57e..15b2372 100644 --- a/README.md +++ b/README.md @@ -694,7 +694,7 @@ curl -X GET http://127.0.0.1:30010/v1/services/rpcs?service_id={service_id} 简单起，你可以仅配置面向微服务和边缘节点的服务监听地址： -``` +```yaml # 微服务端配置 servicebound: # 监听网络 @@ -717,7 +717,7 @@ edgebound: 对于用户来说，比较重要的TLS配置在微服务、边缘节点和控制面都是支持的，另支持mTLS，Frontier由此校验客户端携带的证书。 -``` +```yaml servicebound: listen: addr: 0.0.0.0:30011 @@ -759,7 +759,7 @@ edgebound: **AMQP** -``` +```yaml mqm: amqp: # 是否允许 @@ -777,7 +777,7 @@ mqm: **Kafka** -``` +```yaml mqm: kafka: # 是否允许 @@ -793,7 +793,7 @@ mqm: **NATS** -``` +```yaml mqm: nats: # 是否允许 @@ -816,7 +816,7 @@ NATS配置里，如果允许Jetstream，会优先使用Publish到Jetstream。如 **NSQ** -``` +```yaml mqm: nsq: # 是否允许 @@ -831,7 +831,7 @@ NSQ的Topic里，如果还有微服务或其他外部MQ也声明了该Topic，Fr **Redis** -``` +```yaml mqm: redis: # 是否允许 @@ -851,7 +851,7 @@ mqm: ### 其他配置 -``` +```yaml daemon: # 是否开启PProf pprof: @@ -932,7 +932,7 @@ Frontier需要主动连接Frontlas以上报自己、微服务和边缘的活跃 **Frontier**的frontier.yaml需要添加如下配置： -``` +```yaml frontlas: enable: true dial: @@ -952,7 +952,7 @@ Frontier需要连接Frontlas，用来上报自己、微服务和边缘的活跃 **Frontlas**的frontlas.yaml最小化配置： -``` +```yaml control_plane: listen: # 微服务改连接这个地址，用来发现集群的边缘节点所在的Frontier @@ -1045,7 +1045,7 @@ make install && make deploy **CR** -``` +```yaml apiVersion: frontier.singchia.io/v1alpha1 kind: FrontierCluster metadata: From 14e17e139796c44a42a9d258824ccf3609cc1e70 Mon Sep 17 00:00:00 2001 From: singchia Date: Fri, 31 May 2024 00:29:35 +0800 Subject: [PATCH 4/4] readme: fix spell error in yaml blocl --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 15b2372..b3b477c 100644 --- a/README.md +++ b/README.md @@ -769,9 +769,9 @@ mqm: # 生产者 producer: # exchange名 - exchange: "" - # 等于Frontier内Topic的概念，数组值 - routing_keys: null + exchange: "" + # 等于Frontier内Topic的概念，数组值 + routing_keys: null ``` 对于AMQP来说，以上是最小配置，边缘节点Publish的消息Topic如果在routing_keys内，Frontier会Publish到exchange中，如果还有微服务或其他外部MQ也声明了该Topic，Frontier仍然会按照hashby来选择一个Publish。 @@ -787,7 +787,7 @@ mqm: # 生产者 producer: # 数组值 - topics: null + topics: null ``` 对于Kafka来说，以上是最小配置，边缘节点Publish的消息Topic如果在上面数组中，Frontier会Publish过来。如果还有微服务或其他外部MQ也声明了该Topic，Frontier仍然会按照hashby来选择一个Publish。