Skip to content

Commit

Permalink
Docs: Add a multi-tenant warning. (#12091)
Browse files Browse the repository at this point in the history
  • Loading branch information
strongjz authored Oct 4, 2024
1 parent f034444 commit 114421f
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ balancer.

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

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.

## Troubleshooting

If you encounter issues, review the [troubleshooting docs](docs/troubleshooting.md),
Expand Down
2 changes: 2 additions & 0 deletions docs/deploy/hardening-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

# Hardening Guide

Do not use in multi-tenant Kubernetes production installations. This project assumes that users that can create Ingress objects are administrators of the cluster.

## Overview
There are several ways to do hardening and securing of nginx. In this documentation two guides are used, the guides are
overlapping in some points:
Expand Down
10 changes: 10 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@

# FAQ

## Multi-tenant Kubernetes

Do not use in multi-tenant Kubernetes production installations. This project assumes that users that can create Ingress objects are administrators of the cluster.

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.

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.

We changed the default to allow snippets to `false` in https://github.com/kubernetes/ingress-nginx/pull/10393.

## Multiple controller in one cluster

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

0 comments on commit 114421f

Please sign in to comment.