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

Clarify Installation Document by Separating Helm Steps #2743

Merged
merged 1 commit into from
Jul 5, 2018

Conversation

aamederen
Copy link
Contributor

@aamederen aamederen commented Jul 5, 2018

What this PR does / why we need it:

I found it confusing to see the helm after the list of generic steps (should I run helm install ... after I followed the steps above or is it a different way?). Also, the verification and version detection steps don't work with helm chart due to different app label (ingress-nginx vs nginx-ingress) and namespace.

This change does two things:

  1. Separate helm installation from generic installation and provide version detection commands that work for helm
  2. Rename Custom Service Provider Deployment to Provider Specific Steps and fix the broken link while doing so.

Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #

Couldn't find any specific github issues related to this.

Special notes for your reviewer:

I found it confusing to see the helm after the list of generic steps (should I run `helm install ...` after I followed the steps above or is it a different way?). Also, the verification and version detection steps don't work with helm chart due to different app label (`ingress-nginx` vs `nginx-ingress`) and namespace. 

This change does two things:
1. Separate helm installation from generic installation and provide version detection commands that work for helm
2. Rename `Custom Service Provider Deployment` to `Provider Specific Steps` and fix the broken link while doing so.
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 5, 2018
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 5, 2018
@codecov-io
Copy link

Codecov Report

Merging #2743 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2743   +/-   ##
=======================================
  Coverage   40.91%   40.91%           
=======================================
  Files          73       73           
  Lines        5101     5101           
=======================================
  Hits         2087     2087           
  Misses       2725     2725           
  Partials      289      289

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5039e77...0e89612. Read the comment docs.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 5, 2018
@aamederen
Copy link
Contributor Author

/assign @caseydavenport

@aledbf
Copy link
Member

aledbf commented Jul 5, 2018

@aamederen please don't assign PRs manually.


```console
POD_NAMESPACE=ingress-nginx
Copy link
Member

@aledbf aledbf Jul 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works only if you are running the ingress controller in the default namespace.
By default, we use the ingress-nginx namespace

My fault, this is fine for the helm chart

Copy link
Contributor Author

@aamederen aamederen Jul 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, however the helm chart uses the default namespace by default (at least for me). The instructions for the generic deployment are the same.

@aamederen
Copy link
Contributor Author

@aamederen please don't assign PRs manually.

@aledbf sorry, the bot was telling me to do so: Assign the PR to them by writing /assign @caseydavenport in a comment when ready.

@aledbf
Copy link
Member

aledbf commented Jul 5, 2018

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 5, 2018
@aledbf
Copy link
Member

aledbf commented Jul 5, 2018

@aamederen thanks!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aamederen, aledbf

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 5, 2018
@k8s-ci-robot k8s-ci-robot merged commit c5584cc into kubernetes:master Jul 5, 2018
@aledbf
Copy link
Member

aledbf commented Jul 5, 2018

@aamederen the build to update the docs has started. In approx ~20 minutes, you should see the update in https://kubernetes.github.io/ingress-nginx/deploy/

@aamederen
Copy link
Contributor Author

@aledbf thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants