New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
A newer version is available. For the latest information, see the current release documentation.
« API Reference apm.k8s.elastic.co/v1beta1 »
Elastic Docs ›Elastic Cloud on Kubernetes [1.0] ›API Reference

apm.k8s.elastic.co/v1

edit

apm.k8s.elastic.co/v1

edit

Package v1 contains API schema definitions for managing APM Server resources.

Resource Types

ApmServer

edit

ApmServer represents an APM Server resource in a Kubernetes cluster.

Field Description

apiVersion
string

apm.k8s.elastic.co/v1

kind
string

ApmServer

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ApmServerSpec
version string
Version of the APM Server.
image string
Image is the APM Server Docker image to deploy.
count int32
Count of APM Server instances to deploy.
config Config
Config holds the APM Server configuration. See: https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html
http HTTPConfig
HTTP holds the HTTP layer configuration for the APM Server resource.
elasticsearchRef ObjectSelector
ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster.
podTemplate Kubernetes core/v1.PodTemplateSpec
PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods.
secureSettings []SecretSource
SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for APM Server.

ApmServerSpec

edit

ApmServerSpec holds the specification of an APM Server.

Appears in:

Field Description

version
string

Version of the APM Server.

image
string

Image is the APM Server Docker image to deploy.

count
int32

Count of APM Server instances to deploy.

config
Config

Config holds the APM Server configuration. See: https://www.elastic.co/guide/en/apm/server/current/configuring-howto-apm-server.html

http
HTTPConfig

HTTP holds the HTTP layer configuration for the APM Server resource.

elasticsearchRef
ObjectSelector

ElasticsearchRef is a reference to the output Elasticsearch cluster running in the same Kubernetes cluster.

podTemplate
Kubernetes core/v1.PodTemplateSpec

PodTemplate provides customisation options (labels, annotations, affinity rules, resource requests, and so on) for the APM Server pods.

secureSettings
[]SecretSource

SecureSettings is a list of references to Kubernetes secrets containing sensitive configuration options for APM Server.
« API Reference apm.k8s.elastic.co/v1beta1 »

On this page

Was this helpful?
Feedback