Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve ConfigMap docs #1532

Closed
4 of 24 tasks
rikatz opened this issue Oct 15, 2017 · 6 comments
Closed
4 of 24 tasks

Improve ConfigMap docs #1532

rikatz opened this issue Oct 15, 2017 · 6 comments
Labels
area/docs help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@rikatz
Copy link
Contributor

rikatz commented Oct 15, 2017

Is this a BUG REPORT or FEATURE REQUEST? (choose one): Bug Report / Docs Improvement

As @aledbf is making his brave journey to improve Ingress Docs in #1527 (which we're really thank to!), I've been digging some undocumented / misdocumented ConfigMap directives that should be documented after the PR above is closed.

Some of those ConfigMap directives only exists in the code, as other exists also in configuration.md but there's no default value, or only the default value and no explanation, and some have both but there's no how to use them.

This is a issue of multiple PRs, and needs help from everyone (no need to know how to code in Go, but need to know what's the impact of each directive).

I'm putting them as a list, so we can 'check' each completed box/documented directive.

Undocumented directives/Missing explanation:

  • allow-backend-server-header
  • client-header-buffer-size
  • client-header-timeout
  • client-body-buffer-size
  • client-body-timeout
  • vts-status-zone-size
  • vts-default-filter-key
  • http2-max-field-size
  • http2-max-header-size
  • keep-alive-requests
  • large-client-header-buffers
  • log-format-escape-json
  • ssl-ecdh-curve
  • variables-hash-bucket-size
  • variables-hash-max-size
  • upstream-keepalive-connections
  • proxy-stream-timeout
  • bind-address-ipv4
  • bind-address-ipv6
  • forwarded-for-header
  • proxy-real-ip-cidr
  • ssl-ciphers - Missing the default value

Documentation improvements

  • ssl-dh-param - Needs to be better documented, probably here we should reference to customization/ssl-dh-param/README.md
  • http-snippet / server-snippet / location-snippet - How this works? Is this another ConfigMap?
@aledbf aledbf added area/docs enhancement help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Oct 15, 2017
@pieterlange
Copy link
Contributor

I will try to help out here this week, thanks for coordinating

@rikatz
Copy link
Contributor Author

rikatz commented Oct 17, 2017

@pieterlange I'll try to help you with some items here. @mrrandrade will also take a look.

@diazjf
Copy link

diazjf commented Nov 23, 2017

@rikatz @aledbf I added a PR #1747 which provides information on usage and deployment of the config-map that way we can get new users to help with the documentation.

I added all possible options and their defaults as well by looking at https://github.com/kubernetes/ingress-nginx/blob/master/internal/ingress/controller/config/config.go

For future iteration of the docs maybe we can have sections in the table which point below to the actual option and provide information about it, similar to https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/annotations.md

@aledbf
Copy link
Member

aledbf commented Nov 23, 2017

Closing. Fixed in #1747

@aledbf aledbf closed this as completed Nov 23, 2017
@rikatz
Copy link
Contributor Author

rikatz commented Nov 23, 2017

I'm missing the explanation of each directive there :(

diazjf pushed a commit to diazjf/ingress that referenced this issue Nov 25, 2017
Changes the Config-Map documentation to be easier to search and follow
a format similar to that in the annotations section. Also adds some missing
configuration options.

Fixes kubernetes#1532
@diazjf
Copy link

diazjf commented Nov 25, 2017

@rikatz @aledbf #1752 resolves most if not all of the items in the checklist shown above. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

4 participants