Skip to content

Commit 114421f

Browse files
authored
Docs: Add a multi-tenant warning. (#12091)
1 parent f034444 commit 114421f

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ balancer.
1717

1818
See the [Getting Started](https://kubernetes.github.io/ingress-nginx/deploy/) document.
1919

20+
Do not use in multi-tenant Kubernetes production installations. This project assumes that users that can create Ingress objects are administrators of the cluster. See the [FAQ](https://kubernetes.github.io/ingress-nginx/faq/#faq) for more.
21+
2022
## Troubleshooting
2123

2224
If you encounter issues, review the [troubleshooting docs](docs/troubleshooting.md),

docs/deploy/hardening-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

22
# Hardening Guide
33

4+
Do not use in multi-tenant Kubernetes production installations. This project assumes that users that can create Ingress objects are administrators of the cluster.
5+
46
## Overview
57
There are several ways to do hardening and securing of nginx. In this documentation two guides are used, the guides are
68
overlapping in some points:

docs/faq.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11

22
# FAQ
33

4+
## Multi-tenant Kubernetes
5+
6+
Do not use in multi-tenant Kubernetes production installations. This project assumes that users that can create Ingress objects are administrators of the cluster.
7+
8+
For example, the Ingress NGINX control plane has global and per Ingress configuration options that make it insecure, if enabled, in a multi-tenant environment.
9+
10+
For example, enabling snippets, a global configuration, allows any Ingress object to run arbitrary Lua code that could affect the security of all Ingress objects that a controller is running.
11+
12+
We changed the default to allow snippets to `false` in https://github.com/kubernetes/ingress-nginx/pull/10393.
13+
414
## Multiple controller in one cluster
515

616
Question - How can I easily install multiple instances of the ingress-nginx controller in the same cluster?

0 commit comments

Comments
 (0)