Cloud deprecation and breaking changes general recommender

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Cloud deprecation and breaking changes general recommender provides you with recommendations about Cloud deprecations and breaking changes. It identifies Cloud resources that will be affected by upcoming deprecations and breaking changes while providing guidelines on how to manage them. Recommendations are viewable through Google Cloud CLI, the API, and BigQuery export.

Before you begin

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Recommender API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Recommender API.

   Enable the API

Note: You only need to enable the API on a single billing project. You can then use this same billing project to retrieve recommendations and insights for other projects, the entire organization or the billing account, using the --billing-project flag.

4. Ensure that you have the following roles:

Description	Roles
View recommendations	recommender.cloudDeprecationRecommendationViewer
View and update recommendations	recommender.cloudDeprecationRecommendationAdmin

Required roles

This section describes the roles and necessary permissions to use the Cloud deprecation and breaking changes general recommender.

Role	Included permissions
roles/recommender.cloudDeprecationRecommendationViewer	recommender.cloudDeprecationGeneralInsights.get recommender.cloudDeprecationGeneralInsights.list recommender.cloudDeprecationGeneralRecommendations.get recommender.cloudDeprecationGeneralRecommendations.list
roles/recommender.cloudDeprecationRecommendationAdmin	recommender.cloudDeprecationGeneralInsights.update recommender.cloudDeprecationGeneralRecommendations.update

For more information about roles and about granting access, see the following:

• Understanding roles
• Managing access to projects, folders, and organizations

Pricing

Cloud deprecation and breaking changes general recommender is offered at no charge. For information about other pricing tiers, see Recommender pricing.

View cloud deprecation recommendations

You can list recommendations by using the Console, the Google Cloud CLI, the Recommender API, or through BigQuery export.

Console

1. Go to the Recommendation Hub.

   Go to the Recommendation Hub

2. Set the Filter field to Recommender:google.cloud.deprecation.GeneralRecommender.

   Note: You must have the have the correct IAM permissions (listed above) in order to see recommendations. If you have the correct permissions and the page does not show any recommendations, then the project does not have any deprecations or breaking changes that meet the criteria for a recommendation.

Google Cloud CLI

This tab shows the commands to list recommendations and insights with Google Cloud CLI.

• List recommendations

  gcloud recommender recommendations list \
    --billing-project=BILLING_PROJECT_ID  \
    --project=PROJECT_ID  \
    --location=LOCATION  \
    --recommender=google.cloud.deprecation.GeneralRecommender \
    --format=yaml
  

• List Insights

  gcloud recommender insights list \
    --billing-project=BILLING_PROJECT_ID  \
    --project=PROJECT_ID  \
    --location=LOCATION  \
    --insight-type=google.cloud.deprecation.GeneralInsight \
    --format=yaml
  

Replace the following:

• BILLING_PROJECT_ID with ID of the project that you've enabled with the Recommender API.
• PROJECT_ID with the identifier for your Google Cloud project.
• LOCATION with the Google Cloud location where resources associated with the recommendations are located (for example, global or us-central1-a).

API

This tabs shows your the commands to list recommendations and insights with the Recommender API.

• List Recommendations

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "x-goog-user-project: BILLING_PROJECT_ID " \
  "https://recommender.googleapis.com/v1/projects/PROJECT_ID /locations/LOCATION /recommenders/google.cloud.deprecation.GeneralRecommender/recommendations"
  

• List Insights

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "x-goog-user-project: BILLING_PROJECT_ID " \
  "https://recommender.googleapis.com/v1/projects/PROJECT_ID /locations/LOCATION /insightTypes/google.cloud.deprecation.GeneralInsight/insights"
  

Replace the following:

• BILLING_PROJECT_ID with ID of the project that you've enabled with the Recommender API.
• PROJECT_ID with the identifier for your Google Cloud project.
• LOCATION with the Google Cloud location where resources associated with the recommendations are located (for example, global or us-central1-a).

BigQuery export

This tab shows the commands to list recommendations with BigQuery export.

Cloud deprecation recommendations are also included in BigQuery export. With the BigQuery export, you can view daily snapshots of recommendations for your organization.

1. Follow the BigQuery export documentation to export recommendations to BigQuery.

2. Query all deprecation recommendations:

   SELECT *
   FROM `<project>.<dataset>.recommendations_export`
   WHERE DATE(_PARTITIONTIME) = "<date>"
   and recommender = "google.cloud.deprecation.GeneralRecommender"
   

Available recommendation subtypes

The following table describes the available and disclosable recommendation subtypes.

Subtype	Deprecation or breaking change?
GCE_METADATA_SERVER_HEADER_WHITESPACE	Compute Engine will enforce HTTP request formatting checks in the Compute Engine Metadata Service to align with RFC 7230 Section 3.2, as accepting incorrectly formatted requests might lead to security vulnerabilities.

Warning: Dismissed recommendations are not regenerated and will hide the deprecation recommendation for the instance on all surfaces. Instead, mark it as succeeded once you've applied the recommendation.

Note that this table is not comprehensive and may intentionally omit security-sensitive deprecations or breaking changes.