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

docs for the helm chart of the ingress-nginx-controller #7461

Closed
longwuyuan opened this issue Aug 7, 2021 · 11 comments
Closed

docs for the helm chart of the ingress-nginx-controller #7461

longwuyuan opened this issue Aug 7, 2021 · 11 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@longwuyuan
Copy link
Contributor

longwuyuan commented Aug 7, 2021

Docs should be available for all the configurations possible with a values file for the helm chart installation, of the ingress-nginx-controller.

  • Here is the documentation example of a table of configurations, https://artifacthub.io/packages/helm/bitnami/mysql
  • Here is a documentation example of a bulleted list of configurations, https://www.consul.io/docs/k8s/helm
  • If required multiple people can can do this
  • Related but not associated All the issues & PRs related to the use of v1.0.0 of the ingress-nginx-controller
  • The documentation could go here https://kubernetes.github.io/ingress-nginx/deploy/#using-helm . Below line 236 in /docs/deploy.index.md
  • Use this command to list all values
    $ helm inspect values ingress-nginx/ingress-nginx
    
  • Document should apply to all kubernetes versions
  • This is purely a documentation issue but requires prior knowledge of helm and research on any value that one is not familiar with from the values.yaml

/kind documentation
/help

@longwuyuan longwuyuan added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 7, 2021
@k8s-ci-robot
Copy link
Contributor

@longwuyuan:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

Docs should be available for all the configurations possible with a values file for the helm chart installation, of the ingress-nginx-controller.

Here is the documentation example of a table of configurations, https://artifacthub.io/packages/helm/bitnami/mysql
Here is a documentation example of a bulleted list of configurations, https://www.consul.io/docs/k8s/helm

Related but not associated All the issues & PRs related to the use of v1.0.0 of the ingress-nginx-controller

No

Yes
/kind documentation
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 7, 2021
@k8s-ci-robot
Copy link
Contributor

@longwuyuan: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@longwuyuan
Copy link
Contributor Author

/remove-kind feature

@k8s-ci-robot k8s-ci-robot removed the kind/feature Categorizes issue or PR as related to a new feature. label Aug 7, 2021
@longwuyuan
Copy link
Contributor Author

/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@longwuyuan:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Aug 7, 2021
@sandipanpanda sandipanpanda removed their assignment Aug 7, 2021
@akshitgrover
Copy link
Contributor

I would like to take this up @longwuyuan
Should I wait for the triage on this
Thank you
/assign

@longwuyuan
Copy link
Contributor Author

longwuyuan commented Aug 7, 2021 via email

@akshitgrover
Copy link
Contributor

Sure thing
I'll start working on this
I'll reach out to you if I need some help
Thank you

@KarsonAlford
Copy link

I attempted to follow these instructions https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/. They do not work. I eventually found the instructions you link to from Getting Started here https://kubernetes.github.io/ingress-nginx/deploy/ and they do work.

Will the docs.nginx.com documentation be updated also?

@longwuyuan
Copy link
Contributor Author

@KarsonAlford ,This github repo relates to https://kubernetes.github.io/ingress-nginx/ .. THe link you posted is not related to this repo or the project.

@longwuyuan
Copy link
Contributor Author

Closing in favour of #7757

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

5 participants