Skip to content

datadoghq.v1alpha1.datadogPodAutoscaler

"DatadogPodAutoscaler is the Schema for the datadogpodautoscalers API"

Index

Fields

fn new

new(name)

new returns an instance of DatadogPodAutoscaler

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"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"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"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"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"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."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"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."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"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."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"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."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"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.\n\nIf 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).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

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

fn metadata.withLabels

withLabels(labels)

"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"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"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"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"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"

fn metadata.withNamespace

withNamespace(namespace)

"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.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"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."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"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."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"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.\n\nPopulated 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"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"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.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"DatadogPodAutoscalerSpec defines the desired state of DatadogPodAutoscaler"

fn spec.withOwner

withOwner(owner)

"Owner defines the source of truth for this object (local or remote)\nValue needs to be set when a DatadogPodAutoscaler object is created."

fn spec.withRemoteVersion

withRemoteVersion(remoteVersion)

"RemoteVersion is the version of the .Spec currently store in this object.\nOnly set if the owner is Remote."

fn spec.withTargets

withTargets(targets)

"Targets are objectives to reach and maintain for the target resource.\nDefault to a single target to maintain 80% POD CPU utilization."

fn spec.withTargetsMixin

withTargetsMixin(targets)

"Targets are objectives to reach and maintain for the target resource.\nDefault to a single target to maintain 80% POD CPU utilization."

Note: This function appends passed data to existing values

obj spec.constraints

"Constraints defines constraints that should always be respected."

fn spec.constraints.withContainers

withContainers(containers)

"Containers defines constraints for the containers."

fn spec.constraints.withContainersMixin

withContainersMixin(containers)

"Containers defines constraints for the containers."

Note: This function appends passed data to existing values

fn spec.constraints.withMaxReplicas

withMaxReplicas(maxReplicas)

"MaxReplicas is the upper limit for the number of POD replicas. Needs to be >= minReplicas."

fn spec.constraints.withMinReplicas

withMinReplicas(minReplicas)

"MinReplicas is the lower limit for the number of POD replicas. Needs to be >= 1. Default to 1."

obj spec.constraints.containers

"Containers defines constraints for the containers."

fn spec.constraints.containers.withEnabled

withEnabled(enabled)

"Enabled false allows to disable resources autoscaling for the container. Default to true."

fn spec.constraints.containers.withName

withName(name)

"Name is the name of the container. Can be \"*\" to apply to all containers."

obj spec.constraints.containers.limits

"Limits defines the constraints for the limits of the container."

fn spec.constraints.containers.limits.withMaxAllowed

withMaxAllowed(maxAllowed)

"MaxAllowed is the upper limit for the requests of the container."

fn spec.constraints.containers.limits.withMaxAllowedMixin

withMaxAllowedMixin(maxAllowed)

"MaxAllowed is the upper limit for the requests of the container."

Note: This function appends passed data to existing values

fn spec.constraints.containers.limits.withMinAllowed

withMinAllowed(minAllowed)

"MinAllowed is the lower limit for the requests of the container."

fn spec.constraints.containers.limits.withMinAllowedMixin

withMinAllowedMixin(minAllowed)

"MinAllowed is the lower limit for the requests of the container."

Note: This function appends passed data to existing values

obj spec.constraints.containers.requests

"Requests defines the constraints for the requests of the container."

fn spec.constraints.containers.requests.withMaxAllowed

withMaxAllowed(maxAllowed)

"MaxAllowed is the upper limit for the requests of the container."

fn spec.constraints.containers.requests.withMaxAllowedMixin

withMaxAllowedMixin(maxAllowed)

"MaxAllowed is the upper limit for the requests of the container."

Note: This function appends passed data to existing values

fn spec.constraints.containers.requests.withMinAllowed

withMinAllowed(minAllowed)

"MinAllowed is the lower limit for the requests of the container."

fn spec.constraints.containers.requests.withMinAllowedMixin

withMinAllowedMixin(minAllowed)

"MinAllowed is the lower limit for the requests of the container."

Note: This function appends passed data to existing values

obj spec.policy

"Policy defines how recommendations should be applied."

fn spec.policy.withApplyMode

withApplyMode(applyMode)

"ApplyMode determines recommendations that should be applied by the controller:\n- All: Apply all recommendations (regular and manual).\n- Manual: Apply only manual recommendations (recommendations manually validated by user in the Datadog app).\n- None: Prevent the controller to apply any recommendations.\nIt's also possible to selectively deactivate upscale, downscale or update actions thanks to the Upscale, Downscale and Update fields."

obj spec.policy.downscale

"Downscale defines the policy to scale down the target resource."

fn spec.policy.downscale.withRules

withRules(rules)

"Rules is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the DatadogPodAutoscalerScalingPolicy will be discarded as invalid"

fn spec.policy.downscale.withRulesMixin

withRulesMixin(rules)

"Rules is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the DatadogPodAutoscalerScalingPolicy will be discarded as invalid"

Note: This function appends passed data to existing values

fn spec.policy.downscale.withStrategy

withStrategy(strategy)

"Strategy is used to specify which policy should be used.\nIf not set, the default value Max is used."

obj spec.policy.downscale.rules

"Rules is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the DatadogPodAutoscalerScalingPolicy will be discarded as invalid"

fn spec.policy.downscale.rules.withMatch

withMatch(match)

"Match defines if the rule should be considered or not in the calculation.\nDefault to Always if not set."

fn spec.policy.downscale.rules.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"PeriodSeconds specifies the window of time for which the policy should hold true.\nPeriodSeconds must be greater than zero and less than or equal to 1800 (30 min)."

fn spec.policy.downscale.rules.withType

withType(type)

"Type is used to specify the scaling policy."

fn spec.policy.downscale.rules.withValue

withValue(value)

"Value contains the amount of change which is permitted by the policy.\nSetting it to 0 will prevent any scaling in this direction and should not be used unless Match is set to IfScalingEvent."

obj spec.policy.update

"Update defines the policy to update target resource."

fn spec.policy.update.withStrategy

withStrategy(strategy)

"Mode defines the mode of the update policy."

obj spec.policy.upscale

"Upscale defines the policy to scale up the target resource."

fn spec.policy.upscale.withRules

withRules(rules)

"Rules is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the DatadogPodAutoscalerScalingPolicy will be discarded as invalid"

fn spec.policy.upscale.withRulesMixin

withRulesMixin(rules)

"Rules is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the DatadogPodAutoscalerScalingPolicy will be discarded as invalid"

Note: This function appends passed data to existing values

fn spec.policy.upscale.withStrategy

withStrategy(strategy)

"Strategy is used to specify which policy should be used.\nIf not set, the default value Max is used."

obj spec.policy.upscale.rules

"Rules is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the DatadogPodAutoscalerScalingPolicy will be discarded as invalid"

fn spec.policy.upscale.rules.withMatch

withMatch(match)

"Match defines if the rule should be considered or not in the calculation.\nDefault to Always if not set."

fn spec.policy.upscale.rules.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"PeriodSeconds specifies the window of time for which the policy should hold true.\nPeriodSeconds must be greater than zero and less than or equal to 1800 (30 min)."

fn spec.policy.upscale.rules.withType

withType(type)

"Type is used to specify the scaling policy."

fn spec.policy.upscale.rules.withValue

withValue(value)

"Value contains the amount of change which is permitted by the policy.\nSetting it to 0 will prevent any scaling in this direction and should not be used unless Match is set to IfScalingEvent."

obj spec.targetRef

"TargetRef is the reference to the resource to scale."

fn spec.targetRef.withApiVersion

withApiVersion(apiVersion)

"apiVersion is the API version of the referent"

fn spec.targetRef.withKind

withKind(kind)

"kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.targetRef.withName

withName(name)

"name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.targets

"Targets are objectives to reach and maintain for the target resource.\nDefault to a single target to maintain 80% POD CPU utilization."

fn spec.targets.withType

withType(type)

"Type sets the type of the target."

obj spec.targets.containerResource

"ContainerResource allows to set a container-level resource target."

fn spec.targets.containerResource.withContainer

withContainer(container)

"Container is the name of the container."

fn spec.targets.containerResource.withName

withName(name)

"Name is the name of the resource."

obj spec.targets.containerResource.value

"Value is the value of the target."

fn spec.targets.containerResource.value.withAbsolute

withAbsolute(absolute)

"Absolute defines the absolute value of the target (for instance 500 millicores)."

fn spec.targets.containerResource.value.withType

withType(type)

"Type specifies how the value is expressed (Absolute or Utilization)."

fn spec.targets.containerResource.value.withUtilization

withUtilization(utilization)

"Utilization defines a percentage of the target compared to requested resource"

obj spec.targets.podResource

"PodResource allows to set a POD-level resource target."

fn spec.targets.podResource.withName

withName(name)

"Name is the name of the resource."

obj spec.targets.podResource.value

"Value is the value of the target."

fn spec.targets.podResource.value.withAbsolute

withAbsolute(absolute)

"Absolute defines the absolute value of the target (for instance 500 millicores)."

fn spec.targets.podResource.value.withType

withType(type)

"Type specifies how the value is expressed (Absolute or Utilization)."

fn spec.targets.podResource.value.withUtilization

withUtilization(utilization)

"Utilization defines a percentage of the target compared to requested resource"