Commit graph

529 commits

Author SHA1 Message Date
Makhonin Alexey
a2c9b8833b
Add docs about orphan_ingress metric (#9514) 2023-01-16 13:26:38 -03:00
Libor Ryšavý
dbe88c55a3
Sanitise request metrics in monitoring docs (#9384)
Also add more detailed description to `nginx_ingress_controller_request_duration_seconds`
and `nginx_ingress_controller_response_duration_seconds` based on NGINX docs.
Also reformat the list so the descriptions are under the corresponding list item.
2023-01-16 04:18:51 -08:00
lythandas
1a65027e4c
Change default value of enable-brotli (#9500) 2023-01-15 18:52:50 -08:00
Tomas Hulata
5b2a9475dc
feat: support topology aware hints (#9165)
* support topology aware hints

Signed-off-by: tombokombo <tombo@sysart.tech>

* add flag to enable topology and fixes

Signed-off-by: tombokombo <tombo@sysart.tech>

* update readme

Signed-off-by: tombokombo <tombo@sysart.tech>

* add e2e test

Signed-off-by: tombokombo <tombo@sysart.tech>

* isolate topology test

Signed-off-by: tombokombo <tombo@sysart.tech>

* gofmt fix

Signed-off-by: tombokombo <tombo@sysart.tech>

Signed-off-by: tombokombo <tombo@sysart.tech>
2023-01-15 18:46:50 -08:00
Marcus Noble
e7bee5308e
added option to disable sync event creation (#8528)
* added option to disable event creation

Signed-off-by: Marcus Noble <github@marcusnoble.co.uk>

* Re-trigger github workflows

Signed-off-by: Marcus Noble <github@marcusnoble.co.uk>

Signed-off-by: Marcus Noble <github@marcusnoble.co.uk>
2023-01-09 06:37:31 -08:00
Phil Nichol
8ed3a27e25
Adding ipdenylist annotation (#8795)
* feat: Add support for IP Deny List

* fixed gomod

* Update package

* go mod tidy

* Revert "go mod tidy"

This reverts commit e6a837e1e7.

* update ginko version

* Updates e2e tests

* fix test typo
2023-01-08 14:43:28 -08:00
Naseem Ullah
0b34a037ce
Update monitoring.md (#9269) 2023-01-08 14:27:28 -08:00
Aleksandr Lebedev
69b3e7e8c1
Update command line arguments documentation (#9224)
* update cli-arguents.md with latest version flags.go

* correct punctuation in pkg/flag/flags.go
2022-12-26 13:23:26 -08:00
Tomek Święcicki
f9cce5a4ed
[user-guide configmap] fix doc for global-auth-snippet (#9372) 2022-12-06 07:26:38 -08:00
Justin Wood (Callek)
f71f109b8d
Fix styling in canary annotation docs. (#9259)
Before this change, it appears on the website as:
> A weight of means implies all requests will be sent to the alternative service specified in the Ingress. `<weight-total>` defaults to 100, and can be increased via `nginx.ingress.kubernetes.io/canary-weight-total`.

Where there is the term `weight-total` as a pure html tag in the space.  This fixes it to actually display it as text in the prose.
2022-12-04 11:51:55 -08:00
Tatu Pesonen
8a5eaa63a9
fix(typo): pluralize provider (#9346) 2022-12-03 07:28:58 -03:00
Saumya
5aa49dc66d
removed deprecation messsage for ingressClass annotation (#9357)
* removed deprecation messsage for ingressClass annotation

* modified: docs/user-guide/multiple-ingress.md

* modified: docs/user-guide/multiple-ingress.md

* modified: docs/user-guide/multiple-ingress.md
2022-12-02 21:13:54 -08:00
Long Wu Yuan
1930b1467d
added SAN to cert create command (#9295) 2022-11-15 05:04:42 -08:00
Dmitry Bashkatov
e6ff97fbbe
Consistent prometheus metric names and documentation (#8728)
* clean prometheus metrics

- add new histogram metrics with consistent names
- deprecate summary metrics with inconsistent names

* update prometheus metrics tests

* remove ingress_upstream_header_seconds metric

It hasn't been released so it is safe. Use header_duration_seconds metric.

* add documentation on prometheus metrics
2022-09-30 08:00:36 -07:00
Nate Campbell
7cb91ef9c1
Support none keyword in log-format escape (#8692)
* Support none keyword in log-format escape


## What this PR does / why we need it:
ingress-nginx does not support disabling escaping of special characters in the nginx log. This PR exposes the setting to support that functionality.

## Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation only

## Which issue/s this PR fixes
<!--
(optional, in `fixes #<issue number>` format, will close that issue when PR gets merged):

fixes #
-->

## How Has This Been Tested?
Followed the [getting-started](96b6228a6b/docs/developer-guide/getting-started.md) guide. Used ppa:longsleep/golang-backports on WSL Ubuntu to establish a golang-1.18 environment with latest docker and recommended kind. Built the dev-env successfully; had issues with make test, but they are entirely unrelated to anything I touched. Ultimate test was
```
FOCUS=log-format make kind-e2e-test
...
Ginkgo ran 1 suite in 6m29.7437865s
Test Suite Passed
```

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I've read the [CONTRIBUTION](https://github.com/kubernetes/ingress-nginx/blob/main/CONTRIBUTING.md) guide
- [x] I have added tests to cover my changes.
- [x] All new and existing tests passed.

I did not update docs/e2e-tests.md.

* gofmt -s ./internal/ingress/controller/config/config.go
2022-09-30 08:00:29 -07:00
Matthias Neugebauer
26fe69cb47
Add annotation for setting sticky cookie domain (#9088)
This adds the new annotation `nginx.ingress.kubernetes.io/session-cookie-domain`
for setting the cookie `Domain` attribute of the sticky cookie.

Signed-off-by: Matthias Neugebauer <mtneug@mailbox.org>

Signed-off-by: Matthias Neugebauer <mtneug@mailbox.org>
2022-09-28 07:28:37 -07:00
Ismayil Mirzali
45f71d5a16
make keep-alive docs more explicit #8927 (#8944)
Signed-off-by: Ismayil Mirzali <ismayilmirzeli@gmail.com>

Signed-off-by: Ismayil Mirzali <ismayilmirzeli@gmail.com>
2022-08-22 16:30:28 -07:00
Edvin N
63edd3befd
Document internal-logger-address cli arg (#8873)
Signed-off-by: Edvin Norling <edvin.norling@xenit.se>

Signed-off-by: Edvin Norling <edvin.norling@xenit.se>
2022-08-22 16:14:09 -07:00
qilong.qiu
a581a7bebc
Add docs on Election ID to Multiple Ingress Controller guide (#8855) 2022-07-22 04:21:38 -07:00
inosato
ac3c338e7e
FIx typo x_forwarded_for (#8838) 2022-07-20 08:46:36 -07:00
Miguel Martínez
64efad8415
Fixed typo (#8817) 2022-07-12 17:41:37 -07:00
Taylor Monacelli
23cc900690
Update docs to make it easier for noobs to follow step by step (#8738)
* Change helm release name in docs

Following step by step instructions in readme I ran into error:
Error: release: not found

And realized the commandline was differnent from description.  Let
change description to match commandline?

* Fix verb tense in docs
2022-07-03 10:35:21 -07:00
Long Wu Yuan
96b6228a6b
changed k8s.gcr.io to registry.k8s.io (#8667) 2022-06-10 04:01:52 -07:00
zou rui
2852e2998c
feat: support enbale nginx debug_connection (#8637) 2022-06-10 04:01:46 -07:00
Filip Petkovski
4da96ea26a
Implement reporting status classes in metrics (#8548)
This commit introduces a backwards compatible command line option
--report-status-classes which will enable reporting response status classes
(2xx, 3xx..) instead of status codes in exported metrics.
2022-05-21 11:18:00 -07:00
Maksim Nabokikh
2c27e66cc7
feat: always set auth cookie (#8213)
* feat: always set auth cookie

Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>

* feat: Add annotation to always set auth cookie

* Add annotation
* Add global configmap key
* Provide unit tests and e2e tests
* Fix e2e documentation autogen script

Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>

* Regenerate e2e tests

Signed-off-by: m.nabokikh <maksim.nabokikh@flant.com>
2022-05-19 15:27:53 -07:00
serge-r
730b7408ca
Add header Host into mirror annotations (#8178) 2022-05-07 17:39:17 -07:00
Alexey Miasoedov
67e430cb3a
fix typo (#8550) 2022-05-04 15:56:20 -07:00
kszafran
3230638160
Update default allowed CORS headers (#8459)
X-CustomHeader looks more like an example than a header we would want to
accept in production. Added Range as a useful header that enables
operations on resources that can be fetched in chunks.
2022-05-04 05:11:51 -07:00
Josh Soref
5a7d053c6f
Document nginx 1.19.7 deprecations pulled in by ingress-nginx 1.1.3 (#8532)
* Document nginx 1.19.7 deprecations pulled in by ingress-nginx 1.1.3

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Document ingress-nginx 1.1.3/1.3.0 removals

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2022-05-04 04:45:53 -07:00
Chris Shino
f9372aa495
added new auth-tls-match-cn annotation (#8434)
* added new auth-tls-match-cn annotation

* added few more tests
2022-04-15 12:59:10 -07:00
sskserk
d4b9b486e6
Upstream keepalive time (#8319)
* nginx 1.19.10 keepalive_time parameter

* nginx v1.19.10 base image

* keepalive_time documentation

* base image

* restore base image

* e2e test

* replace default value in test
2022-04-15 04:09:10 -07:00
Ricardo Katz
89ed571d2a
Implement object deep inspector (#8456) 2022-04-11 07:06:07 -07:00
Gabor Lekeny
83ce21b4dd
Add keepalive support for auth requests (#8219)
* Add keepalive support for auth requests

* Fix typo

* Address PR comments

* Log warning when auth-url contains variable in its host:port
* Generate upstream name without replacing dots to underscores in server name
* Add comment in the nginx template when the keepalive upstream block is referenced

* Workaround for auth_request module ignores keepalive in upstream block

* The `auth_request` module does not support HTTP keepalives in upstream block:
  https://trac.nginx.org/nginx/ticket/1579
* As a workaround we use ngx.location.capture but unfortunately it does not
  support HTTP/2 so `use-http2` configuration parameter is needed.

* Handle PR comments

* Address PR comments

* Handle invalid values for int parameters

* Handle PR comments

* Fix e2e test
2022-04-08 20:22:04 -07:00
Mathieu Parent
5e322f79a1
Fix suggested annotation-value-word-blocklist (#8446)
Signed-off-by: Mathieu Parent <mathieu.parent@insee.fr>
2022-04-08 20:14:04 -07:00
陳傑夫
c8ed1f1d7a
typo fixing (#8447) 2022-04-08 09:48:42 -07:00
Josh Soref
c6a8ad9a65
Darwin arm64 (#8399)
* Use sed instead of gnu find flags

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Support building linux/amd64 on darin/arm64

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Upgrade awesome_bot to dkhamsing/awesome_bot:1.20.0

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Favor find -prune for vendor

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Skip golang modcache folder

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Favor find -prune for changelog

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Ignore Changelogs of any case

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Fix service-l7 link

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Fix route53-mapper link

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Update rootfs contents description

The auxiliary scripts were removed after:
ab8349008a/rootfs/ingress-controller

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Update paths for modsecurity

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Update paths for modsecurity_snippet

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Update toc for 20190815-zone-aware-routing.md

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Use Internet Archive for datapath.io blog entry

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Use Internet Archive for cloudflare.com help center entry

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* Use https for nginx.org

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2022-04-06 13:46:26 -07:00
David Jansen
230d8e6792
doc: fix deployment manifest example (#8407) 2022-03-31 18:18:38 -07:00
Tomoyuki KOYAMA
08fcd942c7
fix code highlight (#8392) 2022-03-28 02:29:23 -07:00
Rodrigo Riccitelli Vieira
1fb0aea2c5
Update monitoring.md (#8324)
Added missing repo on "helm upgrade" command
2022-03-14 08:47:58 -07:00
hongkunyoo
5a9fe30a5d
Missing annotations (#8288)
Not quite sure but It seems that `nginx.ingress.kubernetes.io/canary-by-header` is missing.
2022-03-09 06:54:13 -08:00
Indhu Kumar
fd87363b5e
Issue#8241 (#8273)
* replace daemon set for deployment manifest

* nit
2022-02-26 14:53:17 -08:00
Goran
f85dd79221
Updated confusing error (#8262) 2022-02-21 11:52:01 -08:00
Indhu Kumar
be65620b31
prometheus+grafana using servicemonitor (#8186)
* prometheus+grafana using servicemonitor

* fix review comments

* markdown changes

* more formatting changes

* fix review comments
2022-02-07 01:47:45 -08:00
Alexander Brand
6b6ebf0a7c
Update the $req_id placeholder description (#8163) 2022-02-06 12:14:53 -08:00
Tiago Ferreira
8cf73d9720
Fix Indentation of example and link to cert-manager tutorial (#8203) 2022-01-27 08:34:59 -08:00
Sandip Bhattacharya
6eecefd3da
docs: fix inconsistent controller annotation (#8196)
The annotation for the controller class was inconsistent in the example. From my best understanding, I have tried to fix the inconsistency.

Also, removed an incomplete sentence. And made one sentence more clear by breaking it up.
2022-01-26 19:06:50 -08:00
Jintao Zhang
53ac0ddd42
Using Go install for misspell (#8191)
* chore: using go install misspell

Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>

* chore: fix typo

Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
2022-01-26 18:52:50 -08:00
Aditya Kamath
2aa34202c1
Allow to configure delay before controller exits (#8143)
* Allow to configure delay before controller exits

Signed-off-by: Aditya Kamath <theunrealgeek@gmail.com>

* Address comments

Signed-off-by: Aditya Kamath <theunrealgeek@gmail.com>
2022-01-17 15:24:49 -08:00
Josh Soref
1614027cd4
Minor documentation cleanup (#7826)
* clarify link

* Add section headers

* console blocks

* grpc example json was not valid

* multi-tls update text

The preceding point 1 related to 4f2cb51ef8/ingress/controllers/nginx/examples/ingress.yaml
and the deployments referenced in 4f2cb51ef8/ingress/controllers/nginx/examples/README.md

They are not relevant to the current instructions.

* add whitespace around parens

* grammar

setup would be a proper noun, but it is not the intended concept, which is a state

* grammar

* is-only
* via

* Use bullets for choices

* ingress-controller

nginx is a distinct brand.

generally this repo talks about ingress-controller, although it is quite inconsistent about how...

* drop stray paren

* OAuth is a brand and needs an article here

also GitHub is a brand

* Indent text under numbered lists

* use e.g.

* Document that customer header config maps changes do not trigger updates

This should be removed if
https://github.com/kubernetes/ingress-nginx/issues/5238
is fixed.

* article

* period

* infinitive verb + period

* clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application

* avoid using ; and reword

* whitespace

* brand: gRPC

* only-does is the right form

`for` adds nothing here

* spelling: GitHub

* punctuation

`;` is generally not the right punctuation...

* drop stray `to`

* sentence

* backticks

* fix link

* Improve readability of compare/vs

* Renumber list

* punctuation

* Favor Ingress-NGINX and Ingress NGINX

* Simplify custom header restart text

* Undo typo damage

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2022-01-16 16:57:28 -08:00