Deprecate a custom image

Linux Windows

Compute Engine lets you deprecate a custom image that you own by setting the deprecation status on the image. Each deprecation status causes a different response from the server, helping you transition users away from unsupported images in a manageable way. Use the Google Cloud console, the Google Cloud CLI, or the Compute Engine API method to deprecate an image.

Deprecation states

The following deprecation states are supported:

ACTIVE : the image is active and can be used as normal. Image families point to the most recent and active image in a family.
DEPRECATED : the image is marked deprecated but can still be used to create a VM . New links to this image are allowed. Image families no longer point to this image even if it is the most recent image in the family.

If you create a VM with a deprecated image using the Google Cloud CLI, the request succeeds with a warning.
OBSOLETE : the image is marked obsolete and is no longer available for use. An error message is returned if you try to use this image in a request. Existing links to this image are still allowed.
DELETED : this image is deleted. An error message is returned if you try to use a deleted image.

You can revert a deprecation (make an image active again), by changing the deprecation state to ACTIVE .

Before you begin

Read the Images document.
If you haven't already, set up authentication . Authentication verifies your identity for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:
Select the tab for how you plan to use the samples on this page:
Console

When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
1. Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
  gcloud init
  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .
  
  Note:If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update .
2. Set a default region and zone .
REST

To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.
For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

Deprecate a custom image

Console

In the Google Cloud console, go to the Imagespage.

Go to Images
For the image you want to deprecate, click Actions .
Select Deprecate.
For state, select either Deprecatedor Obsolete. For more information about states, see Deprecation states .
Optional: Specify a replacement image.
Click Deprecate Image.

gcloud

Use the gcloud compute images deprecate command to set the deprecation status of an image.

gcloud compute images deprecate IMAGE_NAME 
\
    --state STATE 
\
    --replacement REPLACEMENT

Replace the following:

IMAGE_NAME : the name of the image to deprecate
STATE : the deprecation state
REPLACEMENT : the image to replace the one that is deprecated

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 computepb 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
  
 "google.golang.org/protobuf/proto" 
 ) 
 // Geg a disk image from the given project 
 func 
  
 deprecateDiskImage 
 ( 
  
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 imageName 
  
 string 
 , 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // imageName := "my_image" 
  
 deprecationStatus 
  
 := 
  
& computepb 
 . 
 DeprecationStatus 
 { 
  
 State 
 : 
  
 proto 
 . 
 String 
 ( 
 computepb 
 . 
  DeprecationStatus_DEPRECATED 
 
 . 
 String 
 ()), 
  
 } 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 imagesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewImagesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewImagesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 imagesClient 
 . 
 Close 
 () 
  
 source_req 
  
 := 
  
& computepb 
 . 
 DeprecateImageRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Image 
 : 
  
 imageName 
 , 
  
 DeprecationStatusResource 
 : 
  
 deprecationStatus 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 imagesClient 
 . 
 Deprecate 
 ( 
 ctx 
 , 
  
 source_req 
 ) 
  
 if 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to wait for the operation: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Disk image %s deprecated\n" 
 , 
  
 imageName 
 ) 
  
 return 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. DeprecateImageRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. DeprecationStatus 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Image 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. ImagesClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.UUID 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 SetImageDeprecationStatus 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // Project ID or project number of the Google Cloud project you want to use. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 // Name of the image you want to update. 
  
 String 
  
 imageName 
  
 = 
  
 "your-image-name" 
 ; 
  
 // The status you want to set for the image. Available values are available in 
  
 // `compute_v1.DeprecationStatus.State` enum. Learn more about image deprecation statuses: 
  
 // https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#deprecation-states 
  
  DeprecationStatus 
 
 . 
 State 
  
 status 
  
 = 
  
  DeprecationStatus 
 
 . 
 State 
 . 
 DEPRECATED 
 ; 
  
 setDeprecationStatus 
 ( 
 projectId 
 , 
  
 imageName 
 , 
  
 status 
 ); 
  
 } 
  
 // Modify the deprecation status of an image. 
  
 public 
  
 static 
  
  Image 
 
  
 setDeprecationStatus 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 imageName 
 , 
  
  DeprecationStatus 
 
 . 
 State 
  
 status 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  ImagesClient 
 
  
 client 
  
 = 
  
  ImagesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  DeprecationStatus 
 
  
 deprecationStatusResource 
  
 = 
  
  DeprecationStatus 
 
 . 
 newBuilder 
 () 
  
 . 
 setState 
 ( 
 status 
 . 
 name 
 ()) 
  
 . 
 build 
 (); 
  
  DeprecateImageRequest 
 
  
 request 
  
 = 
  
  DeprecateImageRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setImage 
 ( 
 imageName 
 ) 
  
 . 
  setDeprecationStatusResource 
 
 ( 
 deprecationStatusResource 
 ) 
  
 . 
 setRequestId 
 ( 
 UUID 
 . 
 randomUUID 
 (). 
 toString 
 ()) 
  
 . 
 build 
 (); 
  
 client 
 . 
  deprecateCallable 
 
 (). 
 futureCall 
 ( 
 request 
 ). 
 get 
 ( 
 60 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
  Image 
 
  
 image 
  
 = 
  
 client 
 . 
 get 
 ( 
 projectId 
 , 
  
 imageName 
 ); 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Status '%s' has been updated successfully" 
 , 
  
 image 
 . 
  getDeprecated 
 
 (). 
 getState 
 ()); 
  
 return 
  
 image 
 ; 
  
 } 
  
 } 
 }

Python

  from 
  
 __future__ 
  
 import 
 annotations 
 import 
  
 sys 
 from 
  
 typing 
  
 import 
 Any 
 from 
  
 google.api_core.extended_operation 
  
 import 
 ExtendedOperation 
 from 
  
 google.cloud 
  
 import 
  compute_v1 
 
 def 
  
 wait_for_extended_operation 
 ( 
 operation 
 : 
 ExtendedOperation 
 , 
 verbose_name 
 : 
 str 
 = 
 "operation" 
 , 
 timeout 
 : 
 int 
 = 
 300 
 ) 
 - 
> Any 
 : 
  
 """ 
 Waits for the extended (long-running) operation to complete. 
 If the operation is successful, it will return its result. 
 If the operation ends with an error, an exception will be raised. 
 If there were any warnings during the execution of the operation 
 they will be printed to sys.stderr. 
 Args: 
 operation: a long-running operation you want to wait on. 
 verbose_name: (optional) a more verbose name of the operation, 
 used only during error and warning reporting. 
 timeout: how long (in seconds) to wait for operation to finish. 
 If None, wait indefinitely. 
 Returns: 
 Whatever the operation.result() returns. 
 Raises: 
 This method will raise the exception received from `operation.exception()` 
 or RuntimeError if there is no exception set, but there is an `error_code` 
 set for the `operation`. 
 In case of an operation taking longer than `timeout` seconds to complete, 
 a `concurrent.futures.TimeoutError` will be raised. 
 """ 
 result 
 = 
 operation 
 . 
 result 
 ( 
 timeout 
 = 
 timeout 
 ) 
 if 
 operation 
 . 
 error_code 
 : 
 print 
 ( 
 f 
 "Error during 
 { 
 verbose_name 
 } 
 : [Code: 
 { 
 operation 
 . 
 error_code 
 } 
 ]: 
 { 
 operation 
 . 
 error_message 
 } 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 , 
 ) 
 print 
 ( 
 f 
 "Operation ID: 
 { 
 operation 
 . 
 name 
 } 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 ) 
 raise 
 operation 
 . 
 exception 
 () 
 or 
 RuntimeError 
 ( 
 operation 
 . 
 error_message 
 ) 
 if 
 operation 
 . 
 warnings 
 : 
 print 
 ( 
 f 
 "Warnings during 
 { 
 verbose_name 
 } 
 : 
 \n 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 ) 
 for 
 warning 
 in 
 operation 
 . 
 warnings 
 : 
 print 
 ( 
 f 
 " - 
 { 
 warning 
 . 
 code 
 } 
 : 
 { 
 warning 
 . 
 message 
 } 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 ) 
 return 
 result 
 def 
  
 set_deprecation_status 
 ( 
 project_id 
 : 
 str 
 , 
 image_name 
 : 
 str 
 , 
 status 
 : 
  compute_v1 
 
 . 
  DeprecationStatus 
 
 . 
 State 
 ) 
 - 
> None 
 : 
  
 """ 
 Modify the deprecation status of an image. 
 Note: Image objects by default don't have the `deprecated` attribute at all unless it's set. 
 Args: 
 project_id: project ID or project number of the Cloud project that hosts the image. 
 image_name: name of the image you want to modify 
 status: the status you want to set for the image. Available values are available in 
 `compute_v1.DeprecationStatus.State` enum. Learn more about image deprecation statuses: 
 https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#deprecation-states 
 """ 
 image_client 
 = 
  compute_v1 
 
 . 
  ImagesClient 
 
 () 
 deprecation_status 
 = 
  compute_v1 
 
 . 
  DeprecationStatus 
 
 () 
 deprecation_status 
 . 
 state 
 = 
 status 
 . 
 name 
 operation 
 = 
 image_client 
 . 
  deprecate 
 
 ( 
 project 
 = 
 project_id 
 , 
 image 
 = 
 image_name 
 , 
 deprecation_status_resource 
 = 
 deprecation_status 
 , 
 ) 
 wait_for_extended_operation 
 ( 
 operation 
 , 
 "changing deprecation state of an image" 
 )

REST

Make a POST request to the images().deprecate method . Specify the name of the image you want to deprecate.

POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/images/ RESOURCE_ID 
/deprecate

{
  "state": " STATE 
",
  "replacement": " REPLACEMENT 
"
}

Replace the following:

PROJECT_ID : the project to which the image belongs.
RESOURCE_ID : the name of the image that you are deprecating.
STATE : the deprecation state of this resource.
REPLACEMENT : the image to replace the one that is deprecated.