[RFC0032] CF API v2 End of Life

[stephanme]

This is a tracking issue for the implementation of https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0032-cfapiv2-eol.md

Tasks

Preview Give feedback

1. Remove v2 section from / if temporary_enable_v2 == false cloud_controller_ng#4034
   +0
2. Disable /v2/info endpoint if temporary_enable_v2 == false capi-release#480
   +0
3. Service broker client: Set 'X-Api-Info-Location' according to 'temporary_enable_v2' cloud_controller_ng#4058
   +0
4. Add temporary_enable_v2 flag to cc-worker config capi-release#488
   +0
5. Add temporary_enable_v2 flag to cc-worker config cloud_controller_ng#4067
   +0
6. Adapt SSO and ASGs test for disabled v2 setup cf-acceptance-tests#1312
   +0
7. Migrate service broker functions to v3 capi-bara-tests#103
   +0
8. v3 API does not allow to specify ports on an app's processes cloud_controller_ng#4079
   +0
9. Remove v2 API leftovers capi-bara-tests#105
   +0
10. Apply disable-v2-api ops file to all bbl envs used in cf-deployment validation cf-deployment#1211
    +0
11. Switching to CloudFoundry v3 API concourse/dex#148
    +0
12. Add ops file to enable CF api v2 cf-deployment#1220
    +0
13. Improve some integration-tests and cleanup /v2/info endpoint. fix #1229 #1249 cf-java-client#1250
    +0
14. Disable v2 by default capi-release#503
    +0

Tasks

Preview Give feedback

No tasks being tracked yet.

[stephanme]

Announcement to cf-dev mailing list: https://lists.cloudfoundry.org/g/cf-dev/message/9487

[stephanme]

cf-deployment v44.10.0 is the first cf-d version that was built, validated and released with CF API v2 disabled (see cloudfoundry/cf-deployment#1211).

[stephanme]

The final step of Phase 1 is to disable CF API v2 by default in cf-deployment. The plan looks like this:

1. Provide an ops file enable-v2-api.yml that can be used by operators to re-enable CF API v2 -> Add ops file to enable CF api v2 cf-deployment#1220
2. Disable CF API v2 by default by changing the default of the bosh config property cc.temporary_enable_v2 from true to false and cut a new CAPI release.
3. Ship the new CAPI release as part of a new major release for cf-deployment with prominent release notes mentioning the new ops file.

Step 2 and 3 are planned for beginning of 2025.

Heads-up @cloudfoundry/wg-leads : Step 2 (if you depend on cf-d release candidates) or latest step 3 can be a breaking change for your CI pipelines. The proper solution is not to add the ops file enable-v2-api.yml but to get rid of any remaining v2 usage, of course. But the ops file can buy you some time...