Skip to content

[feat i2g] add documentation for migration tool#4755

Closed
shuqz wants to merge 1 commit into
kubernetes-sigs:mainfrom
shuqz:i2g-doc
Closed

[feat i2g] add documentation for migration tool#4755
shuqz wants to merge 1 commit into
kubernetes-sigs:mainfrom
shuqz:i2g-doc

Conversation

@shuqz
Copy link
Copy Markdown
Collaborator

@shuqz shuqz commented May 22, 2026

Issue

Related to #4728 — this PR extracts and restructures the migration documentation. Should be merged after #4728.

Description

Restructures the Ingress-to-Gateway migration documentation into a 3-page layout for clarity:

  1. Migration Guide (migrate_from_ingress.md) — end-to-end 6-step walkthrough (translate → preview → apply → verify → shift traffic → cleanup)
  2. Migration Tool (lbc_migrate_reference.md) — full CLI reference (flags, annotation support table, output formats, IngressGroup handling, known differences)
  3. Migration Console (in_cluster_console.md) — console UI walkthrough (diff classification, export, RBAC, troubleshooting)

Also adds diagrams generated with matplotlib:

  • 6-step migration flow overview
  • Dry-run verification workflow
  • Service reuse architecture
  • Traffic shifting strategies comparison

Documentation only — no code changes.

Checklist

  • Added tests that cover your change (if possible)
  • Added/modified documentation as required (such as the README.md, or the docs directory)
  • Manually tested
  • 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?! 🤯

  • Backfilled missing tests for code in same general area 🎉
  • Refactored something and made the world a better place 🌟

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: shuqz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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 k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 22, 2026
@shuqz shuqz closed this May 22, 2026
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.57%. Comparing base (22cdb42) to head (26bf955).
⚠️ Report is 45 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4755      +/-   ##
==========================================
+ Coverage   56.09%   56.57%   +0.47%     
==========================================
  Files         388      390       +2     
  Lines       30932    31138     +206     
==========================================
+ Hits        17352    17616     +264     
+ Misses      12566    12496      -70     
- Partials     1014     1026      +12     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants