Copilot commented on code in PR #74: URL: https://github.com/apache/dubbo-go-pixiu-samples/pull/74#discussion_r2096987977
########## README_CN.md: ########## @@ -0,0 +1,61 @@ +# Dubbo-go-pixiu 示例 + + + +[dubbo-go-pixiu](https://github.com/apache/dubbo-go-pixiu) 的示例 + +[中文 🇨🇳](./README_CN.md) + +## 包含内容 + +- dubbogo/simple：此目录包含 dubbogo 和 pixiu 的一些简单示例 + - dubbogo/simple/bestdo：包含 jaeger 和 http 到 dubbo + - dubbogo/simple/body：http 到 dubbo，使用 api_config.yaml + - dubbogo/simple/csrf：CSRF 保护 + - dubbogo/simple/direct：http 到 dubbo 的直接泛化调用 + - dubbogo/simple/farconfnacos：pixiu 使用 nacos 远端配置中心 + - dubbogo/simple/jaeger：pixiu 集成 jaeger + - dubbogo/simple/jwt：JWT 认证 + - dubbogo/simple/nacos：http 到 dubbo，使用 nacos 作为注册中心 + - dubbogo/simple/prometheus：pixiu 集成 prometheus + - dubbogo/simple/dubboproxy：dubbo 到 http 转换和 http 到 dubbo 转换 + - dubbogo/simple/resolve：http 到 dubbo 的协议自动解析 + - dubbogo/simple/traffic：流量切分和金丝雀发布 + - dubbogo/simple/triple：http 到 triple + - dubbogo/simple/zookeeper：pixiu 集成 dubbo，使用 zookeeper 作为注册中心 + +- dubbohttpproxy：dubbo 到 http 转换和 http 到 dubbo 转换 +- dubbotripleproxy：dubbo 到 triple 转换和 triple 到 dubbo 转换 + +- grpc：gRPC 代理 + +- http/grpc：http 到 gRPC 转换 +- http/simple：简单的 HTTP 代理 + +- llm：pixiu 调用 LLM 的简单示例 + +- plugins：此目录包含 pixiu 的一些插件 + - plugins/ratelimit：pixiu 的 ratelimit 插件 + +- seata：示了如何配置 Seata filter 与 Seata TC 交互对分布式事务进行协调 Review Comment: Consider revising '示了' to a fuller form such as '演示了' or '展示了' for improved clarity. ```suggestion - seata：演示了如何配置 Seata filter 与 Seata TC 交互对分布式事务进行协调 ``` ########## README.md: ########## @@ -1,87 +1,60 @@ -# samples +# Dubbo-go-pixiu Samples + + + samples for [dubbo-go-pixiu](https://github.com/apache/dubbo-go-pixiu) +[中文 🇨🇳](./README_CN.md) ## What It Contains -- dubbogo/simple/nacos: http to dubbo with nacos registry -- dubbogo/simple/triple: http to triple -- dubbogo/simple/jaeger: pixiu with jaeger -- dubbogo/simple/direct: http to dubbo with direct generic call -- dubbogo/simple/body: http to dubbo with api_config.yaml -- dubbogo/simple/resolve: http to dubbo with auto resolve protocol +- dubbogo/simple: this directory contains some simple samples for dubbogo and pixiu + - dubbogo/simple/bestdo: include jaeger and http to dubbo + - dubbogo/simple/body: http to dubbo with api_config.yaml + - dubbogo/simple/csrf: csrf protection + - dubbogo/simple/direct: http to dubbo with direct generic call + - dubbogo/simple/farconfnacos: pixiu with nacos remote Configuration Center + - dubbogo/simple/jaeger: pixiu with jaeger + - dubbogo/simple/jwt: jwt authentication + - dubbogo/simple/nacos: http to dubbo with nacos registry + - dubbogo/simple/prometheus: pixiu with prometheus + - dubbogo/simple/dubboproxy: dubbo to http transform and http to dubbo transform + - dubbogo/simple/resolve: http to dubbo with auto resolve protocol + - dubbogo/simple/traffic: traffic splitting and canary release + - dubbogo/simple/triple: http to triple + - dubbogo/simple/zookeeper: pixiu with dubbo using zookeeper as registry center + +- dubbohttpproxy: dubbo to http transform and http to dubbo transform +- dubbotripleproxy: dubbo to triple transform and triple to dubbo transform - grpc: grpc proxy -- http/grpc: http to grpc transform -- http/simple: http proxy - -- springcloud: http proxy with spring cloud registry -- xds: pixiu with xds - -## How to run - -#### cd samples dir - -``` -cd dubbogo/simple -``` - -we can use start.sh to run samples quickly. for more info, execute command as below for more help - -``` -./start.sh [action] [project] -./start.sh help -``` - -we run body samples below step -#### prepare config file and docker - -prepare command will prepare dubbo-server and pixiu config file and start docker container needed - -``` -./start.sh prepare body -``` - -if prepare config file manually, notice: -- modify $PROJECT_DIR in conf.yaml to absolute path in your compute - -#### start dubbo or http server - -``` -./start.sh startServer body -``` - -#### start pixiu - -``` -./start.sh startPixiu body -``` - -if run pixiu manually in pixiu project, use command as below. - -``` - go run pixiu/*.go gateway start -c /[absolute-path]/dubbo-go-pixiu/samples/dubbogo/simple/body/pixiu/conf.yaml -``` +- http/grpc: http to grpc transform +- http/simple: simple http proxy +- llm: simple sample for pixiu to call llm -#### Try a request +- plugins: this directory contains some plugins for pixiu + - plugins/ratelimit: rate limit plugin for pixiu -use curl to send request +- seata: This demonstrates how to configure the Seata filter to interact with the Seata TC for distributed transaction coordination. -```bash -curl -X POST 'localhost:8881/api/v1/test-dubbo/user' -d '{"id":"0003","code":3,"name":"dubbogo","age":99}' --header 'Content-Type: application/json' -``` +- shutdown: this directory demonstrates how to gracefully shut down + - shutdown/dubbo: This demonstrates how to gracefully shut down the Pixiu server with dubbo listener. + - shutdown/http: This demonstrates how to gracefully shut down the Pixiu server with http listener. + - shutdown/http2: This demonstrates how to gracefully shut down the Pixiu server with http2 listener. + - shutdown/triple: This demonstrates how to gracefully shut down the Pixiu server with triple listener. -or just run unit test +- springcloud: http proxy with spring cloud registry +- xds: pixiu with xds -```bash -./start.sh startTest body +## How To Run -``` +Pls refer [How To Run](HOWTO.md) for the instructions. -#### Clean +## How to contribute -``` -./start.sh clean body -``` \ No newline at end of file +If you want to add more samples, pls. read on: +1. Create new sub directory and give it an appropriate name for your new sample. Pls follow the layout of the existing sample if you are not sure how to organize your code. +2. Make sure your sample work as expected before submit PR, and make sure GitHub CI passes after PR is submitted. Pls refer to the existing sample on how to test the sample. +3. Pls provide README.md to explain your samples. Review Comment: [nitpick] Consider replacing abbreviated 'Pls' with 'Please' to maintain a formal tone. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
