linkerd / linkerd/linkerd2

Document ingress containers must not be in hostNetwork mode

Open Beginner friendly
#8,936 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/docs enhancement help wanted
Dominant language
Go
Stars
11.5k
Forks
1.4k
Avg merge
3d 22h
Merged PRs (30d)
53

Description

### What problem are you trying to solve?

Setting up an Nginx ingress per this page - https://linkerd.io/2.11/tasks/using-ingress/ - won't work if the ingress controller (at least Nginx, but others no doubt) is in host mode. It's a known problem, but only after you figure out why linkerd isn't being injected (https://github.com/linkerd/linkerd2/issues/7949).

This is the default install mode for Rancher's rke2 / rke2-ingress-nginx, to run with `hostNetwork: true`

### How should the problem be solved?

At least, add a note on the https://linkerd.io/2.11/tasks/using-ingress/ page about the ingress cannot be running in host mode.

It'd be neat if the check tool detected annotations applied to pods, but the extra containers aren't deployed too. (This check tool is super neat too btw, as is the whole project.)

Another option is https://github.com/linkerd/linkerd2/issues/3330

### Any alternatives you've considered?

Alternative I applied was to remove hostNetwork mode from my ingress.

### How would users interact with this feature?

Reading

### Would you like to work on this feature?

maybe

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked 2.11 tasks/using-ingress/ page and review how it explains ingress controller setup. Document that ingress controllers using hostNetwork, including the described Nginx setup, are incompatible with injection; the work is done when readers can find this limitation and the alternative configuration guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, nginx
Domain
devops, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.