Skip to content

Commit 7c1a57f

Browse files
author
Nicolas Perraut
committed
Add usage and warning in README
[skip build]
1 parent 43a98b3 commit 7c1a57f

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Tunack
22

3+
:warning: Tunack is under heavy development, __NOT SUITABLE FOR PRODUCTION__ (or at your own risks). PR are warmly welcomed
4+
35
Tcp and Udp Nginx Auto Config in Kubernetes
6+
47
Auto configuration service for TCP and UDP services for Kubernetes Nginx ingress manager
58

69
## Getting Started
@@ -20,6 +23,38 @@ kubectl apply -f https://raw.githubusercontent.com/mafzst/tunack/v0.1.0/deploy/w
2023

2124
It will create a deployement in `ingress-nginx` namespace
2225

26+
## Usage
27+
28+
Tunack uses annotations in services to detect ports to expose.
29+
30+
### Synopsis
31+
32+
`tunack.dahus.io/[protocol]-service-[proxyPort]: [servicePort]`
33+
34+
- __protocol__: `tcp|udp`: Specify service type
35+
- __proxyPort__: Port to export to outside (ie. public port)
36+
- __servicePort__: Target service port (ie. port on which your service is listening to)
37+
38+
__ONLY TCP IS IMPLEMENTED YET__
39+
40+
### Example
41+
42+
``` yaml
43+
apiVersion: v1
44+
kind: Service
45+
metadata:
46+
name: my-tcp-service
47+
annotations:
48+
- tunack.dahus.io/tcp-service-3000: 80
49+
spec:
50+
ports:
51+
- port: 80
52+
targetPort: 8080
53+
selector:
54+
app: my-tcp-service
55+
56+
```
57+
2358
## Contributing
2459

2560
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

0 commit comments

Comments
 (0)