Skip to content

Commit

Permalink
Ready for draft PR
Browse files Browse the repository at this point in the history
  • Loading branch information
pburkholder committed Feb 4, 2025
1 parent b0b6774 commit 1b76ef9
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 18 deletions.
2 changes: 2 additions & 0 deletions _posts/2025-01-02-v2api-deprecation.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,6 @@ The Cloud.gov team may accelerate this schedule if v2 usage has ceased, or if ma
Updates to this page, or links to additional documentation will be listed below:

* 2025-01-09: Added update guidance and links to the v3 upgrade guide and the v2 docs.
* 2025-02-04: Added a [v2 EOL readiness checklist]({{site.baseurl}}{% link _posts/2025-01-31-v2api-guidance.md %})


50 changes: 32 additions & 18 deletions _posts/2025-01-31-v2api-guidance.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,55 @@
---
layout: post
date: "2025-01-07"
date: "2025-02-04"
title: "Developer guidance for API v2 EOL"
excerpt: "Checklist for v2 end-of-life preparedness"
---

##

As we announced earlier in January, the Cloud.gov API v2 at
<https://api.fr.cloud.gov> will be discontinued in June, and
As we [announced in January]({{site.baseurl}}/news/2025/01/07/v2api-deprecation/),
the Cloud.gov v2 API at
<https://api.fr.cloud.gov> will be discontinued in June, and
developers should ensure their deployment and app management
code is using the v3 API, which has been the preferred API since 2021.
code is using the v3 API. The v3 API has been the preferred API since 2021
and already accounts for 98% of API calls, so it's likely you are already
set for this change.

This guide provides a quick Readiness Checklist for this transition.
This guide provides a quick [Readiness Checklist](#readiness-checklist) for this transition. Taking
the steps in the checklist will address most uses of the v2 API.

**The code you run _in_ Cloud.gov most likely does _not_ need
updating.** Your applications at <appname>.app.cloud.gov will not
Note: **The code you run _in_ Cloud.gov most likely does _not_ need
updating.** Your applications at &lt;appname&gt;.app.cloud.gov will not
be impacted. The API change may impact how you:

* deploy your apps in Cloud.gov
* manage or monitor your apps in Cloud.gov

## Readiness Checklist

- [ ] Ensure you and your developers are using a [recent version of CF CLI](#update-your-version-of-cf-cli) -- the Cloud Foundry command line interface (CLI).
- [ ] Ensure your deployment code, such as your CD pipeline, is using a [recent version of CF CLI](#update-your-version-of-cf-cli).
- [ ] Scan your application deployment code for the string '/v2'. If you find it, determine if it's a call to the v2 API, e.g. `cf curl /v2/....`.
- [ ] As needed, update your code to use the `/v3/` equivalents. Contact [SupportTKTK] if you're not sure how to do this.
- [ ] If you use Terraform, ensure you're using [v3 CloudFoundry Terraform provider](https://github.com/cloudfoundry/terraform-provider-cloudfoundry)
- [ ] If you use the [cf-python-client](https://github.com/cloudfoundry-community/cf-python-client/), update to version v1.38.2 or higher, and test your code.
- [ ] If you use the [go-cfclient](https://github.com/cloudfoundry/go-cfclient), ensure you're using a version
Going through this checklist will address most places where the v2 API may still be in use.

- [ ] Ensure you and your developers are using a [version of the CF CLI](#update-your-version-of-cf-cli), the Cloud Foundry command line interface (CLI), later than v7.7.1 or v8.7.1.
- [ ] Ensure your deployment code, such as your CD pipeline, is using a supported [version of the CF CLI](#update-your-version-of-cf-cli) later than v7.7.1 or v8.7.1.
- [ ] Scan your application deployment code for the string '/v2'. If you find it, determine if it's a call to the v2 API, e.g. `cf curl /v2/....`.
- [ ] As needed, update your code to use the `/v3/` equivalents, per the [v3 upgrade guide](https://v3-apidocs.cloudfoundry.org/index.html#upgrade-guide).
- [ ] If you use Terraform, ensure you're using [v3 CloudFoundry Terraform provider](https://github.com/cloudfoundry/terraform-provider-cloudfoundry).
- The [community-supported Terraform provider](https://registry.terraform.io/providers/cloudfoundry-community/cloudfoundry/latest) is not v3-compatible.
- The CloudFoundry Terraform maintainers have a [migration guide](https://github.com/cloudfoundry/terraform-provider-cloudfoundry/blob/main/migration-guide/Readme.md) for adopting the v3-compatible provider.
- [ ] If you use the [cf-python-client](https://github.com/cloudfoundry-community/cf-python-client/), update to [version v1.38.2 or higher](https://github.com/cloudfoundry-community/cf-python-client/releases).
- [ ] If you use the [go-cfclient](https://github.com/cloudfoundry/go-cfclient), ensure you're using a [version 3.0.0.alpha release](https://github.com/cloudfoundry/go-cfclient/releases).


'
## Update your version of CF CLI

1. Check your version of version
You need to be running CF CLI v7.7.1 and v8.7.1 or later both
for development work and for your deployment system.

1. Check your version by running `cf version` to check if it's supported.
2. If you need to upgrade, follow the [V8 CLI Installation Guide](https://github.com/cloudfoundry/cli/wiki/V8-CLI-Installation-Guide).

## Next steps

The Cloud.gov team will monitor use of the v2 API, and provide further guidance in the weeks ahead. As use declines, we should be able to identify specific programs using the v2 API and then notify them. If necessary, we may announce "brownouts" when we block access to the v2 API for short periods so teams can test their deployments and processes. Brownouts WILL NOT impact application availability.

As always, the [Support Team](mailto:[email protected]) is ready to assist you with your questions.


0 comments on commit 1b76ef9

Please sign in to comment.