Skip to content

docs(operator): migration guide from kgo 1.6.x to ko 2.0 #2796

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 14 commits into from
Sep 10, 2025
Merged

docs(operator): migration guide from kgo 1.6.x to ko 2.0 #2796

merged 14 commits into from
Sep 10, 2025
+274 −0

Conversation

alacuku
Copy link

@alacuku alacuku commented Sep 8, 2025 •
edited
Loading

Description

Fixes Kong/kong-operator#1984, Kong/kong-operator#1947

Preview Links

https://deploy-preview-2796--kongdeveloper.netlify.app/index/operator/#gateway-deployment--upgrading
https://deploy-preview-2796--kongdeveloper.netlify.app/operator/migrate/
https://deploy-preview-2796--kongdeveloper.netlify.app/operator/migrate/migrate-1.6.x-2.0.0/
https://deploy-preview-2796--kongdeveloper.netlify.app/operator/migrate/konnectextension-konnectid-to-konnectgatewaycontrolplane/

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@netlify Netlify
Copy link

netlify bot commented Sep 8, 2025 •
edited
Loading

✅ Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 652bfc8
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/68c1859caab9f20008d3d578
😎 Deploy Preview https://deploy-preview-2796--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@alacuku
chore: make linter happy
6ed4b92 
Signed-off-by: Aldo Lacuku <[email protected]>
@alacuku alacuku mentioned this pull request Sep 8, 2025
Closed
7 tasks
@Guaris Guaris self-assigned this Sep 8, 2025
pmalek
pmalek reviewed Sep 8, 2025
View reviewed changes
app/operator/migrate/migrate-1.6.x-2.0.0.md
Comment on lines +50 to +53
5. **Verify cert-manager is installed** (required for conversion webhooks):

{:.info}
> **Note**: Kong Operator 2.0.0 uses conversion webhooks that require TLS certificates managed by cert-manager. If cert-manager is not installed, follow the [cert-manager installation guide](https://cert-manager.io/docs/installation/) before proceeding.
Copy link
Member

Choose a reason for hiding this comment

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

This is not required anymore. By default we use helm generated certs.

Users can opt in for cert-manager generated certificates if they want to using https://github.com/Kong/kong-operator/blob/f62c3e4c2052036f95afd654f3a4ff200e1f10d5/charts/kong-operator/values.yaml#L123-L131

Copy link
Author

Choose a reason for hiding this comment

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

This is not required anymore. By default we use helm generated certs.

Helm-generated certificates are fine for development and testing, but for production environments, it’s recommended to use cert-manager. Unless you have a specific reason, I wouldn’t advise dropping cert-manager and relying solely on Helm-generated certs in the migration guide.

Copy link
Member

Choose a reason for hiding this comment

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

Both are self signed certs, the only difference is that cert-manager provides the rotation for the certs, while helm generated ones are valid for 10y.

Tagging @justindavies to get his view on what should land in the docs.

@alacuku alacuku marked this pull request as ready for review September 9, 2025 09:53
@alacuku alacuku requested a review from a team as a code owner September 9, 2025 09:53
@Guaris Guaris removed their assignment Sep 9, 2025
@cloudjumpercat cloudjumpercat self-assigned this Sep 9, 2025
@pmalek pmalek mentioned this pull request Sep 9, 2025
Draft
7 tasks
cloudjumpercat
cloudjumpercat reviewed Sep 9, 2025
View reviewed changes
Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

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

Left some feedback on formatting! I also ran into an issue while I was testing the 1.6.x to 2.0 migration. I've left the error I got as a comment. Thanks for adding these docs!

alacuku and others added 8 commits September 10, 2025 09:52
@alacuku @cloudjumpercat
Update app/_indices/operator.yaml
3825352 
Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/konnectextension-konnectid-to-konnectgate…
67cb068 
…waycontrolplane.md

Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/konnectextension-konnectid-to-konnectgate…
206c399 
…waycontrolplane.md

Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/konnectextension-konnectid-to-konnectgate…
da049e1 
…waycontrolplane.md

Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/migrate-1.6.x-2.0.0.md
4533bae 
Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/migrate-1.6.x-2.0.0.md
fd273cc 
Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/migrate-1.6.x-2.0.0.md
3e66850 
Co-authored-by: Diana <[email protected]>
@alacuku @cloudjumpercat
Update app/operator/migrate/migrate-1.6.x-2.0.0.md
03225b7 
Co-authored-by: Diana <[email protected]>
@alacuku
Copy link
Author

alacuku commented Sep 10, 2025

Hey @cloudjumpercat, thanks for the review. I accepted your suggestions.

pmalek
pmalek approved these changes Sep 10, 2025
View reviewed changes
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.

This looks good to me. Leaving up to @cloudjumpercat to leave a comment or approval on this.

I can still see some suggestions that are pending, @cloudjumpercat if you feel those should be applied let's do that.

cloudjumpercat
cloudjumpercat approved these changes Sep 10, 2025
View reviewed changes
Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

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

LGTM! This can be merged whenever you're ready

@alacuku alacuku merged commit 3828011 into release/operator/2.0.0 Sep 10, 2025
11 checks passed
@alacuku alacuku deleted the kcl/ko-migration branch September 10, 2025 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pmalek pmalek pmalek approved these changes

@cloudjumpercat cloudjumpercat cloudjumpercat approved these changes

Assignees

@cloudjumpercat cloudjumpercat

Labels
product:kgo
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@alacuku @pmalek @cloudjumpercat @Guaris