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.

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

Documentation: add migration document #23751

Merged
merged 1 commit into from
Mar 20, 2023
Merged

Documentation: add migration document #23751

merged 1 commit into from
Mar 20, 2023

Conversation

squeed
Copy link
Contributor

@squeed squeed commented Feb 14, 2023

This document explains the basics of how to migrate Cilium on a running cluster. It includes a copy-and-paste example for migrating off of Flannel.

It utilizes the per-node-configuration override feature to gradually roll out Cilium. It configures a hybrid cluster with multiple overlays so that all pods have full connectivity until migration is complete.

@squeed squeed added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Feb 14, 2023
@squeed squeed requested a review from a team as a code owner February 14, 2023 21:30
qmonnet
qmonnet requested changes Feb 15, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Contents seem all good to me, I just have a few minor comments on formatting (plus nits on case and punctuation, for consistency).

Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
examples/misc/migration/install-reference-cni-plugins.yaml Outdated Show resolved Hide resolved
@squeed
Copy link
Contributor Author

squeed commented Feb 15, 2023 •
edited

For you playing along at home: this won't work until #23743 is merged.

@squeed squeed added the dont-merge/blocked Another PR must be merged before this one. label Feb 15, 2023
@qmonnet
Copy link
Member

qmonnet commented Feb 15, 2023

this won't work until #23751 is merged.

@squeed Wrong URL (it's one of these days...), this points to the current PR.

@squeed
Copy link
Contributor Author

squeed commented Feb 15, 2023

Hah. #23743. Updated.

mauilion
mauilion suggested changes Feb 15, 2023
View reviewed changes
Copy link
Contributor

@mauilion mauilion left a comment

Choose a reason for hiding this comment

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

Overall I think it's fine for us to include this in the documentation. I definitely think that describing this process as simple would be a mistake. There will always be edge cases that make this difficult to manage.

Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
qmonnet
qmonnet approved these changes Feb 24, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Looks good from my side. Thanks!

@squeed
Copy link
Contributor Author

squeed commented Feb 27, 2023

Need one more PR to merge, then this doc should be ready to go: #24009

@squeed squeed force-pushed the migration-docs branch 2 times, most recently from 7f678f1 to 15f81db Compare February 27, 2023 21:01
@squeed squeed force-pushed the migration-docs branch 2 times, most recently from 13febd1 to d44fb6f Compare March 3, 2023 13:01
@squeed
Copy link
Contributor Author

squeed commented Mar 3, 2023

I made a few small changes. @mauilion, would you mind giving this a quick read? Then, we can merge this.

@squeed squeed removed the dont-merge/blocked Another PR must be merged before this one. label Mar 7, 2023
mauilion
mauilion approved these changes Mar 7, 2023
View reviewed changes
Copy link
Contributor

@mauilion mauilion left a comment

Choose a reason for hiding this comment

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

looks great with a minor nit.

Documentation/installation/k8s-install-migration.rst Outdated Show resolved Hide resolved
@squeed @mauilion @qmonnet
Documentation: add migration document
d4da22b 
This document explains the basics of how to migrate Cilium on a running
cluster. It includes a copy-and-paste example for migrating off of
Flannel.

It utilizes the per-node-configuration override feature to gradually
roll out Cilium. It configures a hybrid cluster with multiple overlays
so that all pods have full connectivity until migration is complete.

Signed-off-by: Casey Callendrello <cdc@isovalent.com>
Co-authored-by: Duffie Cooley <dcooley@isovalent.com>
Co-authored-by: Quentin Monnet <qmonnet+github@qoba.lt>
@squeed
Copy link
Contributor Author

squeed commented Mar 15, 2023

@mauilion updated, thanks!

@squeed squeed added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Mar 20, 2023
@squeed
Copy link
Contributor Author

squeed commented Mar 20, 2023

docs PR with approvals, marking as ready-to-merge

@aditighag aditighag merged commit 74ec7a0 into cilium:master Mar 20, 2023
@mohahmed13
Copy link

@squeed , are these docs live anywhere docs.cilium.io? I recall there was a conversation on how this is behind a feature in Cilium v1.13.1 (or maybe 1.13.2?). I was trying to find them but no luck

@pchaigno
Copy link
Member

@mohahmed13 It is rendered at https://docs.cilium.io/en/latest/installation/k8s-install-migration/#migrating-a-cluster-to-cilium.

@squeed Could we backport it to v1.13? I see it relies on the per-node configurations but that looks available on v1.13: https://docs.cilium.io/en/stable/configuration/per-node-config/#per-node-configuration.

@squeed squeed added the needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch label Apr 20, 2023
@squeed
Copy link
Contributor Author

squeed commented Apr 20, 2023

Tagged for backport, good catch.

@nbusseneau nbusseneau mentioned this pull request Apr 20, 2023
Merged
15 tasks
@nbusseneau nbusseneau added backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. and removed needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch labels Apr 20, 2023
@sayboras sayboras added backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. and removed backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. labels Apr 26, 2023
@thorn3r thorn3r mentioned this pull request May 17, 2023
Merged
@joestringer joestringer mentioned this pull request Aug 24, 2023
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qmonnet qmonnet qmonnet approved these changes

@mauilion mauilion mauilion approved these changes

@nvibert nvibert nvibert approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
9 participants
@squeed @qmonnet @mohahmed13 @pchaigno @mauilion @nvibert @nbusseneau @sayboras @aditighag