Kubernetes v4.18.3, Oct 31 24

Kubernetes v4.18.3 published on Thursday, Oct 31, 2024 by Pulumi

kubernetes.core/v1.ServicePatch

Explore with Pulumi AI

Kubernetes v4.18.3 published on Thursday, Oct 31, 2024 by Pulumi

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 for additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi. Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

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:

Service object exists.
Related Endpoint objects are created. Each time we get an update, wait 10 seconds for any stragglers.
There are no “not ready” endpoints – unless the Service is an “empty headless” Service [1], a Service with ‘.spec.type: ExternalName’, or a Service without a selector.
External IP address is allocated (if Service has ‘.spec.type: LoadBalancer’).

If the Service 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.

Create ServicePatch Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServicePatch(name: string, args?: ServicePatch, opts?: CustomResourceOptions);

@overload
def ServicePatch(resource_name: str,
                 args: Optional[ServicePatchArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def ServicePatch(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 metadata: Optional[_meta.v1.ObjectMetaPatchArgs] = None,
                 spec: Optional[ServiceSpecPatchArgs] = None)

func NewServicePatch(ctx *Context, name string, args *ServicePatchArgs, opts ...ResourceOption) (*ServicePatch, error)

public ServicePatch(string name, ServicePatchArgs? args = null, CustomResourceOptions? opts = null)

public ServicePatch(String name, ServicePatchArgs args)
public ServicePatch(String name, ServicePatchArgs args, CustomResourceOptions options)

type: kubernetes:core/v1:ServicePatch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ServicePatch: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ServicePatchArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServicePatchArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServicePatchArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServicePatchArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ServicePatch Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServicePatch resource accepts the following input properties:

Metadata Pulumi.Kubernetes.Meta.V1.Inputs.ObjectMetaPatch: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Spec ServiceSpecPatch: Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Metadata ObjectMetaPatchArgs: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Spec ServiceSpecPatchArgs: Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

metadata ObjectMetaPatch: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec ServiceSpecPatch: Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

metadata meta.v1.ObjectMetaPatch: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec ServiceSpecPatch: Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

metadata meta.v1.ObjectMetaPatchArgs: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec ServiceSpecPatchArgs: Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

metadata Property Map: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec Property Map: Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Outputs

All input properties are implicitly available as output properties. Additionally, the ServicePatch resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Status ServiceStatusPatch: Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Id string: The provider-assigned unique ID for this managed resource.
Status ServiceStatusPatch: Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

id String: The provider-assigned unique ID for this managed resource.
status ServiceStatusPatch: Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

id string: The provider-assigned unique ID for this managed resource.
status ServiceStatusPatch: Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

id str: The provider-assigned unique ID for this managed resource.
status ServiceStatusPatch: Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

id String: The provider-assigned unique ID for this managed resource.
status Property Map: Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Supporting Types

ClientIPConfigPatch, ClientIPConfigPatchArgs

TimeoutSeconds int: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

TimeoutSeconds int: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

timeoutSeconds Integer: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

timeoutSeconds number: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

timeout_seconds int: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

timeoutSeconds Number: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

ConditionPatch, ConditionPatchArgs

LastTransitionTime string: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
Message string: message is a human readable message indicating details about the transition. This may be an empty string.
ObservedGeneration int: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
Reason string: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
Status string: status of the condition, one of True, False, Unknown.
Type string: type of condition in CamelCase or in foo.example.com/CamelCase.

LastTransitionTime string: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
Message string: message is a human readable message indicating details about the transition. This may be an empty string.
ObservedGeneration int: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
Reason string: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
Status string: status of the condition, one of True, False, Unknown.
Type string: type of condition in CamelCase or in foo.example.com/CamelCase.

lastTransitionTime String: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message String: message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration Integer: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason String: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status String: status of the condition, one of True, False, Unknown.
type String: type of condition in CamelCase or in foo.example.com/CamelCase.

lastTransitionTime string: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message string: message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration number: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason string: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status string: status of the condition, one of True, False, Unknown.
type string: type of condition in CamelCase or in foo.example.com/CamelCase.

last_transition_time str: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message str: message is a human readable message indicating details about the transition. This may be an empty string.
observed_generation int: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason str: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status str: status of the condition, one of True, False, Unknown.
type str: type of condition in CamelCase or in foo.example.com/CamelCase.

lastTransitionTime String: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message String: message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration Number: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason String: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status String: status of the condition, one of True, False, Unknown.
type String: type of condition in CamelCase or in foo.example.com/CamelCase.

LoadBalancerIngressPatch, LoadBalancerIngressPatchArgs

Hostname string: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
Ip string: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
IpMode string: IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
Ports List<PortStatusPatch>: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

Hostname string: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
Ip string: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
IpMode string: IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
Ports []PortStatusPatch: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

hostname String: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip String: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
ipMode String: IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
ports List<PortStatusPatch>: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

hostname string: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip string: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
ipMode string: IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
ports PortStatusPatch[]: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

hostname str: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip str: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
ip_mode str: IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
ports Sequence[PortStatusPatch]: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

hostname String: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip String: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
ipMode String: IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
ports List<Property Map>: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

LoadBalancerStatusPatch, LoadBalancerStatusPatchArgs

Ingress List<LoadBalancerIngressPatch>: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

Ingress []LoadBalancerIngressPatch: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

ingress List<LoadBalancerIngressPatch>: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

ingress LoadBalancerIngressPatch[]: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

ingress Sequence[LoadBalancerIngressPatch]: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

ingress List<Property Map>: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

ManagedFieldsEntryPatch, ManagedFieldsEntryPatchArgs

ApiVersion string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 System.Text.Json.JsonElement: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager string: Manager is an identifier of the workflow managing these fields.
Operation string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time string: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

ApiVersion string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 interface{}: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager string: Manager is an identifier of the workflow managing these fields.
Operation string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time string: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

apiVersion String: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType String: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1 JsonElement: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager String: Manager is an identifier of the workflow managing these fields.
operation String: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource String: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time String: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

apiVersion string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1 any: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager string: Manager is an identifier of the workflow managing these fields.
operation string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time string: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

api_version str: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fields_type str: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fields_v1 Any: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager str: Manager is an identifier of the workflow managing these fields.
operation str: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource str: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time str: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

apiVersion String: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType String: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1 JSON: FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager String: Manager is an identifier of the workflow managing these fields.
operation String: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource String: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time String: Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

ObjectMetaPatch, ObjectMetaPatchArgs

Annotations Dictionary<string, string>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ClusterName string

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

CreationTimestamp string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

DeletionGracePeriodSeconds int

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

DeletionTimestamp string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Finalizers List<string>

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

GenerateName string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Generation int

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Labels Dictionary<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

ManagedFields List<Pulumi.Kubernetes.Meta.V1.Inputs.ManagedFieldsEntryPatch>

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

Name string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Namespace string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

OwnerReferences List<Pulumi.Kubernetes.Meta.V1.Inputs.OwnerReferencePatch>

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

ResourceVersion string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

SelfLink string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Annotations map[string]string

ClusterName string

CreationTimestamp string

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

DeletionGracePeriodSeconds int

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

DeletionTimestamp string

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Finalizers []string

GenerateName string

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Generation int

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Labels map[string]string

ManagedFields ManagedFieldsEntryPatch

Name string

Namespace string

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

OwnerReferences OwnerReferencePatch

ResourceVersion string

SelfLink string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations Map<String,String>

clusterName String

creationTimestamp String

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds Integer

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp String

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers List<String>

generateName String

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation Integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels Map<String,String>

managedFields List<ManagedFieldsEntryPatch>

name String

namespace String

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences List<OwnerReferencePatch>

resourceVersion String

selfLink String

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations {[key: string]: string}

clusterName string

creationTimestamp string

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds number

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp string

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers string[]

generateName string

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation number

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels {[key: string]: string}

managedFields meta.v1.ManagedFieldsEntryPatch[]

name string

namespace string

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences meta.v1.OwnerReferencePatch[]

resourceVersion string

selfLink string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations Mapping[str, str]

cluster_name str

creation_timestamp str

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletion_grace_period_seconds int

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletion_timestamp str

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers Sequence[str]

generate_name str

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation int

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels Mapping[str, str]

managed_fields Sequence[meta.v1.ManagedFieldsEntryPatch]

name str

namespace str

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

owner_references Sequence[meta.v1.OwnerReferencePatch]

resource_version str

self_link str

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid str

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

annotations Map<String>

clusterName String

creationTimestamp String

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds Number

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp String

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers List<String>

generateName String

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation Number

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels Map<String>

managedFields List<Property Map>

name String

namespace String

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences List<Property Map>

resourceVersion String

selfLink String

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

OwnerReferencePatch, OwnerReferencePatchArgs

ApiVersion string: API version of the referent.
BlockOwnerDeletion bool: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
Controller bool: If true, this reference points to the managing controller.
Kind string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Uid string: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

ApiVersion string: API version of the referent.
BlockOwnerDeletion bool: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
Controller bool: If true, this reference points to the managing controller.
Kind string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Uid string: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

apiVersion String: API version of the referent.
blockOwnerDeletion Boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller Boolean: If true, this reference points to the managing controller.
kind String: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name String: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid String: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

apiVersion string: API version of the referent.
blockOwnerDeletion boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller boolean: If true, this reference points to the managing controller.
kind string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid string: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

api_version str: API version of the referent.
block_owner_deletion bool: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller bool: If true, this reference points to the managing controller.
kind str: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name str: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid str: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

apiVersion String: API version of the referent.
blockOwnerDeletion Boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller Boolean: If true, this reference points to the managing controller.
kind String: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name String: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid String: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

PortStatusPatch, PortStatusPatchArgs

Error string

Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

Port int

Port is the port number of the service port of which status is recorded here

Protocol string

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

Error string

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

Port int

Port is the port number of the service port of which status is recorded here

Protocol string

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

error String

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

port Integer

Port is the port number of the service port of which status is recorded here

protocol String

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

error string

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

port number

Port is the port number of the service port of which status is recorded here

protocol string

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

error str

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

port int

Port is the port number of the service port of which status is recorded here

protocol str

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

error String

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

port Number

Port is the port number of the service port of which status is recorded here

protocol String

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

ServicePortPatch, ServicePortPatchArgs

AppProtocol string

The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:

Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Kubernetes-defined prefixed names:
- 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
- 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
- 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

Name string

The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.

NodePort int

The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

Port int

The port that will be exposed by this service.

Protocol string

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

TargetPort int | string

Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service

AppProtocol string

Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Kubernetes-defined prefixed names:
- 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
- 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
- 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

Name string

NodePort int

Port int

The port that will be exposed by this service.

Protocol string

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

TargetPort int | string

appProtocol String

Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Kubernetes-defined prefixed names:
- 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
- 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
- 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

name String

nodePort Integer

port Integer

The port that will be exposed by this service.

protocol String

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

targetPort Integer | String

appProtocol string

Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Kubernetes-defined prefixed names:
- 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
- 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
- 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

name string

nodePort number

port number

The port that will be exposed by this service.

protocol string

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

targetPort number | string

app_protocol str

Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Kubernetes-defined prefixed names:
- 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
- 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
- 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

name str

node_port int

port int

The port that will be exposed by this service.

protocol str

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

target_port int | str

appProtocol String

Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
Kubernetes-defined prefixed names:
- 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
- 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
- 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.

name String

nodePort Number

port Number

The port that will be exposed by this service.

protocol String

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

targetPort Number | String

ServiceSpecPatch, ServiceSpecPatchArgs

AllocateLoadBalancerNodePorts bool

allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.

ClusterIP string

clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

ClusterIPs List<string>

ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value.

This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

ExternalIPs List<string>

externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.

ExternalName string

externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires type to be "ExternalName".

ExternalTrafficPolicy string

externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.

HealthCheckNodePort int

healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set.

InternalTrafficPolicy string

InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features).

IpFamilies List<string>

IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName.

This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.

IpFamily string

ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster's primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment.

IpFamilyPolicy string

IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName.

LoadBalancerClass string

loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.

LoadBalancerIP string

Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available.

LoadBalancerSourceRanges List<string>

If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/

Ports List<ServicePortPatch>

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

PublishNotReadyAddresses bool

publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior.

Selector Dictionary<string, string>

Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/

SessionAffinity string

Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

SessionAffinityConfig SessionAffinityConfigPatch

sessionAffinityConfig contains the configurations of session affinity.

TopologyKeys List<string>

topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied.

TrafficDistribution string

TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to "PreferClose", implementations should prioritize endpoints that are topologically close (e.g., same zone). This is an alpha field and requires enabling ServiceTrafficDistribution feature.

Type string | Pulumi.Kubernetes.Core.V1.ServiceSpecType

type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

AllocateLoadBalancerNodePorts bool

ClusterIP string

ClusterIPs []string

ExternalIPs []string

ExternalName string

ExternalTrafficPolicy string

HealthCheckNodePort int

InternalTrafficPolicy string

IpFamilies []string

IpFamily string

IpFamilyPolicy string

LoadBalancerClass string

LoadBalancerIP string

LoadBalancerSourceRanges []string

Ports []ServicePortPatch

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

PublishNotReadyAddresses bool

Selector map[string]string

SessionAffinity string

SessionAffinityConfig SessionAffinityConfigPatch

sessionAffinityConfig contains the configurations of session affinity.

TopologyKeys []string

TrafficDistribution string

Type string | ServiceSpecType

allocateLoadBalancerNodePorts Boolean

clusterIP String

clusterIPs List<String>

externalIPs List<String>

externalName String

externalTrafficPolicy String

healthCheckNodePort Integer

internalTrafficPolicy String

ipFamilies List<String>

ipFamily String

ipFamilyPolicy String

loadBalancerClass String

loadBalancerIP String

loadBalancerSourceRanges List<String>

ports List<ServicePortPatch>

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

publishNotReadyAddresses Boolean

selector Map<String,String>

sessionAffinity String

sessionAffinityConfig SessionAffinityConfigPatch

sessionAffinityConfig contains the configurations of session affinity.

topologyKeys List<String>

trafficDistribution String

type String | ServiceSpecType

allocateLoadBalancerNodePorts boolean

clusterIP string

clusterIPs string[]

externalIPs string[]

externalName string

externalTrafficPolicy string

healthCheckNodePort number

internalTrafficPolicy string

ipFamilies string[]

ipFamily string

ipFamilyPolicy string

loadBalancerClass string

loadBalancerIP string

loadBalancerSourceRanges string[]

ports ServicePortPatch[]

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

publishNotReadyAddresses boolean

selector {[key: string]: string}

sessionAffinity string

sessionAffinityConfig SessionAffinityConfigPatch

sessionAffinityConfig contains the configurations of session affinity.

topologyKeys string[]

trafficDistribution string

type string | ServiceSpecType

allocate_load_balancer_node_ports bool

cluster_ip str

cluster_ips Sequence[str]

external_ips Sequence[str]

external_name str

external_traffic_policy str

health_check_node_port int

internal_traffic_policy str

ip_families Sequence[str]

ip_family str

ip_family_policy str

load_balancer_class str

load_balancer_ip str

load_balancer_source_ranges Sequence[str]

ports Sequence[ServicePortPatch]

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

publish_not_ready_addresses bool

selector Mapping[str, str]

session_affinity str

session_affinity_config SessionAffinityConfigPatch

sessionAffinityConfig contains the configurations of session affinity.

topology_keys Sequence[str]

traffic_distribution str

type str | ServiceSpecType

allocateLoadBalancerNodePorts Boolean

clusterIP String

clusterIPs List<String>

externalIPs List<String>

externalName String

externalTrafficPolicy String

healthCheckNodePort Number

internalTrafficPolicy String

ipFamilies List<String>

ipFamily String

ipFamilyPolicy String

loadBalancerClass String

loadBalancerIP String

loadBalancerSourceRanges List<String>

ports List<Property Map>

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

publishNotReadyAddresses Boolean

selector Map<String>

sessionAffinity String

sessionAffinityConfig Property Map

sessionAffinityConfig contains the configurations of session affinity.

topologyKeys List<String>

trafficDistribution String

type String | "ExternalName" | "ClusterIP" | "NodePort" | "LoadBalancer"

ServiceSpecType, ServiceSpecTypeArgs

ExternalName: ExternalName
ClusterIP: ClusterIP
NodePort: NodePort
LoadBalancer: LoadBalancer

ServiceSpecTypeExternalName: ExternalName
ServiceSpecTypeClusterIP: ClusterIP
ServiceSpecTypeNodePort: NodePort
ServiceSpecTypeLoadBalancer: LoadBalancer

ExternalName: ExternalName
ClusterIP: ClusterIP
NodePort: NodePort
LoadBalancer: LoadBalancer

ExternalName: ExternalName
ClusterIP: ClusterIP
NodePort: NodePort
LoadBalancer: LoadBalancer

EXTERNAL_NAME: ExternalName
CLUSTER_IP: ClusterIP
NODE_PORT: NodePort
LOAD_BALANCER: LoadBalancer

"ExternalName": ExternalName
"ClusterIP": ClusterIP
"NodePort": NodePort
"LoadBalancer": LoadBalancer

ServiceStatusPatch, ServiceStatusPatchArgs

Conditions List<Pulumi.Kubernetes.Meta.V1.Inputs.ConditionPatch>: Current service state
LoadBalancer LoadBalancerStatusPatch: LoadBalancer contains the current status of the load-balancer, if one is present.

Conditions ConditionPatch: Current service state
LoadBalancer LoadBalancerStatusPatch: LoadBalancer contains the current status of the load-balancer, if one is present.

conditions List<ConditionPatch>: Current service state
loadBalancer LoadBalancerStatusPatch: LoadBalancer contains the current status of the load-balancer, if one is present.

conditions meta.v1.ConditionPatch[]: Current service state
loadBalancer LoadBalancerStatusPatch: LoadBalancer contains the current status of the load-balancer, if one is present.

conditions Sequence[meta.v1.ConditionPatch]: Current service state
load_balancer LoadBalancerStatusPatch: LoadBalancer contains the current status of the load-balancer, if one is present.

conditions List<Property Map>: Current service state
loadBalancer Property Map: LoadBalancer contains the current status of the load-balancer, if one is present.

SessionAffinityConfigPatch, SessionAffinityConfigPatchArgs

ClientIP ClientIPConfigPatch: clientIP contains the configurations of Client IP based session affinity.

ClientIP ClientIPConfigPatch: clientIP contains the configurations of Client IP based session affinity.

clientIP ClientIPConfigPatch: clientIP contains the configurations of Client IP based session affinity.

clientIP ClientIPConfigPatch: clientIP contains the configurations of Client IP based session affinity.

client_ip ClientIPConfigPatch: clientIP contains the configurations of Client IP based session affinity.

clientIP Property Map: clientIP contains the configurations of Client IP based session affinity.

Package Details

Repository: Kubernetes pulumi/pulumi-kubernetes
License: Apache-2.0

Kubernetes v4.18.3 published on Thursday, Oct 31, 2024 by Pulumi

pulumi/pulumi-kubernetes

kubernetes.core/v1.ServicePatch

On this page

On this page

Create ServicePatch Resource

Constructor syntax

Parameters

ServicePatch Resource Properties

Inputs

Outputs

Supporting Types

ClientIPConfigPatch, ClientIPConfigPatchArgs

ConditionPatch, ConditionPatchArgs

LoadBalancerIngressPatch, LoadBalancerIngressPatchArgs

LoadBalancerStatusPatch, LoadBalancerStatusPatchArgs

ManagedFieldsEntryPatch, ManagedFieldsEntryPatchArgs

ObjectMetaPatch, ObjectMetaPatchArgs

OwnerReferencePatch, OwnerReferencePatchArgs

PortStatusPatch, PortStatusPatchArgs

ServicePortPatch, ServicePortPatchArgs

ServiceSpecPatch, ServiceSpecPatchArgs

ServiceSpecType, ServiceSpecTypeArgs

ServiceStatusPatch, ServiceStatusPatchArgs

SessionAffinityConfigPatch, SessionAffinityConfigPatchArgs

Package Details

On this page

On this page