@pulumi/kubernetes
Version:
[](https://github.com/pulumi/pulumi-kubernetes/actions) [](https://slack.pulumi.com) [ • 6.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* Patch resources are used to modify existing Kubernetes resources by using
* Server-Side Apply updates. The name of the resource must be specified, but all other properties are optional. More than
* one patch may be applied to the same resource, and a random FieldManager name will be used for each Patch resource.
* Conflicts will result in an error by default, but can be forced using the "pulumi.com/patchForce" annotation. See the
* [Server-Side Apply Docs](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/managing-resources-with-server-side-apply/) for
* additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi.
* Deployment enables declarative updates for Pods and ReplicaSets.
*
* This resource waits until its status is ready before registering success
* for create/update, and populating output properties from the current state of the resource.
* The following conditions are used to determine whether the resource creation has
* succeeded or failed:
*
* 1. The Deployment has begun to be updated by the Deployment controller. If the current
* generation of the Deployment is > 1, then this means that the current generation must
* be different from the generation reported by the last outputs.
* 2. There exists a ReplicaSet whose revision is equal to the current revision of the
* Deployment.
* 3. The Deployment's '.status.conditions' has a status of type 'Available' whose 'status'
* member is set to 'True'.
* 4. If the Deployment has generation > 1, then '.status.conditions' has a status of type
* 'Progressing', whose 'status' member is set to 'True', and whose 'reason' is
* 'NewReplicaSetAvailable'. For generation <= 1, this status field does not exist,
* because it doesn't do a rollout (i.e., it simply creates the Deployment and
* corresponding ReplicaSet), and therefore there is no rollout to mark as 'Progressing'.
*
* If the Deployment 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.
*/
export declare class DeploymentPatch extends pulumi.CustomResource {
/**
* Get an existing DeploymentPatch resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): DeploymentPatch;
/**
* Returns true if the given object is an instance of DeploymentPatch. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DeploymentPatch;
/**
* 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
*/
readonly apiVersion: pulumi.Output<"apps/v1">;
/**
* 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
*/
readonly kind: pulumi.Output<"Deployment">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
readonly metadata: pulumi.Output<outputs.meta.v1.ObjectMetaPatch>;
/**
* Specification of the desired behavior of the Deployment.
*/
readonly spec: pulumi.Output<outputs.apps.v1.DeploymentSpecPatch>;
/**
* Most recently observed status of the Deployment.
*/
readonly status: pulumi.Output<outputs.apps.v1.DeploymentStatusPatch>;
/**
* Create a DeploymentPatch resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: DeploymentPatchArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a DeploymentPatch resource.
*/
export interface DeploymentPatchArgs {
/**
* 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.Input<"apps/v1">;
/**
* 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
*/
kind?: pulumi.Input<"Deployment">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
metadata?: pulumi.Input<inputs.meta.v1.ObjectMetaPatch>;
/**
* Specification of the desired behavior of the Deployment.
*/
spec?: pulumi.Input<inputs.apps.v1.DeploymentSpecPatch>;
}