Skip to content

Commit 02dcfc2

Browse files
authored
Merge pull request #67 from Jefftree/client-proxy-separation-readme
Add note about importing root module
2 parents 5a1d08f + 8910850 commit 02dcfc2

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ build docker/proxy-agent
4040

4141
## Examples
4242

43-
The current examples run two actual services as well as a sample client on one end and a sample destination for
43+
The current examples run two actual services as well as a sample client on one end and a sample destination for
4444
requests on the other.
4545
- *Proxy service:* The proxy service takes the API server requests and forwards them appropriately.
4646
- *Agent service:* The agent service connects to the proxy and then allows traffic to be forwarded to it.
@@ -109,7 +109,11 @@ curl -v -p --proxy-key certs/master/private/proxy-client.key --proxy-cert certs/
109109
```
110110

111111
### Running on kubernetes
112-
See following [README.md](examples/kubernetes/README.md)
112+
See following [README.md](examples/kubernetes/README.md)
113+
114+
### Clients
115+
116+
`apiserver-network-proxy` components are intended to run as standalone binaries and should not be imported as a library. Clients communicating with the network proxy can import the `konnectivity-client` module.
113117

114118
## Troubleshoot
115119

0 commit comments

Comments
 (0)