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/ipsec: Extend troubleshooting section #26808

Merged
merged 1 commit into from Jul 19, 2023

Conversation

pchaigno
Copy link
Member

Recent bugs with IPsec have highlighted a need to document several caveats of IPsec operations. This commit documents those caveats as well as common XFRM errors.

@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/encryption Impacts encryption support such as IPSec, WireGuard, or kTLS. labels Jul 13, 2023
@pchaigno pchaigno requested a review from jrfastab July 13, 2023 17:21
@pchaigno pchaigno requested review from a team as code owners July 13, 2023 17:21
@pchaigno pchaigno requested a review from lambdanis July 13, 2023 17:21
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jul 13, 2023
@pchaigno pchaigno added needs-backport/1.11 needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Jul 13, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.0 Jul 13, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.12.12 Jul 13, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.13.5 Jul 13, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.11.19 Jul 13, 2023
@pchaigno pchaigno added the release-note/misc This PR makes changes that have no direct user impact. label Jul 13, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jul 13, 2023
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

I left some style comments, but looks good otherwise, thank you 🙇‍♀️

Documentation/security/network/encryption-ipsec.rst Outdated Show resolved Hide resolved
Documentation/security/network/encryption-ipsec.rst Outdated Show resolved Hide resolved
Documentation/security/network/encryption-ipsec.rst Outdated Show resolved Hide resolved
Recent bugs with IPsec have highlighted a need to document several
caveats of IPsec operations. This commit documents those caveats as well
as common XFRM errors.

Signed-off-by: Paul Chaignon <paul.chaignon@gmail.com>
@pchaigno
Copy link
Member Author

Thanks @lambdanis for the review! I've addressed all comments as suggested and also extended a bit on XfrmInError after discussing it with John.

@pchaigno pchaigno requested a review from lambdanis July 17, 2023 12:41
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

lgtm

@pchaigno pchaigno requested review from jschwinger233 and removed request for jrfastab July 18, 2023 17:14
@pchaigno
Copy link
Member Author

Marking as ready-to-merge given I discussed the different items documented here with John already and Anna reviewed for the docs-structure & prose.

@pchaigno pchaigno added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 19, 2023
@aditighag aditighag merged commit 3ba76e5 into cilium:main Jul 19, 2023
40 checks passed
@nbusseneau nbusseneau mentioned this pull request Jul 24, 2023
8 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 Jul 24, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.13 in 1.13.5 Jul 24, 2023
@nbusseneau nbusseneau mentioned this pull request Jul 24, 2023
21 tasks
@nbusseneau nbusseneau added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Jul 24, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.14 in 1.14.0 Jul 24, 2023
@nbusseneau nbusseneau added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Jul 25, 2023
@aanm aanm moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.0 Jul 26, 2023
@gentoo-root gentoo-root added backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. and removed backport-pending/1.11 labels Jul 26, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.11 to Backport done to v1.11 in 1.11.19 Jul 26, 2023
@gentoo-root gentoo-root 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 Jul 26, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.13 to Backport done to v1.13 in 1.13.5 Jul 26, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.12 to Needs backport from main in 1.12.12 Jul 26, 2023
@gentoo-root gentoo-root added this to Needs backport from main in 1.12.13 Jul 26, 2023
@gentoo-root gentoo-root removed this from Needs backport from main in 1.12.12 Jul 26, 2023
@julianwiedmann julianwiedmann added backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. and removed backport-pending/1.12 labels Jul 29, 2023
@asauber asauber moved this from Needs backport from main to Backport done to v1.12 in 1.12.13 Aug 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/encryption Impacts encryption support such as IPSec, WireGuard, or kTLS. backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. backport-done/1.14 The backport for Cilium 1.14.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
No open projects
1.11.19
Backport done to v1.11
1.12.13
Backport done to v1.12
1.13.5
Backport done to v1.13
1.14.0
Backport done to v1.14
Development

Successfully merging this pull request may close these issues.

None yet

7 participants