Split documentation #1527

aledbf · 2017-10-13T13:56:07Z

What this PR does / why we need it:

Split and cleanup of documentation and examples

k8s-reviewable · 2017-10-13T13:56:14Z

This change is

coveralls · 2017-10-13T22:43:31Z

Changes Unknown when pulling b18fa8c2eae4c7cd2617f52bb9435df5eed8446f on aledbf:docs into ** on kubernetes:master**.

coveralls · 2017-10-13T22:49:07Z

Changes Unknown when pulling 0d91acc24a4c19649935afce9d9caa5d4f6b9b73 on aledbf:docs into ** on kubernetes:master**.

rikatz · 2017-10-15T15:05:07Z

docs/user-guide/tls.md

@@ -0,0 +1,154 @@
+# TLS
+
+- [Default SSL Certificate](docs/user-guide/default-ssl-certificate.md)


This link is broken, it should be only #default-ssl-certificate

rikatz · 2017-10-15T15:06:05Z

README.md

+- [Command line arguments](docs/user-guide/cli-arguments.md)
+- [Contribute](CONTRIBUTING.md)
+- [TLS](docs/user-guide/tls.md)
+- [Annotation ingress.class](#annotation-ingress.class)


The right reference here is #annotation-ingressclass

rikatz · 2017-10-15T15:09:04Z

README.md

-It is possible to use a number or the name of the port.
-
-The next example shows how to expose the service `kube-dns` running in the namespace `kube-system` in the port `53` using the port `53`
+By default NGINX uses the content of the header `X-Forwarded-For` as the source of truth to get information about the client IP address. This works without issues in L7 **if we configure the setting `proxy-real-ip-cidr`** with the correct information of the IP/network address of trusted external load balancer.


So, should we make explicit how to disable this behaviour? Something like 'not setting proxy-real-ip-cidr will disable this behaviour? Or setting this as 127.0.0.1 is the right config to disable?

rikatz · 2017-10-15T15:12:49Z

docs/user-guide/nginx-status-page.md

+
+![nginx-module-vts screenshot](https://cloud.githubusercontent.com/assets/3648408/10876811/77a67b70-8183-11e5-9924-6a6d0c5dc73a.png "screenshot with filter")
+
+To extract the information in JSON format the module provides a custom URL: `/nginx_status/format/json`


As we're running Ingress as a POD, to access this status do we need to create a service?

rikatz · 2017-10-15T15:16:35Z

docs/user-guide/configmap.md

+    "method": "$request_method", "http_referrer": "$http_referer", "http_user_agent":
+    "$http_user_agent" }'
+  ```
+


I would also make a reference to docs/user-guide/log-format.md here, so user can understand what each field represents :)

rikatz · 2017-10-15T15:20:53Z

@aledbf Really great job here :) I'll take a further look later, try to deploy following the instructions. I would add something about specific nodes and taint, but this is not the focus of this docs anyway :)

Thank you very much for doing this!

gianrubio · 2017-10-16T06:14:22Z

README.md

-type: kubernetes.io/tls
+  name: foo
+  annotations:
+    kubernetes.io/ingress.class: "gce"


I'd suggest to replace gce to internal

* nginx-ingress no longer requires endpoints create/update RBAC Role permissions * kubernetes/ingress-nginx#1527

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 13, 2017

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 13, 2017

aledbf force-pushed the docs branch 6 times, most recently from 8995197 to f8b4eea Compare October 13, 2017 20:02

aledbf mentioned this pull request Oct 13, 2017

Fix tls-termination example to use a working config #1528

Closed

aledbf force-pushed the docs branch 3 times, most recently from 804f9a8 to accd24b Compare October 13, 2017 21:02

Split documentation

a9168f2

aledbf force-pushed the docs branch from accd24b to a9168f2 Compare October 13, 2017 21:14

Merge remote-tracking branch 'master/master' into docs

a30d377

aledbf force-pushed the docs branch 4 times, most recently from 799f7b2 to b18fa8c Compare October 13, 2017 22:34

aledbf changed the title ~~WIP: Split documentation~~ WIP: Split documentation [ci skip] Oct 13, 2017

kubernetes deleted a comment from coveralls Oct 13, 2017

aledbf force-pushed the docs branch from b18fa8c to 46d029d Compare October 13, 2017 22:46

aledbf changed the title ~~WIP: Split documentation [ci skip]~~ WIP: Split documentation Oct 13, 2017

aledbf force-pushed the docs branch from 46d029d to 0d91acc Compare October 13, 2017 22:48

aledbf force-pushed the docs branch 5 times, most recently from 27efca6 to d812bda Compare October 13, 2017 23:33

rikatz reviewed Oct 15, 2017

View reviewed changes

aledbf force-pushed the docs branch 2 times, most recently from edef859 to e273719 Compare October 15, 2017 15:31

aledbf changed the title ~~WIP: Split documentation~~ Split documentation Oct 15, 2017

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 15, 2017

Improve documentation and examples [ci skip]

026bb52

aledbf force-pushed the docs branch from e273719 to 026bb52 Compare October 15, 2017 15:55

rikatz mentioned this pull request Oct 15, 2017

Improve ConfigMap docs #1532

Closed

24 tasks

gianrubio reviewed Oct 16, 2017

View reviewed changes

Merge remote-tracking branch 'master/master' into docs

16c1198

aledbf merged commit d27829c into kubernetes:master Oct 16, 2017

aledbf deleted the docs branch October 16, 2017 12:05

dghubble pushed a commit to poseidon/typhoon that referenced this pull request May 4, 2019

Remove create/update endpoints from nginx-ingress Role (#458)

fd3c81d

* nginx-ingress no longer requires endpoints create/update RBAC Role permissions * kubernetes/ingress-nginx#1527

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split documentation #1527

Split documentation #1527

aledbf commented Oct 13, 2017 •

edited

Loading

k8s-reviewable commented Oct 13, 2017

coveralls commented Oct 13, 2017

coveralls commented Oct 13, 2017

rikatz Oct 15, 2017

aledbf Oct 15, 2017

rikatz Oct 15, 2017

aledbf Oct 15, 2017

rikatz Oct 15, 2017

rikatz Oct 15, 2017

rikatz Oct 15, 2017

aledbf Oct 15, 2017

rikatz commented Oct 15, 2017

gianrubio Oct 16, 2017

		@@ -0,0 +1,154 @@
		# TLS

		- [Default SSL Certificate](docs/user-guide/default-ssl-certificate.md)


		![nginx-module-vts screenshot](https://cloud.githubusercontent.com/assets/3648408/10876811/77a67b70-8183-11e5-9924-6a6d0c5dc73a.png "screenshot with filter")

		To extract the information in JSON format the module provides a custom URL: `/nginx_status/format/json`

Split documentation #1527

Split documentation #1527

Conversation

aledbf commented Oct 13, 2017 • edited Loading

k8s-reviewable commented Oct 13, 2017

coveralls commented Oct 13, 2017

coveralls commented Oct 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rikatz commented Oct 15, 2017

Choose a reason for hiding this comment

aledbf commented Oct 13, 2017 •

edited

Loading