Skip to content

Commit 7a1f800

Browse files
committed
Update TCP ingress documentation with correct Service name and one-time setup instructions
1 parent d85b186 commit 7a1f800

File tree

1 file changed

+7
-32
lines changed

1 file changed

+7
-32
lines changed

TCP_INGRESS_SETUP.md

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,9 @@ Pyrom uses **telnet (TCP protocol)**, not HTTP. The standard HTTP Ingress won't
66

77
## Solution
88

9-
### 1. Apply the TCP Services ConfigMap
9+
### 1. Apply the TCP Services ConfigMap (Managed by ArgoCD)
1010

11-
The ConfigMap tells ingress-nginx which TCP ports to route to which services:
12-
13-
```bash
14-
# Apply via ArgoCD (recommended)
15-
kubectl apply -f argocd/ingress-nginx-tcp-config.yaml
16-
17-
# Or apply directly
18-
kubectl apply -f k8s/ingress-nginx/tcp-services-configmap.yaml
19-
```
11+
The ConfigMap tells ingress-nginx which TCP ports to route to which services. This is **automatically managed by ArgoCD** via the `pyrom-app-of-apps`.
2012

2113
Verify it's applied:
2214

@@ -33,38 +25,21 @@ data:
3325
"1339": "pyrom-dev/pyrom-service:1337"
3426
```
3527
36-
### 2. Configure ingress-nginx Controller to Expose TCP Ports
28+
### 2. Configure ingress-nginx Controller to Expose TCP Ports (One-Time Setup)
3729
38-
The ingress-nginx controller Service needs to expose these TCP ports. You have two options:
30+
The ingress-nginx controller Service needs to expose these TCP ports. This is a **one-time manual step** because the Service is managed by Helm, not ArgoCD.
3931
40-
#### Option A: Patch the existing ingress-nginx controller Service
32+
**Important**: The actual Service name in your cluster is `ingressnginx-ingress-nginx-controller`, not `ingress-nginx-controller`.
4133

4234
```bash
43-
kubectl patch service ingress-nginx-controller -n ingress-nginx --type='json' -p='[
35+
kubectl patch service ingressnginx-ingress-nginx-controller -n ingress-nginx --type='json' -p='[
4436
{"op": "add", "path": "/spec/ports/-", "value": {"name": "pyrom-prod", "port": 1337, "protocol": "TCP", "targetPort": 1337}},
4537
{"op": "add", "path": "/spec/ports/-", "value": {"name": "pyrom-staging", "port": 1338, "protocol": "TCP", "targetPort": 1338}},
4638
{"op": "add", "path": "/spec/ports/-", "value": {"name": "pyrom-dev", "port": 1339, "protocol": "TCP", "targetPort": 1339}}
4739
]'
4840
```
4941

50-
#### Option B: Edit the ingress-nginx Helm values (if using Helm)
51-
52-
If you installed ingress-nginx via Helm, update the values:
53-
54-
```yaml
55-
tcp:
56-
1337: "pyrom-prod/pyrom-service:1337"
57-
1338: "pyrom-staging/pyrom-service:1337"
58-
1339: "pyrom-dev/pyrom-service:1337"
59-
```
60-
61-
Then upgrade:
62-
63-
```bash
64-
helm upgrade ingress-nginx ingress-nginx/ingress-nginx \
65-
-n ingress-nginx \
66-
-f ingress-nginx-values.yaml
67-
```
42+
**Note**: This patch persists across ingress-nginx controller restarts, but may be lost if you upgrade or reinstall ingress-nginx via Helm. If that happens, just re-run the patch command above.
6843

6944
### 3. Verify the Setup
7045

0 commit comments

Comments
 (0)