API reference

API reference for Instana

Packages

instana.io/v1beta2

Package v1beta2 contains API Schema definitions for the v1beta2 API group

Resource Types

Acceptors

Acceptors contain the configuration of the acceptor listeners (hostname and port).

Appears in:

Field Description Default Validation
agent HostPortWithName Host and port for agent acceptor
eum HostPortWithName Host and port for end-user monitoring acceptor (EUM)
synthetics HostPortWithName Host and port for synthetics acceptor
serverless HostPortWithName Host and port for serverless acceptor (EUM)
otlp OTLPAcceptors Configuration for open-telemetry acceptor

AutoscalingConfig

Appears in:

Field Description Default Validation
disabled boolean Disables autoscaling for this component
minReplicas integer The minimum replica count from which the autoscaler starts to scale, the default is 1.
maxReplicas integer The upper limit for the number of replicas to which the autoscaler can scale up, the default based on the ResourceProfile.
metrics MetricSpec array Metrics contains the specifications for which to use to calculate the
desired replica count (the maximum replica count across all metrics will
be used)
If not set, the default metric will be set to 150% average CPU utilization.
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.		 Optional: {}

BeeInstanaConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.
clustered boolean For a BeeInstana Operator cluster, the value must be true true

CassandraConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in the correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.
keyspaces string array
datacenter string cassandra
replicationFactor integer 1 Minimum: 1

CircuitBreakers

Appears in:

Field Description Default Validation
maxConnections integer The maximum number of connections allowed to the upstream cluster.
maxPendingRequests integer The maximum number of pending requests allowed to the upstream cluster.
maxRequests integer The maximum number of parallel requests allowed to the upstream cluster.
maxRetries integer The maximum number of parallel retries allowed to the upstream cluster.

ClickhouseConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.
schemas string array
clusterName string local

ComponentConfig

ComponentConfig allows additional configuration for a specific component.

Appears in:

Field Description Default Validation
name string The name of the component.
disabled boolean Disables the component.
imageTag string Overrides the Docker image tag of the component.
replicas integer Number of desired replicas. Defaults to 1 if not set.
env Envs List of additional environment variables to set in the container.
resources ResourceRequirements Compute resources required by this component.
If omitted, the operator applies reasonable defaults, depending on the configured profile.
autoscalingConfig AutoscalingConfig Autoscaling configuration per component, otherwise the standard behavior applies.
affinity Affinity Group of affinity scheduling rules.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for the pod to be scheduled on that node.
tolerations Toleration array The pod that this toleration is attached to tolerates any taint that matches
the triple key,value,effect by using the matching operator operator.
priorityClassName string Configures a priority class for the component.
properties Properties Configures component configuration properties.

ComponentConfigs

Underlying type: ComponentConfig

Appears in:

Field Description Default Validation
name string The name of the component.
disabled boolean Disables the component.
imageTag string Overrides the Docker image tag of the component.
replicas integer Number of desired replicas. Defaults to 1 if not set.
env Envs List of additional environment variables to set in the container.
resources ResourceRequirements Compute resources required by this component.
If omitted, the operator applies reasonable defaults, depending on the configured profile.
autoscalingConfig AutoscalingConfig Autoscaling configuration per component, otherwise the standard behavior applies.
affinity Affinity Group of affinity scheduling rules.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for the pod to be scheduled on that node.
tolerations Toleration array The pod that this toleration is attached to tolerates any taint that matches
the triple key,value,effect by using the matching operator operator.
priorityClassName string Configures a priority class for the component.
properties Properties Configures component configuration properties.

Controller

Appears in:

Field Description Default Validation
imageConfig ImageConfig Image config for the gateway-controller image
replicas integer Number of gateway-controller replicas
tlsCipherSuites string array List of TLS cipher suites to use. Ignored when 'disableTls' is true
config DeploymentConfig Define configuration for the gateway-controller deployment.

Core

Core is the Schema for the cores API.

Appears in:

Field Description Default Validation
apiVersion string instana.io/v1beta2
kind string Core
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec CoreSpec CoreSpec specifies the configuration of an Instana core.

CoreList

CoreList contains a list of Core.

Field Description Default Validation
apiVersion string instana.io/v1beta2
kind string CoreList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Core array

CoreSpec

CoreSpec defines the desired state of Core.

Appears in:

Field Description Default Validation
imageConfig ImageConfig Overrides the Docker image for the component.
Only the fields that should be overridden (e.g. Tag) have to be set.
imagePullPolicy PullPolicy Image pull policy.
One of Always, Never, IfNotPresent.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
imagePullSecrets LocalObjectReference array ImagePullSecrets is an optional list of references to secrets to use for pulling images.
The specified secrets must be present in core and unit namespaces.
serviceAccountAnnotations object (keys:string, values:string) Annotations for the ServiceAccount that is created for the pods.
Can e.g. be used to assign IAM roles on EKS.
priorityClassName string Configures a global priority class for all pods created by the operator.
baseDomain string Base domain for Instana.
domains Domains DO NOT USE: Configures the domains for the base domain and acceptor domains.
acceptors Acceptors Configuration for the domains and ports of all the acceptors.
gatewayConfig GatewayConfig Configuration for the Gateway components
autoscalingEnabled boolean Beta (Please check the behavior in a reprensentative test cluster.)
Enables the creation of HorizontalPodAutoscaling resources for the Instana backend components, to make further configurations this to the AutoscalingConfig in the ComponentConfig.
resourceProfile ResourceProfile The resource profile to use. medium Enum: [demo small medium large]
storageConfigs StorageConfigs Configuration for all external storages. Configures where external storage for each component should be stored.
heapDumpsPVC PersistentVolumeClaimSpec Configures a PVC for storing JVM heap dumps. If not configured, heaps dump are written
to a mounted emptyDir on OufOfMemoryError. The volume must support ReadWriteMany access.
datastoreConfigs DatastoreConfigs DatastoreConfigs configure data store connection information.
componentConfigs ComponentConfigs ComponentConfigs override component default configurations.
deploymentStrategyType DeploymentStrategyType Type of deployment strategy for the component deployments (default: RollingUpdate) RollingUpdate Enum: [RollingUpdate Recreate]
Optional: {}
emailConfig EmailConfig Configuration for sending e-mails via Amazon SES or an SMTP server.
serviceProviderConfig ServiceProviderConfig Service provider configuration for SAML or OIDC.
proxyConfig ProxyConfig ProxyConfig configuration.
geoDbUrl string URL for downloading the GeoLite2 geolocation data file.
agentAcceptorConfig HostPort Host and port for the agent acceptor.
featureFlags FeatureFlags Configures global feature flags.
env Envs Configures global environment variables.
properties Properties Configures global component configuration properties.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for pods to be scheduled on that node.
tolerations Toleration array The pod that this toleration is attached to tolerates any taint that matches
the triple key,value,effect by using the matching operator operator.
operationMode OperationMode Operator operation mode. One of 'normal' or 'maintenance' (defaults to 'normal').
Deployments are scaled to zero if it is set to 'maintenance'.		 normal Enum: [normal maintenance]
operationScopes OperationScope array Defines components of which scope to deploy. Only relevant for SaaS-like deployment scenarios. [core global] Enum: [core global]

DatastoreConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.

DatastoreConfigs

Appears in:

Field Description Default Validation
cassandraConfigs CassandraConfig array
clickhouseConfigs ClickhouseConfig array
elasticsearchConfig ElasticsearchConfig
kafkaConfig KafkaConfig
beeInstanaConfig BeeInstanaConfig
postgresConfigs PostgresConfig array

DeploymentConfig

DeploymentConfig defines configuration for a component deployment.

Appears in:

Field Description Default Validation
envs Envs Environment variables
resources ResourceRequirements Compute resources required by this component.
If omitted, the operator applies reasonable defaults, depending on the configured profile.
affinity Affinity Group of affinity scheduling rules.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for the pod to be scheduled on that node.
tolerations Toleration array The pod that this toleration is attached to tolerates any taint that matches
the triple key,value,effect by using the matching operator operator.
priorityClassName string Configures a priority class for the component.

Domains

DO NOT USE: Domains defines the FQDNs of the base domain as well as the agent and OTLP acceptors

Appears in:

Field Description Default Validation
base string DO NOT USE: FQDN for base domain
agentAcceptor string DO NOT USE: FQDN for agent acceptor
otlpHttp string DO NOT USE: FQDN for open-telemetry acceptor (HTTP)
otlpGrpc string DO NOT USE: FQDN for open-telemetry acceptor (gRPC)

ElasticsearchConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.
clusterName string onprem_onprem
defaultIndexShards integer 5
defaultIndexReplicas integer 0
defaultIndexRoutingPartitionSize integer 2
indexConfigs IndexConfig array

EmailConfig

EmailConfig is configuration for email.

Appears in:

Field Description Default Validation
smtpConfig SMTPConfig Configures an SMTP server for sending e-mails.
sesConfig SESConfig Configures Amazon Simple Email Service for sending e-mails.

Env

Underlying type: struct{Name string "json:"name""; Value string "json:"value,omitempty""}

Environment variable configuration.

Appears in:

EnvoyLogLevel

Underlying type: string

Appears in:

Field Description
off
debug
info
error

Envs

Underlying type: Env

Appears in:

FeatureFlag

FeatureFlag flag configuration.

Appears in:

Field Description Default Validation
name string The name of the feature flag.
enabled boolean Toggles the feature flag.

FeatureFlags

Underlying type: FeatureFlag

Appears in:

Field Description Default Validation
name string The name of the feature flag.
enabled boolean Toggles the feature flag.

GCloudConfig

Underlying type: struct{Bucket string "json:"bucket""; Prefix string "json:"prefix""; StorageClass string "json:"storageClass""; BucketLongTerm string "json:"bucketLongTerm,omitempty""; PrefixLongTerm string "json:"prefixLongTerm,omitempty""; StorageClassLongTerm string "json:"storageClassLongTerm,omitempty""; ServiceAccountKey string "json:"-" yaml:"serviceAccountKey""}

GCloudConfig configuration.

Appears in:

Gateway

Appears in:

Field Description Default Validation
imageConfig ImageConfig Image config for the gateway image
replicas integer Number of gateway replicas
logLevel EnvoyLogLevel Set the log level for gateway error Enum: [debug info error off]
adminListener string Configure the listener IP for gateway admin endpoint 127.0.0.1
circuitBreakers CircuitBreakers Configure the circuit breaker values for Gateway acceptor ingress traffic.
config DeploymentConfig Define configuration for the gateway deployment.
loadBalancerConfig LoadBalancerConfig LoadBalancer configuration for Gateway.

GatewayConfig

GatewayControllerConfig contains the configuration for the gateway components.

Appears in:

Field Description Default Validation
enabled boolean Enable special handling of the gateway components
disableTLS boolean Disables TLS termination false
gateway Gateway Configuration for the gateway component
controller Controller Configuration for the gateway-controller component

HostPort

HostPort holds a host and port combination.

Appears in:

Field Description Default Validation
host string The host name or IP address.
port integer The port.

HostPortWithName

HostPortWithName holds a host and port combination along with a name.

Appears in:

Field Description Default Validation
host string The host name or IP address.
port integer The port number.

ImageConfig

ImageConfig configures the Docker image for the components.

Appears in:

Field Description Default Validation
registry string The Docker registry to use. Defaults to 'artifact-public.instana.io'.
repository string Path to the image within the registry. Defaults to 'backend'.
The operator automatically appends component names when it computes the full image tag.
tag string The image version to use. Each operator release comes with a default version that is
used when the field is left empty.

IndexConfig

Appears in:

Field Description Default Validation
name string
shards integer
replicas integer
routingPartitionSize integer

KafkaConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.
replicationFactor integer 1 Minimum: 1
saslMechanism string SASL mechanism the client uses to authenticate with the broker. Possible values are PLAIN, SCRAM-SHA-256, SCRAM-SHA-512. PLAIN

LoadBalancerConfig

Appears in:

Field Description Default Validation
enabled boolean Enable creation of loadbalancers. false
ip string Configure external IP for the loadbalancer. MaxLength: 253
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
externalTrafficPolicy ServiceExternalTrafficPolicy Set the external traffic policy for the loadbalancer. Local
annotations Set Configure annotations for the loadbalancer.

NamedPorts

Underlying type: NamedPort

Appears in:

OTLPAcceptors

Appears in:

Field Description Default Validation
http HostPortWithName Host and port for open-telemetry acceptor (HTTP endpoint)
grpc HostPortWithName Host and port for open-telemetry acceptor (gRPC endpoint)

OperationMode

Underlying type: string

Appears in:

Field Description
normal
maintenance

OperationScope

Underlying type: string

Validation:

  • Enum: [core global]

Appears in:

Field Description
global
core

PostgresConfig

Appears in:

Field Description Default Validation
hosts string array A list of hosts for connecting to the data store.
For ClickHouse clusters, entries must be in correct order for sharding.		 MinItems: 1
ports NamedPorts A list of named ports for connecting to the data store.
If omitted, default ports are used.
properties Properties Optional properties for the data store.
authEnabled boolean Enables authentication for the data store. Credentials are expected to be configured in a secret
in the core namespace that has the same name as the corresponding core.
databases string array

Properties

Underlying type: Property

Appears in:

ProxyConfig

Appears in:

Field Description Default Validation
host string The host name or IP address.
port integer The port.
nonProxyHosts string array

ResourceProfile

Underlying type: string

ResourceProfile denotes the type for holding the profile name.

Appears in:

S3Config

Underlying type: struct{Endpoint string "json:"endpoint""; Region string "json:"region""; Bucket string "json:"bucket""; Prefix string "json:"prefix""; StorageClass string "json:"storageClass""; BucketLongTerm string "json:"bucketLongTerm,omitempty""; PrefixLongTerm string "json:"prefixLongTerm,omitempty""; StorageClassLongTerm string "json:"storageClassLongTerm,omitempty""; ForcePathStyle bool "json:"forcePathStyle,omitempty""; AccessKeyId string "json:"-" yaml:"accessKeyId""; SecretAccessKey string "json:"-" yaml:"secretAccessKey""}

S3Config configuration.

Appears in:

SESConfig

SESConfig configures Amazon Simple Email Service for sending e-mails.

Appears in:

Field Description Default Validation
from string From e-mail address.
returnPath string Return path.
region string AWS region.

SMTPConfig

SMTPConfig configures an SMTP server for sending e-mails.

Appears in:

Field Description Default Validation
from string From e-mail address.
host string Host name of the SMTP server.
port integer Port of the SMTP server.
useSSL boolean UseSSL enables SSL if set to true. false
startTLS boolean StartTLS enables StartTLS if set to true. false
check_server_identity boolean CheckServerIdentity enables server identity verification if set to true. false

ServiceProviderConfig

Appears in:

Field Description Default Validation
basePath string Base URL (defaults to "/auth"). /auth Pattern: ^\/.*
maxIDPMetadataSizeInBytes integer The maximum IDP metadata size (defaults to 200000). 200000
maxAuthenticationLifetimeSeconds integer The maximum authentication lifetime (defaults to 604800). 604800

Status

Underlying type: string

Instana Status.

Appears in:

Field Description
Ready
Error
Progressing
Maintenance

StorageConfig

Appears in:

Field Description Default Validation
pvcConfig PersistentVolumeClaimSpec Configures a PersistentVolumeClaim for external storage.
The volume must support ReadWriteMany access.
s3Config S3Config Configures S3 (or compatible) for external storage.
gcloudConfig GCloudConfig Configures Google Cloud Storage for external storage.

StorageConfigs

Configuration for external storage (PVC, S3, GCloud buckets)

Appears in:

Field Description Default Validation
rawSpans StorageConfig Configuration for raw spans external storage. Configures where raw spans should be stored.
synthetics StorageConfig Configuration for synthetics external storage. Configures where synthetics test results should be stored.
syntheticsKeystore StorageConfig Configuration for Synthetics external storage. Configures where Synthetics store credentials.
eumSourceMaps StorageConfig Configuration for EUM external storage. Configures where EUM source maps should be stored.
butlerKeystore StorageConfig Configuration for Butler's external storage.

Unit

Unit is the Schema for the units API.

Appears in:

Field Description Default Validation
apiVersion string instana.io/v1beta2
kind string Unit
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec UnitSpec

UnitList

UnitList contains a list of Unit.

Field Description Default Validation
apiVersion string instana.io/v1beta2
kind string UnitList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Unit array

UnitSpec

UnitSpec defines the desired state of Unit

Appears in:

Field Description Default Validation
coreName string Name of the core.
coreNamespace string Namespace where the core components reside.
unitName string Name of the tenant unit. MaxLength: 13
Pattern: ^[a-z][a-z0-9]*$
tenantName string Name of the tenant. MaxLength: 15
Pattern: ^[a-z][a-z0-9]*$
resourceProfile ResourceProfile The resource profile to use. medium Enum: [demo small medium large]
heapDumpsPVC PersistentVolumeClaimSpec Configures a PVC for storing JVM heap dumps. If not configured, heaps dump are written
to a mounted emptyDir on OufOfMemoryError. The volume must support ReadWriteMany access.
env Envs Configures global environment variables.
componentConfigs ComponentConfigs ComponentConfigs overrides component default configurations.
priorityClassName string Configures a priority class for all unit components.
Overrides a priority class configured on core level.
properties Properties Configures component configuration properties.
nodeSelector object (keys:string, values:string) Selector which must match a node's labels for pods to be scheduled on that node.
Overrides a node selector configured on core level.
tolerations Toleration array The pod that this toleration is attached to tolerates any taint that matches
the triple key,value,effect by using the matching operator operator.
Overrides tolerations configured on core level.
operationMode OperationMode Unit operation mode. One of 'normal' or 'maintenance' (defaults to 'normal').
Deployments are scaled to zero if it is set to 'maintenance'.		 normal Enum: [normal maintenance]