Commit graph

1010 commits

Author SHA1 Message Date
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
Frederik-Baetens
39e721de73
Docs: add documentation about default ingress helm value, corrections to only ingress section (#7943)
* add explanation about ingressClassResource.default for helm users

Also cleaned up the entire "I have only one instance of the
Ingress-NGINX controller in my cluster" section

* docs: default ingressclass only when running one controller

* fix link to what is the flag watch ingress

* clarify usage of default ingress class annotation
2022-01-20 01:17:52 -08:00
Rafael Maciel
feba7e1ffc
docs: correct typo (#8169)
* change docker-destkop to docker-desktop
2022-01-19 18:31:51 -08:00
Alastair Firth
d16e0dec48
Static manifest generation uses kustomize instead of python (#8099)
* regenerate at 4.0.12

* bash for loop and static values files

* add .tool-versions

* fixup static manifests with kustomize instead of python

* remove spec.replicas where set

* generate manifests for all supported versions

* update docs

* remove all versions except default (1.20) for now

* update to 1.1.1/4.0.15
2022-01-17 15:28:56 -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
Long Wu Yuan
784f9c53bb
checking mkdocs & ghpages (#8150) 2022-01-16 16:05:28 -08:00
Gaétan Collaud
9cf5d951aa
jwt accomodation (#8126) 2022-01-16 13:37:28 -08:00
Tiago Ferreira
5552fdf814
Fix api version for ingress objects on K8s version <1.19 (#8112) 2022-01-12 11:08:14 -08:00
Long Wu Yuan
fc38b9f2aa
changes for release v1.1.1 (#8125) 2022-01-12 08:48:37 -08:00
Mario Vejlupek
a9495ecae0
Add custom error pages example file (#8060)
* Add custom error pages example file

* Update docs/examples/customization/custom-errors/README.md

Co-authored-by: Jintao Zhang <tao12345666333@163.com>

Co-authored-by: Jintao Zhang <tao12345666333@163.com>
2022-01-12 06:30:37 -08:00
李远君
d8c9a6c238
Fix ingress module a syntax error (#8129) 2022-01-10 23:23:16 -08:00
agile6v
452515ca2f
doc: improvement (#7996) 2021-12-23 13:54:30 -08:00
Bhumij Gupta
6d4c51c31f
Added docs for --ingress-class-by-name flag in the cli arguments page (#7624)
* Added docs for --ingress-class-by-name flag in the cli arguments page

Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>

* Updated docs to match the flag description in code

Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>
2021-12-23 13:32:30 -08:00
Noelle Leigh
d6284d1672
docs: fix typo'd executible name (#8041)
In "Checking ingress controller version", the paragraph cites the incorrect name for the executable (the one in the code block is correct).
This commit fixes that inconsistency.
2021-12-23 16:50:10 -03:00
Tobias Salzmann
ce9deaa332
Add stream-snippet as a ConfigMap and Annotation option (#8029)
* stream snippet

* gofmt -s
2021-12-23 11:46:30 -08:00
Mani Kanth
2ff5af08d4
docs_multiple_instances_one_cluster_ticket_7543 (#8042) 2021-12-22 02:53:35 -08:00
Ricardo Katz
7bae2e7321
Comment busy owners (#8035)
* Cleanup owners files

* Cleanup owners files
2021-12-15 11:38:27 -03:00
Tim Bannister
ec21629b81
Revise main documentation page (#8019)
- Revise to be more in line with the style guide for Kubernetes official docs
- Avoid recommending that readers use `k8s.io` namespaced controller names
  for their own custom controller configuration.

Co-authored-by: James Strong <strong.james.e@gmail.com>

Co-authored-by: James Strong <strong.james.e@gmail.com>
2021-12-12 05:21:58 -08:00
Yecheng Fu
5cff197bc5
add canary-weight-total annotation (#6338) 2021-12-07 08:40:00 -08:00
Jennifer Kirsch
3f9d443b1e
Add link to example error page manifest (#8014)
Without this change it was a bit difficult to find the manifest so users might not know that there is one.
2021-12-06 12:01:33 -08:00
Jedidiah Park
2b499d9c86
Fix spelling in documentation and top-level files (#8009)
* fix typos in docs

* fix typos in top-level files
2021-12-06 05:46:33 -08:00
Jérôme Petazzoni
bc4c86a791
Minor improvements (formatting, consistency) in install guide (#8003)
Small changes, mostly:
- formatting (especially in lists, since mkdocs doesn't seem
  to support nested lists)
- use the same level of warning when it makes sense
  (intead of "danger", "failure", etc)
- improve wording in a few places
- re-order a few operations
- move a few sentences that were out of place
2021-12-03 20:28:31 -08:00
Ansil H
a03895d91e
Add ssl_reject_handshake to defaul server (#7977)
* Add ssl_reject_handshake to defaul server

* Added SSLRejectHandshake to NewDefault

* Added documentation
2021-11-29 08:33:23 -08:00
Masa
27037a1919
Fix command in index.md (#7935)
* Fix command in index.md

* Fix command in index.md

* Update index.md
2021-11-28 18:39:22 -08:00
Reinhard Nägele
e9c297e74d
Fix names in documentation (#7940)
* Fix names in documentation

This fixes the documentation to reflect the name change from
`nginx-ingress` to `ingress-nginx`.

Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>

* Revert accidental changelog update

Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
2021-11-28 13:11:22 -08:00
TJ Saunders
b615a6808d
Fix a couple of misspellings in the annotations documentation. (#7983) 2021-11-27 16:31:21 -08:00
Kundan Kumar
77a63c6855
updated service upstream definition (#7972) 2021-11-24 10:20:21 -08:00
Sven Schliesing
dbf3689c5e
add documentation for "force-ssl-redirect" (#7957)
See #4628
2021-11-23 15:27:45 -08:00
James Strong
843a16a8f8
Release updates for v1.1.0 (#7964) 2021-11-23 15:07:46 -08:00
James Strong
d4a6ade65f
update default block list,docs, tests (#7942)
* update default block list,docs, tests

* fix config for admin test

* gofmt

* remove the err return
2021-11-23 09:06:17 -08:00
Ricardo Katz
727f4cb925
Release v1.0.5 documents (#7924)
Signed-off-by: Ricardo Pchevuzinske Katz <ricardo.katz@gmail.com>
2021-11-15 17:11:26 -08:00
Ricardo Katz
15567b07c0
Trim spaces from badword items (#7921) 2021-11-15 20:37:29 -03:00
Robert Steele
b7ac27a671
Update Bare Metal anchor link (#7914) 2021-11-15 13:58:48 -08:00
Mac Chaffee
3c08f002f9
Rewrite multiple-ingress.md to work with v1 (#7608)
* Rewrite multiple-ingress.md to work with v1

* Fix --controller-class flag docs
2021-11-15 12:20:49 -08:00
zryfish
7203a0b8bd
support watch namespaces matched namespace selector (#7472)
skip caching namespaces at cluster scope if only watching single namespace

add --watch-namespace-selector in user guide

add e2e test
2021-11-12 11:46:28 -08:00
James Strong
8333c8c127
update docs with a warning about cert chain order (#7908) 2021-11-12 11:34:29 -08:00
sandipanpanda
af232df1af
Update anchor links of Nodeport from #nodeport to #type-nodeport (#7899)
* Update anchor link from #nodeport to #type-nodeport in baremetal.md

* Update anchor link from #nodeport to #type-nodeport in baremetal.md
2021-11-11 09:42:09 -08:00
Gerald Pape
017e1ecde3
Fix Ingress resources in docs (#7579)
* fix Ingress resources in docs

Signed-off-by: Gerald Pape <gerald@giantswarm.io>

* move to ingressClassName

* fix more Ingress resource examples

* empty commit

Signed-off-by: Gerald Pape <gerald@giantswarm.io>

* make NOTES.txt aware of version + add notice about ingress version to examples main page

* add link to legacy documentation

Signed-off-by: Gerald Pape <gerald@giantswarm.io>
2021-11-09 07:43:49 -08:00
James Strong
b7b2714b69
Update proxy-set-header example (#7898)
The Example was directed to the repo markdown and not the site. 

/kind documentation
2021-11-08 22:15:39 -08:00
Jérôme Petazzoni
ce165f9078
Try to improve the installation guide (#7757)
* move generic instructions to the beginning of the file
* add an example of ingress resource creation
* simplify a few commands to make them shorter and simpler
* add short paragraphs about PROXY protocol and traffic policy

This tries to address the concerns I expressed in #7701.
2021-11-05 13:50:40 -07:00
Sablu Miah
62ab435958
Fix Formatting/Typo (#7894)
Quick simple typo/formatting fix to keep consistency with direct sections below
2021-11-05 13:34:41 -07:00
Christopher Larivière
65b8eeddec
Support cors-allow-origin with multiple origins (#7614)
* Add Initial support for multiple cors origins in nginx

- bump cluster version for `make dev-env`
- add buildOriginRegex function in nginx.tmpl
- add e2e 4 e2e tests for cors.go
- refers to feature request #5496

* add tests + use search to identify '*' origin

* add tests + use search to identify '*' origin

Signed-off-by: Christopher Larivière <lariviere.c@gmail.com>

* fix "should enable cors test" looking at improper values

* Modify tests and add some logic for origin validation

- add origin validation in cors ingress annotations
- add extra tests to validate regex
- properly escape regex using "QuoteMeta"
- fix some copy/paste errors

* add TrimSpace and length validation before adding a new origin

* modify documentation for cors and remove dangling comment

* add support for optional port mapping on origin

* support single-level wildcard subdomains + tests

* Remove automatic `*` fonctionality from incorrect origins

- use []string instead of basic string to avoid reparsing in template.go
- fix typo in docs
- modify template to properly enable only if the whole block is enabled
- modify cors parsing
- test properly by validating that the value returned is the proper
  origin
- update unit tests and annotation tests

* Re-add `*` when no cors origins are supplied + fix tests

- fix e2e tests to allow for `*`
- re-add `*` to cors parsing if trimmed cors-allow-origin is empty
(supplied but empty) and if it wasn't supplied at all.

* remove unecessary logic for building cors origin + remove comments

- add some edge cases in e2e tests
- rework logic for building cors origin

there was no need for logic in template.go for buildCorsOriginRegex
if there is a `*` it ill be short-circuited by first if.

if it's a wildcard domain or any domain (without a wildcard), it MUST
match the main/cors.go regex format.

if there's a star in a wildcard domain, it must be replaced with
`[A-Za-z0-9]+`

* add missing check in e2e tests
2021-11-02 12:31:42 -07:00
Rahil Patel
c8ab4dc307
add brotli-min-length configuration option (#7854)
* add `brotli-min-length` configuration option

* add e2e tests for brotli

* include check for expected content type

* fix header and format
2021-11-02 04:52:59 -07:00
counter2015
ed34f6c93d
fix ingress syntax. (#7867) 2021-11-01 17:12:58 -07:00
Paul McDonald
8467124c24
Update upgrade.md (#7828)
Updated to the same release name in the installation guide
2021-10-27 10:05:25 -07:00
Jessica Andersson
4da87d128d
improves text format for readability (#7855)
Small text format changes to section "I have more than one controller running in my cluster, and I want to use the new spec?" to allow for better readability.
2021-10-27 06:31:26 -07:00