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

Add ops file to enable CF api v2 #1220

Merged
merged 2 commits into from
Dec 5, 2024
Merged

Add ops file to enable CF api v2 #1220

merged 2 commits into from
Dec 5, 2024

Conversation

stephanme
Copy link
Contributor

WHAT is this change about?

Add an ops file to enable CF api v2.

enable-v2-api.yml can be used by operators to re-enable v2 once it gets disabled by default (~Q1 25).

What customer problem is being addressed?

https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0032-cfapiv2-eol.md

We are currently in Phase 1 of the described removal process and the next step is to turn off CF API v2 by default in cf-deployment. The proposed ops file enable-v2-api.yml can be used by operators to re-enable v2.

Please provide any contextual information.

https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0032-cfapiv2-eol.md
cloudfoundry/community#1001

Today (cf-d 45.x), CF API v2 is enabled by default and operators can use the experimental ops file disable-v2-api.yml to disable v2.
In a future cf-d version, we plan to disable CF API v2 by default and operators use the proposed ops file enable-v2-api.yml to enable v2 again.

Has a cf-deployment including this change passed cf-acceptance-tests?

  • YES
  • NO

Today, the new ops file is a no-op because the CAPI property cc.temporary_enable_v2 is still set to true by default.

Does this PR introduce a breaking change? Please take a moment to read through the examples before answering the question.

  • YES - please choose the category from below. Feel free to provide additional details.
  • NO

How should this change be described in cf-deployment release notes?

No need to mention it now in the release notes. It will be mentioned in a future major cf-deployment version when CAPI disables CF API v2 by default. Planned for beginning 2025.

Does this PR introduce a new BOSH release into the base cf-deployment.yml manifest or any ops-files?

  • YES - please specify
  • NO

Does this PR make a change to an experimental or GA'd feature/component?

  • experimental feature/component
  • GA'd feature/component

It sets the bosh config property cc.temporary_enable_v2 of capi-release to its default value = no-op

Please provide Acceptance Criteria for this change?

If the new ops file is added to cf-deployment 45.x, the generated bosh manifest doesn't change.

What is the level of urgency for publishing this change?

  • Urgent - unblocks current or future work
  • Slightly Less than Urgent

Tag your pair, your PM, and/or team!

@jochenehret

- enable-v2-api.yml can be used by operators to re-enable v2 once it gets disabled by default (~Q1 25)
- there is an experimental ops file disable-v2-api.yml which will be deprecated and removed later
jochenehret
jochenehret previously approved these changes Dec 4, 2024
@ard-wg-gitbot
Copy link
Contributor

Hello friend, it looks like your pull request has failed one or more of our checks. Please take a look! 👀

@jochenehret jochenehret merged commit 7d4b424 into develop Dec 5, 2024
3 checks passed
@jochenehret jochenehret deleted the enable-v2-opsfile branch December 5, 2024 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants