API reference

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

Appears in:

• CoreSpec

Table 1. Acceptor configuration fields

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

Appears in:

• ComponentConfig
• CoreSpec

Table 2. Autoscaling configuration

Field	Description	Default	Validation
enabledboolean	Enables autoscaling for this component. If not set, inherits from global config.
minReplicasinteger	The minimum replica count from which the autoscaler starts to scale, the default is 1.
maxReplicasinteger	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: {}

Appears in:

• DatastoreConfigs

Table 3. Beeinstana configuration

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.
clusteredboolean	For a BeeInstana Operator cluster, the value must betrue	true

Appears in:

• DatastoreConfigs

Table 4. Cassandra configuration

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.
keyspacesstring array
datacenterstring		cassandra
strategystring	Specifies the data replication strategy used by keyspaces	NetworkTopologyStrategy	Enum: [SimpleStrategy NetworkTopologyStrategy SingleRegionStrategy LocalStrategy]
replicationFactorinteger		1	Minimum: 1
isAmazonKeyspacesboolean	Specifies whether Amazon Keyspaces is used instead of Datastax Cassandra. This feature is currently for internal use only.	false

Appears in:

• Gateway

Table 5. Circuit configuration

Field	Description	Default	Validation
maxConnectionsinteger	The maximum number of connections allowed to the upstream cluster.
maxPendingRequestsinteger	The maximum number of pending requests allowed to the upstream cluster.
maxRequestsinteger	The maximum number of parallel requests allowed to the upstream cluster.
maxRetriesinteger	The maximum number of parallel retries allowed to the upstream cluster.

Appears in:

• DatastoreConfigs

Table 6. Clickhouse configuration

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.
schemasstring array
clusterNamestring		local

ComponentConfig allows additional configuration for a specific component.

Appears in:

• ComponentConfigs

Table 7. Component configuration

Field	Description	Default	Validation
namestring	The name of the component.
extraLabelsobject (keys:string, values:string)	ExtraLabels to be added to all objects related to this component.
disabledboolean	Disables the component.
imageTagstring	Overrides the Docker image tag of the component.
imageConfigImageConfig	// Overrides the Docker image for the components. controller-gen requires JSON tags to be set, even though they don't make sense for a private field.
replicasinteger	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.
nodeSelectorobject (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 triplekey,value,effect by using the matching operatoroperator.
priorityClassNamestring	Configures a priority class for the component.
properties Properties	Configures component configuration properties.

Underlying type: ComponentConfig

Appears in:

• CoreSpec
• UnitSpec

Table 8. Component configuration

Field	Description	Default	Validation
namestring	The name of the component.
extraLabelsobject (keys:string, values:string)	ExtraLabels to be added to all objects related to this component.
disabledboolean	Disables the component.
imageTagstring	Overrides the Docker image tag of the component.
imageConfigImageConfig	// Overrides the Docker image for the components. controller-gen requires JSON tags to be set, even though they don't make sense for a private field.
replicasinteger	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.
nodeSelectorobject (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 triplekey,value,effect by using the matching operatoroperator.
priorityClassNamestring	Configures a priority class for the component.
properties Properties	Configures component configuration properties.

Appears in:

• GatewayConfig

Table 9. Concert Gateway configuration fields

Field	Description	Default	Validation
enabledboolean	Enables the concert gateway component.	false
config DeploymentConfig	Configuration for the concert gateway deployment.
imageConfig ImageConfig	Image config for the concert gateway image
imagePullSecrets LocalObjectReference array	ImagePullSecrets is a list of references to secrets to use for pulling images.
replicasinteger	Number of concert gateway replicas.
loadBalancerConfig LoadBalancerConfig	LoadBalancer configuration for the concert gateway.
internalTLSSecretNamestring	Name of the secret containing internal TLS certificates for the concert gateway.
propertiesProperties	Concert gateway specific configuration properties.

Appears in:

• GatewayConfig

Table 10. Controller configuration fields

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

Core is the Schema for the cores API.

Appears in:

• CoreList

Table 11. Core configuration fields

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

CoreList contains a list of Core.

Table 12. Corelist configuration fields

Field	Description	Default	Validation
apiVersionstring	instana.io/v1beta2
kindstring	CoreList
metadata ListMeta	Refer to Kubernetes API documentation for fields ofmetadata.
items Core array

CoreSpec defines the desired state of Core.

Appears in:

• Core

Table 13. Corespec configuration fields

Field	Description	Default	Validation
extraLabelsobject (keys:string, values:string)	Additional labels to be added to all objects the operator creates. This includes Unit objects unless explicitly set there.
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.
serviceAccountAnnotationsobject (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.
priorityClassNamestring	Configures a global priority class for all pods created by the operator.
baseDomainstring	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
autoscalingEnabledboolean	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.
portalConfigPortalConfig	PortalConfig contains the configuration for Portal
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.
geoDbUrlstring	URL for downloading the GeoLite2 geolocation data file.	https://artifact-public.instana.io/artifactory/rel-generic-instana-virtual/geodb/geolite2-city.tar.gz
repositoryURLstring	The agent artifact repository URL.	https://artifact-public.instana.io/artifactory/rel-generic-instana-virtual/
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.
nodeSelectorobject (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 triplekey,value,effect by using the matching operatoroperator.
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]

Appears in:

• BeeInstanaConfig
• CassandraConfig
• ClickhouseConfig
• ElasticsearchConfig
• KafkaConfig
• PostgresConfig

Table 14. Datastore configuration fields

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.

Appears in:

• CoreSpec

Table 15. Datastore configuration fields

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

DeploymentConfig defines configuration for a component deployment.

Appears in:

• ConcertGatewayConfig
• Controller
• Gateway

Table 16. Deployment configuration fields

Field	Description	Default	Validation
envs Envs	Environment variables
extraLabelsSet	Extra labels for the Gateway pod
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.
nodeSelectorobject (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 triplekey,value,effect by using the matching operatoroperator.
priorityClassNamestring	Configures a priority class for the component.

Appears in:

• DatastoreConfigs

Table 17. Elasticsearch configuration fields

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.
clusterNamestring		onprem_onprem
defaultIndexShardsinteger		5
defaultIndexReplicasinteger		0
defaultIndexRoutingPartitionSizeinteger		2
indexConfigs IndexConfig array
isAmazonOpensearchboolean	Specifies whether Amazon Opensearch is used instead of Elasticsearch. This feature is currently for internal use only.	false

EmailConfig is configuration for email.

Appears in:

• CoreSpec

Table 18. Email configuration fields

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.

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

Environment variable configuration.

Appears in:

• Envs

Underlying type: string

Appears in:

• Gateway

Table 19. Envoylog level configuration fields

Field	Description
off
debug
info
error

Underlying type: Env

Appears in:

• ComponentConfig
• CoreSpec
• DeploymentConfig
• UnitSpec

FeatureFlag flag configuration.

Appears in:

• FeatureFlags

Table 20. Featureflag configuration fields

Field	Description	Default	Validation
namestring	The name of the feature flag.
enabledboolean	Toggles the feature flag.

Underlying type: FeatureFlag

Appears in:

• CoreSpec

Table 21. Featureflags configuration fields

Field	Description	Default	Validation
namestring	The name of the feature flag.
enabledboolean	Toggles the feature flag.

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:

• StorageConfig

Appears in:

• GatewayConfig

Table 22. Gateway configuration fields

Field	Description	Default	Validation
imageConfig ImageConfig	Image config for the gateway image
replicasinteger	Number of gateway replicas
logLevel EnvoyLogLevel	Set the log level for gateway	error	Enum: [debug info error off]
adminListenerstring	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.
externalHTTPSPortinteger	Configures the external HTTPS port for the gateway.
overloadManagerOverloadManager	Overload Manager configuration for Gateway

GatewayControllerConfig contains the configuration for the gateway components.

Appears in:

• CoreSpec

Table 23. Gateway configuration fields

Field	Description	Default	Validation
disableTLSboolean	Disables TLS termination	false
gateway Gateway	Configuration for the gateway component
controller Controller	Configuration for the gateway-controller component
concertConcertGatewayConfig	Configuration for the concert gateway component

HostPort holds a host and port combination.

Appears in:

• CoreSpec
• ProxyConfig

Table 24. Hostport configuration fields

Field	Description	Default	Validation
hoststring	The host name or IP address.
portinteger	The port.

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

Appears in:

• Acceptors
• OTLPAcceptors

Table 25. Hostport with name configuration fields

Field	Description	Default	Validation
hoststring	The host name or IP address.
portinteger	The port number.

ImageConfig configures the Docker image for the components.

Appears in:

• ComponentConfig
• ConcertGatewayConfig
• Controller
• CoreSpec
• Gateway

Table 26. Image configuration fields

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

Appears in:

• ElasticsearchConfig

Table 27. Index configuration fields

Field	Description	Default	Validation
namestring
shardsinteger
replicasinteger
routingPartitionSizeinteger

Appears in:

• DatastoreConfigs

Table 28. Kafka configuration fields

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.
replicationFactorinteger		1	Minimum: 1
saslMechanismstring	SASL mechanism the client uses to authenticate with the broker. Possible values are PLAIN, SCRAM-SHA-256, SCRAM-SHA-512.	PLAIN
securityProtocolstring	Security protocol used by the Kafka client. Possible values are PLAINTEXT, SASL_PLAINTEXT, SASL_SSL, SSL	SASL_PLAINTEXT

Appears in:

• ConcertGatewayConfig
• Gateway

Table 29. Load balancer configuration fields

Field	Description	Default	Validation
enabledboolean	Enable creation of loadbalancers.	false
ipstring	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.

Underlying type: NamedPort

Appears in:

• BeeInstanaConfig
• CassandraConfig
• ClickhouseConfig
• DatastoreConfig
• ElasticsearchConfig
• KafkaConfig
• PostgresConfig

Appears in:

• Acceptors

Table 30. OTLP acceptor configuration fields

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)

Underlying type: string

Appears in:

• CoreSpec
• UnitSpec

Table 31. Operation mode configuration fields

Field	Description
normal
maintenance

Underlying type: string

Validation:

• Enum: [core global]

Appears in:

• CoreSpec

Table 32. Operation scope configuration fields

Field	Description
global
core

Appears in:

• CoreSpec

Table 34. Portal configuration fields

Field	Description	Default	Validation
hoststring	Portal endpoint URL

Appears in:

• DatastoreConfigs

Table 35. Postgres configuration fields

Field	Description	Default	Validation
hostsstring 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.
authEnabledboolean	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.
databasesstring array

Underlying type: Property

Appears in:

• BeeInstanaConfig
• CassandraConfig
• ClickhouseConfig
• ComponentConfig
• ConcertGatewayConfig
• CoreSpec
• DatastoreConfig
• ElasticsearchConfig
• KafkaConfig
• PostgresConfig
• UnitSpec

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

Property for component configuration.

Appears in:

• Properties

Appears in:

• CoreSpec

Table 36. Proxy configuration fields

Field	Description	Default	Validation
hoststring	The host name or IP address.
portinteger	The port.
nonProxyHostsstring array

Underlying type: string

ResourceProfile denotes the type for holding the profile name.

Appears in:

• CoreSpec
• UnitSpec

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:

• StorageConfig

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

Appears in:

• EmailConfig

Table 37. SES configuration fields

Field	Description	Default	Validation
fromstring	From e-mail address.
returnPathstring	Return path.
regionstring	AWS region.

SMTPConfig configures an SMTP server for sending e-mails.

Appears in:

• EmailConfig

Table 38. SMTP configuration fields

Field	Description	Default	Validation
fromstring	From e-mail address.
hoststring	Host name of the SMTP server.
portinteger	Port of the SMTP server.
useSSLboolean	UseSSL enables SSL if set to true.	false
startTLSboolean	StartTLS enables StartTLS if set to true.	false
check_server_identityboolean	CheckServerIdentity enables server identity verification if set to true.	false

Appears in:

• CoreSpec

Table 39. Service provider configuration fields

Field	Description	Default	Validation
basePathstring	Base URL (defaults to "/auth").	/auth	Pattern:^\/.*
maxIDPMetadataSizeInBytesinteger	The maximum IDP metadata size (defaults to 200000).	200000
maxAuthenticationLifetimeSecondsinteger	The maximum authentication lifetime (defaults to 604800).	604800

Underlying type: string

Instana Status.

Appears in:

• ResourceStatus

Table 40. Status configuration fields

Field	Description
Ready
Error
Progressing
Maintenance

Appears in:

• StorageConfigs

Table 41. Storage configuration fields

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.

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

Appears in:

• CoreSpec

Table 42. Storage configuration fields

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 is the Schema for the units API.

Appears in:

• UnitList

Table 43. Unit configuration fields

Field	Description	Default	Validation
apiVersionstring	instana.io/v1beta2
kindstring	Unit
metadata ObjectMeta	Refer to Kubernetes API documentation for fields ofmetadata.
spec UnitSpec

UnitList contains a list of Unit.

Table 44. Unit list configuration fields

Field	Description	Default	Validation
apiVersionstring	instana.io/v1beta2
kindstring	UnitList
metadata ListMeta	Refer to Kubernetes API documentation for fields ofmetadata.
items Unit array

UnitSpec defines the desired state of Unit

Appears in:

• Unit

Table 45. Unit spec configuration fields

Field	Description	Default	Validation
extraLabelsobject (keys:string, values:string)	Additional labels to be added to all unit objects the operator creates.
coreNamestring	Name of the core.
coreNamespacestring	Namespace where the core components reside.
unitNamestring	Name of the tenant unit.		MaxLength: 13 Pattern:^[a-z][a-z0-9]*$
tenantNamestring	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.
priorityClassNamestring	Configures a priority class for all unit components. Overrides a priority class configured on core level.
properties Properties	Configures component configuration properties.
nodeSelectorobject (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 triplekey,value,effect by using the matching operatoroperator. 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]