AutoOpsAgentPolicy represents an Elastic AutoOps Policy resource in a Kubernetes cluster.
Last changed in eck-operator v3.5.0
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
AutoOpsRef defines a reference to a secret containing connection details for AutoOps via Cloud Connect.
SecretName references a Secret containing connection details for external AutoOps. Required when connecting via Cloud Connect. The secret must contain: - `cloud-connected-mode-api-key`: Cloud Connected Mode API key - `autoops-otel-url`: AutoOps OpenTelemetry endpoint URL - `autoops-token`: AutoOps authentication token - `cloud-connected-mode-api-url`: (optional) Cloud Connected Mode API URL This field cannot be used in combination with `name`.
Config holds additional OpenTelemetry collector configuration for the AutoOps agent. User-supplied settings are merged between the operator baseline defaults and the operator-owned mandatory settings, which always take final precedence. This allows tuning knobs such as the sending_queue sizing, appending custom metricbeat modules, or defining additional exporters and pipelines. Supplying at least one autoops_es module replaces the operator's built-in modules entirely, giving full control over which metricsets are collected and at what period. Elasticsearch connection details (hosts, SSL), OTLP endpoint and authorization, and the healthcheck extension are always injected by the operator and cannot be overridden. At most one of [`config`, `configRef`] can be specified.
ConfigRef references a Kubernetes Secret holding the AutoOps agent configuration under the `autoops_es.yml` key. Applies the same merge semantics as `config`. At most one of [`config`, `configRef`] can be specified.
SecretName is the name of the secret.
Image is the AutoOps Agent Docker image to deploy.
NamespaceSelector is a namespace selector for the resources to be configured. Any Elasticsearch instances that belong to the selected namespaces will be configured to send data to AutoOps.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
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.
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.
PodTemplate provides customization options (labels, annotations, affinity rules, resource requests, and so on) for the Agent pods
ResourceSelector is a label selector for the resources to be configured. Any Elasticsearch instances that match the selector will be configured to send data to AutoOps.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
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.
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.
Resources provides a shorthand to set CPU and Memory resources on the AutoOps Agent container. When set, these values override any CPU or memory resource settings specified in the PodTemplate for the primary AutoOps Agent container. To set resources on other containers, use the PodTemplate.
Limits is the shorthand for the main container's CPU and memory limits.
CPU overrides the main container's CPU request/limit when the parent Resources is merged into a PodTemplate. A nil value means "do not override": any CPU value already set on the main container in the PodTemplate is passed through unchanged. Setting this field to nil does not unset a CPU value present in the PodTemplate; to remove it, edit the PodTemplate's container resources. A non-nil value wins over the PodTemplate's CPU, including an explicit zero quantity.
Memory overrides the main container's memory request/limit when the parent Resources is merged into a PodTemplate. A nil value means "do not override": any memory value already set on the main container in the PodTemplate is passed through unchanged. Setting this field to nil does not unset a memory value present in the PodTemplate; to remove it, edit the PodTemplate's container resources. A non-nil value wins over the PodTemplate's memory, including an explicit zero quantity.
Requests is the shorthand for the main container's CPU and memory requests.
CPU overrides the main container's CPU request/limit when the parent Resources is merged into a PodTemplate. A nil value means "do not override": any CPU value already set on the main container in the PodTemplate is passed through unchanged. Setting this field to nil does not unset a CPU value present in the PodTemplate; to remove it, edit the PodTemplate's container resources. A non-nil value wins over the PodTemplate's CPU, including an explicit zero quantity.
Memory overrides the main container's memory request/limit when the parent Resources is merged into a PodTemplate. A nil value means "do not override": any memory value already set on the main container in the PodTemplate is passed through unchanged. Setting this field to nil does not unset a memory value present in the PodTemplate; to remove it, edit the PodTemplate's container resources. A non-nil value wins over the PodTemplate's memory, including an explicit zero quantity.
RevisionHistoryLimit is the number of revisions to retain to allow rollback in the underlying Deployment.
ServiceAccountName is used to check access to Elasticsearch resources in different namespaces. Can only be used if ECK is enforcing RBAC on references (--enforce-rbac-on-refs flag). The service account must have "get" permission on elasticsearch.k8s.elastic.co/elasticsearches in the target namespaces.
Version of the AutoOpsAgentPolicy.
Conditions holds the current service state of the deployment.
ConditionType defines the condition of a resource.
Details contains lightweight per-resource details.
Error contains the error message when the resource is in an error state. Only populated when Phase is "Error".
Message provides a human-readable explanation of the current phase. Only populated for non-ready states to provide context about why the resource is not ready.
Phase indicates the current state of the monitored resource. Possible values are "Error" (resource encountered an error) or "Skipped" (resource was skipped due to RBAC permissions).
Errors is the number of resources that are in an error state.
ObservedGeneration is the most recent generation observed for this AutoOpsAgentPolicy.
Phase is the phase of the AutoOpsAgentPolicy.
Ready is the number of resources that are in a ready state.
ReadyCount is a human readable string of ready monitored resources vs all monitored resources, Ready/Resources.
Resources is the number of resources that match the ResourceSelector.
Skipped is the number of resources that are skipped from monitoring due to rbac permissions.
Source: all-crds.yaml
Changes to AutoOpsAgentPolicy (autoops.k8s.elastic.co/v1alpha1) in each eck-operator version, compared to the version before it.
5 properties have been added
1 property has been removed
8 properties have changed the description
Released · View AutoOpsAgentPolicy in v3.5.0
3 properties have been added
Released · View AutoOpsAgentPolicy in v3.4.0
1 property has been added
Released · View AutoOpsAgentPolicy in v3.3.1
AutoOpsAgentPolicy was first seen on this version of eck-operator
Released · View AutoOpsAgentPolicy in v3.3.0
No examples of AutoOpsAgentPolicy yet. Contribute one on GitHub.