fix(vm-instance): keep an external PortList VM valid with no ports (#5270)

## What this PR does

A `vm-instance` with `external: true`, `externalMethod: PortList` and an
empty `externalPorts` list renders a `LoadBalancer` Service with no port
at all. The API server rejects it (`Service "vm-instance-<name>" is
invalid: spec.ports: Required value`), so the HelmRelease fails on every
retry. The previous Service stays in place meanwhile, which means the
ports the user believes they removed are still open.

Emptying the list is a legitimate request: keep the VM's external IP
(egress SNAT, ICMP) but expose no inbound port. This PR renders a single
placeholder port in that case, `65535/SCTP`, named `no-ports`. The
protocol is the point: cozy-proxy's `EnsurePortFilter` only admits TCP
and UDP ports into `allowed_ports` and skips anything else, while the
pod still enters `filtered_pods`, so every inbound TCP and UDP packet is
dropped. A TCP or UDP placeholder would open that port on the VM
instead.

The `WholeIP` branch and the non-external branch keep their existing
`65535` placeholder unchanged.

Tested on a lab cluster running cozy-proxy with node-local rules,
against a running PortList VM exposing 22 and 80: with the placeholder
Service, MetalLB kept the same IP, cozy-proxy logged `Skipping
unsupported protocol for port filter` and kept the egress SNAT and
ingress DNAT, TCP 22, 80 and 65535 timed out from outside, ICMP still
answered (`allowICMP: "true"`), and the Cilium agents logged nothing
about the Service. Restoring the port list reopened 22 and 80.

`tests/service_ports_test.yaml` covers the three external cases. Its
first case fails on `main` (`unknown path spec.ports[0]`) and passes
with the fix.

### Screenshots

Not a UI change.

### Downstream repositories

Walked the trigger map against the diff (`templates/service.yaml` and a
new unit test in `packages/apps/vm-instance`): no package is added or
renamed, no value, schema, default or annotation changes, and the
`service-proxy-name` label and the `wholeIP` / `allowICMP` annotations
cozy-proxy matches on are untouched. The fix does rely on cozy-proxy
ignoring non-TCP/UDP ports in its port filter, which holds on cozy-proxy
`main` today; if it ever learns SCTP, this placeholder would open
`65535/SCTP` and nothing else.

- [x] No downstream repository is affected by this change
- [ ] [cozystack/website](https://github.com/cozystack/website) -
follow-up:
- [ ]
[cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack)
- follow-up:
- [ ]
[cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack)
- follow-up:
- [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up:
- [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up:
- [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) -
follow-up:
- [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) -
follow-up:
- [ ]
[cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server)
- follow-up:
- [ ]
[cozystack/external-apps-example](https://github.com/cozystack/external-apps-example)
- follow-up:
- [ ] [cozystack/examples](https://github.com/cozystack/examples) -
follow-up:
- [ ] [cozystack/community](https://github.com/cozystack/community) -
follow-up:

### Release note

```release-note
fix(vm-instance): an external PortList VM with an empty port list no longer fails to deploy; it keeps its external IP and blocks all inbound TCP and UDP traffic.
```


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

* **Bug Fixes**
* External services without configured ports now include an SCTP
placeholder on port 65535, except for `WholeIP` services, whose existing
behavior is unchanged.
* Services with configured ports continue to render those ports without
the placeholder. This keeps the rendered service configuration
consistent across these cases.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Aleksei Sviridkin authored and GitHub committed 2026-11-13 12:20:42 +03:00
commit 8741fb31f9
2 files changed
+77

No files matched your search

@@ -30,6 +30,13 @@ spec:
{{- if .Values.external }}
{{- if and (eq .Values.externalMethod "WholeIP") (not .Values.externalPorts) }}
- port: 65535
{{- else if not .Values.externalPorts }}
{{- /* A Service needs at least one port. cozy-proxy only admits TCP and
UDP ports into its PortList filter, so an SCTP placeholder keeps the
external IP while every inbound TCP and UDP packet is dropped. */}}
- name: no-ports
port: 65535
protocol: SCTP
{{- else }}
{{- range .Values.externalPorts }}
- name: port-{{ . }}
@@ -0,0 +1,70 @@
suite: vm-instance external Service ports
# The API server rejects a Service without ports, so an external PortList VM
# whose port list was emptied could not be upgraded at all. The placeholder
# must be SCTP: cozy-proxy only admits TCP and UDP ports into its filter, so
# any TCP or UDP placeholder would open that port on the VM.
release:
name: test-vm
namespace: tenant-test
templates:
- templates/service.yaml
set:
fullnameOverride: test-vm
external: true
tests:
- it: renders an SCTP placeholder for PortList with no ports
set:
externalMethod: PortList
externalPorts: []
asserts:
- equal:
path: spec.type
value: LoadBalancer
- equal:
path: metadata.annotations["networking.cozystack.io/wholeIP"]
value: "false"
- lengthEqual:
path: spec.ports
count: 1
- equal:
path: spec.ports[0]
value:
name: no-ports
port: 65535
protocol: SCTP
- it: renders the listed ports for PortList
set:
externalMethod: PortList
externalPorts: [22, 443]
asserts:
- lengthEqual:
path: spec.ports
count: 2
- equal:
path: spec.ports[0]
value:
name: port-22
port: 22
targetPort: 22
- notContains:
path: spec.ports
content:
name: no-ports
port: 65535
protocol: SCTP
- it: keeps the WholeIP placeholder when no ports are listed
set:
externalMethod: WholeIP
externalPorts: []
asserts:
- equal:
path: metadata.annotations["networking.cozystack.io/wholeIP"]
value: "true"
- equal:
path: spec.ports
value:
- port: 65535