HorizontalPodAutoscaler

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 a HorizontalPodAutoscaler Resource

def HorizontalPodAutoscaler(resource_name, opts=None, metadata=None, spec=None);
name string
The unique name of the resource.
args HorizontalPodAutoscaler
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args HorizontalPodAutoscalerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HorizontalPodAutoscalerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

HorizontalPodAutoscaler Resource Properties

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

Inputs

The HorizontalPodAutoscaler resource accepts the following input properties:

Metadata Pulumi.Kubernetes.Meta.V1.Inputs.ObjectMetaArgs
metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Spec HorizontalPodAutoscalerSpecArgs
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 ObjectMeta
metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Spec HorizontalPodAutoscalerSpec
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.ObjectMeta
metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec HorizontalPodAutoscalerSpec
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 Dict[ObjectMeta]
metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec Dict[HorizontalPodAutoscalerSpec]
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 HorizontalPodAutoscaler resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status HorizontalPodAutoscalerStatus
status is the current information about the autoscaler.
Id string
The provider-assigned unique ID for this managed resource.
Status HorizontalPodAutoscalerStatus
status is the current information about the autoscaler.
id string
The provider-assigned unique ID for this managed resource.
status HorizontalPodAutoscalerStatus
status is the current information about the autoscaler.
id str
The provider-assigned unique ID for this managed resource.
status Dict[HorizontalPodAutoscalerStatus]
status is the current information about the autoscaler.

Supporting Types

CrossVersionObjectReference

See the input and output API doc for this type.

See the input and output API doc for this type.

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: http://kubernetes.io/docs/user-guide/identifiers#names
ApiVersion string
API version of the referent
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: http://kubernetes.io/docs/user-guide/identifiers#names
ApiVersion string
API version of the referent
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: http://kubernetes.io/docs/user-guide/identifiers#names
apiVersion string
API version of the referent
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: http://kubernetes.io/docs/user-guide/identifiers#names
api_version str
API version of the referent

ExternalMetricSource

See the input and output API doc for this type.

See the input and output API doc for this type.

Metric MetricIdentifierArgs
metric identifies the target metric by name and selector
Target MetricTargetArgs
target specifies the target value for the given metric
Metric MetricIdentifier
metric identifies the target metric by name and selector
Target MetricTarget
target specifies the target value for the given metric
metric MetricIdentifier
metric identifies the target metric by name and selector
target MetricTarget
target specifies the target value for the given metric
metric Dict[MetricIdentifier]
metric identifies the target metric by name and selector
target Dict[MetricTarget]
target specifies the target value for the given metric

ExternalMetricStatus

See the output API doc for this type.

See the output API doc for this type.

Current MetricValueStatusArgs
current contains the current value for the given metric
Metric MetricIdentifierArgs
metric identifies the target metric by name and selector
Current MetricValueStatus
current contains the current value for the given metric
Metric MetricIdentifier
metric identifies the target metric by name and selector
current MetricValueStatus
current contains the current value for the given metric
metric MetricIdentifier
metric identifies the target metric by name and selector
current Dict[MetricValueStatus]
current contains the current value for the given metric
metric Dict[MetricIdentifier]
metric identifies the target metric by name and selector

HPAScalingPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

PeriodSeconds 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
PeriodSeconds 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
periodSeconds 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 float
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 float
Value contains the amount of change which is permitted by the policy. It must be greater than zero

HPAScalingRules

See the input and output API doc for this type.

See the input and output API doc for this type.

Policies List<HPAScalingPolicyArgs>
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
SelectPolicy string
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
StabilizationWindowSeconds int
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 []HPAScalingPolicy
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
SelectPolicy string
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
StabilizationWindowSeconds int
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 HPAScalingPolicy[]
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
selectPolicy string
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
stabilizationWindowSeconds number
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[HPAScalingPolicy]
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 MaxPolicySelect is used.
stabilization_window_seconds float
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).

HorizontalPodAutoscalerBehavior

See the input and output API doc for this type.

See the input and output API doc for this type.

ScaleDown HPAScalingRulesArgs
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).
ScaleUp HPAScalingRulesArgs

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.

ScaleDown HPAScalingRules
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).
ScaleUp HPAScalingRules

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.

scaleDown HPAScalingRules
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).
scaleUp HPAScalingRules

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 Dict[HPAScalingRules]
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 Dict[HPAScalingRules]

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.

HorizontalPodAutoscalerCondition

See the output API doc for this type.

See the output API doc for this type.

Status string
status is the status of the condition (True, False, Unknown)
Type string
type describes the current condition
LastTransitionTime string
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
LastTransitionTime string
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
lastTransitionTime string
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 str
status is the status of the condition (True, False, Unknown)
type str
type describes the current condition
last_transition_time str
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.

HorizontalPodAutoscalerSpec

See the input and output API doc for this type.

See the input and output API doc for this type.

MaxReplicas int
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
ScaleTargetRef CrossVersionObjectReferenceArgs
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 HorizontalPodAutoscalerBehaviorArgs
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.
Metrics List<MetricSpecArgs>
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.
MinReplicas 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.
MaxReplicas int
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
ScaleTargetRef CrossVersionObjectReference
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 HorizontalPodAutoscalerBehavior
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.
Metrics []MetricSpec
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.
MinReplicas 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.
maxReplicas number
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
scaleTargetRef CrossVersionObjectReference
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 HorizontalPodAutoscalerBehavior
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.
metrics MetricSpec[]
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.
minReplicas 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.
max_replicas float
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
scale_target_ref Dict[CrossVersionObjectReference]
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 Dict[HorizontalPodAutoscalerBehavior]
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.
metrics List[MetricSpec]
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 float
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.

HorizontalPodAutoscalerStatus

See the output API doc for this type.

See the output API doc for this type.

Conditions List<HorizontalPodAutoscalerConditionArgs>
conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
CurrentReplicas int
currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
DesiredReplicas int
desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
CurrentMetrics List<MetricStatusArgs>
currentMetrics is the last read state of the metrics used by this autoscaler.
LastScaleTime string
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.
ObservedGeneration int
observedGeneration is the most recent generation observed by this autoscaler.
Conditions []HorizontalPodAutoscalerCondition
conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
CurrentReplicas int
currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
DesiredReplicas int
desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
CurrentMetrics []MetricStatus
currentMetrics is the last read state of the metrics used by this autoscaler.
LastScaleTime string
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.
ObservedGeneration int
observedGeneration is the most recent generation observed by this autoscaler.
conditions HorizontalPodAutoscalerCondition[]
conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
currentReplicas number
currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
desiredReplicas number
desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
currentMetrics MetricStatus[]
currentMetrics is the last read state of the metrics used by this autoscaler.
lastScaleTime string
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.
observedGeneration number
observedGeneration is the most recent generation observed by this autoscaler.
conditions List[HorizontalPodAutoscalerCondition]
conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
current_replicas float
currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
desired_replicas float
desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
current_metrics List[MetricStatus]
currentMetrics is the last read state of the metrics used by this autoscaler.
last_scale_time str
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 float
observedGeneration is the most recent generation observed by this autoscaler.

LabelSelector

See the input and output API doc for this type.

See the input and output API doc for this type.

MatchExpressions List<Pulumi.Kubernetes.Meta.V1.Inputs.LabelSelectorRequirementArgs>
matchExpressions is a list of label selector requirements. The requirements are ANDed.
MatchLabels 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.
MatchExpressions LabelSelectorRequirement
matchExpressions is a list of label selector requirements. The requirements are ANDed.
MatchLabels 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.
matchExpressions meta.v1.LabelSelectorRequirement[]
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels {[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 List[LabelSelectorRequirement]
matchExpressions is a list of label selector requirements. The requirements are ANDed.
match_labels Dict[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.

LabelSelectorRequirement

See the input and output API doc for this type.

See the input and output API doc for this type.

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 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 List[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.

ManagedFieldsEntry

See the input and output API doc for this type.

See the input and output API doc for this type.

ApiVersion string
APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType string
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
FieldsV1 System.Text.Json.JsonElement
FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
Manager string
Manager is an identifier of the workflow managing these fields.
Operation string
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
Time string
Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
ApiVersion string
APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType string
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
FieldsV1 interface{}
FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
Manager string
Manager is an identifier of the workflow managing these fields.
Operation string
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
Time string
Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
apiVersion string
APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType string
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”
fieldsV1 any
FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.
manager string
Manager is an identifier of the workflow managing these fields.
operation string
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
time string
Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’
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 Dict[str, 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’.
time str
Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’

MetricIdentifier

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string
name is the name of the given metric
Selector Pulumi.Kubernetes.Meta.V1.Inputs.LabelSelectorArgs
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 LabelSelector
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.LabelSelector
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 Dict[LabelSelector]
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.

MetricSpec

See the input and output API doc for this type.

See the input and output API doc for this type.

Type string
type is the type of metric source. It should be one of “Object”, “Pods” or “Resource”, each mapping to a matching field in the object.
External ExternalMetricSourceArgs
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 ObjectMetricSourceArgs
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
Pods PodsMetricSourceArgs
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 ResourceMetricSourceArgs
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 “Object”, “Pods” or “Resource”, each mapping to a matching field in the object.
External ExternalMetricSource
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 ObjectMetricSource
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
Pods PodsMetricSource
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 ResourceMetricSource
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 “Object”, “Pods” or “Resource”, each mapping to a matching field in the object.
external ExternalMetricSource
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 ObjectMetricSource
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
pods PodsMetricSource
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 ResourceMetricSource
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 “Object”, “Pods” or “Resource”, each mapping to a matching field in the object.
external Dict[ExternalMetricSource]
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 Dict[ObjectMetricSource]
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
pods Dict[PodsMetricSource]
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 Dict[ResourceMetricSource]
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.

MetricStatus

See the output API doc for this type.

See the output API doc for this type.

Type string
type is the type of metric source. It will be one of “Object”, “Pods” or “Resource”, each corresponds to a matching field in the object.
External ExternalMetricStatusArgs
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 ObjectMetricStatusArgs
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
Pods PodsMetricStatusArgs
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 ResourceMetricStatusArgs
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 “Object”, “Pods” or “Resource”, each corresponds to a matching field in the object.
External ExternalMetricStatus
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 ObjectMetricStatus
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
Pods PodsMetricStatus
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 ResourceMetricStatus
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 “Object”, “Pods” or “Resource”, each corresponds to a matching field in the object.
external ExternalMetricStatus
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 ObjectMetricStatus
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
pods PodsMetricStatus
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 ResourceMetricStatus
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 “Object”, “Pods” or “Resource”, each corresponds to a matching field in the object.
external Dict[ExternalMetricStatus]
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 Dict[ObjectMetricStatus]
object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
pods Dict[PodsMetricStatus]
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 Dict[ResourceMetricStatus]
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.

MetricTarget

See the input and output API doc for this type.

See the input and output API doc for this type.

Type string
type represents whether the metric type is Utilization, Value, or AverageValue
AverageUtilization 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
AverageValue string
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
Value string
value is the target value of the metric (as a quantity).
Type string
type represents whether the metric type is Utilization, Value, or AverageValue
AverageUtilization 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
AverageValue string
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
Value string
value is the target value of the metric (as a quantity).
type string
type represents whether the metric type is Utilization, Value, or AverageValue
averageUtilization 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
averageValue string
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
value string
value is the target value of the metric (as a quantity).
type str
type represents whether the metric type is Utilization, Value, or AverageValue
average_utilization float
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)
value str
value is the target value of the metric (as a quantity).

MetricValueStatus

See the output API doc for this type.

See the output API doc for this type.

AverageUtilization 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.
AverageValue 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).
AverageUtilization 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.
AverageValue 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).
averageUtilization 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.
averageValue 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 float
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).

ObjectMeta

See the input and output API doc for this type.

See the input and output API doc for this type.

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: http://kubernetes.io/docs/user-guide/annotations
ClusterName string
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
CreationTimestamp string

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

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

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

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

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

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

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

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

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: http://kubernetes.io/docs/user-guide/labels
ManagedFields List<Pulumi.Kubernetes.Meta.V1.Inputs.ManagedFieldsEntryArgs>
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: http://kubernetes.io/docs/user-guide/identifiers#names
Namespace string

Namespace defines the space within 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: http://kubernetes.io/docs/user-guide/namespaces

OwnerReferences List<Pulumi.Kubernetes.Meta.V1.Inputs.OwnerReferenceArgs>
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
ResourceVersion string

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

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

SelfLink string

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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: http://kubernetes.io/docs/user-guide/identifiers#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: http://kubernetes.io/docs/user-guide/annotations
ClusterName string
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
CreationTimestamp string

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

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

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

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

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

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

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

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

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: http://kubernetes.io/docs/user-guide/labels
ManagedFields ManagedFieldsEntry
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: http://kubernetes.io/docs/user-guide/identifiers#names
Namespace string

Namespace defines the space within 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: http://kubernetes.io/docs/user-guide/namespaces

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

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

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

SelfLink string

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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: http://kubernetes.io/docs/user-guide/identifiers#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: http://kubernetes.io/docs/user-guide/annotations
clusterName string
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp string

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

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

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

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.
generateName string

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

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

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: http://kubernetes.io/docs/user-guide/labels
managedFields meta.v1.ManagedFieldsEntry[]
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: http://kubernetes.io/docs/user-guide/identifiers#names
namespace string

Namespace defines the space within 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: http://kubernetes.io/docs/user-guide/namespaces

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

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

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

selfLink string

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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: http://kubernetes.io/docs/user-guide/identifiers#uids

annotations Dict[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: http://kubernetes.io/docs/user-guide/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_period_seconds float
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 List[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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

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

generation float
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels Dict[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: http://kubernetes.io/docs/user-guide/labels
managed_fields List[ManagedFieldsEntry]
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: http://kubernetes.io/docs/user-guide/identifiers#names
namespace str

Namespace defines the space within 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: http://kubernetes.io/docs/user-guide/namespaces

owner_references List[OwnerReference]
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

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

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: http://kubernetes.io/docs/user-guide/identifiers#uids

ObjectMetricSource

See the input and output API doc for this type.

See the input and output API doc for this type.

DescribedObject CrossVersionObjectReferenceArgs
Metric MetricIdentifierArgs
metric identifies the target metric by name and selector
Target MetricTargetArgs
target specifies the target value for the given metric
DescribedObject CrossVersionObjectReference
Metric MetricIdentifier
metric identifies the target metric by name and selector
Target MetricTarget
target specifies the target value for the given metric
describedObject CrossVersionObjectReference
metric MetricIdentifier
metric identifies the target metric by name and selector
target MetricTarget
target specifies the target value for the given metric
described_object Dict[CrossVersionObjectReference]
metric Dict[MetricIdentifier]
metric identifies the target metric by name and selector
target Dict[MetricTarget]
target specifies the target value for the given metric

ObjectMetricStatus

See the output API doc for this type.

See the output API doc for this type.

Current MetricValueStatusArgs
current contains the current value for the given metric
DescribedObject CrossVersionObjectReferenceArgs
Metric MetricIdentifierArgs
metric identifies the target metric by name and selector
Current MetricValueStatus
current contains the current value for the given metric
DescribedObject CrossVersionObjectReference
Metric MetricIdentifier
metric identifies the target metric by name and selector
current MetricValueStatus
current contains the current value for the given metric
describedObject CrossVersionObjectReference
metric MetricIdentifier
metric identifies the target metric by name and selector
current Dict[MetricValueStatus]
current contains the current value for the given metric
described_object Dict[CrossVersionObjectReference]
metric Dict[MetricIdentifier]
metric identifies the target metric by name and selector

OwnerReference

See the input and output API doc for this type.

See the input and output API doc for this type.

ApiVersion string
API version of the referent.
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: http://kubernetes.io/docs/user-guide/identifiers#names
Uid string
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
BlockOwnerDeletion bool
If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. 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.
ApiVersion string
API version of the referent.
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: http://kubernetes.io/docs/user-guide/identifiers#names
Uid string
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
BlockOwnerDeletion bool
If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. 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.
apiVersion string
API version of the referent.
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: http://kubernetes.io/docs/user-guide/identifiers#names
uid string
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
blockOwnerDeletion boolean
If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. 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.
api_version str
API version of the referent.
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: http://kubernetes.io/docs/user-guide/identifiers#names
uid str
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
block_owner_deletion bool
If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. 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.

PodsMetricSource

See the input and output API doc for this type.

See the input and output API doc for this type.

Metric MetricIdentifierArgs
metric identifies the target metric by name and selector
Target MetricTargetArgs
target specifies the target value for the given metric
Metric MetricIdentifier
metric identifies the target metric by name and selector
Target MetricTarget
target specifies the target value for the given metric
metric MetricIdentifier
metric identifies the target metric by name and selector
target MetricTarget
target specifies the target value for the given metric
metric Dict[MetricIdentifier]
metric identifies the target metric by name and selector
target Dict[MetricTarget]
target specifies the target value for the given metric

PodsMetricStatus

See the output API doc for this type.

See the output API doc for this type.

Current MetricValueStatusArgs
current contains the current value for the given metric
Metric MetricIdentifierArgs
metric identifies the target metric by name and selector
Current MetricValueStatus
current contains the current value for the given metric
Metric MetricIdentifier
metric identifies the target metric by name and selector
current MetricValueStatus
current contains the current value for the given metric
metric MetricIdentifier
metric identifies the target metric by name and selector
current Dict[MetricValueStatus]
current contains the current value for the given metric
metric Dict[MetricIdentifier]
metric identifies the target metric by name and selector

ResourceMetricSource

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string
name is the name of the resource in question.
Target MetricTargetArgs
target specifies the target value for the given metric
Name string
name is the name of the resource in question.
Target MetricTarget
target specifies the target value for the given metric
name string
name is the name of the resource in question.
target MetricTarget
target specifies the target value for the given metric
name str
name is the name of the resource in question.
target Dict[MetricTarget]
target specifies the target value for the given metric

ResourceMetricStatus

See the output API doc for this type.

See the output API doc for this type.

Current MetricValueStatusArgs
current contains the current value for the given metric
Name string
Name is the name of the resource in question.
Current MetricValueStatus
current contains the current value for the given metric
Name string
Name is the name of the resource in question.
current MetricValueStatus
current contains the current value for the given metric
name string
Name is the name of the resource in question.
current Dict[MetricValueStatus]
current contains the current value for the given metric
name str
Name is the name of the resource in question.

Package Details

Repository
https://github.com/pulumi/pulumi-kubernetes
License
Apache-2.0