Merge pull request #2926 from aledbf/misspell

Add misspell target
This commit is contained in:
k8s-ci-robot 2018-08-11 11:08:53 -07:00 committed by GitHub
commit df3ea394b4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 12 additions and 4 deletions

View file

@ -244,3 +244,11 @@ live-docs:
build-docs: build-docs:
@docker build --pull -t ingress-nginx/mkdocs build/mkdocs @docker build --pull -t ingress-nginx/mkdocs build/mkdocs
@docker run --rm -it -v ${PWD}:/docs ingress-nginx/mkdocs build @docker run --rm -it -v ${PWD}:/docs ingress-nginx/mkdocs build
.PHONY: misspell
misspell:
@go get github.com/client9/misspell/cmd/misspell
misspell \
-locale US \
-error \
cmd/* internal/* deploy/* docs/* design/* test/* README.md

View file

@ -370,7 +370,7 @@ This annotation allows to return a permanent redirect instead of sending data to
### Permanent Redirect Code ### Permanent Redirect Code
This annotation allows you to modify the status code used for permanent redirects. For example `nginx.ingress.kubernetes.io/permanent-redirect-code: '308'` would return your permanet-redirect with a 308. This annotation allows you to modify the status code used for permanent redirects. For example `nginx.ingress.kubernetes.io/permanent-redirect-code: '308'` would return your permanent-redirect with a 308.
### SSL Passthrough ### SSL Passthrough

View file

@ -471,7 +471,7 @@ Enables or disables the [PROXY protocol](https://www.nginx.com/resources/admin-g
## proxy-protocol-header-timeout ## proxy-protocol-header-timeout
Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinetly on a dropped connection. Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinitely on a dropped connection.
_**default:**_ 5s _**default:**_ 5s
## use-gzip ## use-gzip

View file

@ -7,7 +7,7 @@ The [ModSecurity-nginx](https://github.com/SpiderLabs/ModSecurity-nginx) connect
The default ModSecurity configuration file is located in `/etc/nginx/modsecurity/modsecurity.conf`. This is the only file located in this directory and contains the default recommended configuration. Using a volume we can replace this file with the desired configuration. The default ModSecurity configuration file is located in `/etc/nginx/modsecurity/modsecurity.conf`. This is the only file located in this directory and contains the default recommended configuration. Using a volume we can replace this file with the desired configuration.
To enable the ModSecurity feature we need to specify `enable-modsecurity: "true"` in the configuration configmap. To enable the ModSecurity feature we need to specify `enable-modsecurity: "true"` in the configuration configmap.
>__Note:__ the default configuration use detection only, because that minimises the chances of post-installation disruption. >__Note:__ the default configuration use detection only, because that minimizes the chances of post-installation disruption.
The file `/var/log/modsec_audit.log` contains the log of ModSecurity. The file `/var/log/modsec_audit.log` contains the log of ModSecurity.

View file

@ -244,7 +244,7 @@ func New(checkOCSP bool,
Component: "nginx-ingress-controller", Component: "nginx-ingress-controller",
}) })
// k8sStore fulfils resolver.Resolver interface // k8sStore fulfills resolver.Resolver interface
store.annotations = annotations.NewAnnotationExtractor(store) store.annotations = annotations.NewAnnotationExtractor(store)
store.listers.IngressAnnotation.Store = cache.NewStore(cache.DeletionHandlingMetaNamespaceKeyFunc) store.listers.IngressAnnotation.Store = cache.NewStore(cache.DeletionHandlingMetaNamespaceKeyFunc)