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(kic): fallback configuration guide #7463

Merged
merged 9 commits into from
Jun 11, 2024
Merged

docs(kic): fallback configuration guide #7463

merged 9 commits into from
Jun 11, 2024

Conversation

czeslavo
Copy link
Contributor

@czeslavo czeslavo commented Jun 4, 2024

Description

Adds a guide explaining the new FallbackConfiguration feature usage.

Part of Kong/kubernetes-ingress-controller#5934.

Testing instructions

Preview link: https://deploy-preview-7463--kongdocs.netlify.app/kubernetes-ingress-controller/unreleased/guides/high-availability/fallback-config/

Checklist

Copy link

netlify bot commented Jun 4, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 3ebb711
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/666878f6fccc7b0008287fc9
😎 Deploy Preview https://deploy-preview-7463--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 93 (🟢 up 1 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@czeslavo czeslavo force-pushed the fallback-config branch 3 times, most recently from cd329fb to 97f8d60 Compare June 4, 2024 17:31
@czeslavo czeslavo added the team-k8s Kubernetes task tracking (including KIC,KGO) label Jun 4, 2024
@czeslavo czeslavo added this to the KIC v3.2 milestone Jun 4, 2024
@czeslavo czeslavo requested a review from a team June 4, 2024 17:38
Copy link
Member

@pmalek pmalek left a comment

Choose a reason for hiding this comment

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

First round of review (without taking this for a spin):

  • I'd add section to this doc so that it's easier to follow. Currently this only has Example scenario which doesn't tell the reader what stage of the scenario they're at (am I deploying manifests, testing them, patching them or verifying that fallback config works?)
  • I'd dd a separate (named) section which shows how last known config backfill + fallback works on concrete example. This should be separate in my eyes from what already described and the difference should be noted (X route still works, having previous config filled in).

@czeslavo
Copy link
Contributor Author

czeslavo commented Jun 5, 2024

@pmalek I noticed that the /debug/config/problems endpoint doesn't work as expected - giving you a heads up so you don't waste time figuring out why it doesn't give you proper responses.

@czeslavo czeslavo requested a review from pmalek June 5, 2024 14:35
@czeslavo
Copy link
Contributor Author

czeslavo commented Jun 5, 2024

First round of review (without taking this for a spin):

  • I'd add section to this doc so that it's easier to follow. Currently this only has Example scenario which doesn't tell the reader what stage of the scenario they're at (am I deploying manifests, testing them, patching them or verifying that fallback config works?)
  • I'd dd a separate (named) section which shows how last known config backfill + fallback works on concrete example. This should be separate in my eyes from what already described and the difference should be noted (X route still works, having previous config filled in).

Added more granular sections as well as the whole section about backfilling. Thanks for the comments, I hope I addressed all of them. 🙇

Copy link
Member

@pmalek pmalek left a comment

Choose a reason for hiding this comment

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

@czeslavo
Copy link
Contributor Author

czeslavo commented Jun 5, 2024

Can we already add docs for the feature gate at https://github.com/Kong/docs.konghq.com/blob/86f6865fae98afe729d77583563d982060465578/app/_src/kubernetes-ingress-controller/reference/feature-gates.md ?

Updated the feature gates reference (we were missing some from KIC 3.1): 9bbe69b

@czeslavo czeslavo marked this pull request as ready for review June 5, 2024 16:29
@czeslavo czeslavo requested a review from a team as a code owner June 5, 2024 16:29
@czeslavo czeslavo added review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:copyedit Request for writer review. labels Jun 5, 2024
czeslavo and others added 2 commits June 7, 2024 14:10
Co-authored-by: Patryk Małek <patryk.malek@konghq.com>
Copy link
Member

@mheap mheap left a comment

Choose a reason for hiding this comment

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

This is an awesome guide, thank you.

The config debug endpoint isn't working (known issue), but otherwise it all worked as expected (with my latest commit to fix Helm values)

@czeslavo czeslavo added the do not merge Issues/ PRs whose changes should not be merged at this time label Jun 11, 2024
@czeslavo
Copy link
Contributor Author

czeslavo commented Jun 11, 2024

Labeling do not merge as we need to:

@czeslavo czeslavo requested review from lena-larionova and mheap June 11, 2024 16:27
@czeslavo czeslavo removed the do not merge Issues/ PRs whose changes should not be merged at this time label Jun 11, 2024
@czeslavo czeslavo merged commit af0efd0 into main Jun 11, 2024
21 checks passed
@czeslavo czeslavo deleted the fallback-config branch June 11, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? team-k8s Kubernetes task tracking (including KIC,KGO)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants