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: add KongServiceFacade docs and examples #5298

Merged
merged 2 commits into from
Dec 14, 2023
Merged

Conversation

czeslavo
Copy link
Contributor

@czeslavo czeslavo commented Dec 6, 2023

What this PR does / why we need it:

Adds a new FEATURE_GATES.md section "Using KongServiceFacade" explaining the basics of KongServiceFacade. It also references a new example manifest that demonstrates complete usage of KongServiceFacade to set a different set of plugins for the same Kubernetes Service.

The instructions in the example manifest depend on Kong/charts#963 which adds RBACs for KongServiceFacade.

PR also adds an integration test that verifies the new example manifest to make sure it doesn't get outdated.

Which issue this PR fixes:

Closes #5152.

Special notes for your reviewer:

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

  • the CHANGELOG.md release notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR

@czeslavo czeslavo force-pushed the docs/kong-service-facade branch from 0049594 to a3e2379 Compare December 6, 2023 12:12
@czeslavo czeslavo added this to the KIC v3.1.x milestone Dec 6, 2023
@czeslavo czeslavo force-pushed the docs/kong-service-facade branch from a3e2379 to 904aabf Compare December 6, 2023 12:22
Copy link

codecov bot commented Dec 6, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6470f94) 75.9% compared to head (5aa80f5) 75.8%.
Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #5298     +/-   ##
=======================================
- Coverage   75.9%   75.8%   -0.1%     
=======================================
  Files        170     170             
  Lines      19458   19447     -11     
=======================================
- Hits       14769   14756     -13     
- Misses      3858    3860      +2     
  Partials     831     831             

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@czeslavo czeslavo force-pushed the docs/kong-service-facade branch from 904aabf to 5d578c2 Compare December 6, 2023 12:28
@czeslavo czeslavo self-assigned this Dec 6, 2023
@czeslavo czeslavo force-pushed the docs/kong-service-facade branch from 5d578c2 to d4a46ee Compare December 6, 2023 13:06
@czeslavo czeslavo marked this pull request as ready for review December 6, 2023 13:28
@czeslavo czeslavo requested a review from a team as a code owner December 6, 2023 13:28
@czeslavo czeslavo force-pushed the docs/kong-service-facade branch from d4a46ee to 19e3059 Compare December 6, 2023 13:30
@czeslavo czeslavo requested a review from mheap December 6, 2023 13:55
FEATURE_GATES.md Outdated Show resolved Hide resolved
@czeslavo czeslavo force-pushed the docs/kong-service-facade branch 3 times, most recently from 14bb238 to 506c2cf Compare December 7, 2023 11:31
@czeslavo czeslavo force-pushed the docs/kong-service-facade branch from 506c2cf to fca78c7 Compare December 7, 2023 11:45
Copy link
Contributor

@mflendrich mflendrich left a comment

Choose a reason for hiding this comment

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

Looking good 👍

Only the kustomize command comment is blocking (as the original URL did not work for me with a spurious kustomize error).

FEATURE_GATES.md Outdated Show resolved Hide resolved
FEATURE_GATES.md Outdated Show resolved Hide resolved
FEATURE_GATES.md Show resolved Hide resolved
Co-authored-by: Michał Flendrich <[email protected]>
@czeslavo czeslavo requested review from mflendrich and mheap December 11, 2023 10:00
@czeslavo
Copy link
Contributor Author

@mheap @mflendrich Thanks for your comments, PTAL again 👍

@czeslavo czeslavo enabled auto-merge (squash) December 12, 2023 15:08
@czeslavo czeslavo merged commit 57f1c0a into main Dec 14, 2023
36 checks passed
@czeslavo czeslavo deleted the docs/kong-service-facade branch December 14, 2023 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement ServiceFacade behind an alpha feature gate
3 participants