@@ -47,6 +47,12 @@ NOTE: The forwarding session is not affected after rolling update.
47
47
| [ Krew] ( https://krew.sigs.k8s.io/ ) | ` kubectl krew install relay ` |
48
48
| Pre-built binaries for macOS, Linux | [ GitHub releases] ( https://github.com/knight42/krelay/releases ) |
49
49
50
+ NOTE: If you only have limited access to the cluster, please make sure the permissions specified in [ rbac.yaml] ( ./manifests/rbac.yaml )
51
+ is granted:
52
+ ``` bash
53
+ kubectl create -f https://raw.githubusercontent.com/knight42/krelay/main/manifests/rbac.yaml
54
+ ```
55
+
50
56
### Build from source
51
57
52
58
```
@@ -75,17 +81,17 @@ kubectl relay host/redis.cn-north-1.cache.amazonaws.com 6379
75
81
# Listen on port 5000 and 6000 locally, forwarding data to "1.2.3.4:5000" and "1.2.3.4:6000" from the cluster
76
82
kubectl relay ip/1.2.3.4 5000@tcp 6000@udp
77
83
78
- # Forwarding local port 8080 to 8080 in the service , and delete the krelay-server pod after the command has finished.
79
- kubectl relay --rm svc/my-service 8080
84
+ # Create the agent in the kube-public namespace , and forward local port 5000 to "1.2.3.4:5000"
85
+ kubectl relay --server.namespace kube-public ip/1.2.3.4 5000
80
86
```
81
87
82
88
## Flags
83
89
84
- | flag | default | description |
85
- | ------------------| -----------------------------------------| --------------- -------------------------------------------------------------|
86
- | ` --address ` | ` 127.0.0.1 ` | Address to listen on. Only accepts IP addresses as a value. |
87
- | ` --rm ` | ` false ` | Automatically remove the krelay-server pod after the command has finished. |
88
- | ` --server-image ` | ` ghcr.io/knight42/krelay-server:v0.0.1 ` | The krelay-server image to use. |
90
+ | flag | default | description |
91
+ | ----------------------| -----------------------------------------| -------------------------------------------------------------|
92
+ | ` --address ` | ` 127.0.0.1 ` | Address to listen on. Only accepts IP addresses as a value. |
93
+ | ` --server.image ` | ` ghcr.io/knight42/krelay-server:v0.0.1 ` | The krelay-server image to use. |
94
+ | ` --server.namespace ` | ` default ` | The namespace in which krelay-server is located. |
89
95
90
96
## How It Works
91
97
0 commit comments