aws-load-balancer-controller icon indicating copy to clipboard operation
aws-load-balancer-controller copied to clipboard

docs: add manual tls instructions

Open loshz opened this issue 4 years ago • 12 comments

Issue

https://github.com/kubernetes-sigs/aws-load-balancer-controller/issues/2015

Description

As mentioned in the above issue, it is possible to use self-signed certificates instead of using cert-manager. This PR adds documentation for configuring the AWS LB Controller in this fashion.

I have tested this on k8s 1.20 and 1.21 with controller versions v2.2.0 and v2.2.1.

Notes:

  • ~I tried to match the doc styling as best as possible. Are there instructions for running the docs locally so I can test?~
  • ~I didn't add exact instructions for creating the certs as I feel like it should be up to the user - thoughts?~
  • Would be great if someone else could also test the controller with self-signed certs.

Checklist

  • [ ] Added tests that cover your change (if possible)
  • [x] Added/modified documentation as required (such as the README.md, or the docs directory)
  • [x] Manually tested
  • [x] Made sure the title of the PR is a good description that can go into the release notes

BONUS POINTS checklist: complete for good vibes and maybe prizes?! :exploding_head:

  • [ ] Backfilled missing tests for code in same general area :tada:
  • [ ] Refactored something and made the world a better place :star2:

loshz avatar Oct 15 '21 18:10 loshz

Welcome @syscll!

It looks like this is your first PR to kubernetes-sigs/aws-load-balancer-controller 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/aws-load-balancer-controller has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot avatar Oct 15 '21 18:10 k8s-ci-robot

Hi @syscll. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 avatar Oct 15 '21 18:10 k8s-ci-robot

@syscll, you can run make docs-preview and verify the documentation page on your local browser.

kishorj avatar Oct 15 '21 19:10 kishorj

Codecov Report

Merging #2298 (0548926) into main (314a9fd) will decrease coverage by 0.01%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2298      +/-   ##
==========================================
- Coverage   53.55%   53.54%   -0.02%     
==========================================
  Files         136      136              
  Lines        7607     7609       +2     
==========================================
  Hits         4074     4074              
- Misses       3217     3218       +1     
- Partials      316      317       +1     
Impacted Files Coverage Δ
pkg/service/model_build_load_balancer.go 82.56% <0.00%> (-0.77%) :arrow_down:

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 314a9fd...0548926. Read the comment docs.

codecov-commenter avatar Oct 15 '21 20:10 codecov-commenter

Added some basic openssl commands to the best of my knowledge.

loshz avatar Oct 20 '21 16:10 loshz

@kishorj PTAL

loshz avatar Oct 27 '21 17:10 loshz

Does anyone have have time to review this? Much appreciated (not passive-aggressive).

loshz avatar Jan 29 '22 23:01 loshz

@syscll, I feel the clientConfig section in step 4 is confusing. We need to clarify it further so users don't need to spend time trying to debug failures.

kishorj avatar Feb 01 '22 19:02 kishorj

Would be very nice is someone merged this, took me a while to figure this out. We would prefer not to add cert-manager to our cluster due to managing yet another component, just to get ingress working which didnt even require this for 1.x versions.

rdubya16 avatar Apr 25 '22 16:04 rdubya16

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: loshz To complete the pull request process, please assign m00nf1sh after the PR has been reviewed. You can assign the PR to them by writing /assign @m00nf1sh in a comment when ready.

The full list of commands accepted by this bot can be found 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 avatar Jun 07 '22 19:06 k8s-ci-robot

I just fixed a bug where I wasn't using the Root CA during self-signed cert creation.

loshz avatar Jun 07 '22 19:06 loshz

Any thoughts on merging this?

loshz avatar Sep 01 '22 04:09 loshz

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Nov 30 '22 04:11 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Dec 30 '22 04:12 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-triage-robot avatar Jan 29 '23 05:01 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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 avatar Jan 29 '23 05:01 k8s-ci-robot