8000 Add custom listener controls to VirtualServer by shaun-nx · Pull Request #4271 · nginx/kubernetes-ingress · GitHub
[go: up one dir, main page]
Skip to content

Add custom listener controls to VirtualServer #4271

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 36 commits into from
Aug 24, 2023
Merged

Add custom listener controls to VirtualServer #4271

merged 36 commits into from
Aug 24, 2023

Conversation

shaun-nx
Copy link
Contributor
@shaun-nx shaun-nx commented Aug 21, 2023 •
edited
Loading

Proposed changes

Related issue: #4094
Related discussion: #3724

This change updates both VirtualServer and GlobalConfiguration resources to enable VirtualServers to specify custom HTTP and HTTPS listener ports.

Example VirtualServer YAML:

apiVersion: k8s.nginx.org/v1
kind: VirtualServer
metadata:
  name: cafe
spec:
  listener:
    http: http-8083
    https: https-8443
  host: cafe.example.com
  tls:
    secret: cafe-secret
  upstreams:
  ...

Example GlobalConfiguration YAML:

apiVersion: k8s.nginx.org/v1alpha1
kind: GlobalConfiguration
metadata:
  name: nginx-configuration
  namespace: nginx-ingress
spec:
  listeners:
  - name: http-8083
    port: 8083
    protocol: HTTP
  - name: https-8443
    port: 8443
    protocol: HTTP
    ssl: true

When performing requests to the example VirtualServer, all HTTP based requests will use port 8083 and HTTPS based requests will use 8443.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

shaun-nx and others added 28 commits August 17, 2023 14:55
@shaun-nx @haywoodsh
Update CRDS and types
3d4db9c
@shaun-nx @haywoodsh
Add custom HTTP and HTTPs listeners
85f41d5
@shaun-nx @haywoodsh
Add configuration problems for listeners
1218590
@shaun-nx @haywoodsh
Update calls to vs listener function
11cc3bf
@shaun-nx @haywoodsh
Update addProblemsForVSListeners function
637c77c
@shaun-nx @haywoodsh
Ensure VirtualServer config is updated when changes are made to Globa…
1cd1328 
…lConfiguration
@shaun-nx @haywoodsh
Report correct warnings for missconfigured listeners
b068954
@shaun-nx @haywoodsh
Remove unused function
3e9f651
@shaun-nx @haywoodsh
Add new unit tests for configuration.go
222654a
@shaun-nx @haywoodsh
Move validateListenerProtocol function to validation/globalconfigurat…
f79e6c4 
…ion.go
@shaun-nx @haywoodsh
Add unit tests for virtual server when using custom listeners
3105884
@shaun-nx @haywoodsh
Add additional unit test. Create map of listener name to listener struct
b45c503
@shaun-nx @haywoodsh
Add unit test for empty http and https listeners
8000
e98d171
@shaun-nx @haywoodsh
Refactor test to use mustInitGlobalConfiguration()
8b412d6
@shaun-nx @haywoodsh
Add additional unit tests
90d3f2d
@shaun-nx @haywoodsh
Add test for Deleted GlobalConfiguration with default VirtualSErver d…
553ac36 
…eployed
@shaun-nx @haywoodsh
Update VirtualServer template for nginx plus
dee1fa2
@shaun-nx @haywoodsh
Add example files for custom listeners
f43bb81
@shaun-nx @haywoodsh
Add sample README file
692ed7f
@shaun-nx @haywoodsh
Update GlobalConfiguration to ensure VS and TS can't listen on the sa…
004f183 
…me port
@haywoodsh
add template tests
45606fa
@vepatel
add initial functional test
8f2738d
@shaun-nx
Remove debug lines
db1dc8a
@shaun-nx
Merge branch 'main' into exp-vs-custom-listeners
5df07bb
@shaun-nx
Add test for deleting gc
d39ac81
@shaun-nx
Revert "Add test for deleting gc"
9d7557f 
This reverts commit d39ac81.
@shaun-nx
Revert "add initial functional test"
a3f1109 
This reverts commit 8f2738d.
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
91522fe 
for more information, see https://pre-commit.ci
@github-actions github-actions bot added documentation Pull requests/issues for documentation enhancement Pull requests for new features/feature enhancements labels Aug 21, 2023
@github-actions github-actions bot added the helm_chart Pull requests that update the Helm Chart label Aug 21, 2023
@codecov
Copy link
codecov bot commented Aug 21, 2023 •
edited
Loading

Codecov Report

Merging #4271 (772d3c6) into main (79a3eb9) will increase coverage by 0.19%.
The diff coverage is 70.00%.

@@            Coverage Diff             @@
##             main    #4271      +/-   ##
==========================================
+ Coverage   51.97%   52.17%   +0.19%     
==========================================
  Files          59       59              
  Lines       16762    16930     +168     
==========================================
+ Hits         8712     8833     +121     
- Misses       7753     7798      +45     
- Partials      297      299       +2
Files Changed Coverage Δ
internal/configs/configurator.go 37.94% <0.00%> (-0.54%) ⬇️
internal/configs/version2/http.go 0.00% <ø> (ø)
internal/k8s/controller.go 12.00% <0.00%> (-0.11%) ⬇️
...g/apis/configuration/validation/transportserver.go 96.21% <ø> (-0.10%) ⬇️
internal/configs/virtualserver.go 94.57% <100.00%> (+0.02%) ⬆️
internal/k8s/configuration.go 95.76% <100.00%> (-0.04%) ⬇️
...is/configuration/validation/globalconfiguration.go 92.39% <100.00%> (+5.11%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@shaun-nx shaun-nx changed the title Feat/custom listeners Add custom listener controls to VirtualServer Aug 22, 2023
@shaun-nx shaun-nx marked this pull request as ready for review August 22, 2023 12:27
@shaun-nx shaun-nx requested a review from a team as a code owner August 22, 2023 12:27
@shaun-nx shaun-nx mentioned this pull request Aug 22, 2023
Closed
@shaun-nx shaun-nx added this to the v3.3.0 milestone Aug 22, 2023
vepatel
vepatel reviewed Aug 23, 2023
View reviewed changes
jjngx
jjngx approved these changes Aug 24, 2023
View reviewed changes
Copy link
Contributor
@jjngx jjngx left a comment

Choose a reason for hiding this comment

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

👍🏻 great stuff!

@shaun-nx shaun-nx requested a review from vepatel August 24, 2023 14:11
@shaun-nx shaun-nx merged commit 05ba01b into main Aug 24, 2023
@shaun-nx shaun-nx deleted the feat/custom-listeners 67E6 branch August 24, 2023 15:39
@haywoodsh haywoodsh mentioned this pull request Sep 4, 2023
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vepatel vepatel vepatel approved these changes

@haywoodsh haywoodsh Awaiting requested review from haywoodsh

+1 more reviewer

@jjngx jjngx jjngx approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
documentation Pull requests/issues for documentation enhancement Pull requests for new features/feature enhancements helm_chart Pull requests that update the Helm Chart
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
4 participants
@shaun-nx @vepatel @jjngx @haywoodsh
0