Add replaceUnready annotation for Jobs (#1575)

Add the `pulumi.com/replaceUnready` annotation that allows
the user to specify that a Job resource should be replaced
during an update if it is not ready. This annotation could be
extended to support other resource types as well, but currently
only supports Jobs.

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## HEAD (Unreleased)
+
 - Allow opting out of CRD rendering for Helm v3 by specifying `SkipCRDRendering` argument to Helm charts. (https://github.com/pulumi/pulumi-kubernetes/pull/1572)
+- Add replaceUnready annotation for Jobs. (https://github.com/pulumi/pulumi-kubernetes/pull/1575)
 
 ## 3.1.2 (May 12, 2021)
 

provider/cmd/pulumi-resource-kubernetes/schema.json

@@ -9680,7 +9680,7 @@
             }
         },
         "kubernetes:batch/v1:Job": {
-            "description": "Job represents the configuration of a single job.\n\nThis resource waits until its status is ready before registering success\nfor create/update, and populating output properties from the current state of the resource.\nThe following conditions are used to determine whether the resource creation has\nsucceeded or failed:\n\n1. The Job's '.status.startTime' is set, which indicates that the Job has started running.\n2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set\n   to 'True'.\n3. The Job's '.status.conditions' do not have a status of type 'Failed', with a\n\t'status' set to 'True'. If this condition is set, we should fail the Job immediately.\n\nIf the Job has not reached a Ready state after 10 minutes, it will\ntime out and mark the resource update as Failed. You can override the default timeout value\nby setting the 'customTimeouts' option on the resource.",
+            "description": "Job represents the configuration of a single job.\n\nThis resource waits until its status is ready before registering success\nfor create/update, and populating output properties from the current state of the resource.\nThe following conditions are used to determine whether the resource creation has\nsucceeded or failed:\n\n1. The Job's '.status.startTime' is set, which indicates that the Job has started running.\n2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set\n   to 'True'.\n3. The Job's '.status.conditions' do not have a status of type 'Failed', with a\n\t'status' set to 'True'. If this condition is set, we should fail the Job immediately.\n\nIf the Job has not reached a Ready state after 10 minutes, it will\ntime out and mark the resource update as Failed. You can override the default timeout value\nby setting the 'customTimeouts' option on the resource.\n\nBy default, if a resource failed to become ready in a previous update, \nPulumi will continue to wait for readiness on the next update. If you would prefer\nto schedule a replacement for an unready resource on the next update, you can add the\n\"pulumi.com/replaceUnready\": \"true\" annotation to the resource definition.",
             "properties": {
                 "apiVersion": {
                     "type": "string",
@@ -33131,7 +33131,7 @@
             ]
         },
         "kubernetes:batch/v1:Job": {
-            "description": "Job represents the configuration of a single job.\n\nThis resource waits until its status is ready before registering success\nfor create/update, and populating output properties from the current state of the resource.\nThe following conditions are used to determine whether the resource creation has\nsucceeded or failed:\n\n1. The Job's '.status.startTime' is set, which indicates that the Job has started running.\n2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set\n   to 'True'.\n3. The Job's '.status.conditions' do not have a status of type 'Failed', with a\n\t'status' set to 'True'. If this condition is set, we should fail the Job immediately.\n\nIf the Job has not reached a Ready state after 10 minutes, it will\ntime out and mark the resource update as Failed. You can override the default timeout value\nby setting the 'customTimeouts' option on the resource.",
+            "description": "Job represents the configuration of a single job.\n\nThis resource waits until its status is ready before registering success\nfor create/update, and populating output properties from the current state of the resource.\nThe following conditions are used to determine whether the resource creation has\nsucceeded or failed:\n\n1. The Job's '.status.startTime' is set, which indicates that the Job has started running.\n2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set\n   to 'True'.\n3. The Job's '.status.conditions' do not have a status of type 'Failed', with a\n\t'status' set to 'True'. If this condition is set, we should fail the Job immediately.\n\nIf the Job has not reached a Ready state after 10 minutes, it will\ntime out and mark the resource update as Failed. You can override the default timeout value\nby setting the 'customTimeouts' option on the resource.\n\nBy default, if a resource failed to become ready in a previous update, \nPulumi will continue to wait for readiness on the next update. If you would prefer\nto schedule a replacement for an unready resource on the next update, you can add the\n\"pulumi.com/replaceUnready\": \"true\" annotation to the resource definition.",
             "properties": {
                 "apiVersion": {
                     "type": "string",

provider/pkg/gen/additionalComments.go

@@ -147,15 +147,24 @@ https://kubernetes.io/docs/concepts/configuration/secret/#risks`
 	}
 }
 
+func replaceUnreadyComment() string {
+	return `By default, if a resource failed to become ready in a previous update, 
+Pulumi will continue to wait for readiness on the next update. If you would prefer
+to schedule a replacement for an unready resource on the next update, you can add the
+"pulumi.com/replaceUnready": "true" annotation to the resource definition.`
+}
+
 // PulumiComment adds additional information to the docs generated automatically from the OpenAPI specs.
 // This includes information about Pulumi's await behavior, deprecation information, etc.
 func PulumiComment(kind string) string {
 	const prefix = "\n\n"
 
 	k := kinds.Kind(kind)
 	switch k {
-	case kinds.Deployment, kinds.Ingress, kinds.Job, kinds.Pod, kinds.Service, kinds.StatefulSet:
+	case kinds.Deployment, kinds.Ingress, kinds.Pod, kinds.Service, kinds.StatefulSet:
 		return prefix + awaitComments(k)
+	case kinds.Job:
+		return prefix + awaitComments(k) + prefix + replaceUnreadyComment()
 	case kinds.Secret:
 		return prefix + helpfulLinkComments(k)
 	default:

provider/pkg/metadata/annotations.go

@@ -31,6 +31,7 @@ const (
 	AnnotationSkipAwait         = AnnotationPrefix + "skipAwait"
 	AnnotationTimeoutSeconds    = AnnotationPrefix + "timeoutSeconds"
 	AnnotationInitialAPIVersion = AnnotationPrefix + "initialApiVersion"
+	AnnotationReplaceUnready    = AnnotationPrefix + "replaceUnready"
 
 	AnnotationHelmHook = "helm.sh/hook"
 )

provider/pkg/metadata/overrides.go

@@ -26,6 +26,11 @@ func SkipAwaitLogic(obj *unstructured.Unstructured) bool {
 	return IsAnnotationTrue(obj, AnnotationSkipAwait)
 }
 
+// ReplaceUnready returns true if the `pulumi.com/replaceUnready` annotation is "true", false otherwise.
+func ReplaceUnready(obj *unstructured.Unstructured) bool {
+	return IsAnnotationTrue(obj, AnnotationReplaceUnready)
+}
+
 // TimeoutDuration returns the resource timeout duration. There are a number of things it can do here in this order
 // 1. Return the timeout as specified in the customResource options
 // 2. Return the timeout as specified in `pulumi.com/timeoutSeconds` annotation,

provider/pkg/provider/provider.go

@@ -1,4 +1,4 @@
-// Copyright 2016-2018, Pulumi Corporation.
+// Copyright 2016-2021, Pulumi Corporation.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@ import (
 	structpb "github.com/golang/protobuf/ptypes/struct"
 	pkgerrors "github.com/pkg/errors"
 	"github.com/pulumi/pulumi-kubernetes/provider/v3/pkg/await"
+	"github.com/pulumi/pulumi-kubernetes/provider/v3/pkg/await/states"
 	"github.com/pulumi/pulumi-kubernetes/provider/v3/pkg/clients"
 	"github.com/pulumi/pulumi-kubernetes/provider/v3/pkg/cluster"
 	"github.com/pulumi/pulumi-kubernetes/provider/v3/pkg/gen"
@@ -1368,6 +1369,23 @@ func (k *kubeProvider) Diff(
 		}
 	}
 
+	if metadata.ReplaceUnready(newInputs) {
+		switch newInputs.GetKind() {
+		case "Job":
+			jobChecker := states.NewJobChecker()
+			job, err := clients.FromUnstructured(newInputs)
+			if err == nil {
+				jobChecker.Update(job)
+				if !jobChecker.Ready() {
+					hasChanges = pulumirpc.DiffResponse_DIFF_SOME
+					replaces = append(replaces, `.metadata.annotations["pulumi.com/replaceUnready"]`)
+				}
+			}
+		default:
+			_ = k.host.Log(ctx, diag.Warning, urn, "replaceUnready annotation is not supported for this resource")
+		}
+	}
+
 	// Delete before replacement if we are forced to replace the old object, and the new version of
 	// that object MUST have the same name.
 	deleteBeforeReplace :=

sdk/dotnet/Batch/V1/Job.cs

@@ -26,6 +26,11 @@ namespace Pulumi.Kubernetes.Batch.V1
     /// If the Job has not reached a Ready state after 10 minutes, it will
     /// time out and mark the resource update as Failed. You can override the default timeout value
     /// by setting the 'customTimeouts' option on the resource.
+    /// 
+    /// By default, if a resource failed to become ready in a previous update,
+    /// Pulumi will continue to wait for readiness on the next update. If you would prefer
+    /// to schedule a replacement for an unready resource on the next update, you can add the
+    /// "pulumi.com/replaceUnready": "true" annotation to the resource definition.
     /// </summary>
     [KubernetesResourceType("kubernetes:batch/v1:Job")]
     public partial class Job : KubernetesResource

sdk/go/kubernetes/batch/v1/job.go

@@ -27,6 +27,11 @@ import (
 // If the Job has not reached a Ready state after 10 minutes, it will
 // time out and mark the resource update as Failed. You can override the default timeout value
 // by setting the 'customTimeouts' option on the resource.
+//
+// By default, if a resource failed to become ready in a previous update,
+// Pulumi will continue to wait for readiness on the next update. If you would prefer
+// to schedule a replacement for an unready resource on the next update, you can add the
+// "pulumi.com/replaceUnready": "true" annotation to the resource definition.
 type Job struct {
 	pulumi.CustomResourceState
 

sdk/go/kubernetes/batch/v1/pulumiTypes.go

@@ -666,6 +666,11 @@ func (o CronJobStatusPtrOutput) LastSuccessfulTime() pulumi.StringPtrOutput {
 // If the Job has not reached a Ready state after 10 minutes, it will
 // time out and mark the resource update as Failed. You can override the default timeout value
 // by setting the 'customTimeouts' option on the resource.
+//
+// By default, if a resource failed to become ready in a previous update,
+// Pulumi will continue to wait for readiness on the next update. If you would prefer
+// to schedule a replacement for an unready resource on the next update, you can add the
+// "pulumi.com/replaceUnready": "true" annotation to the resource definition.
 type JobType struct {
 	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
 	ApiVersion *string `pulumi:"apiVersion"`
@@ -706,6 +711,11 @@ type JobTypeInput interface {
 // If the Job has not reached a Ready state after 10 minutes, it will
 // time out and mark the resource update as Failed. You can override the default timeout value
 // by setting the 'customTimeouts' option on the resource.
+//
+// By default, if a resource failed to become ready in a previous update,
+// Pulumi will continue to wait for readiness on the next update. If you would prefer
+// to schedule a replacement for an unready resource on the next update, you can add the
+// "pulumi.com/replaceUnready": "true" annotation to the resource definition.
 type JobTypeArgs struct {
 	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
 	ApiVersion pulumi.StringPtrInput `pulumi:"apiVersion"`
@@ -772,6 +782,11 @@ func (i JobTypeArray) ToJobTypeArrayOutputWithContext(ctx context.Context) JobTy
 // If the Job has not reached a Ready state after 10 minutes, it will
 // time out and mark the resource update as Failed. You can override the default timeout value
 // by setting the 'customTimeouts' option on the resource.
+//
+// By default, if a resource failed to become ready in a previous update,
+// Pulumi will continue to wait for readiness on the next update. If you would prefer
+// to schedule a replacement for an unready resource on the next update, you can add the
+// "pulumi.com/replaceUnready": "true" annotation to the resource definition.
 type JobTypeOutput struct{ *pulumi.OutputState }
 
 func (JobTypeOutput) ElementType() reflect.Type {

sdk/nodejs/batch/v1/job.ts

@@ -22,6 +22,11 @@ import * as utilities from "../../utilities";
  * If the Job has not reached a Ready state after 10 minutes, it will
  * time out and mark the resource update as Failed. You can override the default timeout value
  * by setting the 'customTimeouts' option on the resource.
+ *
+ * By default, if a resource failed to become ready in a previous update,
+ * Pulumi will continue to wait for readiness on the next update. If you would prefer
+ * to schedule a replacement for an unready resource on the next update, you can add the
+ * "pulumi.com/replaceUnready": "true" annotation to the resource definition.
  */
 export class Job extends pulumi.CustomResource {
     /**

sdk/nodejs/types/input.ts

@@ -4831,6 +4831,11 @@ export namespace batch {
          * If the Job has not reached a Ready state after 10 minutes, it will
          * time out and mark the resource update as Failed. You can override the default timeout value
          * by setting the 'customTimeouts' option on the resource.
+         *
+         * By default, if a resource failed to become ready in a previous update, 
+         * Pulumi will continue to wait for readiness on the next update. If you would prefer
+         * to schedule a replacement for an unready resource on the next update, you can add the
+         * "pulumi.com/replaceUnready": "true" annotation to the resource definition.
          */
         export interface Job {
             /**

sdk/nodejs/types/output.ts

@@ -5091,6 +5091,11 @@ export namespace batch {
          * If the Job has not reached a Ready state after 10 minutes, it will
          * time out and mark the resource update as Failed. You can override the default timeout value
          * by setting the 'customTimeouts' option on the resource.
+         *
+         * By default, if a resource failed to become ready in a previous update, 
+         * Pulumi will continue to wait for readiness on the next update. If you would prefer
+         * to schedule a replacement for an unready resource on the next update, you can add the
+         * "pulumi.com/replaceUnready": "true" annotation to the resource definition.
          */
         export interface Job {
             /**

sdk/python/pulumi_kubernetes/batch/v1/Job.py

@@ -114,6 +114,11 @@ def __init__(__self__,
         time out and mark the resource update as Failed. You can override the default timeout value
         by setting the 'customTimeouts' option on the resource.
 
+        By default, if a resource failed to become ready in a previous update,
+        Pulumi will continue to wait for readiness on the next update. If you would prefer
+        to schedule a replacement for an unready resource on the next update, you can add the
+        "pulumi.com/replaceUnready": "true" annotation to the resource definition.
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] api_version: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
@@ -145,6 +150,11 @@ def __init__(__self__,
         time out and mark the resource update as Failed. You can override the default timeout value
         by setting the 'customTimeouts' option on the resource.
 
+        By default, if a resource failed to become ready in a previous update,
+        Pulumi will continue to wait for readiness on the next update. If you would prefer
+        to schedule a replacement for an unready resource on the next update, you can add the
+        "pulumi.com/replaceUnready": "true" annotation to the resource definition.
+
         :param str resource_name: The name of the resource.
         :param JobArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

sdk/python/pulumi_kubernetes/batch/v1/_inputs.py

@@ -308,6 +308,11 @@ def __init__(__self__, *,
         If the Job has not reached a Ready state after 10 minutes, it will
         time out and mark the resource update as Failed. You can override the default timeout value
         by setting the 'customTimeouts' option on the resource.
+
+        By default, if a resource failed to become ready in a previous update, 
+        Pulumi will continue to wait for readiness on the next update. If you would prefer
+        to schedule a replacement for an unready resource on the next update, you can add the
+        "pulumi.com/replaceUnready": "true" annotation to the resource definition.
         :param pulumi.Input[str] api_version: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
         :param pulumi.Input[str] kind: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
         :param pulumi.Input['_meta.v1.ObjectMetaArgs'] metadata: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata