File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed
Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change 11# Tunack
22
3+ :warning : Tunack is under heavy development, __ NOT SUITABLE FOR PRODUCTION__ (or at your own risks). PR are warmly welcomed
4+
35Tcp and Udp Nginx Auto Config in Kubernetes
6+
47Auto 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
2124It 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
2560Please read [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for details on our code of conduct, and the process for submitting pull requests to us.
You can’t perform that action at this time.
0 commit comments