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: Deprecate cluster-pool-v2beta #25767

Merged

Conversation

gandro
Copy link
Member

@gandro gandro commented May 30, 2023

The cluster-pool-v2beta IPAM mode has been added in Cilium v1.12 as a preview feature. Since then, we have added a more flexible multi-pool IPAM mode (c.f. #22762), which addresses some of the shortcomings of cluster-pool-v2. Mainly, multi-pool supports multiple pod CIDR pools, it has a simpler CIDR release mechanism, and it allows users to specify what IP pool a certain pod should allocate from via pod annotation.

Therefore, since cluster-pool-v2beta was never made generally available and was never recommended for production (and indeed still has a few known limitations and bugs that make it unlikely it has been deployed in production), we therefore deprecate it in v1.14, with the plan to remove it in v1.15.

The only cluster-pool-v2beta feature that is lacking in multi-pool IPAM mode is BGP support. We intend to add BGP support to multi-pool IPAM in Cilium v1.15.

This PR also hides a few mentions of the cluster-pool-v2beta mode from the command-line help page. This does not impact any functional behavior.

@gandro gandro 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. sig/ipam IP address management, including cloud IPAM area/ipam Impacts IP address management functionality. labels May 30, 2023
@gandro gandro requested review from a team as code owners May 30, 2023 14:33
@gandro gandro mentioned this pull request May 30, 2023
29 tasks
@christarazi
Copy link
Member

christarazi commented May 31, 2023

/test

Job 'Cilium-PR-K8s-1.25-kernel-4.19' failed:

Click to show.

Test Name

K8sDatapathServicesTest Checks E/W loadbalancing (ClusterIP, NodePort from inside cluster, etc) Tests NodePort inside cluster (kube-proxy) 

Failure Output

FAIL: Request from testclient-9znn8 pod to service tftp://[fd04::11]:31219/hello failed

Jenkins URL: https://jenkins.cilium.io/job/Cilium-PR-K8s-1.25-kernel-4.19/255/

If it is a flake and a GitHub issue doesn't already exist to track it, comment /mlh new-flake Cilium-PR-K8s-1.25-kernel-4.19 so I can create one.

Then please upload the Jenkins artifacts to that issue.

@gandro
Copy link
Member Author

gandro commented May 31, 2023

CI failure looks like #25785

@gandro
Copy link
Member Author

gandro commented May 31, 2023

/test-1.25-4.19

@gandro gandro added the release-blocker/1.14 This issue will prevent the release of the next version of Cilium. label Jun 6, 2023
@gandro
Copy link
Member Author

gandro commented Jun 6, 2023

CI was green. Unfortunately this needs a rebase now.

The `cluster-pool-v2beta` IPAM mode has been added in Cilium v1.12 as a
preview feature. Since then, we have added a more flexible `multi-pool`
IPAM mode, which addresses some of the shortcomings of
`cluster-pool-v2`. Mainly, `multi-pool` supports multiple pod CIDR
pools, it has a simpler CIDR release mechanism, and it allows users to
specify what IP pool a certain pod should allocate from via pod
annotation.

Therefore, since `cluster-pool-v2beta` was never made generally
available and was never recommended for production (and indeed still has
a few known limitations and bugs), we therefore deprecate it in v1.14,
with the plan to remove it in v1.15.

The only `cluster-pool-v2beta` feature that is lacking in `multi-pool`
IPAM mode is BGP support. We intend to add BGP support to multi-pool
IPAM in Cilium v1.15.

This commit also hides a few mentions of the `cluster-pool-v2beta` mode
from the command-line help page. This does not impact any functional
behavior.

Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
@gandro gandro force-pushed the pr/gandro/deprecate-cluster-pool-v2beta branch from 67e67ad to 6f2fe9e Compare June 6, 2023 14:27
@gandro
Copy link
Member Author

gandro commented Jun 6, 2023

/test

Job 'Cilium-PR-K8s-1.16-kernel-4.19' failed:

Click to show.

Test Name

K8sAgentPolicyTest Multi-node policy test with L7 policy using connectivity-check to check datapath

Failure Output

FAIL: connectivity-check pods are not ready after timeout

Jenkins URL: https://jenkins.cilium.io/job/Cilium-PR-K8s-1.16-kernel-4.19/461/

If it is a flake and a GitHub issue doesn't already exist to track it, comment /mlh new-flake Cilium-PR-K8s-1.16-kernel-4.19 so I can create one.

Then please upload the Jenkins artifacts to that issue.

@gandro
Copy link
Member Author

gandro commented Jun 7, 2023

@gandro
Copy link
Member Author

gandro commented Jun 7, 2023

/test-1.16-4.19

Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

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

One small change, otherwise LGTM for docs. Approving with the understanding that changes are required prior to merge.

Comment on lines +362 to +363
The functionality to dynamically allocate Pod CIDRs is now provided by the
more flexible ``multi-pool`` IPAM mode.
Copy link
Contributor

Choose a reason for hiding this comment

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

Edits for clarity

Suggested change
The functionality to dynamically allocate Pod CIDRs is now provided by the
more flexible ``multi-pool`` IPAM mode.
Dynamic allocation of Pod CIDRs is now provided by the
more flexible ``multi-pool`` IPAM mode.

@maintainer-s-little-helper maintainer-s-little-helper bot added ready-to-merge This PR has passed all tests and received consensus from code owners to merge. labels Jun 7, 2023
@dylandreimerink dylandreimerink merged commit d18cf57 into cilium:main Jun 8, 2023
61 checks passed
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/ipam Impacts IP address management functionality. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-blocker/1.14 This issue will prevent the release of the next version of Cilium. release-note/misc This PR makes changes that have no direct user impact. sig/ipam IP address management, including cloud IPAM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants