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: Clarify ingress-nginx ssl termination example #13913

Merged
merged 3 commits into from
Jun 14, 2023

Conversation

rtsmith
Copy link
Contributor

@rtsmith rtsmith commented Jun 5, 2023

Note on DCO:

If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the Details link next to the DCO action for instructions on how to resolve this.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.

Please see Contribution FAQs if you have questions about your pull-request.


This PR attempts to improve the docs for terminating SSL at ingress controller by:

  1. Changing subtitle to reflect intention of example
  2. Removing do not change, this is provided by Argo CD comment on secretName declaration. In this example, we are not terminating SSL at argocd server, so we don't need this TLS cert in argocd-server-tls secret. Even better to not have it there in this case.
  3. Use separate secrets for HTTP and GRPC. In the current example, two certs (one for each domain) try to occupy the same secret. This can lead to unexpected behavior.

@rtsmith rtsmith changed the title Clarify ingress-nginx ssl termination example [docs]: Clarify ingress-nginx ssl termination example Jun 5, 2023
@rtsmith rtsmith changed the title [docs]: Clarify ingress-nginx ssl termination example docs: Clarify ingress-nginx ssl termination example Jun 5, 2023
@codecov
Copy link

codecov bot commented Jun 5, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (f63b856) 49.57% compared to head (459237f) 49.56%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #13913      +/-   ##
==========================================
- Coverage   49.57%   49.56%   -0.01%     
==========================================
  Files         256      256              
  Lines       43920    43920              
==========================================
- Hits        21773    21770       -3     
- Misses      19985    19987       +2     
- Partials     2162     2163       +1     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

rtsmith and others added 2 commits June 6, 2023 08:38
Signed-off-by: Thomas Smith <tom@solrr.net>
Co-authored-by: Nicholas Morey <nicholas@morey.tech>
Signed-off-by: Tom Smith <rtsmith@users.noreply.github.com>
Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

lgtm

@pasha-codefresh
Copy link
Member

LGTM, thank you

@pasha-codefresh pasha-codefresh merged commit 9403f25 into argoproj:master Jun 14, 2023
@rtsmith rtsmith deleted the patch-1 branch June 20, 2023 17:31
yyzxw pushed a commit to yyzxw/argo-cd that referenced this pull request Aug 9, 2023
* Clarify ingress-nginx ssl termination example

Signed-off-by: Thomas Smith <tom@solrr.net>

* Expand on ingress-nginx ssl termination section context

Co-authored-by: Nicholas Morey <nicholas@morey.tech>
Signed-off-by: Tom Smith <rtsmith@users.noreply.github.com>

---------

Signed-off-by: Thomas Smith <tom@solrr.net>
Signed-off-by: Tom Smith <rtsmith@users.noreply.github.com>
Co-authored-by: Nicholas Morey <nicholas@morey.tech>
Co-authored-by: pasha-codefresh <pavel@codefresh.io>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
* Clarify ingress-nginx ssl termination example

Signed-off-by: Thomas Smith <tom@solrr.net>

* Expand on ingress-nginx ssl termination section context

Co-authored-by: Nicholas Morey <nicholas@morey.tech>
Signed-off-by: Tom Smith <rtsmith@users.noreply.github.com>

---------

Signed-off-by: Thomas Smith <tom@solrr.net>
Signed-off-by: Tom Smith <rtsmith@users.noreply.github.com>
Co-authored-by: Nicholas Morey <nicholas@morey.tech>
Co-authored-by: pasha-codefresh <pavel@codefresh.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants