kubernetes.autoscaling/v2.HorizontalPodAutoscalerPatch
Explore with Pulumi AI
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. HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
Create HorizontalPodAutoscalerPatch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HorizontalPodAutoscalerPatch(name: string, args?: HorizontalPodAutoscalerPatch, opts?: CustomResourceOptions);
@overload
def HorizontalPodAutoscalerPatch(resource_name: str,
args: Optional[HorizontalPodAutoscalerPatchArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def HorizontalPodAutoscalerPatch(resource_name: str,
opts: Optional[ResourceOptions] = None,
metadata: Optional[_meta.v1.ObjectMetaPatchArgs] = None,
spec: Optional[HorizontalPodAutoscalerSpecPatchArgs] = None)
func NewHorizontalPodAutoscalerPatch(ctx *Context, name string, args *HorizontalPodAutoscalerPatchArgs, opts ...ResourceOption) (*HorizontalPodAutoscalerPatch, error)
public HorizontalPodAutoscalerPatch(string name, HorizontalPodAutoscalerPatchArgs? args = null, CustomResourceOptions? opts = null)
public HorizontalPodAutoscalerPatch(String name, HorizontalPodAutoscalerPatchArgs args)
public HorizontalPodAutoscalerPatch(String name, HorizontalPodAutoscalerPatchArgs args, CustomResourceOptions options)
type: kubernetes:autoscaling/v2:HorizontalPodAutoscalerPatch
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 HorizontalPodAutoscalerPatch
- 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 HorizontalPodAutoscalerPatchArgs
- 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 HorizontalPodAutoscalerPatchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HorizontalPodAutoscalerPatchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HorizontalPodAutoscalerPatchArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
HorizontalPodAutoscalerPatch 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 HorizontalPodAutoscalerPatch resource accepts the following input properties:
- Metadata
Pulumi.
Kubernetes. Meta. V1. Inputs. Object Meta Patch - metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Spec
Horizontal
Pod Autoscaler Spec Patch - spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- Metadata
Object
Meta Patch Args - metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- Spec
Horizontal
Pod Autoscaler Spec Patch Args - spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- metadata
Object
Meta Patch - metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Horizontal
Pod Autoscaler Spec Patch - spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- metadata
meta.v1.
Object Meta Patch - metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Horizontal
Pod Autoscaler Spec Patch - spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- metadata
meta.v1.
Object Meta Patch Args - metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Horizontal
Pod Autoscaler Spec Patch Args - spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- metadata Property Map
- metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec Property Map
- spec is the specification for the behaviour of the autoscaler. More info: 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 HorizontalPodAutoscalerPatch resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Horizontal
Pod Autoscaler Status Patch - status is the current information about the autoscaler.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Horizontal
Pod Autoscaler Status Patch - status is the current information about the autoscaler.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Horizontal
Pod Autoscaler Status Patch - status is the current information about the autoscaler.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Horizontal
Pod Autoscaler Status Patch - status is the current information about the autoscaler.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Horizontal
Pod Autoscaler Status Patch - status is the current information about the autoscaler.
- id String
- The provider-assigned unique ID for this managed resource.
- status Property Map
- status is the current information about the autoscaler.
Supporting Types
ContainerResourceMetricSourcePatch, ContainerResourceMetricSourcePatchArgs
- Container string
- container is the name of the container in the pods of the scaling target
- Name string
- name is the name of the resource in question.
- Target
Metric
Target Patch - target specifies the target value for the given metric
- Container string
- container is the name of the container in the pods of the scaling target
- Name string
- name is the name of the resource in question.
- Target
Metric
Target Patch - target specifies the target value for the given metric
- container String
- container is the name of the container in the pods of the scaling target
- name String
- name is the name of the resource in question.
- target
Metric
Target Patch - target specifies the target value for the given metric
- container string
- container is the name of the container in the pods of the scaling target
- name string
- name is the name of the resource in question.
- target
Metric
Target Patch - target specifies the target value for the given metric
- container str
- container is the name of the container in the pods of the scaling target
- name str
- name is the name of the resource in question.
- target
Metric
Target Patch - target specifies the target value for the given metric
- container String
- container is the name of the container in the pods of the scaling target
- name String
- name is the name of the resource in question.
- target Property Map
- target specifies the target value for the given metric
ContainerResourceMetricStatusPatch, ContainerResourceMetricStatusPatchArgs
- Container string
- container is the name of the container in the pods of the scaling target
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Name string
- name is the name of the resource in question.
- Container string
- container is the name of the container in the pods of the scaling target
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Name string
- name is the name of the resource in question.
- container String
- container is the name of the container in the pods of the scaling target
- current
Metric
Value Status Patch - current contains the current value for the given metric
- name String
- name is the name of the resource in question.
- container string
- container is the name of the container in the pods of the scaling target
- current
Metric
Value Status Patch - current contains the current value for the given metric
- name string
- name is the name of the resource in question.
- container str
- container is the name of the container in the pods of the scaling target
- current
Metric
Value Status Patch - current contains the current value for the given metric
- name str
- name is the name of the resource in question.
- container String
- container is the name of the container in the pods of the scaling target
- current Property Map
- current contains the current value for the given metric
- name String
- name is the name of the resource in question.
CrossVersionObjectReferencePatch, CrossVersionObjectReferencePatchArgs
- Api
Version string - apiVersion is the API version of the referent
- Kind string
- kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Name string
- name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- Api
Version string - apiVersion is the API version of the referent
- Kind string
- kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Name string
- name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- api
Version String - apiVersion is the API version of the referent
- kind String
- kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name String
- name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- api
Version string - apiVersion is the API version of the referent
- kind string
- kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name string
- name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- api_
version str - apiVersion is the API version of the referent
- kind str
- kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name str
- name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- api
Version String - apiVersion is the API version of the referent
- kind String
- kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name String
- name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
ExternalMetricSourcePatch, ExternalMetricSourcePatchArgs
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Target
Metric
Target Patch - target specifies the target value for the given metric
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Target
Metric
Target Patch - target specifies the target value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- metric Property Map
- metric identifies the target metric by name and selector
- target Property Map
- target specifies the target value for the given metric
ExternalMetricStatusPatch, ExternalMetricStatusPatchArgs
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current Property Map
- current contains the current value for the given metric
- metric Property Map
- metric identifies the target metric by name and selector
HPAScalingPolicyPatch, HPAScalingPolicyPatchArgs
- Period
Seconds int - periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- Type string
- type is used to specify the scaling policy.
- Value int
- value contains the amount of change which is permitted by the policy. It must be greater than zero
- Period
Seconds int - periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- Type string
- type is used to specify the scaling policy.
- Value int
- value contains the amount of change which is permitted by the policy. It must be greater than zero
- period
Seconds Integer - periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- type String
- type is used to specify the scaling policy.
- value Integer
- value contains the amount of change which is permitted by the policy. It must be greater than zero
- period
Seconds number - periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- type string
- type is used to specify the scaling policy.
- value number
- value contains the amount of change which is permitted by the policy. It must be greater than zero
- period_
seconds int - periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- type str
- type is used to specify the scaling policy.
- value int
- value contains the amount of change which is permitted by the policy. It must be greater than zero
- period
Seconds Number - periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- type String
- type is used to specify the scaling policy.
- value Number
- value contains the amount of change which is permitted by the policy. It must be greater than zero
HPAScalingRulesPatch, HPAScalingRulesPatchArgs
- Policies
List<HPAScaling
Policy Patch> - policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- Select
Policy string - selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- Stabilization
Window intSeconds - stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- Policies
[]HPAScaling
Policy Patch - policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- Select
Policy string - selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- Stabilization
Window intSeconds - stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- policies
List<HPAScaling
Policy Patch> - policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- select
Policy String - selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- stabilization
Window IntegerSeconds - stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- policies
HPAScaling
Policy Patch[] - policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- select
Policy string - selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- stabilization
Window numberSeconds - stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- policies
Sequence[HPAScaling
Policy Patch] - policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- select_
policy str - selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- stabilization_
window_ intseconds - stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- policies List<Property Map>
- policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- select
Policy String - selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
- stabilization
Window NumberSeconds - stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
HorizontalPodAutoscalerBehaviorPatch, HorizontalPodAutoscalerBehaviorPatchArgs
- Scale
Down HPAScalingRules Patch - scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
- Scale
Up HPAScalingRules Patch - scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
- increase no more than 4 pods per 60 seconds
- double the number of pods per 60 seconds No stabilization is used.
- Scale
Down HPAScalingRules Patch - scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
- Scale
Up HPAScalingRules Patch - scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
- increase no more than 4 pods per 60 seconds
- double the number of pods per 60 seconds No stabilization is used.
- scale
Down HPAScalingRules Patch - scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
- scale
Up HPAScalingRules Patch - scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
- increase no more than 4 pods per 60 seconds
- double the number of pods per 60 seconds No stabilization is used.
- scale
Down HPAScalingRules Patch - scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
- scale
Up HPAScalingRules Patch - scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
- increase no more than 4 pods per 60 seconds
- double the number of pods per 60 seconds No stabilization is used.
- scale_
down HPAScalingRules Patch - scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
- scale_
up HPAScalingRules Patch - scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
- increase no more than 4 pods per 60 seconds
- double the number of pods per 60 seconds No stabilization is used.
- scale
Down Property Map - scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
- scale
Up Property Map - scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:
- increase no more than 4 pods per 60 seconds
- double the number of pods per 60 seconds No stabilization is used.
HorizontalPodAutoscalerConditionPatch, HorizontalPodAutoscalerConditionPatchArgs
- Last
Transition stringTime - lastTransitionTime is the last time the condition transitioned from one status to another
- Message string
- message is a human-readable explanation containing details about the transition
- Reason string
- reason is the reason for the condition's last transition.
- Status string
- status is the status of the condition (True, False, Unknown)
- Type string
- type describes the current condition
- Last
Transition stringTime - lastTransitionTime is the last time the condition transitioned from one status to another
- Message string
- message is a human-readable explanation containing details about the transition
- Reason string
- reason is the reason for the condition's last transition.
- Status string
- status is the status of the condition (True, False, Unknown)
- Type string
- type describes the current condition
- last
Transition StringTime - lastTransitionTime is the last time the condition transitioned from one status to another
- message String
- message is a human-readable explanation containing details about the transition
- reason String
- reason is the reason for the condition's last transition.
- status String
- status is the status of the condition (True, False, Unknown)
- type String
- type describes the current condition
- last
Transition stringTime - lastTransitionTime is the last time the condition transitioned from one status to another
- message string
- message is a human-readable explanation containing details about the transition
- reason string
- reason is the reason for the condition's last transition.
- status string
- status is the status of the condition (True, False, Unknown)
- type string
- type describes the current condition
- last_
transition_ strtime - lastTransitionTime is the last time the condition transitioned from one status to another
- message str
- message is a human-readable explanation containing details about the transition
- reason str
- reason is the reason for the condition's last transition.
- status str
- status is the status of the condition (True, False, Unknown)
- type str
- type describes the current condition
- last
Transition StringTime - lastTransitionTime is the last time the condition transitioned from one status to another
- message String
- message is a human-readable explanation containing details about the transition
- reason String
- reason is the reason for the condition's last transition.
- status String
- status is the status of the condition (True, False, Unknown)
- type String
- type describes the current condition
HorizontalPodAutoscalerSpecPatch, HorizontalPodAutoscalerSpecPatchArgs
- Behavior
Horizontal
Pod Autoscaler Behavior Patch - behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
- Max
Replicas int - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- Metrics
List<Metric
Spec Patch> - metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
- Min
Replicas int - minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- Scale
Target CrossRef Version Object Reference Patch - scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
- Behavior
Horizontal
Pod Autoscaler Behavior Patch - behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
- Max
Replicas int - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- Metrics
[]Metric
Spec Patch - metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
- Min
Replicas int - minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- Scale
Target CrossRef Version Object Reference Patch - scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
- behavior
Horizontal
Pod Autoscaler Behavior Patch - behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
- max
Replicas Integer - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- metrics
List<Metric
Spec Patch> - metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
- min
Replicas Integer - minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- scale
Target CrossRef Version Object Reference Patch - scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
- behavior
Horizontal
Pod Autoscaler Behavior Patch - behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
- max
Replicas number - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- metrics
Metric
Spec Patch[] - metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
- min
Replicas number - minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- scale
Target CrossRef Version Object Reference Patch - scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
- behavior
Horizontal
Pod Autoscaler Behavior Patch - behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
- max_
replicas int - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- metrics
Sequence[Metric
Spec Patch] - metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
- min_
replicas int - minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- scale_
target_ Crossref Version Object Reference Patch - scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
- behavior Property Map
- behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
- max
Replicas Number - maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
- metrics List<Property Map>
- metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
- min
Replicas Number - minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
- scale
Target Property MapRef - scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
HorizontalPodAutoscalerStatusPatch, HorizontalPodAutoscalerStatusPatchArgs
- Conditions
List<Horizontal
Pod Autoscaler Condition Patch> - conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
- Current
Metrics List<MetricStatus Patch> - currentMetrics is the last read state of the metrics used by this autoscaler.
- Current
Replicas int - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- Desired
Replicas int - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- Last
Scale stringTime - lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
- Observed
Generation int - observedGeneration is the most recent generation observed by this autoscaler.
- Conditions
[]Horizontal
Pod Autoscaler Condition Patch - conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
- Current
Metrics []MetricStatus Patch - currentMetrics is the last read state of the metrics used by this autoscaler.
- Current
Replicas int - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- Desired
Replicas int - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- Last
Scale stringTime - lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
- Observed
Generation int - observedGeneration is the most recent generation observed by this autoscaler.
- conditions
List<Horizontal
Pod Autoscaler Condition Patch> - conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
- current
Metrics List<MetricStatus Patch> - currentMetrics is the last read state of the metrics used by this autoscaler.
- current
Replicas Integer - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- desired
Replicas Integer - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- last
Scale StringTime - lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
- observed
Generation Integer - observedGeneration is the most recent generation observed by this autoscaler.
- conditions
Horizontal
Pod Autoscaler Condition Patch[] - conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
- current
Metrics MetricStatus Patch[] - currentMetrics is the last read state of the metrics used by this autoscaler.
- current
Replicas number - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- desired
Replicas number - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- last
Scale stringTime - lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
- observed
Generation number - observedGeneration is the most recent generation observed by this autoscaler.
- conditions
Sequence[Horizontal
Pod Autoscaler Condition Patch] - conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
- current_
metrics Sequence[MetricStatus Patch] - currentMetrics is the last read state of the metrics used by this autoscaler.
- current_
replicas int - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- desired_
replicas int - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- last_
scale_ strtime - lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
- observed_
generation int - observedGeneration is the most recent generation observed by this autoscaler.
- conditions List<Property Map>
- conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
- current
Metrics List<Property Map> - currentMetrics is the last read state of the metrics used by this autoscaler.
- current
Replicas Number - currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
- desired
Replicas Number - desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
- last
Scale StringTime - lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
- observed
Generation Number - observedGeneration is the most recent generation observed by this autoscaler.
LabelSelectorPatch, LabelSelectorPatchArgs
- Match
Expressions List<Pulumi.Kubernetes. Meta. V1. Inputs. Label Selector Requirement Patch> - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Match
Labels Dictionary<string, string> - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- Match
Expressions LabelSelector Requirement Patch - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Match
Labels map[string]string - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- match
Expressions List<LabelSelector Requirement Patch> - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels Map<String,String> - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- match
Expressions meta.v1.Label Selector Requirement Patch[] - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels {[key: string]: string} - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- match_
expressions Sequence[meta.v1.Label Selector Requirement Patch] - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- match_
labels Mapping[str, str] - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
- match
Expressions List<Property Map> - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels Map<String> - matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
LabelSelectorRequirementPatch, LabelSelectorRequirementPatchArgs
- Key string
- key is the label key that the selector applies to.
- Operator string
- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- Values List<string>
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- Key string
- key is the label key that the selector applies to.
- Operator string
- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- Values []string
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- key String
- key is the label key that the selector applies to.
- operator String
- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- values List<String>
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- key string
- key is the label key that the selector applies to.
- operator string
- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- values string[]
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- key str
- key is the label key that the selector applies to.
- operator str
- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- values Sequence[str]
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
- key String
- key is the label key that the selector applies to.
- operator String
- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- values List<String>
- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
ManagedFieldsEntryPatch, ManagedFieldsEntryPatchArgs
- Api
Version 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.
- Fields
Type string - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
- Fields
V1 System.Text. Json. Json Element - 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 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.
- Fields
Type string - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
- Fields
V1 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.
- api
Version 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.
- fields
Type String - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
- fields
V1 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.
- api
Version 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.
- fields
Type string - 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 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.
- api
Version 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.
- fields
Type String - FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
- fields
V1 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.
MetricIdentifierPatch, MetricIdentifierPatchArgs
- Name string
- name is the name of the given metric
- Selector
Pulumi.
Kubernetes. Meta. V1. Inputs. Label Selector Patch - selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- Name string
- name is the name of the given metric
- Selector
Label
Selector Patch - selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- name String
- name is the name of the given metric
- selector
Label
Selector Patch - selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- name string
- name is the name of the given metric
- selector
meta.v1.
Label Selector Patch - selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- name str
- name is the name of the given metric
- selector
meta.v1.
Label Selector Patch - selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- name String
- name is the name of the given metric
- selector Property Map
- selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
MetricSpecPatch, MetricSpecPatchArgs
- Container
Resource ContainerResource Metric Source Patch - containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
- External
External
Metric Source Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- Object
Object
Metric Source Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- Pods
Pods
Metric Source Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- Resource
Resource
Metric Source Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- Type string
- type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- Container
Resource ContainerResource Metric Source Patch - containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
- External
External
Metric Source Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- Object
Object
Metric Source Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- Pods
Pods
Metric Source Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- Resource
Resource
Metric Source Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- Type string
- type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container
Resource ContainerResource Metric Source Patch - containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
- external
External
Metric Source Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object
Object
Metric Source Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods
Pods
Metric Source Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource
Resource
Metric Source Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type String
- type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container
Resource ContainerResource Metric Source Patch - containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
- external
External
Metric Source Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object
Object
Metric Source Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods
Pods
Metric Source Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource
Resource
Metric Source Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type string
- type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container_
resource ContainerResource Metric Source Patch - containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
- external
External
Metric Source Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object
Object
Metric Source Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods
Pods
Metric Source Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource
Resource
Metric Source Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type str
- type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container
Resource Property Map - containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
- external Property Map
- external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object Property Map
- object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods Property Map
- pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource Property Map
- resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type String
- type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
MetricStatusPatch, MetricStatusPatchArgs
- Container
Resource ContainerResource Metric Status Patch - container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- External
External
Metric Status Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- Object
Object
Metric Status Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- Pods
Pods
Metric Status Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- Resource
Resource
Metric Status Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- Type string
- type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- Container
Resource ContainerResource Metric Status Patch - container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- External
External
Metric Status Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- Object
Object
Metric Status Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- Pods
Pods
Metric Status Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- Resource
Resource
Metric Status Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- Type string
- type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container
Resource ContainerResource Metric Status Patch - container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- external
External
Metric Status Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object
Object
Metric Status Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods
Pods
Metric Status Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource
Resource
Metric Status Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type String
- type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container
Resource ContainerResource Metric Status Patch - container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- external
External
Metric Status Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object
Object
Metric Status Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods
Pods
Metric Status Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource
Resource
Metric Status Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type string
- type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container_
resource ContainerResource Metric Status Patch - container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- external
External
Metric Status Patch - external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object
Object
Metric Status Patch - object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods
Pods
Metric Status Patch - pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource
Resource
Metric Status Patch - resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type str
- type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
- container
Resource Property Map - container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- external Property Map
- external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
- object Property Map
- object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
- pods Property Map
- pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
- resource Property Map
- resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
- type String
- type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
MetricTargetPatch, MetricTargetPatchArgs
- Average
Utilization int - averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- Average
Value string - averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- Type string
- type represents whether the metric type is Utilization, Value, or AverageValue
- Value string
- value is the target value of the metric (as a quantity).
- Average
Utilization int - averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- Average
Value string - averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- Type string
- type represents whether the metric type is Utilization, Value, or AverageValue
- Value string
- value is the target value of the metric (as a quantity).
- average
Utilization Integer - averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- average
Value String - averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- type String
- type represents whether the metric type is Utilization, Value, or AverageValue
- value String
- value is the target value of the metric (as a quantity).
- average
Utilization number - averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- average
Value string - averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- type string
- type represents whether the metric type is Utilization, Value, or AverageValue
- value string
- value is the target value of the metric (as a quantity).
- average_
utilization int - averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- average_
value str - averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- type str
- type represents whether the metric type is Utilization, Value, or AverageValue
- value str
- value is the target value of the metric (as a quantity).
- average
Utilization Number - averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- average
Value String - averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- type String
- type represents whether the metric type is Utilization, Value, or AverageValue
- value String
- value is the target value of the metric (as a quantity).
MetricValueStatusPatch, MetricValueStatusPatchArgs
- Average
Utilization int - currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- Average
Value string - averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- Value string
- value is the current value of the metric (as a quantity).
- Average
Utilization int - currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- Average
Value string - averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- Value string
- value is the current value of the metric (as a quantity).
- average
Utilization Integer - currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- average
Value String - averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- value String
- value is the current value of the metric (as a quantity).
- average
Utilization number - currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- average
Value string - averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- value string
- value is the current value of the metric (as a quantity).
- average_
utilization int - currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- average_
value str - averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- value str
- value is the current value of the metric (as a quantity).
- average
Utilization Number - currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- average
Value String - averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- value String
- value is the current value of the metric (as a quantity).
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
- Cluster
Name 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.
- Creation
Timestamp 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
- Deletion
Grace intPeriod Seconds - 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 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.
- Generate
Name 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
- Managed
Fields List<Pulumi.Kubernetes. Meta. V1. Inputs. Managed Fields Entry Patch> - 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
- Owner
References List<Pulumi.Kubernetes. Meta. V1. Inputs. Owner Reference Patch> - 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.
- Resource
Version 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
- Self
Link 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
- 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
- Cluster
Name 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.
- Creation
Timestamp 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
- Deletion
Grace intPeriod Seconds - 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 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 []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.
- Generate
Name 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 map[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
- Managed
Fields ManagedFields Entry Patch - 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
- Owner
References OwnerReference Patch - 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.
- Resource
Version 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
- Self
Link 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>
- 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
- cluster
Name 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.
- creation
Timestamp 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
- deletion
Grace IntegerPeriod Seconds - 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 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.
- generate
Name 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 Integer
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- labels Map<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
- managed
Fields List<ManagedFields Entry Patch> - 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
- owner
References List<OwnerReference Patch> - 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.
- resource
Version 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
- self
Link 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}
- 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
- cluster
Name 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.
- creation
Timestamp 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
- deletion
Grace numberPeriod Seconds - 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 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 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.
- generate
Name 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 number
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- labels {[key: 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
- managed
Fields meta.v1.Managed Fields Entry Patch[] - 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
- owner
References meta.v1.Owner Reference Patch[] - 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.
- resource
Version 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
- self
Link 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]
- 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
- cluster_
name str - 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.
- creation_
timestamp str 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
- deletion_
grace_ intperiod_ seconds - 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 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 Sequence[str]
- 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.
- generate_
name str 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 Mapping[str, str]
- 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
- managed_
fields Sequence[meta.v1.Managed Fields Entry Patch] - 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 str
- 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 str
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
- owner_
references Sequence[meta.v1.Owner Reference Patch] - 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.
- resource_
version str 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
- 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>
- 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
- cluster
Name 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.
- creation
Timestamp 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
- deletion
Grace NumberPeriod Seconds - 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 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.
- generate
Name 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 Number
- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- labels Map<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
- managed
Fields List<Property Map> - 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
- owner
References List<Property Map> - 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.
- resource
Version 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
- self
Link 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
ObjectMetricSourcePatch, ObjectMetricSourcePatchArgs
- Described
Object CrossVersion Object Reference Patch - describedObject specifies the descriptions of a object,such as kind,name apiVersion
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Target
Metric
Target Patch - target specifies the target value for the given metric
- Described
Object CrossVersion Object Reference Patch - describedObject specifies the descriptions of a object,such as kind,name apiVersion
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Target
Metric
Target Patch - target specifies the target value for the given metric
- described
Object CrossVersion Object Reference Patch - describedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- described
Object CrossVersion Object Reference Patch - describedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- described_
object CrossVersion Object Reference Patch - describedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- described
Object Property Map - describedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric Property Map
- metric identifies the target metric by name and selector
- target Property Map
- target specifies the target value for the given metric
ObjectMetricStatusPatch, ObjectMetricStatusPatchArgs
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Described
Object CrossVersion Object Reference Patch - DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Described
Object CrossVersion Object Reference Patch - DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- described
Object CrossVersion Object Reference Patch - DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- described
Object CrossVersion Object Reference Patch - DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- described_
object CrossVersion Object Reference Patch - DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current Property Map
- current contains the current value for the given metric
- described
Object Property Map - DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
- metric Property Map
- metric identifies the target metric by name and selector
OwnerReferencePatch, OwnerReferencePatchArgs
- Api
Version string - API version of the referent.
- Block
Owner boolDeletion - 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
- Api
Version string - API version of the referent.
- Block
Owner boolDeletion - 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
- api
Version String - API version of the referent.
- block
Owner BooleanDeletion - 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 string - API version of the referent.
- block
Owner booleanDeletion - 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_ booldeletion - 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
- api
Version String - API version of the referent.
- block
Owner BooleanDeletion - 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
PodsMetricSourcePatch, PodsMetricSourcePatchArgs
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Target
Metric
Target Patch - target specifies the target value for the given metric
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Target
Metric
Target Patch - target specifies the target value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- target
Metric
Target Patch - target specifies the target value for the given metric
- metric Property Map
- metric identifies the target metric by name and selector
- target Property Map
- target specifies the target value for the given metric
PodsMetricStatusPatch, PodsMetricStatusPatchArgs
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current
Metric
Value Status Patch - current contains the current value for the given metric
- metric
Metric
Identifier Patch - metric identifies the target metric by name and selector
- current Property Map
- current contains the current value for the given metric
- metric Property Map
- metric identifies the target metric by name and selector
ResourceMetricSourcePatch, ResourceMetricSourcePatchArgs
- Name string
- name is the name of the resource in question.
- Target
Metric
Target Patch - target specifies the target value for the given metric
- Name string
- name is the name of the resource in question.
- Target
Metric
Target Patch - target specifies the target value for the given metric
- name String
- name is the name of the resource in question.
- target
Metric
Target Patch - target specifies the target value for the given metric
- name string
- name is the name of the resource in question.
- target
Metric
Target Patch - target specifies the target value for the given metric
- name str
- name is the name of the resource in question.
- target
Metric
Target Patch - target specifies the target value for the given metric
- name String
- name is the name of the resource in question.
- target Property Map
- target specifies the target value for the given metric
ResourceMetricStatusPatch, ResourceMetricStatusPatchArgs
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Name string
- name is the name of the resource in question.
- Current
Metric
Value Status Patch - current contains the current value for the given metric
- Name string
- name is the name of the resource in question.
- current
Metric
Value Status Patch - current contains the current value for the given metric
- name String
- name is the name of the resource in question.
- current
Metric
Value Status Patch - current contains the current value for the given metric
- name string
- name is the name of the resource in question.
- current
Metric
Value Status Patch - current contains the current value for the given metric
- name str
- name is the name of the resource in question.
- current Property Map
- current contains the current value for the given metric
- name String
- name is the name of the resource in question.
Package Details
- Repository
- Kubernetes pulumi/pulumi-kubernetes
- License
- Apache-2.0