Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wzshiming committed Sep 21, 2022
1 parent a431623 commit 108b9b1
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/roadmap.md
Expand Up @@ -10,10 +10,10 @@ This document outlines some goals, non-goals, and future aspirations for Ferry a
- [x] Support multi-level proxy
- [x] Support for [mcs api](https://github.com/kubernetes-sigs/mcs-api)
- [x] Load balancing
- [x] Monitor status and display in Hub's status

## TODO
- [ ] Support complete uninstallation of itself and cleanup
- [ ] Monitor status and display in Hub's status
- [ ] Adapting to the ecosystem
- [ ] Multi-replicas tunnels for a single Hub
- [ ] SSH-via-QUIC: QUIC is used to replace TCP in SSH, no need to reconnect after an IP change, expect better performance
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/user/examples/manual.md
Expand Up @@ -19,15 +19,15 @@ The routing rules configured by this feature are not controlled by the ferry-con
### Define exporting a service from another cluster

``` bash
ferryctl local manual import --reachable=true "--tunnel-address=${HOST_IP}:31000" --export-host-port=web-1.test.svc:8080 --import-service-name=web-1-8080
ferryctl local manual import --reachable=true --tunnel-address=tunneladdress:31000 --export-service=web-1.test --import-service=web-1-8080.ferry-tunnel-system --port=8080
```

This command describes the mapping of the web-1.test.svc:8080 service of the export service cluster to the web-1-8080.ferry-tunnel-system:8080 service of the current cluster

--reachable=true Is the current cluster is reachable
--tunnel-address The address of the Tunnel if the current cluster is reachable
--export-host-port Service ports exported from other clusters
--import-service-name Mapped services created by the current cluster from services exported from other clusters (by default under the ferry-tunnel-system namespace)
--port The port of the service exported from the other cluster
--export-service Service exported from other cluster
--import-service Mapping service created by the current cluster from services exported from other clusters

Need [handshake](/docs/user/handshake)

Expand Down
3 changes: 1 addition & 2 deletions content/zh/docs/roadmap.md
Expand Up @@ -10,18 +10,17 @@
- [x] 支持多级代理
- [x] 支持 [mcs api](https://github.com/kubernetes-sigs/mcs-api)
- [x] 负载均衡
- [x] 监控状态,并显示在Hub的状态中

## TODO
- [ ] 支持完整的卸载自身和清理
- [ ] 监控状态,并显示在Hub的状态中
- [ ] 适配上下游生态
- [ ] 单个 Hub 支持多副本 Tunnel
- [ ] SSH-via-QUIC: Tunnel 之间的 ssh 协议使用 quic 替换 tcp, 在 IP 变化后无需重新连接, 预期更好的性能
- [ ] 支持任何设备主动连接并加入作为 Hub, 提供 SDK 和 Binary
- [ ] 支持两个无公网 IP 的 Hub 经过控制面撮合, 通过 UDP p2p 直连
- [ ] 故障转移
- [ ] 就近访问
- [ ] 访问控制

## IDEA
- [ ] 提供流量和业务性能的视图
Expand Down
8 changes: 4 additions & 4 deletions content/zh/docs/user/examples/manual.md
Expand Up @@ -19,15 +19,15 @@ title: "手动映射服务"
### 定义从其他集群导出某一服务

``` bash
ferryctl local manual import --reachable=true "--tunnel-address=${HOST_IP}:31000" --export-host-port=web-1.test.svc:8080 --import-service-name=web-1-8080
ferryctl local manual import --reachable=true --tunnel-address=tunneladdress:31000 --export-service=web-1.test --import-service=web-1-8080.ferry-tunnel-system --port=8080
```

这条命令描述将导出服务集群的 web-1.test.svc:8080 服务映射到当前集群的 web-1-8080.ferry-tunnel-system:8080 服务

--reachable=true 当前集群是否可以达到
--tunnel-address 当前集群如果可以达到的情况下 Tunnel 的地址
--export-host-port 从其他集群导出的服务端口
--import-service-name 当前集群从其他集群导出的服务建立的映射服务 (默认在 ferry-tunnel-system 命名空间下)
--port 从其他集群导出的服务端口
--export-service 从其他集群导出的服务
--import-service 当前集群从其他集群导出的服务建立的映射服务

需要[握手](/docs/user/handshake)

Expand Down

0 comments on commit 108b9b1

Please sign in to comment.