Ingress NGINX Controller for Kubernetes
Find a file
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
.github expand CI testing for all stable versions of Kubernetes (#9078) 2022-09-29 10:40:39 -07:00
build updated testrunner image sha after bump to go1191 (#9058) 2022-09-16 15:36:49 -07:00
charts/ingress-nginx kubewebhookcertgen sha change after go1191 (#9059) 2022-09-29 08:42:54 -07:00
cmd plugin - endpoints to slices (#9081) 2022-09-28 07:34:36 -07:00
deploy release 1.3.1 (#9014) 2022-09-05 04:28:36 -07:00
docs Support none keyword in log-format escape (#8692) 2022-09-30 08:00:29 -07:00
hack release 1.3.1 (#9014) 2022-09-05 04:28:36 -07:00
images Update Version ModSecurity and Coreruleset (#9086) 2022-09-27 06:59:51 -07:00
internal Support none keyword in log-format escape (#8692) 2022-09-30 08:00:29 -07:00
pkg Add annotation for setting sticky cookie domain (#9088) 2022-09-28 07:28:37 -07:00
rootfs Support none keyword in log-format escape (#8692) 2022-09-30 08:00:29 -07:00
test Support none keyword in log-format escape (#8692) 2022-09-30 08:00:29 -07:00
version Refactor version helper (#4437) 2019-08-13 13:46:16 -04:00
.gitignore release 1.1.3 details (#8411) 2022-04-01 09:14:46 -07:00
.goreleaser.yaml Reimplement kubectl plugin release workflow (#8812) 2022-08-11 21:22:43 -07:00
.luacheckrc Enable lj-releng tool to lint lua code. 2020-06-09 18:01:35 +08:00
Changelog.md updates for fixing 1.3.1 release (#9023) 2022-09-05 19:10:56 -07:00
cloudbuild.yaml images: use k8s-staging-test-infra/gcb-docker-gcloud (#7999) 2021-12-12 05:19:59 -08:00
code-of-conduct.md Update code-of-conduct.md (#1842) 2017-12-20 15:34:27 -03:00
CONTRIBUTING.md Tips for new contributors (#8924) 2022-09-19 06:15:23 -07:00
go.mod Bump k8s.io/component-base from 0.25.1 to 0.25.2 (#9089) 2022-09-28 07:24:36 -07:00
go.sum Bump k8s.io/component-base from 0.25.1 to 0.25.2 (#9089) 2022-09-28 07:24:36 -07:00
ISSUE_TRIAGE.md Fix typos in ISSUE_TRIAGE.md (#7863) 2021-11-04 04:52:03 -07:00
LICENSE Initial commit 2016-11-04 23:54:14 +01:00
Makefile Reimplement kubectl plugin release workflow (#8812) 2022-08-11 21:22:43 -07:00
mkdocs.yml set edit_uri value with main branch (#8088) 2021-12-29 09:21:36 -08:00
NEW_CONTRIBUTOR.md Tips for new contributors (#8924) 2022-09-19 06:15:23 -07:00
NGINX_BASE bump baseimage alpine to v3.16.2 for zlib CVE fix (#8939) 2022-08-18 19:30:09 -07:00
OWNERS Comment busy owners (#8035) 2021-12-15 11:38:27 -03:00
OWNERS_ALIASES Promote Jintao to maintainer (#8485) 2022-04-17 15:26:41 -07:00
README.md release 1.3.1 (#9014) 2022-09-05 04:28:36 -07:00
RELEASE.md release 1.3.1 (#9014) 2022-09-05 04:28:36 -07:00
SECURITY.md Add SECURITY.md 2020-07-27 16:01:17 -06:00
SECURITY_CONTACTS Add security contacts (#7642) 2021-09-15 12:24:12 -07:00
TAG 1.3.1 for real (#9013) 2022-09-02 15:58:46 -03:00

Ingress NGINX Controller

CII Best Practices Go Report Card GitHub license GitHub stars GitHub stars FOSSA Status

Please fill out our 2022 Ingress-Nginx User Survey and let us know what you want to see in future releases.

https://www.surveymonkey.com/r/ingressngx2022

Overview

ingress-nginx is an Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer.

Learn more about Ingress on the main Kubernetes documentation site.

Get started

See the Getting Started document.

Troubleshooting

If you encounter issues, review the troubleshooting docs, file an issue, or talk to us on the #ingress-nginx channel on the Kubernetes Slack server.

Changelog

See the list of releases to find out about feature changes. For detailed changes for each release; please check the Changelog.md file. For detailed changes on the ingress-nginx helm chart, please check the following CHANGELOG.md file.

Support Versions table

Ingress-NGINX version k8s supported version Alpine Version Nginx Version
v1.3.1 1.24, 1.23, 1.22, 1.21, 1.20 3.16.2 1.19.10†
v1.3.0 1.24, 1.23, 1.22, 1.21, 1.20 3.16.0 1.19.10†
v1.2.1 1.23, 1.22, 1.21, 1.20, 1.19 3.14.6 1.19.10†
v1.1.3 1.23, 1.22, 1.21, 1.20, 1.19 3.14.4 1.19.10†
v1.1.2 1.23, 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.1.1 1.23, 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.1.0 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.0.5 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.0.4 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.0.3 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.0.2 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.0.1 1.22, 1.21, 1.20, 1.19 3.14.2 1.19.9†
v1.0.0 1.22, 1.21, 1.20, 1.19 3.13.5 1.20.1

This build is patched against CVE-2021-23017.

See this article if you want upgrade to the stable Ingress API.

Get Involved

Thanks for taking the time to join our community and start contributing!

  • This project adheres to the Kubernetes Community Code of Conduct. By participating in this project, you agree to abide by its terms.

  • Contributing: Contributions of all kind are welcome!

    • Read CONTRIBUTING.md for information about setting up your environment, the workflow that we expect, and instructions on the developer certificate of origin that we require.

    • Join our Kubernetes Slack channel for developer discussion : #ingress-nginx-dev.

    • Submit github issues for any feature enhancements, bugs or documentation problems. Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

  • Support: Join the #ingress-nginx-users channel inside the Kubernetes Slack to ask questions or get support from the maintainers and other users.

    • The GitHub issues in the repository are exclusively for bug reports and feature requests.
  • Discuss: Tweet using the #IngressNginx hashtag.

License

Apache License 2.0